VgLineDescriptor (VisioDevKit)

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

```
public class VgLineDescriptor
extends VgGeometryDescriptor
```
A structure which describes the attributes of a Vg3DModule::VgLine. Below is a code snippet showing how an allocated VgPointDescriptor can be configured: n* mVgApplication;

Method Summary

Methods
Modifier and Type	Method and Description
`VgLineDescriptorRefPtr`	`clone()`
`static VgLineDescriptorRefPtr`	`create()` This static method returns a new heap-allocated descriptor.
`void`	`delete()`
`VgAltitudeMode`	`getMAltitudeMode()` The altitude mode tells how to interpret the 'mHeight' members for all the mPositions elements.
`VgColorVector`	`getMColors()` The line colors.
`boolean`	`getMHaveCaps()` Tells whether the line should have round caps at start and end.
`VgLineType`	`getMLineType()` The type of line that will be rendered.
`double`	`getMMaxCornerRadius()` This member sets the maximal curvature radius used in corners when smoothing the line. expressed in meters.
`VgPositionVector`	`getMPositions()` The positions of the control points ordered sequentially.
`VgITextureRefPtr`	`getMTexture()` The texture that will be used when drawing the track.
`float`	`getMTextureAnimationSpeed()` The texture animation speed in meters/second (along the vertical axis of the texture).
`float`	`getMTextureSize()` The texture's size in y coordinate (metric).
`VgDoubleVector`	`getMWidths()` The line widths.
`void`	`setMAltitudeMode(VgAltitudeMode value)` The altitude mode tells how to interpret the 'mHeight' members for all the mPositions elements.
`void`	`setMColors(VgColorVector value)` The line colors.
`void`	`setMHaveCaps(boolean value)` Tells whether the line should have round caps at start and end.
`void`	`setMLineType(VgLineType value)` The type of line that will be rendered.
`void`	`setMMaxCornerRadius(double value)` This member sets the maximal curvature radius used in corners when smoothing the line. expressed in meters.
`void`	`setMPositions(VgPositionVector value)` The positions of the control points ordered sequentially.
`void`	`setMTexture(VgITextureRefPtr value)` The texture that will be used when drawing the track.
`void`	`setMTextureAnimationSpeed(float value)` The texture animation speed in meters/second (along the vertical axis of the texture).
`void`	`setMTextureSize(float value)` The texture's size in y coordinate (metric).
`void`	`setMWidths(VgDoubleVector value)` The line widths.

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 VgLineDescriptorRefPtr 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.
  - setMPositions
```
public void setMPositions(VgPositionVector value)
```
    The positions of the control points ordered sequentially. If you want to close the VgLine you have to push_back the first point at the end of the vector.
  - getMPositions
```
public VgPositionVector getMPositions()
```
    The positions of the control points ordered sequentially. If you want to close the VgLine you have to push_back the first point at the end of the vector.
  - setMColors
```
public void setMColors(VgColorVector value)
```
    The line colors. This vector should contain either 1 element in which case all the line will be drawn using that color. If the vector's size is greater or equal to the size of VgLineDescriptor::mPositions, then one color element will be used for each position, and these will be interpolated by the spline erp.
    
    Note:
    
    When using colors, the visibility ramps will not be able to adjust transparency, only binary (on/off) visibility is possible.
  - getMColors
```
public VgColorVector getMColors()
```
    The line colors. This vector should contain either 1 element in which case all the line will be drawn using that color. If the vector's size is greater or equal to the size of VgLineDescriptor::mPositions, then one color element will be used for each position, and these will be interpolated by the spline erp.
    
    Note:
    
    When using colors, the visibility ramps will not be able to adjust transparency, only binary (on/off) visibility is possible.
  - setMWidths
```
public void setMWidths(VgDoubleVector value)
```
    The line widths. Depending on VgLineDescriptor::mLineType value these parameters can represent either pixel values (ePixelConstantSize) or meter values (eGeometryConstantSize). This vector should contain either 1 element in which case all the line will be drawn using that width. If the vector's size is greater or equal to the size of VgLineDescriptor::mPositions, then one width element will be used for each position, and these will be interpolated by the spline erp.
    
    Note:
    
    In case the line is of ePixelConstantSize type, only the first element will be used as the overall width, whatever the vector's size is.
  - getMWidths
```
public VgDoubleVector getMWidths()
```
    The line widths. Depending on VgLineDescriptor::mLineType value these parameters can represent either pixel values (ePixelConstantSize) or meter values (eGeometryConstantSize). This vector should contain either 1 element in which case all the line will be drawn using that width. If the vector's size is greater or equal to the size of VgLineDescriptor::mPositions, then one width element will be used for each position, and these will be interpolated by the spline erp.
    
    Note:
    
    In case the line is of ePixelConstantSize type, only the first element will be used as the overall width, whatever the vector's size is.
  - setMTexture
```
public void setMTexture(VgITextureRefPtr value)
```
    The texture that will be used when drawing the track. The texture mapping will ensure that the full texture width is mapped on the track's width.
    
    Note:
    
    If using a texture, then VgLineDescriptor::mLineType should be set to eGeometryConstantSize.
  - getMTexture
```
public VgITextureRefPtr getMTexture()
```
    The texture that will be used when drawing the track. The texture mapping will ensure that the full texture width is mapped on the track's width.
    
    Note:
    
    If using a texture, then VgLineDescriptor::mLineType should be set to eGeometryConstantSize.
  - setMTextureSize
```
public void setMTextureSize(float value)
```
    The texture's size in y coordinate (metric).
  - getMTextureSize
```
public float getMTextureSize()
```
    The texture's size in y coordinate (metric).
  - setMTextureAnimationSpeed
```
public void setMTextureAnimationSpeed(float value)
```
    The texture animation speed in meters/second (along the vertical axis of the texture). a zero or close-to-zero value (<1e-3) means no animation.
  - getMTextureAnimationSpeed
```
public float getMTextureAnimationSpeed()
```
    The texture animation speed in meters/second (along the vertical axis of the texture). a zero or close-to-zero value (<1e-3) means no animation.
  - setMLineType
```
public void setMLineType(VgLineType value)
```
    The type of line that will be rendered.
  - getMLineType
```
public VgLineType getMLineType()
```
    The type of line that will be rendered.
  - setMAltitudeMode
```
public void setMAltitudeMode(VgAltitudeMode value)
```
    The altitude mode tells how to interpret the 'mHeight' members for all the mPositions elements. Default is eAbsolute.
  - getMAltitudeMode
```
public VgAltitudeMode getMAltitudeMode()
```
    The altitude mode tells how to interpret the 'mHeight' members for all the mPositions elements. Default is eAbsolute.
  - setMMaxCornerRadius
```
public void setMMaxCornerRadius(double value)
```
    This member sets the maximal curvature radius used in corners when smoothing the line. expressed in meters.
  - getMMaxCornerRadius
```
public double getMMaxCornerRadius()
```
    This member sets the maximal curvature radius used in corners when smoothing the line. expressed in meters.
  - setMHaveCaps
```
public void setMHaveCaps(boolean value)
```
    Tells whether the line should have round caps at start and end.
  - getMHaveCaps
```
public boolean getMHaveCaps()
```
    Tells whether the line should have round caps at start and end.
  - clone
```
public VgLineDescriptorRefPtr clone()
```
    Overrides:
    
    clone in class java.lang.Object

Class VgLineDescriptor

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

setMPositions

getMPositions

setMColors

getMColors

setMWidths

getMWidths

setMTexture

getMTexture

setMTextureSize

getMTextureSize

setMTextureAnimationSpeed

getMTextureAnimationSpeed

setMLineType

getMLineType

setMAltitudeMode

getMAltitudeMode

setMMaxCornerRadius

getMMaxCornerRadius

setMHaveCaps

getMHaveCaps

clone