EntityPoint Class Reference

An entity point. More...

#include <EntityPoint.h>

Collaboration diagram for EntityPoint:

Public Member Functions
	EntityPoint (const Ogre::String &name)
	Constructor. More...
virtual	~EntityPoint ()
	Destructor. More...
void	UpdateDebug ()
	Updates the point state with debug information. More...
const Ogre::String &	GetName () const
	Retrieves the entity point name. More...
void	SetPosition (const Ogre::Vector3 &point)
	Sets the point position. More...
const Ogre::Vector3 &	GetPosition () const
	Retrieves the point position. More...
void	ScriptGetPosition () const
	Informs the script manager of the point position. More...
void	SetRotation (const float rotation)
	Sets the point orientation. More...
float	GetRotation () const
	Retrieves the point orientation. More...
float	ScriptGetRotation () const
	Retrieves the point orientation. More...

Protected Attributes
Ogre::String	name_
	The entity point name. More...
Ogre::Vector3	position_
	The entity point's position. More...
float	rotation_
	The entity point's orientation. More...

Detailed Description

An entity point.

Constructor & Destructor Documentation

EntityPoint()

EntityPoint::EntityPoint

(

const Ogre::String &

name

)

Constructor.

Parameters

[in]

name

Name of the entity point.

~EntityPoint()

EntityPoint::~EntityPoint ( )

virtual

Destructor.

Member Function Documentation

GetName()

const Ogre::String & EntityPoint::GetName

(

)

const

Retrieves the entity point name.

Returns

The name of the entity point.

GetPosition()

const Ogre::Vector3 & EntityPoint::GetPosition

(

)

const

Retrieves the point position.

Returns

The point position.

GetRotation()

float EntityPoint::GetRotation

(

)

const

Retrieves the point orientation.

Returns

The point orientation.

ScriptGetPosition()

void EntityPoint::ScriptGetPosition

(

)

const

Informs the script manager of the point position.

ScriptGetRotation()

float EntityPoint::ScriptGetRotation

(

)

const

Retrieves the point orientation.

Returns

The point orientation.

SetPosition()

void EntityPoint::SetPosition

(

const Ogre::Vector3 &

point

)

Sets the point position.

Parameters

[in]

point

The new point position

SetRotation()

void EntityPoint::SetRotation

(

const float

rotation

)

Sets the point orientation.

Parameters

[in]

rotation

The new orientation (0-360).

UpdateDebug()

void EntityPoint::UpdateDebug

(

)

Updates the point state with debug information.

Member Data Documentation

name_

Ogre::String EntityPoint::name_

protected

The entity point name.

position_

Ogre::Vector3 EntityPoint::position_

protected

The entity point's position.

rotation_

float EntityPoint::rotation_

protected

The entity point's orientation.

---

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

• src/core/EntityPoint.h
• src/core/EntityPoint.cpp