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

Information about changes to fields and other objects in the scene viewer. More...

#include <sceneviewer.hpp>

Public Types

enum  ChangeFlag { CHANGE_FLAG_NONE = CMZN_SCENEVIEWEREVENT_CHANGE_FLAG_NONE, CHANGE_FLAG_REPAINT_REQUIRED = CMZN_SCENEVIEWEREVENT_CHANGE_FLAG_REPAINT_REQUIRED, CHANGE_FLAG_TRANSFORM = CMZN_SCENEVIEWEREVENT_CHANGE_FLAG_TRANSFORM, CHANGE_FLAG_FINAL = CMZN_SCENEVIEWEREVENT_CHANGE_FLAG_FINAL }
 
typedef int ChangeFlags
 

Public Member Functions

 Sceneviewerevent (cmzn_sceneviewerevent_id in_sceneviewer_event_id)
 
 Sceneviewerevent (const Sceneviewerevent &sceneviewerEvent)
 
Sceneviewereventoperator= (const Sceneviewerevent &sceneviewerEvent)
 
bool isValid () const
 
cmzn_sceneviewerevent_id getId () const
 
ChangeFlags getChangeFlags () const
 

Protected Attributes

cmzn_sceneviewerevent_id id
 

Detailed Description

Information about changes to fields and other objects in the scene viewer.

Information about changes to fields and other objects in the scene viewer, sent with each callback from the sceneviewer notifier.

Member Typedef Documentation

Type for passing logical OR of ChangeFlag

See Also
getChangeFlags

Member Enumeration Documentation

Bit flags summarising changes to fields in the field module.

Enumerator
CHANGE_FLAG_NONE 

object not changed

CHANGE_FLAG_REPAINT_REQUIRED 

repaint required evenet

CHANGE_FLAG_TRANSFORM 

sceneviewer receive input

CHANGE_FLAG_FINAL 

sceneviewer is currently being destroyed

Member Function Documentation

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

Get logical OR of flags indicating how fields in the scene viewer have changed.

See Also
Sceneviewerevent::ChangeFlag
  @return  The change flags summarising the change: logical OR of
  enum Sceneviewerevent::ChangeFlag

values.

cmzn_sceneviewerevent_id OpenCMISS::Zinc::Sceneviewerevent::getId ( ) const
inline

Return the C handle of the Sceneviewerevent object.

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

Check if this is a valid Sceneviewerevent object.

Returns
Status True if object is valid, false otherwise.

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