VgEngine::VgSpatial Class Reference

This class gives access to the spatial aspect of an object (layer, point, etc). More...

Inheritance diagram for VgEngine::VgSpatial:

Collaboration diagram for VgEngine::VgSpatial:

List of all members.

Public Member Functions
void	setAnimation (const std::string &pAnimationName, VgEngine::VgRefPtr< VgEngine::VgAnimation > &pAnimation)
	Sets an animation on this spatial.
void	setAnimation (VgEngine::VgRefPtr< VgEngine::VgAnimation > pAnimation)
	Sets an animation with an empty name on this spatial.
void	setLocalAnimation (VgEngine::VgRefPtr< VgEngine::VgAnimation > pAnimation)
	Sets an animation on this spatial.
VgConstRefPtr< VgAnimation >	getAnimation (const std::string &pName) const
	Gets an animation from the spatial's animation map.
VgRefPtr< VgAnimation >	editAnimation (const std::string &pName)
	Edits an animation from the spatial's animation map.
void	getAnimationNames (std::list< std::string > &pNameList) const
	Gets the list of the stored animation names.
VgEngine::VgPosition	getPosition () const
	Gets spatial's position.
void	setPosition (const VgEngine::VgPosition &pPosition, bool pHaveGeographicCoherence=true)
	Sets the spatial position.
VgEngine::VgOrientation	getOrientation () const
	Gets spatial's orientation.
void	setOrientation (const VgEngine::VgOrientation &pOrientation)
	Sets the spatial orientation.
void	setScale (float pScale)
	Sets the spatial's scale.
Protected Member Functions
	VgSpatial ()
	Default constructor.
virtual	~VgSpatial ()
	Destructor.
Protected Attributes
Private *	mPrivate
	Private.
Friends
class	VgObjectBridge
class	VgLayer

---

Detailed Description

This class gives access to the spatial aspect of an object (layer, point, etc).

The spatial aspect controls the object's position in scene space. It also enables animation features on spatial objects.

Version:

2.0

---

Constructor & Destructor Documentation

VgEngine::VgSpatial::VgSpatial

(

)

[protected]

Default constructor.

This is protected since it is not possible to create a spatial directly. Instead, instantiate a spatial object (like point for example) and access it's spatial aspect.

virtual VgEngine::VgSpatial::~VgSpatial

(

)

[protected, virtual]

Destructor.

---

Member Function Documentation

VgRefPtr< VgAnimation > VgEngine::VgSpatial::editAnimation

(

const std::string &

pName )

Edits an animation from the spatial's animation map.

Parameters:

pName

The name of the animation to fetch.

Returns:

A reference pointer that is valid if an animation exists by that name in this spatial.

Version:

2.0.8744

VgConstRefPtr< VgAnimation > VgEngine::VgSpatial::getAnimation

(

const std::string &

pName )

const

Gets an animation from the spatial's animation map.

Parameters:

pName

The name of the animation to fetch.

Returns:

A const reference pointer that is valid if an animation exists by that name in this spatial.

Version:

2.0.8744

void VgEngine::VgSpatial::getAnimationNames

(

std::list< std::string > &

pNameList )

const

Gets the list of the stored animation names.

Parameters:

pNameList

The list of strings to feed with the names.

Version:

2.0.8744

VgEngine::VgOrientation VgEngine::VgSpatial::getOrientation

(

)

const

Gets spatial's orientation.

Returns:

The spatial's orientation.

Version:

2.0.8744

VgEngine::VgPosition VgEngine::VgSpatial::getPosition

(

)

const

Gets spatial's position.

Returns:

The spatial's position.

Version:

2.0.7445

void VgEngine::VgSpatial::setAnimation

(

VgEngine::VgRefPtr< VgEngine::VgAnimation >

pAnimation )

Sets an animation with an empty name on this spatial.

Parameters:

pAnimation

An animation to animate the spatial with.

Deprecated:

Version:

2.0.7445

void VgEngine::VgSpatial::setAnimation	(	const std::string &	pAnimationName,
		VgEngine::VgRefPtr< VgEngine::VgAnimation > &	pAnimation
	)

Sets an animation on this spatial.

As of version 2.0.8744, multiple animations can be set (and played) on a spatial at the same time. This is the reason why a name has to be provided along with the animation. If an animation already exists in the spatial with that name, the new one will replace the old one (and the previous one will one less reference to it).

Parameters:

pAnimation	An animation to animate the spatial with.
pAnimationName	The name to associate the animation with in this spatial

Version:

2.0.8744

void VgEngine::VgSpatial::setLocalAnimation

(

VgEngine::VgRefPtr< VgEngine::VgAnimation >

pAnimation )

Sets an animation on this spatial.

Parameters:

pAnimation

An animation to animate the spatial with.

Deprecated:

Warning:

This method is kept for compatibility concerns. It will set all of the animation's channels to address the local animation node. The animation will be named "local". YOUR ANIMATION MAY BE MODIFIED BY THIS CALL.

void VgEngine::VgSpatial::setOrientation

(

const VgEngine::VgOrientation &

pOrientation )

Sets the spatial orientation.

Parameters:

pOrientation

The orientation to set on the spatial.

Version:

2.0.8744

void VgEngine::VgSpatial::setPosition	(	const VgEngine::VgPosition &	pPosition,
		bool	pHaveGeographicCoherence = true
	)

Sets the spatial position.

Parameters:

pPosition	The position to put the spatial at.
pHaveGeographicCoherence	An optional parameter who by default is true. Is used to determine the geographic coherence of the spatial. If set to false, then the spatial will be coherent with the scene.

Version:

2.0.7445

void VgEngine::VgSpatial::setScale

(

float

pScale )

Sets the spatial's scale.

Parameters:

pScale

The scale to set on the spatial.

Version:

2.0.8744

---

Friends And Related Function Documentation

friend class VgLayer [friend]

friend class VgObjectBridge [friend]

Reimplemented in VgEngine::VgLayer.

---

Member Data Documentation

Private* VgEngine::VgSpatial::mPrivate [protected]

Private.

---

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

• VgSpatial.h