com.visioglobe.libVisioDevKit
Class VgLayer

java.lang.Object
  com.visioglobe.libVisioDevKit.VgReferenced
      com.visioglobe.libVisioDevKit.VgSpatial
          com.visioglobe.libVisioDevKit.VgLayer

public class VgLayer
extends VgSpatial

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.

Field Summary

Fields inherited from class com.visioglobe.libVisioDevKit.VgReferenced

swigCMemOwn, swigRefPtr

Constructor Summary

VgLayer(long cPtr, boolean cMemoryOwn)
The constructor is private, you are required to instantiate layers through VgEngine::VgInstanceFactory using a descriptor.

Method Summary

void	delete()
static long	getCPtr(VgLayer obj)
float	getLoadFactor() Gets the load factor of the layer.
float	getLODFactor() Gets the LOD factor of the layer.
java.lang.String	getName() Get the layer's name.
VgSRSConstRefPtr	getSRS()
boolean	isVisible() Gets the visibility of the layer.
void	setHostedVisible(boolean pVisible) Sets the visibility of hosted (i.e.
void	setLoadFactor(float pLoadFactor) Sets the load factor of the layer.
void	setLODFactor(float pLODFactor) Sets the LOD factor of the layer.
void	setVisible(boolean pVisible) Sets the overall visibility of the layer.

Methods inherited from class com.visioglobe.libVisioDevKit.VgSpatial

editAnimation, getAnimation, getAnimationNames, getCPtr, getOrientation, getPosition, setAnimation, setAnimation, setLocalAnimation, setOrientation, setPosition, setPosition, setScale

Methods inherited from class com.visioglobe.libVisioDevKit.VgReferenced

finalize, getCPtr, getNbReferences, ref, unref

Methods inherited from class java.lang.Object

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

Constructor Detail

VgLayer

public VgLayer(long cPtr,
               boolean cMemoryOwn)

The constructor is private, you are required to instantiate layers through VgEngine::VgInstanceFactory using a descriptor.

Method Detail

getCPtr

public static long getCPtr(VgLayer obj)

delete

public void delete()

Overrides:

delete in class VgSpatial

getName

public java.lang.String getName()

Get the layer's name.

Returns:

The layer's name.

setHostedVisible

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

isVisible

public boolean isVisible()

Gets the visibility of the layer.

Returns:

true if the layer is visible, false if invisible.

setVisible

public void setVisible(boolean pVisible)

Sets the overall visibility of the layer.

Parameters:

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

setLODFactor

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

Parameters:

pLODFactor - The LOD factor to assign to the layer.

setLoadFactor

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

getLODFactor

public float getLODFactor()

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

Returns:

The current LOD factor.

getLoadFactor

public float getLoadFactor()

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

Returns:

The current load factor.

getSRS

public VgSRSConstRefPtr getSRS()

Returns:

The layers SRS