IPlaneEnum

Represents a fixed CVB IPlane set. More...

Typedefs
typedef void *	CVPLANEENUM
	CVB plane handle. More...

Functions
cvbbool_t	CVCIsPlaneEnum (CVPLANEENUM hPlaneEnum)
	Tests whether the given hPlaneEnum handle is a valid plane enumeration object. More...
cvbres_t	CVCPlaneEnumGetAt (CVPLANEENUM hPlaneEnum, cvbdim_t PlaneIndex, CVPLANE &hPlane)
	Gets the hPlane at the given PlaneIndex. More...
cvbres_t	CVCPlaneEnumGetCount (CVPLANEENUM hPlaneEnum, cvbdim_t &NumElements)
	Gets the number of planes available. More...

Detailed Description

Represents a fixed CVB IPlane set.

An IPlane is a linear (not necessary contiguous) data plane (see CVCImg library documentation for an explanation of CVB's plane concept). For a description on what linear means see CVCPlaneGetPixelPointer.

Every IPlaneEnum aggregates a fixed Count of IPlane objects
composing e.g. a 2D image or a 3D point cloud.

Typedef Documentation

CVPLANEENUM

CVPLANEENUM

CVB plane handle.

The CVPLANEENUM is a reference counted OBJ handle. CVPLANEENUM objects at least implement the IPlaneEnum interface.

Function Documentation

CVCIsPlaneEnum()

cvbbool_t CVCIsPlaneEnum

(

CVPLANEENUM

hPlaneEnum

)

Tests whether the given hPlaneEnum handle is a valid plane enumeration object.

Parameters

[in]

hPlaneEnum

Plane enumeration handle to test.

Returns

true if hPlaneEnum is a valid plane enumeration object; false if not.

CVCPlaneEnumGetAt()

cvbres_t CVCPlaneEnumGetAt	(	CVPLANEENUM	hPlaneEnum,
		cvbdim_t	PlaneIndex,
		CVPLANE &	hPlane
	)

Gets the hPlane at the given PlaneIndex.

Attention

If successful, the returned hPlane will have a by one increased reference count. Thus free the object via ReleaseObject if not needed anymore.

Parameters

[in]	hPlaneEnum	Plane enumeration handle to query.
[in]	PlaneIndex	Zero based index of plane to be retrieved.
[out]	hPlane	Variable to receive the plane handle.

Returns

• CVC_ERROR (CVC_E_OK) on success
• CVC_ERROR (CVC_E_WRONGOBJECT) if hPlaneEnum is not an CVPLANEENUM
• CVC_ERROR (CVC_E_INVALIDINDEX) if PlaneIndex is out of bounds

CVCPlaneEnumGetCount()

cvbres_t CVCPlaneEnumGetCount	(	CVPLANEENUM	hPlaneEnum,
		cvbdim_t &	NumElements
	)

Gets the number of planes available.

Parameters

[in]	hPlaneEnum	Plane enumeration handle to query.
[out]	NumElements	Variable to receive the number of planes.

Returns

CVC_ERROR (CVC_E_WRONGOBJECT) if hPlaneEnum is not an CVPLANEENUM; CVC_ERROR (CVC_E_OK) on success.