Composite Class Reference

The Common Vision Blox composite. More...

Inherits object.

Public Member Functions
None	Composite (self, int purpose=cvb.CompositePurpose.Custom)
	Creates a composite with the given optional parameter. More...
cvb.Composite	from_object (Union[cvb.MultiPartImage, cvb.PointCloud] object)
	Returns a composite object from the given composite compatible object. More...
None	insert_item_at (self, int index, Union[cvb.Image, cvb.Plane] item)
	Insert a composite item specified at given index. More...

Properties
	item_count = property
	int: Number of variants in the composite.
	purpose = property
	int: The purpose of the composite container (see cvb.CompositePurpose).

Detailed Description

The Common Vision Blox composite.

Constructor & Destructor Documentation

Composite()

None Composite	(		self,
		int	purpose = cvb.CompositePurpose.Custom
	)

Creates a composite with the given optional parameter.

For accessing the individual items use[].

Parameters

purpose : int The purpose of this container (see cvb.CompositePurpose).

Member Function Documentation

from_object()

cvb.Composite from_object

(

Union[cvb.MultiPartImage, cvb.PointCloud]

object

)

Returns a composite object from the given composite compatible object.

Parameters

object : Union[cvb.MultiPartImage, cvb.PointCloud] A composite compatible object to share.

Returns

cvb.Composite A composite that shares resources with the given object.

insert_item_at()

None insert_item_at	(		self,
		int	index,
		Union[cvb.Image, cvb.Plane]	item
	)

Insert a composite item specified at given index.

Parameters

index : int Item index to insert the composite item at given index.

item : Union[cvb.Image, cvb.Plane] The composite item to insert.