Class SBDControllerEvent#

#include <SBDControllerEvent.hpp>

Inherits the following classes: SBDDataGraphEvent

Public Types#

Type	Name
enum	Type

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.
	SB_DECLARE_DATA (SBDControllerEvent)
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 ()

Public Functions inherited from SBDDataGraphEvent#

See SBDDataGraphEvent

Type	Name
	SBDDataGraphEvent (SBDDataGraphNode * sender)
	SB_DECLARE_DATA (SBDDataGraphEvent)
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 ()

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

Protected Functions inherited from SBDDataGraphEvent#

See SBDDataGraphEvent

Type	Name
	SBDDataGraphEvent (SBDDataGraphEventData * dataPointer)

Detailed Description#

This class describes a controller event.

Short name: SBControllerEvent

Public Types Documentation#

enum Type#

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
)

function SB_DECLARE_DATA#

SBDControllerEvent::SB_DECLARE_DATA (
    SBDControllerEvent
)

function getAuxiliaryNode#

Returns a pointer to the auxiliary node.

SBDControllerNode * SBDControllerEvent::getAuxiliaryNode () const

function getCategory#

Returns the category of the data graph event.

virtual Category SBDControllerEvent::getCategory () override const

Implements SBDDataGraphEvent::getCategory

function getType#

Returns the controller event type.

Type SBDControllerEvent::getType () const

function print#

Prints debugging information.

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

Implements SBDDataGraphEvent::print

function ~SBDControllerEvent#

virtual SBDControllerEvent::~SBDControllerEvent ()

Public Static Functions Documentation#

function getTypeString#

Returns the controller event type as a string.

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