Class SBDControllerEvent#

This class describes a controller event. More...

#include <SBDControllerEvent.hpp>

Inherits the following classes: SBDDataGraphEvent

Public Types#

Type	Name
enum	Type Available controller event types.

Public Types inherited from SBDDataGraphEvent#

See SBDDataGraphEvent

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

Public Functions#

Type	Name
	SBDControllerEvent (SBDController * controller, Type type, SBDControllerNode * auxiliaryNode=nullptr) Builds a controller event.
SBDControllerNode *	getAuxiliaryNode () const Returns a pointer to the auxiliary node.
virtual Category	getCategory () override const Returns the category of the data graph event.
Type	getType () const Returns the controller event type.
virtual void	print (unsigned int offset=0) override const Prints debugging information.
virtual	~SBDControllerEvent () 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 controller 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: SBControllerEvent

Public Types Documentation#

enum Type#

Available controller event types.

enum SBDControllerEvent::Type {
    ControllerNodeAdded = 1,
    ControllerNodeRemoved = 2,
    ControllerPressed = 3,
    ControllerReleased = 4,
    ControllerStateChanged = 5
};

Public Functions Documentation#

function SBDControllerEvent#

Builds a controller event.

SBDControllerEvent::SBDControllerEvent (
    SBDController * controller,
    Type type,
    SBDControllerNode * auxiliaryNode=nullptr
)

Constructs a controller event.

Parameters:

controller The controller associated with the event.
type The type of the controller event.
auxiliaryNode Optional auxiliary node related to the event.

function getAuxiliaryNode#

Returns a pointer to the auxiliary node.

SBDControllerNode * SBDControllerEvent::getAuxiliaryNode () const

Returns the auxiliary node associated with this event, if any.

Returns:

Pointer to the auxiliary node, or nullptr if none.

function getCategory#

Returns the category of the data graph event.

virtual Category SBDControllerEvent::getCategory () override const

Returns the category of this data graph event.

Returns:

The event category (ControllerEvent).

Implements SBDDataGraphEvent::getCategory

function getType#

Returns the controller event type.

Type SBDControllerEvent::getType () const

Retrieves the type of this controller event.

Returns:

The controller event type.

function print#

Prints debugging information.

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

Prints debugging information for this event.

Parameters:

offset Number of tab characters to indent the output.

Implements SBDDataGraphEvent::print

function ~SBDControllerEvent#

Destructor.

virtual SBDControllerEvent::~SBDControllerEvent ()

Destroys the controller event.

Public Static Functions Documentation#

function getTypeString#

Returns the controller event type as a string.

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

Converts a controller event type to its string representation.

Parameters:

type The controller event type to convert.

Returns:

A string describing the event type.