dt::TriggerComponent Class Reference

A simple trigger component that triggers a callback on certain conditions. More...

#include "TriggerComponent.hpp"

Inheritance diagram for dt::TriggerComponent:

Collaboration diagram for dt::TriggerComponent:

List of all members.

Public Types
typedef std::shared_ptr < Component >	ComponentSP
Public Slots
bool	isEnabled ()
	Returns whether the component is enabled.
bool	isInitialized ()
	Returns whether the component is created.
const QString	getName () const
	Returns the name of the Component.
QString	getFullName () const
	Returns the name of the Component, including all parent names.
Node *	getNode ()
	Returns the Node of this component.
QScriptValue	getScriptNode ()
	Returns the Node of this component.
void	initialize ()
	Initializes the component.
void	deinitialize ()
	Deinitializes the component.
void	enable ()
	Enables the component.
void	disable ()
	Disables the component.
Signals
void	componentInitialized ()
void	componentUninitialized ()
void	componentEnabled ()
void	componentDisabled ()
Public Member Functions
	TriggerComponent (const QString name="")
	Advanced constructor.
void	onInitialize ()
	Called when the component is activated.
void	onDeinitialize ()
	Called when the component is deactivated.
void	onUpdate (double time_diff)
	Called every frame.
virtual void	onEnable ()
	Called when the component is enabled.
virtual void	onDisable ()
	Called when the component is disabled.
void	setNode (Node *node)
	Sets the node of this component.
void	serialize (IOPacket &packet)
virtual void	onSerialize (IOPacket &packet)
Protected Attributes
QString	mName
	The Component name.
Node *	mNode
	The parent Node.
Properties
QString	name
bool	isEnabled
bool	isInitialized
QScriptValue	node

---

Detailed Description

A simple trigger component that triggers a callback on certain conditions.

Warning:

Class not complete.

Definition at line 24 of file TriggerComponent.hpp.

---

Constructor & Destructor Documentation

dt::TriggerComponent::TriggerComponent

(

const QString

name = ""

)

Advanced constructor.

Parameters:

name	The name for this component.

See also:

Component

---

Member Function Documentation

QString dt::Component::getFullName

(

)

const [slot, inherited]

Returns the name of the Component, including all parent names.

Returns:

The name of the Component, including all parent names.

const QString dt::Component::getName

(

)

const [slot, inherited]

Returns the name of the Component.

Returns:

The name of the Component.

Node* dt::Component::getNode

(

)

[slot, inherited]

Returns the Node of this component.

Returns:

The Node of this component.

QScriptValue dt::Component::getScriptNode

(

)

[slot, inherited]

Returns the Node of this component.

Used for scripting access.

Returns:

The Node of this component.

bool dt::Component::isEnabled

(

)

[slot, inherited]

Returns whether the component is enabled.

Returns:

Whether the component is enabled.

bool dt::Component::isInitialized

(

)

[slot, inherited]

Returns whether the component is created.

Returns:

Whether the component is created.

void dt::TriggerComponent::onDeinitialize

(

)

[virtual]

Called when the component is deactivated.

Deinitialize all scene objects here.

Reimplemented from dt::Component.

virtual void dt::Component::onDisable

(

)

[virtual, inherited]

Called when the component is disabled.

Hide/disable all scene objects here.

Reimplemented in dt::ParticleSystemComponent, dt::PhysicsBodyComponent, dt::MeshComponent, dt::AdvancedPlayerComponent, dt::BillboardSetComponent, dt::LightComponent, dt::CameraComponent, dt::ScriptComponent, dt::MusicComponent, dt::TextComponent, and dt::TriggerAreaComponent.

virtual void dt::Component::onEnable

(

)

[virtual, inherited]

Called when the component is enabled.

Show/enable all scene objects here.

Reimplemented in dt::ParticleSystemComponent, dt::PhysicsBodyComponent, dt::MeshComponent, dt::AdvancedPlayerComponent, dt::BillboardSetComponent, dt::LightComponent, dt::CameraComponent, dt::ScriptComponent, dt::MusicComponent, dt::TextComponent, and dt::TriggerAreaComponent.

void dt::TriggerComponent::onInitialize

(

)

[virtual]

Called when the component is activated.

Initialize all scene objects here.

Reimplemented from dt::Component.

void dt::TriggerComponent::onUpdate

(

double

time_diff

)

[virtual]

Called every frame.

Update the Node here.

Parameters:

time_diff

The frame delta time.

Reimplemented from dt::Component.

void dt::Component::setNode

(

Node *

node

)

[inherited]

Sets the node of this component.

Parameters:

node	The node to be set.

---

Member Data Documentation

QString dt::Component::mName [protected, inherited]

The Component name.

Definition at line 155 of file Component.hpp.

Node* dt::Component::mNode [protected, inherited]

The parent Node.

Definition at line 156 of file Component.hpp.

---

The documentation for this class was generated from the following file:

• TriggerComponent.hpp