VgLineDescriptor (VisioDevKit)

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.visioglobe.libVisioDevKit
Class VgLineDescriptor

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

public class VgLineDescriptor
extends VgReferenced
extends VgReferenced

A structure which describes the attributes of a Vg3DModule::VgLine. 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
`VgLineDescriptor(long cPtr, boolean cMemoryOwn)` Creates a new descriptor by copyiong another one.

Method Summary
`VgLineDescriptorRefPtr`	`clone()`
`static VgLineDescriptorRefPtr`	`create()` This static method returns a new heap-allocated descriptor.
`void`	`delete()`
`static long`	`getCPtr(VgLineDescriptor obj)`
`VgAltitudeMode`	`getMAltitudeMode()` The altitude mode tells how to interpret the 'mHeight' members for all the mPositions elements.
`VgColorVector`	`getMColors()` The line colors.
`boolean`	`getMDrawOnTop()` Tells whether the line should draw on top (ignoring z-buffer).
`boolean`	`getMHaveCaps()` Tells whether the line should have round caps at start and end.
`boolean`	`getMHaveVertexColor()` Tells whether the line should use vertex colors (mandatory to modulate the texture's color).
`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.
`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).
`double`	`getMVisibilityRampFullyInvisible()` The altitude mode tells how to interpret the 'mHeight' members for all the mPositions elements.
`double`	`getMVisibilityRampFullyVisible()` The altitude mode tells how to interpret the 'mHeight' members for all the mPositions elements.
`double`	`getMVisibilityRampStartInvisible()` The altitude mode tells how to interpret the 'mHeight' members for all the mPositions elements.
`double`	`getMVisibilityRampStartVisible()` The altitude mode tells how to interpret the 'mHeight' members for all the mPositions elements.
`VgDoubleVector`	`getMWidths()` The line widths.
`int`	`getMZIndex()` This member sets the z-index of the line.
`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`	`setMDrawOnTop(boolean value)` Tells whether the line should draw on top (ignoring z-buffer).
`void`	`setMHaveCaps(boolean value)` Tells whether the line should have round caps at start and end.
`void`	`setMHaveVertexColor(boolean value)` Tells whether the line should use vertex colors (mandatory to modulate the texture's color).
`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.
`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`	`setMVisibilityRampFullyInvisible(double value)` The altitude mode tells how to interpret the 'mHeight' members for all the mPositions elements.
`void`	`setMVisibilityRampFullyVisible(double value)` The altitude mode tells how to interpret the 'mHeight' members for all the mPositions elements.
`void`	`setMVisibilityRampStartInvisible(double value)` The altitude mode tells how to interpret the 'mHeight' members for all the mPositions elements.
`void`	`setMVisibilityRampStartVisible(double value)` The altitude mode tells how to interpret the 'mHeight' members for all the mPositions elements.
`void`	`setMWidths(VgDoubleVector value)` The line widths.
`void`	`setMZIndex(int value)` This member sets the z-index of the line.

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

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

Constructor Detail

VgLineDescriptor

public VgLineDescriptor(long cPtr,
                        boolean cMemoryOwn)

Creates a new descriptor by copyiong another one.

Method Detail

getCPtr

public static long getCPtr(VgLineDescriptor obj)

delete

public void delete()

Overrides:: delete in class VgReferenced

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.

getMColors

public VgColorVector getMColors()

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

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.