SBDDataGraphBaseEvent Class Reference

This class describes a base event. More...

Event types

enum  Type {
  NodeCreated,
  NodeEraseBegin,
  NodeEraseEnd,
  NodeErased,
  NodeDeleteBegin,
  NodeDeleteEnd,
  NodeDeleted,
  SelectionFlagChanged,
  VisibilityFlagChanged,
  HighlightingFlagChanged,
  IndexChanged,
  NameChanged,
  Shown,
  Hidden,
  MaterialAdded,
  MaterialRemoved,
  MaterialChanged,
  UUIDChanged,
  LockedFlagChanged,
  TransparencyChanged
}
 The type of the data graph base event. More...
 

Constructors and destructors

 SBDDataGraphBaseEvent (SBDDataGraphNode *sender, Type type)
 
virtual ~SBDDataGraphBaseEvent ()
 

Identity

virtual Category getCategory () const
 Returns the category of the event.
 
Type getType () const
 Returns the type of the data graph base event.
 
static std::string getTypeString (Type type)
 Returns a string describing the type of the data graph base event. More...
 

Debugging

virtual void print (unsigned int offset=0) const
 Prints some debugging information.
 
 SB_DECLARE_DATA (SBDDataGraphBaseEvent)
 
 SBDDataGraphBaseEvent (SBDDataGraphBaseEventData *dataPointer)
 

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
 This function returns the sender of an event.
 
- Static Public Member Functions inherited from SBDDataGraphEvent
static std::string getCategoryString (Category category)
 
- Protected Member Functions inherited from SBDDataGraphEvent
 SBDDataGraphEvent (SBDDataGraphEventData *dataPointer)
 
- Protected Attributes inherited from SBDDataGraphEvent
SBDDataGraphEventData * dataPointer
 

Detailed Description

Short name: SBBaseEvent

Member Enumeration Documentation

◆ Type

Enumerator
NodeCreated 

A node was created.

NodeEraseBegin 

Node erasing started.

NodeEraseEnd 

Node erasing finished.

NodeErased 

A node was erased.

NodeDeleteBegin 

Node deleting started.

NodeDeleteEnd 

Node deleting finished.

NodeDeleted 

A node was deleted.

SelectionFlagChanged 

A node's selection flag was changed.

VisibilityFlagChanged 

A node's visibility flag was changed.

HighlightingFlagChanged 

A node's highlighting flag was changed.

IndexChanged 

A node's index was changed.

NameChanged 

A node's name was changed.

Shown 

A node was shown.

Hidden 

A node was hidden.

MaterialAdded 

A node's material was added.

MaterialRemoved 

A node's material was removed.

MaterialChanged 

A node's material was changed.

UUIDChanged 

A node's UUID was changed.

LockedFlagChanged 

A node's locked flag was changed.

TransparencyChanged 

A node's transparency was changed.

Member Function Documentation

◆ getTypeString()

std::string SBDDataGraphBaseEvent::getTypeString ( SBDDataGraphBaseEvent::Type  type)
static
Parameters
typeA type of the base event

This function returns the string representation of the base event type type