VgLineConstRefPtr Class Reference

Public Member Functions
	VgLineConstRefPtr ()
	VgLineConstRefPtr (VgLine pPointer)
	VgLineConstRefPtr (VgLineConstRefPtr pConstRefPtr)
VgLineConstRefPtr	set (VgLine pPointer)
VgLine	__ref__ ()
VgLine	__deref__ ()
VgLine	get ()
boolean	isValid ()
VgLineDescriptorConstRefPtr	getDescriptor ()
VgIGeometryType	getType ()
VgITextureRefPtr	getTexture ()
float	getTextureAnimationSpeed ()
VgVisibilityRamp	getVisibilityRamp ()
String	getID ()
boolean	getNotifyPOISelectedOnClick ()
VgPosition	getLocalPosition ()
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 VgLineConstRefPtr	getNull ()

Detailed Description

A VgLine is created using Vg3DModule::VgInstanceFactory::instantiate. Once created, it may be added to a layer using VgLine::setLayer .

...
VgApplication::VgIApplication* mVgApplication;
Vg3DModule::VgLineDescriptor lLineDesc;
...

VgEngine::VgRefPtr< Vg3DModule::VgLine > lLine = mVgApplication->editEngine()->editInstanceFactory()->instantiate(lLineDesc);

const VgEngine::VgLayerManager::LayerList& lLayers = mVgApplication->editEngine()->editLayerManager()->getLayers();

// Choose the first layer.
VgEngine::VgRefPtr< VgEngine::VgLayer > lLayer = lLayers.at(0);

// Note: The line will only be seen if it's associated layer is visible.
lLine->setLayer(lLayer);

// To hide the line. Pass true to show it again. By default, a line is visible.
lLine->setVisible(false);

// To query its visibility
bool lIsVisible = lLine->isVisible();

// To remove the line from the layer 
lLine->setLayer(NULL);

// If the line is no longer required, then release it's memory.
// VgLine is reference counted, so just null-out the VgRefPtr.
lLine = NULL;

Version

2.0

Constructor & Destructor Documentation

VgLineConstRefPtr.VgLineConstRefPtr

(

)

VgLineConstRefPtr.VgLineConstRefPtr

(

VgLine

pPointer

)

VgLineConstRefPtr.VgLineConstRefPtr

(

VgLineConstRefPtr

pConstRefPtr

)

Member Function Documentation

VgLine VgLineConstRefPtr.__deref__

(

)

VgLine VgLineConstRefPtr.__ref__

(

)

VgLine VgLineConstRefPtr.get

(

)

VgAnimationConstRefPtr VgLineConstRefPtr.getAnimation

(

String

pName

)

VgValue VgLineConstRefPtr.getAnimationChannelValue

(

String

pChannelName

)

void VgLineConstRefPtr.getAnimationNames

(

VgStringList

pNameList

)

VgLineDescriptorConstRefPtr VgLineConstRefPtr.getDescriptor

(

)

Retrieves the descriptor containing line information.

Returns

The descriptor.

String VgLineConstRefPtr.getID

(

)

VgPosition VgLineConstRefPtr.getLocalPosition

(

)

int VgLineConstRefPtr.getNbReferences

(

)

boolean VgLineConstRefPtr.getNotifyPOISelectedOnClick

(

)

static VgLineConstRefPtr VgLineConstRefPtr.getNull ( )

static

VgOrientation VgLineConstRefPtr.getOrientation

(

)

VgPosition VgLineConstRefPtr.getPosition

(

)

float VgLineConstRefPtr.getScale

(

)

VgITextureRefPtr VgLineConstRefPtr.getTexture

(

)

Version

2.0.9263

Returns

The line texture.

float VgLineConstRefPtr.getTextureAnimationSpeed

(

)

Version

2.0.9263

Returns

The line texture animation speed in meters/second

VgIGeometryType VgLineConstRefPtr.getType

(

)

Returns

The geometry type for this object

References VgIGeometryType.swigToEnum().

VgVisibilityRamp VgLineConstRefPtr.getVisibilityRamp

(

)

int VgLineConstRefPtr.getZIndex

(

)

boolean VgLineConstRefPtr.isDrawnOnTop

(

)

boolean VgLineConstRefPtr.isValid

(

)

boolean VgLineConstRefPtr.isVisible

(

)

void VgLineConstRefPtr.ref

(

)

VgLineConstRefPtr VgLineConstRefPtr.set

(

VgLine

pPointer

)

int VgLineConstRefPtr.unref

(

)

---

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

• VgLineConstRefPtr.java