VgLayerRefPtr Class Reference

Public Member Functions
	VgLayerRefPtr ()
	VgLayerRefPtr (VgLayer pPointer)
	VgLayerRefPtr (VgLayerRefPtr pRefPtr)
VgLayerRefPtr	set (VgLayer pPointer)
VgLayer	__ref__ ()
VgLayer	__deref__ ()
VgLayer	get ()
boolean	isValid ()
String	getName ()
void	setHostedVisible (boolean pVisible)
boolean	isVisible ()
void	setVisible (boolean pIsVisible)
void	setLODFactor (float pLODFactor)
void	setLoadFactor (float pLoadFactor)
float	getLODFactor ()
float	getLoadFactor ()
VgSRSConstRefPtr	getSRS ()
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)
VgIGeometry	asGeometry ()
VgPoint	asPoint ()
VgLine	asLine ()
void	ref ()
int	unref ()
int	getNbReferences ()

Static Public Member Functions
static VgLayerRefPtr	getNull ()

Detailed Description

This class exposes the layer concept. There are two types of layers, one is the type of layers which come from the XML configuration file. This type of layer can't be instantiated except through XML configuration. The other type of layer (called user created layer) may be instantiated by the user through the VgInstanceFactory class using a VgEngine::VgLayer::Descriptor .

Version

2.0

Constructor & Destructor Documentation

VgLayerRefPtr.VgLayerRefPtr

(

)

VgLayerRefPtr.VgLayerRefPtr

(

VgLayer

pPointer

)

VgLayerRefPtr.VgLayerRefPtr

(

VgLayerRefPtr

pRefPtr

)

Member Function Documentation

VgLayer VgLayerRefPtr.__deref__

(

)

VgLayer VgLayerRefPtr.__ref__

(

)

VgIGeometry VgLayerRefPtr.asGeometry

(

)

VgLine VgLayerRefPtr.asLine

(

)

VgPoint VgLayerRefPtr.asPoint

(

)

VgAnimationRefPtr VgLayerRefPtr.editAnimation

(

String

pName

)

VgLayer VgLayerRefPtr.get

(

)

VgAnimationConstRefPtr VgLayerRefPtr.getAnimation

(

String

pName

)

VgValue VgLayerRefPtr.getAnimationChannelValue

(

String

pChannelName

)

void VgLayerRefPtr.getAnimationNames

(

VgStringList

pNameList

)

float VgLayerRefPtr.getLoadFactor

(

)

Gets the load factor of the layer. Only applicable on layers created through XML configuration.

Returns

The current load factor.

float VgLayerRefPtr.getLODFactor

(

)

Gets the LOD factor of the layer. Only applicable on layers created through XML configuration.

Returns

The current LOD factor.

String VgLayerRefPtr.getName

(

)

Get the layer's name.

Returns

The layer's name.

int VgLayerRefPtr.getNbReferences

(

)

static VgLayerRefPtr VgLayerRefPtr.getNull ( )

static

VgOrientation VgLayerRefPtr.getOrientation

(

)

VgPosition VgLayerRefPtr.getPosition

(

)

float VgLayerRefPtr.getScale

(

)

VgSRSConstRefPtr VgLayerRefPtr.getSRS

(

)

Returns

The layers SRS

int VgLayerRefPtr.getZIndex

(

)

boolean VgLayerRefPtr.isDrawnOnTop

(

)

boolean VgLayerRefPtr.isValid

(

)

boolean VgLayerRefPtr.isVisible

(

)

Gets the visibility of the layer.

Returns

true if the layer is visible, false if invisible.

void VgLayerRefPtr.ref

(

)

VgLayerRefPtr VgLayerRefPtr.set

(

VgLayer

pPointer

)

void VgLayerRefPtr.setAnimation	(	String	pAnimationName,
		VgAnimationRefPtr	pAnimation
	)

void VgLayerRefPtr.setAnimation

(

VgAnimationRefPtr

pAnimation

)

void VgLayerRefPtr.setDrawOnTop

(

boolean

pEnable

)

void VgLayerRefPtr.setHostedVisible

(

boolean

pVisible

)

Sets the visibility of hosted (i.e. user or database created) visuals.

Parameters

pVisible

If true, the visuals are visible, invisible if false.

void VgLayerRefPtr.setLoadFactor

(

float

pLoadFactor

)

Sets the load factor of the layer. This will impact how much data is loadeded at a same time. May be a usefull handle to control memory footprint and loading speeds. Higher values will cause more data to be loaded at the same time. Only applicable on layers created through XML configuration.

Parameters

pLoadFactor

The load factor to assign to the layer.

void VgLayerRefPtr.setLocalAnimation

(

VgAnimationRefPtr

pAnimation

)

void VgLayerRefPtr.setLODFactor

(

float

pLODFactor

)

Sets the LOD factor of the layer. This will impact how much data is displayed at a same time. May be a usefull handle to control frame rate. Higher values lead to more geometry being displayed. Only applicable on layers created through XML configuration. Does not affect hosted visuals (e.g. labels).

Parameters

pLODFactor

The LOD factor to assign to the layer.

void VgLayerRefPtr.setOrientation

(

VgOrientation

pOrientation

)

void VgLayerRefPtr.setPosition	(	VgPosition	pPosition,
		boolean	pHaveGeographicCoherence
	)

void VgLayerRefPtr.setPosition

(

VgPosition

pPosition

)

void VgLayerRefPtr.setScale

(

float

pScale

)

void VgLayerRefPtr.setVisible

(

boolean

pIsVisible

)

Sets the overall visibility of the layer.

Parameters

pIsVisible

If true the layer will be visible, invisible if false.

void VgLayerRefPtr.setZIndex

(

int

pZIndex

)

int VgLayerRefPtr.unref

(

)

---

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

• VgLayerRefPtr.java