VgLine Class Reference

Inheritance diagram for VgLine:

Public Member Functions
VgLineDescriptorConstRefPtr	getDescriptor ()
VgIGeometryType	getType ()
VgITextureRefPtr	getTexture ()
boolean	setTexture (VgITextureRefPtr pTexture)
float	getTextureAnimationSpeed ()
void	setTextureAnimationSpeed (float pSpeed)
VgPosition	getInterpolatedPosition (float pValue)
VgPoint	asPoint ()
VgLine	asLine ()
Public Member Functions inherited from VgIGeometry
	VgIGeometry ()
VgIGeometryType	getType ()
VgLayerRefPtr	getLayer ()
void	setLayer (VgLayerRefPtr pLayer, boolean pHaveGeographicCoherence)
void	setLayer (VgLayerRefPtr pLayer)
void	addListener (VgIGeometryCallbackRefPtr pCallback)
void	removeListener (VgIGeometryCallbackRefPtr pCallback)
VgVisibilityRamp	getVisibilityRamp ()
void	setVisibilityRamp (VgVisibilityRamp pRamp)
String	getID ()
boolean	getNotifyPOISelectedOnClick ()
void	setNotifyPOISelectedOnClick (boolean pValue)
boolean	getBoundingPositions (VgPositionVector pResult)
VgPosition	getLocalPosition ()
void	setLocalPosition (VgPosition pPosition)
VgIGeometry	asGeometry ()
VgPoint	asPoint ()
VgLine	asLine ()
Public Member Functions inherited from VgSpatial
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 ()
Public Member Functions inherited from VgReferenced
synchronized void	release ()
	VgReferenced ()
	VgReferenced (VgReferenced pThis)
void	ref ()
int	unref ()
int	getNbReferences ()

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

Member Function Documentation

VgLine VgLine.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 VgLine.asPoint

(

)

Casts this instance into a VgPoint .

Version

2.0.9590

Returns

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

VgLineDescriptorConstRefPtr VgLine.getDescriptor

(

)

Retrieves the descriptor containing line information.

Returns

The descriptor.

VgPosition VgLine.getInterpolatedPosition

(

float

pValue

)

returns interpolated position for this line.

Parameters

pValue

between 0.0f and 1.0f

Version

2.1.3

Returns

VgEngine::VgPosition with interpolated value.

VgITextureRefPtr VgLine.getTexture

(

)

Version

2.0.9263

Returns

The line texture.

float VgLine.getTextureAnimationSpeed

(

)

Version

2.0.9263

Returns

The line texture animation speed in meters/second

VgIGeometryType VgLine.getType

(

)

Returns

The geometry type for this object

References VgIGeometryType.swigToEnum().

boolean VgLine.setTexture

(

VgITextureRefPtr

pTexture

)

Sets a new texture for this line.

Parameters

pTexture

Version

2.0.9263

void VgLine.setTextureAnimationSpeed

(

float

pSpeed

)

Sets the texture animation speed in meters/second for this line.

Parameters

pSpeed

Version

2.0.9263

---

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

• VgLine.java