Public Member Functions
	VgLineRefPtr ()

	VgLineRefPtr (VgLine pPointer)

	VgLineRefPtr (VgLineRefPtr pRefPtr)

VgLineRefPtr	set (VgLine pPointer)

VgLine	__ref__ ()

VgLine	__deref__ ()

VgLine	get ()

boolean	isValid ()

VgLineDescriptorConstRefPtr	getDescriptor ()

VgIGeometryType	getType ()

VgITextureRefPtr	getTexture ()

boolean	setTexture (VgITextureRefPtr pTexture)

float	getTextureAnimationSpeed ()

void	setTextureAnimationSpeed (float pSpeed)

VgPosition	getInterpolatedPosition (float pValue)

VgPoint	asPoint ()

VgLine	asLine ()

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 ()

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 ()

void	ref ()

int	unref ()

int	getNbReferences ()

Static Public Member Functions
static VgLineRefPtr	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

VgLineRefPtr.VgLineRefPtr ( )

VgLineRefPtr.VgLineRefPtr ( VgLine pPointer )

VgLineRefPtr.VgLineRefPtr ( VgLineRefPtr pRefPtr )

Member Function Documentation

VgLine VgLineRefPtr.__deref__ ( )

VgLine VgLineRefPtr.__ref__ ( )

void VgLineRefPtr.addListener ( VgIGeometryCallbackRefPtr pCallback )

VgIGeometry VgLineRefPtr.asGeometry ( )

VgLine VgLineRefPtr.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 VgLineRefPtr.asPoint ( )

Casts this instance into a VgPoint .

Version: 2.0.9590

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

VgAnimationRefPtr VgLineRefPtr.editAnimation ( String pName )

VgLine VgLineRefPtr.get ( )

VgAnimationConstRefPtr VgLineRefPtr.getAnimation ( String pName )

VgValue VgLineRefPtr.getAnimationChannelValue ( String pChannelName )

void VgLineRefPtr.getAnimationNames ( VgStringList pNameList )

boolean VgLineRefPtr.getBoundingPositions ( VgPositionVector pResult )

VgLineDescriptorConstRefPtr VgLineRefPtr.getDescriptor ( )

Retrieves the descriptor containing line information.

Returns: The descriptor.

String VgLineRefPtr.getID ( )

VgPosition VgLineRefPtr.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.

VgLayerRefPtr VgLineRefPtr.getLayer ( )

VgPosition VgLineRefPtr.getLocalPosition ( )

int VgLineRefPtr.getNbReferences ( )

boolean VgLineRefPtr.getNotifyPOISelectedOnClick ( )

static VgLineRefPtr VgLineRefPtr.getNull ( )

static

VgOrientation VgLineRefPtr.getOrientation ( )

VgPosition VgLineRefPtr.getPosition ( )

float VgLineRefPtr.getScale ( )

VgITextureRefPtr VgLineRefPtr.getTexture ( )

Version: 2.0.9263

Returns: The line texture.

float VgLineRefPtr.getTextureAnimationSpeed ( )

Version: 2.0.9263

Returns: The line texture animation speed in meters/second

VgIGeometryType VgLineRefPtr.getType ( )

Returns: The geometry type for this object

References VgIGeometryType.swigToEnum().

VgVisibilityRamp VgLineRefPtr.getVisibilityRamp ( )

int VgLineRefPtr.getZIndex ( )

boolean VgLineRefPtr.isDrawnOnTop ( )

boolean VgLineRefPtr.isValid ( )

boolean VgLineRefPtr.isVisible ( )

void VgLineRefPtr.ref ( )

void VgLineRefPtr.removeListener ( VgIGeometryCallbackRefPtr pCallback )

VgLineRefPtr VgLineRefPtr.set ( VgLine pPointer )

void VgLineRefPtr.setAnimation	(	String	pAnimationName,
		VgAnimationRefPtr	pAnimation
	)

void VgLineRefPtr.setAnimation ( VgAnimationRefPtr pAnimation )

void VgLineRefPtr.setDrawOnTop ( boolean pEnable )

void VgLineRefPtr.setLayer	(	VgLayerRefPtr	pLayer,
		boolean	pHaveGeographicCoherence
	)

void VgLineRefPtr.setLayer ( VgLayerRefPtr pLayer )

void VgLineRefPtr.setLocalAnimation ( VgAnimationRefPtr pAnimation )

void VgLineRefPtr.setLocalPosition ( VgPosition pPosition )

void VgLineRefPtr.setNotifyPOISelectedOnClick ( boolean pValue )

void VgLineRefPtr.setOrientation ( VgOrientation pOrientation )

void VgLineRefPtr.setPosition	(	VgPosition	pPosition,
		boolean	pHaveGeographicCoherence
	)

void VgLineRefPtr.setPosition ( VgPosition pPosition )

void VgLineRefPtr.setScale ( float pScale )

boolean VgLineRefPtr.setTexture ( VgITextureRefPtr pTexture )

Sets a new texture for this line.

Parameters

pTexture

Version: 2.0.9263

void VgLineRefPtr.setTextureAnimationSpeed ( float pSpeed )

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

Parameters

pSpeed

Version: 2.0.9263

void VgLineRefPtr.setVisibilityRamp ( VgVisibilityRamp pRamp )

void VgLineRefPtr.setVisible ( boolean pIsVisible )

void VgLineRefPtr.setZIndex ( int pZIndex )

int VgLineRefPtr.unref ( )

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

VgLineRefPtr.java

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation