OpenCMISS-Zinc C++ API Documentation
 All Classes Namespaces Files Functions Typedefs Enumerations Enumerator Pages
Public Member Functions | Protected Attributes | List of all members
OpenCMISS::Zinc::Sceneviewernotifier Class Reference

Manages individual user notification of changes with a scene viewer. More...

#include <sceneviewer.hpp>

Public Member Functions

 Sceneviewernotifier (cmzn_sceneviewernotifier_id in_sceneviewernotifier_id)
 
 Sceneviewernotifier (const Sceneviewernotifier &sceneviewerNotifier)
 
Sceneviewernotifieroperator= (const Sceneviewernotifier &sceneviewerNotifier)
 
bool isValid () const
 
cmzn_sceneviewernotifier_id getId () const
 
int setCallback (Sceneviewercallback &callback)
 
int clearCallback ()
 

Protected Attributes

cmzn_sceneviewernotifier_id id
 

Detailed Description

Manages individual user notification of changes with a scene viewer.

Manages individual user notification of changes with a scene viewer.

Member Function Documentation

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

Stop and clear scene viewer callback. This will stop the callback and also remove the callback function from the sceneviewer notifier.

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

Return the C handle of the Sceneviewernotifier object.

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

Check if this is a valid Sceneviewernotifier object.

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

Assign the callback function and user data for the sceneviewer notifier. This function also starts the callback.

See Also
cmzn_sceneviewernotifier_callback_function
Parameters
callbackfunction to be called when event is triggered.
user_data_inVoid pointer to user object. User must ensure this object's lifetime exceeds the duration for which callbacks are active.
Returns
Status OpenCMISS::Zinc::OK on success, any other value on failure.

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