![]() |
OpenNI 1.5.4
|
#include <XnCppWrapper.h>
Public Member Functions | |
CroppingCapability (XnNodeHandle hNode) | |
CroppingCapability (const NodeWrapper &node) | |
XnStatus | SetCropping (const XnCropping &Cropping) |
XnStatus | GetCropping (XnCropping &Cropping) const |
XnStatus | RegisterToCroppingChange (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback) |
void | UnregisterFromCroppingChange (XnCallbackHandle hCallback) |
Purpose: Provides Cropping capability for map generator nodes. Cropping capability restricts the size of the data frames to be generated by the MapGenerator node to a selected (cropped) area of the full field-of-view.
Usage: Do not instantiate directly. Instead, use MapGenerator::GetCroppingCap() to obtain an instance.
Remarks:
When cropping is enabled, the size of the generated map is reduced to fit a lower resolution (smaller FOV dimensions). For example, if the map generator is working in VGA resolution (640x480) and the application chooses to crop at 300x200, the next pixel row will begin after 300 pixels. Pixels outside the cropping area are not returned in the buffer - they are not blacked out; they are not returned at all. Thus, cropping is very useful for providing a performance boost.
Event: 'Cropping Change'
Signals that the holder node's cropping area has been changed.
Use RegisterToCroppingChange() and UnregisterFromCroppingChange() for using this event.
Calling the SetCropping() method raises this event.
xn::CroppingCapability::CroppingCapability | ( | XnNodeHandle | hNode | ) | [inline] |
Ctor
[in] | hNode | Node handle |
xn::CroppingCapability::CroppingCapability | ( | const NodeWrapper & | node | ) | [inline] |
XnStatus xn::CroppingCapability::GetCropping | ( | XnCropping & | Cropping | ) | const [inline] |
Gets the current cropping configuration of the holder node. This configuration is that set by SetCropping(). This configuration is used for generating the next frame.
[out] | Cropping | Retreived cropping configuration. |
XN_STATUS_INVALID_OPERATION | The MapGenerator node does not support the Cropping capability. |
XnStatus xn::CroppingCapability::RegisterToCroppingChange | ( | StateChangedHandler | handler, |
void * | pCookie, | ||
XnCallbackHandle & | hCallback | ||
) | [inline] |
Registers an event handler for the 'Cropping Change' event.
[in] | handler | Callback function to be invoked when the event is raised. |
[in] | pCookie | User's cookie, to be delivered to the callback. |
[out] | hCallback | Handle to the callback to be used for unregistering it. |
For full details and usage of the parameters, see Registering to Events.
XnStatus xn::CroppingCapability::SetCropping | ( | const XnCropping & | Cropping | ) | [inline] |
Sets the holder node's current cropping configuration. This configuration is used for generating the next frame.
[in] | Cropping | Cropping configuration to be set. |
XN_STATUS_INVALID_OPERATION | The MapGenerator node does not support the Cropping capability. |
void xn::CroppingCapability::UnregisterFromCroppingChange | ( | XnCallbackHandle | hCallback | ) | [inline] |
Unregisters the event handler for the 'Cropping Change' event.
[in] | hCallback | Handle received from registration. |
For full details and usage of the parameter, see Unregistering from Events .