VgLinkDescriptor (VisioDevKit)

java.lang.Object
- com.visioglobe.libVisioDevKit.VgReferenced
- - com.visioglobe.libVisioDevKit.VgLinkDescriptor

```
public class VgLinkDescriptor
extends VgReferenced
```
A structure which describes the attributes of a Vg3DModule::VgLink.

Constructor Summary

Constructors
Constructor and Description
`VgLinkDescriptor()`
`VgLinkDescriptor(VgLinkDescriptor pOther)`
`VgLinkDescriptor(VgPosition pSourcePosition, VgColor pSourceColor, VgPosition pTargetPosition, VgColor pTargetColor, VgITextureRefPtr pTexture, float pWidth, float pTextureRatio, float pAnimationSpeed)`

Method Summary

Methods
Modifier and Type	Method and Description
`static VgLinkDescriptorRefPtr`	`create()` This static method returns a new heap-allocated descriptor.
`void`	`delete()`
`float`	`getMAnimationSpeed()` Texture's animation speed.
`VgColor`	`getMSourceColor()` The source point's color, The link's color will be interpolated linearly from source color.
`VgPosition`	`getMSourcePosition()` The source position.
`VgColor`	`getMTargetColor()` The end's color.
`VgPosition`	`getMTargetPosition()` The 'end' position.
`VgITextureRefPtr`	`getMTexture()` The optional texture to apply to the link's geometry.
`float`	`getMTextureRatio()` Texture's width/height ratio.
`float`	`getMWidth()` Width of the link
`void`	`setMAnimationSpeed(float value)` Texture's animation speed.
`void`	`setMSourceColor(VgColor value)` The source point's color, The link's color will be interpolated linearly from source color.
`void`	`setMSourcePosition(VgPosition value)` The source position.
`void`	`setMTargetColor(VgColor value)` The end's color.
`void`	`setMTargetPosition(VgPosition value)` The 'end' position.
`void`	`setMTexture(VgITextureRefPtr value)` The optional texture to apply to the link's geometry.
`void`	`setMTextureRatio(float value)` Texture's width/height ratio.
`void`	`setMWidth(float value)` Width of the link

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

- Constructor Detail
  - VgLinkDescriptor
```
public VgLinkDescriptor()
```
  - VgLinkDescriptor
```
public VgLinkDescriptor(VgPosition pSourcePosition,
                VgColor pSourceColor,
                VgPosition pTargetPosition,
                VgColor pTargetColor,
                VgITextureRefPtr pTexture,
                float pWidth,
                float pTextureRatio,
                float pAnimationSpeed)
```
  - VgLinkDescriptor
```
public VgLinkDescriptor(VgLinkDescriptor pOther)
```
- Method Detail
  - delete
```
public void delete()
```
    Overrides:
    
    delete in class VgReferenced
  - create
```
public static VgLinkDescriptorRefPtr 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.
  - setMSourcePosition
```
public void setMSourcePosition(VgPosition value)
```
    The source position.
    
    Note:
    
    This position will be constantly converted to scene coordinates. This will result in having the start end of the link to "follow" the provided SRS as it is updated. This also means that positions provided in the scene's SRS or the WGS84 SRS will always appear at the same scene position
  - getMSourcePosition
```
public VgPosition getMSourcePosition()
```
    The source position.
    
    Note:
    
    This position will be constantly converted to scene coordinates. This will result in having the start end of the link to "follow" the provided SRS as it is updated. This also means that positions provided in the scene's SRS or the WGS84 SRS will always appear at the same scene position
  - setMSourceColor
```
public void setMSourceColor(VgColor value)
```
    The source point's color, The link's color will be interpolated linearly from source color.
  - getMSourceColor
```
public VgColor getMSourceColor()
```
    The source point's color, The link's color will be interpolated linearly from source color.
  - setMTargetPosition
```
public void setMTargetPosition(VgPosition value)
```
    The 'end' position. Same note applies as for Vg3DModule::VgLinkDescriptor::mSourcePosition.
  - getMTargetPosition
```
public VgPosition getMTargetPosition()
```
    The 'end' position. Same note applies as for Vg3DModule::VgLinkDescriptor::mSourcePosition.
  - setMTargetColor
```
public void setMTargetColor(VgColor value)
```
    The end's color.
  - getMTargetColor
```
public VgColor getMTargetColor()
```
    The end's color.
  - setMTexture
```
public void setMTexture(VgITextureRefPtr value)
```
    The optional texture to apply to the link's geometry.
  - getMTexture
```
public VgITextureRefPtr getMTexture()
```
    The optional texture to apply to the link's geometry.
  - setMWidth
```
public void setMWidth(float value)
```
    Width of the link
  - getMWidth
```
public float getMWidth()
```
    Width of the link
  - setMTextureRatio
```
public void setMTextureRatio(float value)
```
    Texture's width/height ratio.
  - getMTextureRatio
```
public float getMTextureRatio()
```
    Texture's width/height ratio.
  - setMAnimationSpeed
```
public void setMAnimationSpeed(float value)
```
    Texture's animation speed.
  - getMAnimationSpeed
```
public float getMAnimationSpeed()
```
    Texture's animation speed.

Class VgLinkDescriptor

Constructor Summary

Method Summary

Methods inherited from class com.visioglobe.libVisioDevKit.VgReferenced

Methods inherited from class java.lang.Object

Constructor Detail

VgLinkDescriptor

VgLinkDescriptor

VgLinkDescriptor

Method Detail

delete

create

setMSourcePosition

getMSourcePosition

setMSourceColor

getMSourceColor

setMTargetPosition

getMTargetPosition

setMTargetColor

getMTargetColor

setMTexture

getMTexture

setMWidth

getMWidth

setMTextureRatio

getMTextureRatio

setMAnimationSpeed

getMAnimationSpeed