VgSpatialConstRefPtr Class Reference

Public Member Functions
	VgSpatialConstRefPtr ()
	VgSpatialConstRefPtr (VgSpatial pPointer)
	VgSpatialConstRefPtr (VgSpatialConstRefPtr pConstRefPtr)
VgSpatialConstRefPtr	set (VgSpatial pPointer)
VgSpatial	__ref__ ()
VgSpatial	__deref__ ()
VgSpatial	get ()
boolean	isValid ()
VgAnimationConstRefPtr	getAnimation (String pName)
void	getAnimationNames (VgStringList pNameList)
VgValue	getAnimationChannelValue (String pChannelName)
VgPosition	getPosition ()
VgOrientation	getOrientation ()
float	getScale ()
int	getZIndex ()
boolean	isDrawnOnTop ()
boolean	isVisible ()
void	ref ()
int	unref ()
int	getNbReferences ()

Static Public Member Functions
static VgSpatialConstRefPtr	getNull ()

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

VgSpatialConstRefPtr.VgSpatialConstRefPtr

(

)

VgSpatialConstRefPtr.VgSpatialConstRefPtr

(

VgSpatial

pPointer

)

VgSpatialConstRefPtr.VgSpatialConstRefPtr

(

VgSpatialConstRefPtr

pConstRefPtr

)

Member Function Documentation

VgSpatial VgSpatialConstRefPtr.__deref__

(

)

VgSpatial VgSpatialConstRefPtr.__ref__

(

)

VgSpatial VgSpatialConstRefPtr.get

(

)

VgAnimationConstRefPtr VgSpatialConstRefPtr.getAnimation

(

String

pName

)

Gets an animation from the spatial's animation map.

Parameters

pName

The name of the animation to fetch.

Version

2.0.8744

Returns

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

VgValue VgSpatialConstRefPtr.getAnimationChannelValue

(

String

pChannelName

)

Get the current value of a given animation channel.

Parameters

pChannelName

The name of the channel.

Version

2.1.19

Returns

The value stored in a VgValue object.

void VgSpatialConstRefPtr.getAnimationNames

(

VgStringList

pNameList

)

Gets the list of the stored animation names.

Parameters

pNameList

The list of strings to feed with the names.

Version

2.0.8744

int VgSpatialConstRefPtr.getNbReferences

(

)

static VgSpatialConstRefPtr VgSpatialConstRefPtr.getNull ( )

static

VgOrientation VgSpatialConstRefPtr.getOrientation

(

)

Gets spatial's orientation.

Version

2.0.8744

Returns

The spatial's orientation.

VgPosition VgSpatialConstRefPtr.getPosition

(

)

Gets spatial's position.

Version

2.0.7445

Returns

The spatial's position.

float VgSpatialConstRefPtr.getScale

(

)

Version

2.0.9263

Returns

the spatial's scale.

int VgSpatialConstRefPtr.getZIndex

(

)

Version

2.0.9263

2.1.0 Updated documentation with default value

Returns

Z index. default value is 0.

boolean VgSpatialConstRefPtr.isDrawnOnTop

(

)

Version

2.0.9263

2.1.0 Updated documentation with default value

Returns

True if the current spatial is drawn on top. Default value is false.

boolean VgSpatialConstRefPtr.isValid

(

)

boolean VgSpatialConstRefPtr.isVisible

(

)

Version

2.0.9334

Returns

True if visible. By default, a VgSpatial is visible.

void VgSpatialConstRefPtr.ref

(

)

VgSpatialConstRefPtr VgSpatialConstRefPtr.set

(

VgSpatial

pPointer

)

int VgSpatialConstRefPtr.unref

(

)

---

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

• VgSpatialConstRefPtr.java