VgPointDescriptor (VisioDevKit)

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

```
public class VgPointDescriptor
extends VgGeometryDescriptor
```
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:

Method Summary

Methods
Modifier and Type	Method and Description
`static VgPointDescriptorRefPtr`	`create()` This static method returns a new heap-allocated descriptor.
`static VgPointDescriptorRefPtr`	`create(VgPointDescriptorRefPtr pOther)`
`void`	`delete()`
`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`	`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`	`getMGeometryConstantSizeMaxScale()` Controls the scale of the VgPoint when viewed from a distance equal to mGeometryConstantSizeDistance.
`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.
`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`	`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`	`setMGeometryConstantSizeMaxScale(float value)` Controls the scale of the VgPoint when viewed from a distance equal to mGeometryConstantSizeDistance.
`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.

Methods inherited from class com.visioglobe.libVisioDevKit.VgGeometryDescriptor
getMDrawOnTop, getMVisibilityRampFullyInvisible, getMVisibilityRampFullyVisible, getMVisibilityRampStartInvisible, getMVisibilityRampStartVisible, getMZIndex, setMDrawOnTop, setMVisibilityRampFullyInvisible, setMVisibilityRampFullyVisible, setMVisibilityRampStartInvisible, setMVisibilityRampStartVisible, setMZIndex

Methods inherited from class com.visioglobe.libVisioDevKit.VgReferenced
getNbReferences, ref, unref

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - delete
```
public void delete()
```
    Overrides:
    
    delete in class VgGeometryDescriptor
  - 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.
  - 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.
  - setMGeometryConstantSizeMaxScale
```
public void setMGeometryConstantSizeMaxScale(float value)
```
    Controls the scale of the VgPoint when viewed from a distance equal to mGeometryConstantSizeDistance. The default value of this property is 1.0.
  - getMGeometryConstantSizeMaxScale
```
public float getMGeometryConstantSizeMaxScale()
```
    Controls the scale of the VgPoint when viewed from a distance equal to mGeometryConstantSizeDistance. The default value of this property is 1.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.
  - 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.

Class VgPointDescriptor

Method Summary

Methods inherited from class com.visioglobe.libVisioDevKit.VgGeometryDescriptor

Methods inherited from class com.visioglobe.libVisioDevKit.VgReferenced

Methods inherited from class java.lang.Object

Method Detail

delete

create

create

setMPosition

getMPosition

setMAltitudeMode

getMAltitudeMode

setMAnchorPosition

getMAnchorPosition

setMGeometryConstantSizeDistance

getMGeometryConstantSizeDistance

setMGeometryConstantSizeMaxScale

getMGeometryConstantSizeMaxScale

setMHeading

getMHeading

setMPitch

getMPitch

setMRoll

getMRoll

setMForceFrontFace

getMForceFrontFace

setMHeadingOrientationType

getMHeadingOrientationType

setMPitchOrientationType

getMPitchOrientationType

setMRollOrientationType

getMRollOrientationType

setMMarkerDescriptors

getMMarkerDescriptors