VgSpatialRefPtr Class Reference

Public Member Functions
	VgSpatialRefPtr ()
	VgSpatialRefPtr (VgSpatial pPointer)
	VgSpatialRefPtr (VgSpatialRefPtr pRefPtr)
VgSpatialRefPtr	set (VgSpatial pPointer)
VgSpatial	__ref__ ()
VgSpatial	__deref__ ()
VgSpatial	get ()
boolean	isValid ()
	VgSpatialRefPtr (VgLayerRefPtr pRefPtr)
	VgSpatialRefPtr (VgIGeometryRefPtr pRefPtr)
	VgSpatialRefPtr (VgPointRefPtr pRefPtr)
	VgSpatialRefPtr (VgLineRefPtr pRefPtr)
void	setAnimation (String pAnimationName, VgAnimationRefPtr pAnimation)
void	setAnimation (VgAnimationRefPtr pAnimation)
void	setLocalAnimation (VgAnimationRefPtr pAnimation)
VgAnimationConstRefPtr	getAnimation (String pName)
VgAnimationRefPtr	editAnimation (String pName)
void	getAnimationNames (VgStringList pNameList)
VgValue	getAnimationChannelValue (String pChannelName)
VgPosition	getPosition ()
void	setPosition (VgPosition pPosition, boolean pHaveGeographicCoherence)
void	setPosition (VgPosition pPosition)
VgOrientation	getOrientation ()
void	setOrientation (VgOrientation pOrientation)
float	getScale ()
void	setScale (float pScale)
int	getZIndex ()
void	setZIndex (int pZIndex)
boolean	isDrawnOnTop ()
void	setDrawOnTop (boolean pEnable)
void	setVisible (boolean pIsVisible)
boolean	isVisible ()
VgIGeometry	asGeometry ()
VgPoint	asPoint ()
VgLine	asLine ()
void	ref ()
int	unref ()
int	getNbReferences ()

Static Public Member Functions
static VgSpatialRefPtr	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

VgSpatialRefPtr.VgSpatialRefPtr

(

)

VgSpatialRefPtr.VgSpatialRefPtr

(

VgSpatial

pPointer

)

VgSpatialRefPtr.VgSpatialRefPtr

(

VgSpatialRefPtr

pRefPtr

)

VgSpatialRefPtr.VgSpatialRefPtr

(

VgLayerRefPtr

pRefPtr

)

VgSpatialRefPtr.VgSpatialRefPtr

(

VgIGeometryRefPtr

pRefPtr

)

VgSpatialRefPtr.VgSpatialRefPtr

(

VgPointRefPtr

pRefPtr

)

VgSpatialRefPtr.VgSpatialRefPtr

(

VgLineRefPtr

pRefPtr

)

Member Function Documentation

VgSpatial VgSpatialRefPtr.__deref__

(

)

VgSpatial VgSpatialRefPtr.__ref__

(

)

VgIGeometry VgSpatialRefPtr.asGeometry

(

)

Casts this instance into a VgIGeometry.

Version

2.0.9590

Returns

A valid pointer if this instance as the correct type, NULL otherwise.

VgLine VgSpatialRefPtr.asLine

(

)

Casts this instance into a VgLine.

Version

2.0.9590

Returns

A valid pointer if this instance as the correct type, NULL otherwise.

VgPoint VgSpatialRefPtr.asPoint

(

)

Casts this instance into a VgPoint.

Version

2.0.9590

Returns

A valid pointer if this instance as the correct type, NULL otherwise.

VgAnimationRefPtr VgSpatialRefPtr.editAnimation

(

String

pName

)

Edits an animation from the spatial's animation map.

Parameters

pName

The name of the animation to fetch.

Version

2.0.8744

Returns

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

VgSpatial VgSpatialRefPtr.get

(

)

VgAnimationConstRefPtr VgSpatialRefPtr.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 VgSpatialRefPtr.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 VgSpatialRefPtr.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 VgSpatialRefPtr.getNbReferences

(

)

static VgSpatialRefPtr VgSpatialRefPtr.getNull ( )

static

VgOrientation VgSpatialRefPtr.getOrientation

(

)

Gets spatial's orientation.

Version

2.0.8744

Returns

The spatial's orientation.

VgPosition VgSpatialRefPtr.getPosition

(

)

Gets spatial's position.

Version

2.0.7445

Returns

The spatial's position.

float VgSpatialRefPtr.getScale

(

)

Version

2.0.9263

Returns

the spatial's scale.

int VgSpatialRefPtr.getZIndex

(

)

Version

2.0.9263

2.1.0 Updated documentation with default value

Returns

Z index. default value is 0.

boolean VgSpatialRefPtr.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 VgSpatialRefPtr.isValid

(

)

boolean VgSpatialRefPtr.isVisible

(

)

Version

2.0.9334

Returns

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

void VgSpatialRefPtr.ref

(

)

VgSpatialRefPtr VgSpatialRefPtr.set

(

VgSpatial

pPointer

)

void VgSpatialRefPtr.setAnimation	(	String	pAnimationName,
		VgAnimationRefPtr	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

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

Version

2.0.8744

void VgSpatialRefPtr.setAnimation

(

VgAnimationRefPtr

pAnimation

)

Sets an animation with an empty name on this spatial.

Deprecated:

Parameters

pAnimation

An animation to animate the spatial with.

Version

2.0.7445

void VgSpatialRefPtr.setDrawOnTop

(

boolean

pEnable

)

Sets the drawOnTop flag. The VgSpatial will be visible even if there are objects in front.

Parameters

pEnable

Version

2.0.9263

void VgSpatialRefPtr.setLocalAnimation

(

VgAnimationRefPtr

pAnimation

)

Sets an animation on this spatial.

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.

Parameters

pAnimation

An animation to animate the spatial with.

void VgSpatialRefPtr.setOrientation

(

VgOrientation

pOrientation

)

Sets the spatial orientation.

Parameters

pOrientation

The orientation to set on the spatial.

Version

2.0.8744

void VgSpatialRefPtr.setPosition	(	VgPosition	pPosition,
		boolean	pHaveGeographicCoherence
	)

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 VgSpatialRefPtr.setPosition

(

VgPosition

pPosition

)

void VgSpatialRefPtr.setScale

(

float

pScale

)

Sets the spatial's scale.

Parameters

pScale

The scale to set on the spatial.

Version

2.0.8744

void VgSpatialRefPtr.setVisible

(

boolean

pIsVisible

)

Sets the visibility. By default, a VgSpatial is visible.

Parameters

pIsVisible

Version

2.0.9334

void VgSpatialRefPtr.setZIndex

(

int

pZIndex

)

Sets the Z Index, an object with a smaller ZIndex will be drawn in front of another with a larger one.

Parameters

pZIndex

Version

2.0.9263

2.1.2 Updated documentation

int VgSpatialRefPtr.unref

(

)

---

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

• VgSpatialRefPtr.java