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

Information about changes to the selection group in the scene. More...

#include <selection.hpp>

Public Types

enum  ChangeFlag { CHANGE_FLAG_NONE = CMZN_SELECTIONEVENT_CHANGE_FLAG_NONE, CHANGE_FLAG_ADD = CMZN_SELECTIONEVENT_CHANGE_FLAG_ADD, CHANGE_FLAG_REMOVE = CMZN_SELECTIONEVENT_CHANGE_FLAG_REMOVE, CHANGE_FLAG_FINAL = CMZN_SELECTIONEVENT_CHANGE_FLAG_FINAL }
 
typedef int ChangeFlags
 

Public Member Functions

 Selectionevent (cmzn_selectionevent_id in_selection_event_id)
 
 Selectionevent (const Selectionevent &selectionEvent)
 
Selectioneventoperator= (const Selectionevent &selectionEvent)
 
bool isValid () const
 
cmzn_selectionevent_id getId () const
 
ChangeFlags getChangeFlags () const
 

Protected Attributes

cmzn_selectionevent_id id
 

Detailed Description

Information about changes to the selection group in the scene.

Information about changes to the selection group in the scene, sent with each callback from the selection notifier.

Member Typedef Documentation

Type for passing logical OR of ChangeFlag

See also
getChangeFlags

Member Enumeration Documentation

Bit flags summarising changes to the selection.

Enumerator
CHANGE_FLAG_NONE 

no change

CHANGE_FLAG_ADD 

one or more objects added

CHANGE_FLAG_REMOVE 

one or more objects removed

CHANGE_FLAG_FINAL 

final notification: owning object destroyed

Member Function Documentation

ChangeFlags OpenCMISS::Zinc::Selectionevent::getChangeFlags ( ) const
inline

Get logical OR of flags indicating how the selection has changed, whether in the local region or hierarchically.

See also
Selectionevent::ChangeFlag
Returns
The change flags summarising the change: logical OR of enum Selectionevent::ChangeFlag values.
cmzn_selectionevent_id OpenCMISS::Zinc::Selectionevent::getId ( ) const
inline

Return the C handle of the Selectionevent object.

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

Check if this is a valid Selectionevent object.

Returns
Status True if object is valid, false otherwise.

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