Class SBDDocumentEvent

ClassList > SBDDocumentEvent

This class describes a document event. More...

• #include <SBDDocumentEvent.hpp>

Inherits the following classes: SBDDataGraphEvent

Public Types

Type	Name
enum	Type The type of the document event.

Public Types inherited from SBDDataGraphEvent

See SBDDataGraphEvent

Type	Name
enum	Category The category of the data graph event.

Public Functions

Type	Name
	SBDDocumentEvent (SBDDataGraphNode * sender, Type type, SBDDataGraphNode * auxiliaryNode=nullptr) Builds a document event.
SBDDataGraphNode *	getAuxiliaryNode () const Returns the auxiliary node pointer.
virtual Category	getCategory () override const Returns the category of the event.
Type	getType () const Returns the document event type.
virtual void	print (unsigned int offset=0) override const Prints some debugging information.
virtual	~SBDDocumentEvent () Destroys the document event.

Public Functions inherited from SBDDataGraphEvent

See SBDDataGraphEvent

Type	Name
	SBDDataGraphEvent (SBDDataGraphNode * sender) Build a data graph event for the sender sender .
virtual Category	getCategory () const Returns the category of the data graph event.
SBDDataGraphNode *	getSender () const Returns the sender of the event.
virtual void	print (unsigned int offset=0) const Prints debugging information.
virtual	~SBDDataGraphEvent () Destructor.

Public Static Functions

Type	Name
std::string	getTypeString (Type type) Returns the document event as a string.

Public Static Functions inherited from SBDDataGraphEvent

See SBDDataGraphEvent

Type	Name
std::string	getCategoryString (Category category) Returns a string representation of the category of the data graph event.

Protected Attributes inherited from SBDDataGraphEvent

See SBDDataGraphEvent

Type	Name
SBDDataGraphEventData *	dataPointer A pointer to the private data.

Protected Functions inherited from SBDDataGraphEvent

See SBDDataGraphEvent

Type	Name
	SBDDataGraphEvent (SBDDataGraphEventData * dataPointer) Protected constructor.

Detailed Description

Short name: SBDocumentEvent

Public Types Documentation

enum Type

The type of the document event.

enum SBDDocumentEvent::Type {
    FileNameChanged = 10,
    DocumentAdded = 20,
    DocumentRemoved = 21,
    ActiveDocumentChanged = 22,
    DocumentCloseBegin = 23,
    DocumentCloseEnd = 24,
    FolderAdded = 30,
    FolderRemoved = 31,
    CameraAdded = 40,
    CameraRemoved = 41,
    CameraChanged = 42,
    ActiveCameraChanged = 43,
    GroupAdded = 50,
    GroupRemoved = 51,
    SelectionChanged = 60,
    StructuralModelAdded = 70,
    StructuralModelRemoved = 71,
    VisualModelAdded = 80,
    VisualModelRemoved = 81,
    DynamicalModelAdded = 90,
    DynamicalModelRemoved = 91,
    InteractionModelAdded = 100,
    InteractionModelRemoved = 101,
    PropertyModelAdded = 110,
    PropertyModelRemoved = 111,
    ActiveStructuralModelChanged = 120,
    SimulatorAdded = 130,
    SimulatorRemoved = 131,
    ControllerAdded = 140,
    ControllerRemoved = 141,
    LabelAdded = 150,
    LabelRemoved = 151,
    LabelChanged = 152,
    ConformationAdded = 160,
    ConformationRemoved = 161,
    PathAdded = 170,
    PathRemoved = 171,
    AssetAdded = 180,
    AssetRemoved = 181,
    NoteAdded = 190,
    NoteRemoved = 191,
    NoteChanged = 192,
    KeyframeAdded = 200,
    KeyframeRemoved = 201,
    KeyframeChanged = 202,
    AnimationAdded = 210,
    AnimationRemoved = 211,
    AnimationChanged = 212,
    PresentationAdded = 220,
    PresentationRemoved = 221,
    PresentationChanged = 222,
    ActivePresentationChanged = 223,
    LightAdded = 230,
    LightRemoved = 231,
    LightChanged = 232,
    FileAdded = 240,
    FileRemoved = 241,
    FileChanged = 242,
    BackgroundChanged = 250,
    RenderPresetAdded = 260,
    RenderPresetRemoved = 261,
    RenderPresetChanged = 262
};

---

Public Functions Documentation

function SBDDocumentEvent

Builds a document event.

SBDDocumentEvent::SBDDocumentEvent (
    SBDDataGraphNode * sender,
    Type type,
    SBDDataGraphNode * auxiliaryNode=nullptr
) 

Constructs a document event.

Creates a new SBDDocumentEvent with the specified sender, event type, and optional auxiliary node.

Parameters:

• sender The data graph node that sent the event.
• type The type of the document event.
• auxiliaryNode An optional auxiliary node associated with the event (may be nullptr).

---

function getAuxiliaryNode

Returns the auxiliary node pointer.

SBDDataGraphNode * SBDDocumentEvent::getAuxiliaryNode () const

Returns the auxiliary node associated with the event.

The auxiliary node may be nullptr if no additional node is relevant.

Returns:

Pointer to the auxiliary node, or nullptr if none.

---

function getCategory

Returns the category of the event.

virtual Category SBDDocumentEvent::getCategory () override const

All SBDDocumentEvent instances belong to the DocumentEvent category.

Returns:

The event category.

Implements SBDDataGraphEvent::getCategory

---

function getType

Returns the document event type.

Type SBDDocumentEvent::getType () const

Returns the specific document event type.

This value indicates the kind of document event that occurred.

Returns:

The document event type.

---

function print

Prints some debugging information.

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

Prints debugging information for the document event.

The output includes the event type, sender, and auxiliary node, with optional indentation.

Parameters:

• offset Number of tab characters to prepend to each line of output.

Implements SBDDataGraphEvent::print

---

function ~SBDDocumentEvent

Destroys the document event.

virtual SBDDocumentEvent::~SBDDocumentEvent () 

---

Public Static Functions Documentation

function getTypeString

Returns the document event as a string.

static std::string SBDDocumentEvent::getTypeString (
    Type type
) 

Returns a string representation of a document event type.

Provides a human-readable name for the given event type.

Parameters:

• type The document event type to convert to a string.

Returns:

The string name of the event type, or a default message if the type is unknown.

---