Class SBMVisualModelEvent#

This class describes a visual event. More...

#include <SBMVisualModelEvent.hpp>

Inherits the following classes: SBDDataGraphEvent

Public Types#

Type	Name
enum	Type The type of the visual model event.

Public Types inherited from SBDDataGraphEvent#

See SBDDataGraphEvent

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

Public Functions#

Type	Name
	SBMVisualModelEvent (SBMVisualModel * sender, Type type) Builds a visual model event.
virtual Category	getCategory () override const Returns the category of the event.
SBMVisualModel *	getSender () const Returns the sender of the event.
Type	getType () const Returns the visual model event type.
virtual void	print (unsigned int offset=0) override const Prints debugging information.
virtual	~SBMVisualModelEvent () Destructor.

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 visual model event type 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: SBVisualEvent

Public Types Documentation#

enum Type#

The type of the visual model event.

enum SBMVisualModelEvent::Type {
    VisualModelChanged = 1,
    TransformChanged = 2,
    OpacityChanged = 3,
    DiffuseColorReplacementChanged = 4
};

Public Functions Documentation#

function SBMVisualModelEvent#

Builds a visual model event.

SBMVisualModelEvent::SBMVisualModelEvent (
    SBMVisualModel * sender,
    Type type
)

Constructs a visual model event.

Creates an SBMVisualModelEvent associated with the specified sender and event type.

Parameters:

sender The visual model that generated the event.
type The type of the visual model event.

function getCategory#

Returns the category of the event.

virtual Category SBMVisualModelEvent::getCategory () override const

The category indicates that this event belongs to the visual event group.

Returns:

The event category.

Implements SBDDataGraphEvent::getCategory

function getSender#

Returns the sender of the event.

SBMVisualModel * SBMVisualModelEvent::getSender () const

Retrieves the visual model that generated this event.

Returns:

A pointer to the SBMVisualModel that sent the event, or nullptr if none.

function getType#

Returns the visual model event type.

Type SBMVisualModelEvent::getType () const

Returns the type of the visual model event.

Retrieves the specific event type stored in the event data.

Returns:

The visual model event type.

function print#

Prints debugging information.

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

Prints debugging information for the visual model event.

Outputs the event type and sender information to the standard output, indented by the specified offset.

Parameters:

offset Number of tab characters to indent the output.

Implements SBDDataGraphEvent::print

function ~SBMVisualModelEvent#

Destructor.

virtual SBMVisualModelEvent::~SBMVisualModelEvent ()

Destroys the visual model event.

Public Static Functions Documentation#

function getTypeString#

Returns the visual model event type as a string.

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

Returns the string representation of a visual model event type.

Converts the specified event type enum value to a human-readable string.

Parameters:

type The event type to convert.

Returns:

The string representation of the given event type.