SBDDocumentEvent Class Reference

This class describes a document event.

Event types
enum	Type {   FileNameChanged ,   DocumentAdded ,   DocumentRemoved ,   ActiveDocumentChanged ,   DocumentCloseBegin ,   DocumentCloseEnd ,   FolderAdded ,   FolderRemoved ,   CameraAdded ,   CameraRemoved ,   CameraChanged ,   ActiveCameraChanged ,   GroupAdded ,   GroupRemoved ,   SelectionChanged ,   StructuralModelAdded ,   StructuralModelRemoved ,   VisualModelAdded ,   VisualModelRemoved ,   DynamicalModelAdded ,   DynamicalModelRemoved ,   InteractionModelAdded ,   InteractionModelRemoved ,   PropertyModelAdded ,   PropertyModelRemoved ,   ActiveStructuralModelChanged ,   SimulatorAdded ,   SimulatorRemoved ,   ControllerAdded ,   ControllerRemoved ,   LabelAdded ,   LabelRemoved ,   LabelChanged ,   ConformationAdded ,   ConformationRemoved ,   PathAdded ,   PathRemoved ,   AssetAdded ,   AssetRemoved ,   NoteAdded ,   NoteRemoved ,   NoteChanged ,   KeyframeAdded ,   KeyframeRemoved ,   KeyframeChanged ,   AnimationAdded ,   AnimationRemoved ,   AnimationChanged ,   PresentationAdded ,   PresentationRemoved ,   PresentationChanged ,   ActivePresentationChanged ,   LightAdded ,   LightRemoved ,   LightChanged ,   FileAdded ,   FileRemoved ,   FileChanged ,   BackgroundChanged ,   RenderPresetAdded ,   RenderPresetRemoved ,   RenderPresetChanged }
	The type of the document event. More...

Constructors and destructors
	SBDDocumentEvent (SBDDataGraphNode *sender, Type type, SBDDataGraphNode *auxiliaryNode=nullptr)
	Builds a document event.
virtual	~SBDDocumentEvent ()

Identity
virtual Category	getCategory () const override
	Returns the category of the event.
Type	getType () const
	Returns the document event type.
SBDDataGraphNode *	getAuxiliaryNode () const
	Returns the auxiliary node pointer.
static std::string	getTypeString (Type type)
	Returns the document event as a string.

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

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 ()
SBDDataGraphNode *	getSender () 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

enum SBDDocumentEvent::Type

Enumerator
FileNameChanged	A file name was changed.
DocumentAdded	A document was added.
DocumentRemoved	A document was removed.
ActiveDocumentChanged	An active document was changed.
DocumentCloseBegin	A document is about to be closed.
DocumentCloseEnd	A document was closed.
FolderAdded	A folder was added.
FolderRemoved	A folder was removed.
CameraAdded	A camera was added.
CameraRemoved	A camera was removed.
CameraChanged	A camera was changed.
ActiveCameraChanged	An active camera was changed.
GroupAdded	A group was added.
GroupRemoved	A group was removed.
SelectionChanged	A selection was changed.
StructuralModelAdded	A structural model was added.
StructuralModelRemoved	A structural model was removed.
VisualModelAdded	A visual model was added.
VisualModelRemoved	A visual model was removed.
DynamicalModelAdded	A dynamical model was added.
DynamicalModelRemoved	A dynamical model was removed.
InteractionModelAdded	An interaction model was added.
InteractionModelRemoved	An interaction model was removed.
PropertyModelAdded	A property model was added.
PropertyModelRemoved	A property model was removed.
ActiveStructuralModelChanged	An active structural model was changed
SimulatorAdded	A simulator was added.
SimulatorRemoved	A simulator was removed.
ControllerAdded	A controller was added.
ControllerRemoved	A controller was removed.
LabelAdded	A label was added.
LabelRemoved	A label was removed.
LabelChanged	A label was changed.
ConformationAdded	A conformation was added.
ConformationRemoved	A conformation was removed.
PathAdded	A path was added.
PathRemoved	A path was removed.
AssetAdded	An asset was added.
AssetRemoved	An asset was removed.
NoteAdded	A note was added.
NoteRemoved	A note was removed.
NoteChanged	A note was changed.
KeyframeAdded	A keyframe was added.
KeyframeRemoved	A keyframe was removed.
KeyframeChanged	A keyframe was changed.
AnimationAdded	An animation was added.
AnimationRemoved	An animation was removed.
AnimationChanged	An animation was changed.
PresentationAdded	A presentation was added.
PresentationRemoved	A presentation was removed.
PresentationChanged	A presentation was changed.
ActivePresentationChanged	An active presentation was changed.
LightAdded	A light was added.
LightRemoved	A light was removed.
LightChanged	A light was changed.
FileAdded	A file was added.
FileRemoved	A file was removed.
FileChanged	A file was changed.
BackgroundChanged	A background was changed.
RenderPresetAdded	A render preset was added.
RenderPresetRemoved	A render preset was removed.
RenderPresetChanged	A render preset was changed.

Member Function Documentation

getCategory()

SBDDataGraphEvent::Category SBDDocumentEvent::getCategory ( ) const

overridevirtual

Reimplemented from SBDDataGraphEvent.

print()

void SBDDocumentEvent::print ( unsigned int  offset = 0 ) const

overridevirtual

Reimplemented from SBDDataGraphEvent.