OpenCMISS-Zinc C++ API Documentation
Public Member Functions | Protected Attributes | List of all members
OpenCMISS::Zinc::Selectionnotifier Class Reference

Manages individual user notification of changes to the selection group. More...

#include <selection.hpp>

Public Member Functions

 Selectionnotifier (cmzn_selectionnotifier_id in_selectionnotifier_id)
 
 Selectionnotifier (const Selectionnotifier &selectionNotifier)
 
Selectionnotifieroperator= (const Selectionnotifier &selectionNotifier)
 
bool isValid () const
 
cmzn_selectionnotifier_id getId () const
 
int setCallback (Selectioncallback &callback)
 
int clearCallback ()
 

Protected Attributes

cmzn_selectionnotifier_id id
 

Detailed Description

Manages individual user notification of changes to the selection group.

Manages individual user notification of changes to the selection group in a scene.

Member Function Documentation

int OpenCMISS::Zinc::Selectionnotifier::clearCallback ( )
inline

Stop and clear selection callback. This will stop the callback and also remove the callback function from the selection notifier.

Returns
Status OpenCMISS::Zinc::OK on success, any other value on failure.
cmzn_selectionnotifier_id OpenCMISS::Zinc::Selectionnotifier::getId ( ) const
inline

Return the C handle of the Selectionnotifier object.

Returns
C handle of Selectionnotifier if this objects is valid, 0 otherwise.
bool OpenCMISS::Zinc::Selectionnotifier::isValid ( ) const
inline

Check if this is a valid Selectionnotifier object.

Returns
Status True if object is valid, false otherwise.
int OpenCMISS::Zinc::Selectionnotifier::setCallback ( Selectioncallback callback)
inline

Assign the callback function and user_data for the selection notifier. This function also starts the callback.

See also
cmzn_selectionnotifier_callback_function
Parameters
callbackfunction to be called when event is triggered.
user_data_inVoid pointer to an user object. User is responsible for the life time of such object.
Returns
Status OpenCMISS::Zinc::OK on success, any other value on failure.

The documentation for this class was generated from the following file: