com.visioglobe.libVisioDevKit
Class VgPointDescriptor

java.lang.Object
  com.visioglobe.libVisioDevKit.VgReferenced
      com.visioglobe.libVisioDevKit.VgPointDescriptor

public class VgPointDescriptor
extends VgReferenced

This structure encapsulates the point description parameters. The VgPointDescriptor contains the all the attributes that are useful for describing the behaviour of a VgPoint object. Below is a code snippet showing how an allocated VgPointDescriptor can be configured:

Endcode:

Field Summary

Fields inherited from class com.visioglobe.libVisioDevKit.VgReferenced

swigCMemOwn, swigRefPtr

Constructor Summary

VgPointDescriptor(long cPtr, boolean cMemoryOwn)

Method Summary

static VgPointDescriptorRefPtr	create() This static method returns a new heap-allocated descriptor.
static VgPointDescriptorRefPtr	create(VgPointDescriptorRefPtr pOther)
void	delete()
static long	getCPtr(VgPointDescriptor obj)
VgAltitudeMode	getMAltitudeMode() The altitude mode tells how to interpret the VgPointDescriptor::mPosition::mZOrAltitude member.
VgAnchorMode	getMAnchorPosition() Controls the anchoring of the point's bounding box with its position.
boolean	getMDrawOnTop() In cases where an object is partially or completely hidden by an object in front, our engine will not display it (or partially display it).
boolean	getMForceFrontFace() In cases where the camera can view the poi from behind, our engine will not display the label.
float	getMGeometryConstantSizeDistance() Controls the distance at which the VgPoint does not become bigger as you approach it.
float	getMHeading() Controls the heading of the VgPoint.
VgOrientationType	getMHeadingOrientationType() Controls the orientation type of the Heading.
VgMarkerDescriptorVector	getMMarkerDescriptors() A vector of VgMarkerDescriptors which determine what markers and how many of them are associated with this VgPoint.
float	getMPitch() Controls the pitch of the VgPoint.
VgOrientationType	getMPitchOrientationType() Controls the orientation type of the Heading.
VgPosition	getMPosition() The point's position.
float	getMRoll() Controls the roll of the VgPoint.
VgOrientationType	getMRollOrientationType() Controls the orientation type of the Roll.
float	getMVisibilityRampFullyInvisible() Distance in meters at which the VgPoint is fully invisible.
float	getMVisibilityRampFullyVisible() Distance in meters at which the VgPoint is fully visible.
float	getMVisibilityRampStartInvisible() Distance in meters at which the VgPoint starts to become invisible.
float	getMVisibilityRampStartVisible() Distance in meters at which the VgPoint starts becoming visible.
int	getMZIndex() This member sets the z-index of the point.
void	setMAltitudeMode(VgAltitudeMode value) The altitude mode tells how to interpret the VgPointDescriptor::mPosition::mZOrAltitude member.
void	setMAnchorPosition(VgAnchorMode value) Controls the anchoring of the point's bounding box with its position.
void	setMDrawOnTop(boolean value) In cases where an object is partially or completely hidden by an object in front, our engine will not display it (or partially display it).
void	setMForceFrontFace(boolean value) In cases where the camera can view the poi from behind, our engine will not display the label.
void	setMGeometryConstantSizeDistance(float value) Controls the distance at which the VgPoint does not become bigger as you approach it.
void	setMHeading(float value) Controls the heading of the VgPoint.
void	setMHeadingOrientationType(VgOrientationType value) Controls the orientation type of the Heading.
void	setMMarkerDescriptors(VgMarkerDescriptorVector value) A vector of VgMarkerDescriptors which determine what markers and how many of them are associated with this VgPoint.
void	setMPitch(float value) Controls the pitch of the VgPoint.
void	setMPitchOrientationType(VgOrientationType value) Controls the orientation type of the Heading.
void	setMPosition(VgPosition value) The point's position.
void	setMRoll(float value) Controls the roll of the VgPoint.
void	setMRollOrientationType(VgOrientationType value) Controls the orientation type of the Roll.
void	setMVisibilityRampFullyInvisible(float value) Distance in meters at which the VgPoint is fully invisible.
void	setMVisibilityRampFullyVisible(float value) Distance in meters at which the VgPoint is fully visible.
void	setMVisibilityRampStartInvisible(float value) Distance in meters at which the VgPoint starts to become invisible.
void	setMVisibilityRampStartVisible(float value) Distance in meters at which the VgPoint starts becoming visible.
void	setMZIndex(int value) This member sets the z-index of the point.

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

VgPointDescriptor

public VgPointDescriptor(long cPtr,
                         boolean cMemoryOwn)

Method Detail

getCPtr

public static long getCPtr(VgPointDescriptor obj)

delete

public void delete()

Overrides:

delete in class VgReferenced

create

public static VgPointDescriptorRefPtr create()

This static method returns a new heap-allocated descriptor. It is the only method that should be used to instantiate new descriptors. It is a way to make sure no one will delete it, except the last VgRefPtr pointing to it.

create

public static VgPointDescriptorRefPtr create(VgPointDescriptorRefPtr pOther)

setMPosition

public void setMPosition(VgPosition value)

The point's position.

getMPosition

public VgPosition getMPosition()

The point's position.

setMAltitudeMode

public void setMAltitudeMode(VgAltitudeMode value)

The altitude mode tells how to interpret the VgPointDescriptor::mPosition::mZOrAltitude member. Default is eAbsolute.

getMAltitudeMode

public VgAltitudeMode getMAltitudeMode()

The altitude mode tells how to interpret the VgPointDescriptor::mPosition::mZOrAltitude member. Default is eAbsolute.

setMAnchorPosition

public void setMAnchorPosition(VgAnchorMode value)

Controls the anchoring of the point's bounding box with its position. Default is VgEngine::eVgBottomCenter.

getMAnchorPosition

public VgAnchorMode getMAnchorPosition()

Controls the anchoring of the point's bounding box with its position. Default is VgEngine::eVgBottomCenter.

setMVisibilityRampStartVisible

public void setMVisibilityRampStartVisible(float value)

Distance in meters at which the VgPoint starts becoming visible. If set to 0.0, the VgPoint is always visble no matter how close you are. The default value of this property is 2.0.

getMVisibilityRampStartVisible

public float getMVisibilityRampStartVisible()

Distance in meters at which the VgPoint starts becoming visible. If set to 0.0, the VgPoint is always visble no matter how close you are. The default value of this property is 2.0.

setMVisibilityRampFullyVisible

public void setMVisibilityRampFullyVisible(float value)

Distance in meters at which the VgPoint is fully visible. If set to 0.0, the VgPoint is always visble when you are close. The default value of this property is 5.0.

getMVisibilityRampFullyVisible

public float getMVisibilityRampFullyVisible()

Distance in meters at which the VgPoint is fully visible. If set to 0.0, the VgPoint is always visble when you are close. The default value of this property is 5.0.

setMVisibilityRampStartInvisible

public void setMVisibilityRampStartInvisible(float value)

Distance in meters at which the VgPoint starts to become invisible. By default 3000 meters

getMVisibilityRampStartInvisible

public float getMVisibilityRampStartInvisible()

Distance in meters at which the VgPoint starts to become invisible. By default 3000 meters

setMVisibilityRampFullyInvisible

public void setMVisibilityRampFullyInvisible(float value)

Distance in meters at which the VgPoint is fully invisible. By default 5000 meters. If set to a very large value, VgPoint will never fade out.

getMVisibilityRampFullyInvisible

public float getMVisibilityRampFullyInvisible()

Distance in meters at which the VgPoint is fully invisible. By default 5000 meters. If set to a very large value, VgPoint will never fade out.

setMGeometryConstantSizeDistance

public void setMGeometryConstantSizeDistance(float value)

Controls the distance at which the VgPoint does not become bigger as you approach it. When the camera is within this distance of the VgPoint, the visible size of the VgPoint on the screen will be the same as what it looked like when it was mGeometryConstantSizeDistance meters away. If set to 0.0, the size of the POI will be determined by mScale, regardless of it's distance from the camera. The default value of this property is 700.0.

getMGeometryConstantSizeDistance

public float getMGeometryConstantSizeDistance()

Controls the distance at which the VgPoint does not become bigger as you approach it. When the camera is within this distance of the VgPoint, the visible size of the VgPoint on the screen will be the same as what it looked like when it was mGeometryConstantSizeDistance meters away. If set to 0.0, the size of the POI will be determined by mScale, regardless of it's distance from the camera. The default value of this property is 700.0.

setMHeading

public void setMHeading(float value)

Controls the heading of the VgPoint. Default value is 0.0.

Note:

This value is only used if VgPointDescriptor::mHeadingOrientationType takes into account heading.

getMHeading

public float getMHeading()

Controls the heading of the VgPoint. Default value is 0.0.

Note:

This value is only used if VgPointDescriptor::mHeadingOrientationType takes into account heading.

setMPitch

public void setMPitch(float value)

Controls the pitch of the VgPoint. The valid range is between -90.0 and 90.0. A value of 0, means the VgPoint is facing the horizon. Default value is 0.0.

Note:

This value is only used if VgPointDescriptor::mPitchOrientationType takes into account pitch.

getMPitch

public float getMPitch()

Controls the pitch of the VgPoint. The valid range is between -90.0 and 90.0. A value of 0, means the VgPoint is facing the horizon. Default value is 0.0.

Note:

This value is only used if VgPointDescriptor::mPitchOrientationType takes into account pitch.

setMRoll

public void setMRoll(float value)

Controls the roll of the VgPoint. The valid range is between -90.0 and 90.0. A value of 0, means the VgPoint is straight. Default value is 0.0.

Note:

This value is only used if VgPointDescriptor::mRollOrientationType takes into account roll.

getMRoll

public float getMRoll()

Controls the roll of the VgPoint. The valid range is between -90.0 and 90.0. A value of 0, means the VgPoint is straight. Default value is 0.0.

Note:

This value is only used if VgPointDescriptor::mRollOrientationType takes into account roll.

setMForceFrontFace

public void setMForceFrontFace(boolean value)

In cases where the camera can view the poi from behind, our engine will not display the label. For example this will happen if the VgPoint has a fixed orientation (it will not happen if it is always camera facing). Default value is false. Setting this to true will allow to view fixed VgPoints from behind.

getMForceFrontFace

public boolean getMForceFrontFace()

In cases where the camera can view the poi from behind, our engine will not display the label. For example this will happen if the VgPoint has a fixed orientation (it will not happen if it is always camera facing). Default value is false. Setting this to true will allow to view fixed VgPoints from behind.

setMDrawOnTop

public void setMDrawOnTop(boolean value)

In cases where an object is partially or completely hidden by an object in front, our engine will not display it (or partially display it). Default value is false. Setting this to true will always display the VgPoint regardless of whether there are objects in front. This value is related to the concept of Depth Test. The points are drawn back to front.

getMDrawOnTop

public boolean getMDrawOnTop()

In cases where an object is partially or completely hidden by an object in front, our engine will not display it (or partially display it). Default value is false. Setting this to true will always display the VgPoint regardless of whether there are objects in front. This value is related to the concept of Depth Test. The points are drawn back to front.

setMHeadingOrientationType

public void setMHeadingOrientationType(VgOrientationType value)

Controls the orientation type of the Heading. By default is eVgOrientaitonCameraFacing.

getMHeadingOrientationType

public VgOrientationType getMHeadingOrientationType()

Controls the orientation type of the Heading. By default is eVgOrientaitonCameraFacing.

setMPitchOrientationType

public void setMPitchOrientationType(VgOrientationType value)

Controls the orientation type of the Heading. By default is eVgOrientaitonCameraFacing.

getMPitchOrientationType

public VgOrientationType getMPitchOrientationType()

Controls the orientation type of the Heading. By default is eVgOrientaitonCameraFacing.

setMRollOrientationType

public void setMRollOrientationType(VgOrientationType value)

Controls the orientation type of the Roll. By default is eVgOrientationFixedModulo180degrees.

getMRollOrientationType

public VgOrientationType getMRollOrientationType()

Controls the orientation type of the Roll. By default is eVgOrientationFixedModulo180degrees.

setMMarkerDescriptors

public void setMMarkerDescriptors(VgMarkerDescriptorVector value)

A vector of VgMarkerDescriptors which determine what markers and how many of them are associated with this VgPoint. See Vg3DModule::VgMarkerType for a list of available markers.

Note:

It is the responsability of the caller to release the VgMarkerDescriptor objects.

getMMarkerDescriptors

public VgMarkerDescriptorVector getMMarkerDescriptors()

A vector of VgMarkerDescriptors which determine what markers and how many of them are associated with this VgPoint. See Vg3DModule::VgMarkerType for a list of available markers.

Note:

It is the responsability of the caller to release the VgMarkerDescriptor objects.

setMZIndex

public void setMZIndex(int value)

This member sets the z-index of the point. This is used to solve cases where translucent objects can not be sorted correctly. Forces a rendering order (only used on translucent objects). Smaller values (can be negative) lead to object appearing "over" the others.

getMZIndex

public int getMZIndex()

This member sets the z-index of the point. This is used to solve cases where translucent objects can not be sorted correctly. Forces a rendering order (only used on translucent objects). Smaller values (can be negative) lead to object appearing "over" the others.