com.visioglobe.libVisioDevKit

Class VgSpatial

java.lang.Object

com.visioglobe.libVisioDevKit.VgReferenced

com.visioglobe.libVisioDevKit.VgSpatial

Direct Known Subclasses:

VgIGeometry, VgLayer

public class VgSpatial
extends VgReferenced

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	delete()
VgAnimationRefPtr	editAnimation(java.lang.String pName) Edits an animation from the spatial's animation map.
VgAnimationConstRefPtr	getAnimation(java.lang.String pName) Gets an animation from the spatial's animation map.
void	getAnimationNames(VgStringList pNameList) Gets the list of the stored animation names.
VgOrientation	getOrientation() Gets spatial's orientation.
VgPosition	getPosition() Gets spatial's position.
float	getScale()
int	getZIndex()
boolean	isDrawnOnTop()
void	setAnimation(java.lang.String pAnimationName, VgAnimationRefPtr pAnimation)
void	setAnimation(VgAnimationRefPtr pAnimation) Deprecated.
void	setDrawOnTop(boolean pEnable)
void	setLocalAnimation(VgAnimationRefPtr pAnimation) Deprecated.
void	setOrientation(VgOrientation pOrientation) Sets the spatial orientation.
void	setPosition(VgPosition pPosition)
void	setPosition(VgPosition pPosition, boolean pHaveGeographicCoherence) Sets the spatial position.
void	setScale(float pScale) Sets the spatial's scale.
void	setZIndex(int pZIndex)

Methods inherited from class com.visioglobe.libVisioDevKit.VgReferenced

getNbReferences, ref, unref

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

delete

public void delete()

Overrides:

delete in class VgReferenced

setAnimation

public void setAnimation(java.lang.String pAnimationName,
                VgAnimationRefPtr pAnimation)

setAnimation

public void setAnimation(VgAnimationRefPtr pAnimation)

Deprecated.

Sets an animation with an empty name on this spatial.

Parameters:

pAnimation - An animation to animate the spatial with.

setLocalAnimation

public void setLocalAnimation(VgAnimationRefPtr pAnimation)

Deprecated.

Sets an animation on this spatial.

Parameters:

pAnimation - An animation to animate the spatial with.

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.

getAnimation

public VgAnimationConstRefPtr getAnimation(java.lang.String pName)

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.

editAnimation

public VgAnimationRefPtr editAnimation(java.lang.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.

getAnimationNames

public void getAnimationNames(VgStringList pNameList)

Gets the list of the stored animation names.

Parameters:

pNameList - The list of strings to feed with the names.

getPosition

public VgPosition getPosition()

Gets spatial's position.

Returns:

The spatial's position.

setPosition

public void 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.

setPosition

public void setPosition(VgPosition pPosition)

getOrientation

public VgOrientation getOrientation()

Gets spatial's orientation.

Returns:

The spatial's orientation.

setOrientation

public void setOrientation(VgOrientation pOrientation)

Sets the spatial orientation.

Parameters:

pOrientation - The orientation to set on the spatial.

getScale

public float getScale()

Returns:

the spatial's scale.

setScale

public void setScale(float pScale)

Sets the spatial's scale.

Parameters:

pScale - The scale to set on the spatial.

getZIndex

public int getZIndex()

Returns:

Z index.

setZIndex

public void setZIndex(int pZIndex)

isDrawnOnTop

public boolean isDrawnOnTop()

Returns:

True if the current spatial is drawn on top.

setDrawOnTop

public void setDrawOnTop(boolean pEnable)