VgIGeometryRefPtr Class Reference

Public Member Functions
	VgIGeometryRefPtr ()
	VgIGeometryRefPtr (VgIGeometry pPointer)
	VgIGeometryRefPtr (VgIGeometryRefPtr pRefPtr)
VgIGeometryRefPtr	set (VgIGeometry pPointer)
VgIGeometry	__ref__ ()
VgIGeometry	__deref__ ()
VgIGeometry	get ()
boolean	isValid ()
	VgIGeometryRefPtr (VgPointRefPtr pRefPtr)
	VgIGeometryRefPtr (VgLineRefPtr pRefPtr)
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 ()
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 VgIGeometryRefPtr	getNull ()

Detailed Description

The Vg3DModule::VgIGeometry interface is used as an abstraction of geometric features that can be added to or removed from the scene.

Constructor & Destructor Documentation

VgIGeometryRefPtr.VgIGeometryRefPtr

(

)

VgIGeometryRefPtr.VgIGeometryRefPtr

(

VgIGeometry

pPointer

)

VgIGeometryRefPtr.VgIGeometryRefPtr

(

VgIGeometryRefPtr

pRefPtr

)

VgIGeometryRefPtr.VgIGeometryRefPtr

(

VgPointRefPtr

pRefPtr

)

VgIGeometryRefPtr.VgIGeometryRefPtr

(

VgLineRefPtr

pRefPtr

)

Member Function Documentation

VgIGeometry VgIGeometryRefPtr.__deref__

(

)

VgIGeometry VgIGeometryRefPtr.__ref__

(

)

void VgIGeometryRefPtr.addListener

(

VgIGeometryCallbackRefPtr

pCallback

)

Adds a listener to the geometry object. Alternatively you can use setNotifyPOISelectedOnClick with true and use the VgMapModule::VgIMapModule::addListener to receive the notifications in one place.

Parameters

pCallback

The callback to associate with this geometry object.

Version

2.0

2.1.3 Updated documentation to point out that might be easier to use VgMapModule::VgIPlaceListener

See also

Vg3DModule::VgIGeometry::setNotifyPOISelectedOnClick

VgMapModule::VgIPlaceListener

VgIGeometry VgIGeometryRefPtr.asGeometry

(

)

Casts this instance into a VgIGeometry .

Version

2.0.9590

Returns

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

VgLine VgIGeometryRefPtr.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 VgIGeometryRefPtr.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 VgIGeometryRefPtr.editAnimation

(

String

pName

)

VgIGeometry VgIGeometryRefPtr.get

(

)

VgAnimationConstRefPtr VgIGeometryRefPtr.getAnimation

(

String

pName

)

VgValue VgIGeometryRefPtr.getAnimationChannelValue

(

String

pChannelName

)

void VgIGeometryRefPtr.getAnimationNames

(

VgStringList

pNameList

)

boolean VgIGeometryRefPtr.getBoundingPositions

(

VgPositionVector

pResult

)

Returns a vector of points that can be used to determine a viewpoint where one is guaranteed that the whole object is visible.

Parameters

pResult

Vector reference where it will place the results. The VgSRS of all positions will not be geo-referenced.

Version

2.1.3

See also

VgEngine::VgICamera::getViewpointFromPositions

Returns

true if the VgIGeometry has a valid bound

String VgIGeometryRefPtr.getID

(

)

Version

2.1.0

See also

VgEngine::VgQuery

Returns

VgIGeometry's Identifier used at its creation.

VgLayerRefPtr VgIGeometryRefPtr.getLayer

(

)

Version

2.0.9517

Returns

The layer containing this geometry. NULL if the geometry is not attached yet.

VgPosition VgIGeometryRefPtr.getLocalPosition

(

)

Gets the geometry's local node position relative to it's parent.

Version

2.1.9

Returns

The spatial's local node relative position.

int VgIGeometryRefPtr.getNbReferences

(

)

boolean VgIGeometryRefPtr.getNotifyPOISelectedOnClick

(

)

Version

2.1.3

See also

VgMapModule::VgIPlaceListener

Returns

true if the VgIGeometry is set to called the VgMapModule::VgIPlaceListener on click

static VgIGeometryRefPtr VgIGeometryRefPtr.getNull ( )

static

VgOrientation VgIGeometryRefPtr.getOrientation

(

)

VgPosition VgIGeometryRefPtr.getPosition

(

)

float VgIGeometryRefPtr.getScale

(

)

VgIGeometryType VgIGeometryRefPtr.getType

(

)

Gets the geometry type.

Returns

The type of the geometry object.

References VgIGeometryType.swigToEnum().

VgVisibilityRamp VgIGeometryRefPtr.getVisibilityRamp

(

)

Version

2.0.9263

Returns

The visibility ramp.

int VgIGeometryRefPtr.getZIndex

(

)

boolean VgIGeometryRefPtr.isDrawnOnTop

(

)

boolean VgIGeometryRefPtr.isValid

(

)

boolean VgIGeometryRefPtr.isVisible

(

)

void VgIGeometryRefPtr.ref

(

)

void VgIGeometryRefPtr.removeListener

(

VgIGeometryCallbackRefPtr

pCallback

)

Removes a listener from the geometry object.

Parameters

pCallback

The callback to disassociate from this geometry object.

Version

2.0

VgIGeometryRefPtr VgIGeometryRefPtr.set

(

VgIGeometry

pPointer

)

void VgIGeometryRefPtr.setAnimation	(	String	pAnimationName,
		VgAnimationRefPtr	pAnimation
	)

void VgIGeometryRefPtr.setAnimation

(

VgAnimationRefPtr

pAnimation

)

void VgIGeometryRefPtr.setDrawOnTop

(

boolean

pEnable

)

void VgIGeometryRefPtr.setLayer	(	VgLayerRefPtr	pLayer,
		boolean	pHaveGeographicCoherence
	)

Sets the associated layer.

Note

To be displayed a geometry must have a layer set, with visible hosted visuals and be visible.

Parameters

pLayer	The VgLayer to associate with the geometry object. Pass pLayer as null to disassociate the geometry object from a layer.
pHaveGeographicCoherence	An optional parameter who by default is true. Is used to determine the geographic coherence of the geometry. If set to false, then the geometry will be coherent with the scene.

See also

VgEngine::VgSpatial::setVisible

VgEngine::VgLayer

Version

2.0

void VgIGeometryRefPtr.setLayer

(

VgLayerRefPtr

pLayer

)

void VgIGeometryRefPtr.setLocalAnimation

(

VgAnimationRefPtr

pAnimation

)

void VgIGeometryRefPtr.setLocalPosition

(

VgPosition

pPosition

)

Sets the geometry's local node position relative to it's parent.

Parameters

pPosition

The spatial's local node relative position.

Version

2.1.9

void VgIGeometryRefPtr.setNotifyPOISelectedOnClick

(

boolean

pValue

)

Sets the VgIGeometry to call the VgIMapModule::VgIPlaceListeners when the user clicks on the VgIGeometry . This is done after calling all the listeners added to the VgIGeometry directly.

Parameters

pValue

Version

2.1.3

See also

VgMapModule::VgIPlaceListener

void VgIGeometryRefPtr.setOrientation

(

VgOrientation

pOrientation

)

void VgIGeometryRefPtr.setPosition	(	VgPosition	pPosition,
		boolean	pHaveGeographicCoherence
	)

void VgIGeometryRefPtr.setPosition

(

VgPosition

pPosition

)

void VgIGeometryRefPtr.setScale

(

float

pScale

)

void VgIGeometryRefPtr.setVisibilityRamp

(

VgVisibilityRamp

pRamp

)

Sets the visibility ramp.

Parameters

pRamp

Version

2.0.9263

void VgIGeometryRefPtr.setVisible

(

boolean

pIsVisible

)

void VgIGeometryRefPtr.setZIndex

(

int

pZIndex

)

int VgIGeometryRefPtr.unref

(

)

---

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

• VgIGeometryRefPtr.java