Loading...
Searching...
No Matches
SBDControllerEvent Class Reference

This class describes a controller event.

Event types

enum  Type {
  ControllerNodeAdded ,
  ControllerNodeRemoved ,
  ControllerPressed ,
  ControllerReleased ,
  ControllerStateChanged
}
 

Constructors and destructors

 SBDControllerEvent (SBDController *controller, Type type, SBDControllerNode *auxiliaryNode=nullptr)
 Builds a controller event.
 
virtual ~SBDControllerEvent ()
 

Identity

virtual Category getCategory () const override
 Returns the category of the data graph event.
 
Type getType () const
 Returns the controller event type.
 
SBDControllerNodegetAuxiliaryNode () const
 Returns a pointer to the auxiliary node.
 
static std::string getTypeString (Type type)
 Returns the controller event type as a string.
 

Debugging

virtual void print (unsigned int offset=0) const override
 Prints debugging information.
 
 SB_DECLARE_DATA (SBDControllerEvent)
 

Additional Inherited Members

- Public Types inherited from SBDDataGraphEvent
enum  Category {
  UndefinedEvent ,
  BaseEvent ,
  DocumentEvent ,
  StructuralEvent ,
  VisualEvent ,
  DynamicalEvent ,
  InteractionEvent ,
  PropertyEvent ,
  StateUpdaterEvent ,
  SimulatorEvent ,
  ControllerEvent ,
  AssetEvent
}
 The category of the data graph event. More...
 
- Public Member Functions inherited from SBDDataGraphEvent
 SB_DECLARE_DATA (SBDDataGraphEvent)
 
 SBDDataGraphEvent (SBDDataGraphNode *sender)
 
virtual ~SBDDataGraphEvent ()
 
SBDDataGraphNodegetSender () const
 Returns the sender of the event.
 
- Static Public Member Functions inherited from SBDDataGraphEvent
static std::string getCategoryString (Category category)
 Returns a string representation of the category of the data graph event.
 
- Protected Member Functions inherited from SBDDataGraphEvent
 SBDDataGraphEvent (SBDDataGraphEventData *dataPointer)
 
- Protected Attributes inherited from SBDDataGraphEvent
SBDDataGraphEventData * dataPointer
 

Member Enumeration Documentation

◆ Type

Enumerator
ControllerNodeAdded 

Controller node added.

ControllerNodeRemoved 

Controller node removed.

ControllerPressed 

Controller node pressed.

ControllerReleased 

Controller node released.

ControllerStateChanged 

Controller node state changed.

Member Function Documentation

◆ getCategory()

SBDDataGraphEvent::Category SBDControllerEvent::getCategory ( ) const
overridevirtual

Reimplemented from SBDDataGraphEvent.

◆ print()

void SBDControllerEvent::print ( unsigned int  offset = 0) const
overridevirtual

Reimplemented from SBDDataGraphEvent.