com.visioglobe.libVisioDevKit
Class VgTextMarkerDescriptor

java.lang.Object
  com.visioglobe.libVisioDevKit.VgReferenced
      com.visioglobe.libVisioDevKit.VgMarkerDescriptor
          com.visioglobe.libVisioDevKit.VgTextMarkerDescriptor

public class VgTextMarkerDescriptor
extends VgMarkerDescriptor

Describes a text marker. The text will be displayed at the point associated.

Field Summary

Fields inherited from class com.visioglobe.libVisioDevKit.VgReferenced

swigCMemOwn, swigRefPtr

Constructor Summary

VgTextMarkerDescriptor(long cPtr, boolean cMemoryOwn)
Constructor

Method Summary

static VgTextMarkerDescriptorRefPtr	create() This static method returns a new heap-allocated descriptor.
void	delete()
static long	getCPtr(VgTextMarkerDescriptor obj)
VgColor	getMColor() The text's color.
double	getMScale() Controls the size of the POI in meters, by default 70.0.
java.lang.String	getMText() The POI's label.
long	getMTextAttributesMask() Text attributes.
VgMarkerType	getType()
void	setMColor(VgColor value) The text's color.
void	setMScale(double value) Controls the size of the POI in meters, by default 70.0.
void	setMText(java.lang.String value) The POI's label.
void	setMTextAttributesMask(long value) Text attributes.

Methods inherited from class com.visioglobe.libVisioDevKit.VgMarkerDescriptor

finalize, getCPtr

Methods inherited from class com.visioglobe.libVisioDevKit.VgReferenced

getCPtr, getNbReferences, ref, unref

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VgTextMarkerDescriptor

public VgTextMarkerDescriptor(long cPtr,
                              boolean cMemoryOwn)

Constructor

Method Detail

getCPtr

public static long getCPtr(VgTextMarkerDescriptor obj)

delete

public void delete()

Overrides:

delete in class VgMarkerDescriptor

create

public static VgTextMarkerDescriptorRefPtr 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.

setMText

public void setMText(java.lang.String value)

The POI's label. If an icon is defined, the icon will be placed on the left side of the label, with horizontal centers aligned By default this property is an empty string.

getMText

public java.lang.String getMText()

The POI's label. If an icon is defined, the icon will be placed on the left side of the label, with horizontal centers aligned By default this property is an empty string.

setMTextAttributesMask

public void setMTextAttributesMask(long value)

Text attributes. You specify the value of this mask by combining the constants described in VgEngine::VgTextAttributes using the C bitwise OR operator. Combining these constants lets you specify which attributes should be associated with the text. The default value of this property is eTextAttributeNone.

getMTextAttributesMask

public long getMTextAttributesMask()

Text attributes. You specify the value of this mask by combining the constants described in VgEngine::VgTextAttributes using the C bitwise OR operator. Combining these constants lets you specify which attributes should be associated with the text. The default value of this property is eTextAttributeNone.

setMColor

public void setMColor(VgColor value)

The text's color.

getMColor

public VgColor getMColor()

The text's color.

setMScale

public void setMScale(double value)

Controls the size of the POI in meters, by default 70.0. The visible size can also be determined by the distance of the POI from the camera, see the property mGeometryConstantSizeDistance.

getMScale

public double getMScale()

Controls the size of the POI in meters, by default 70.0. The visible size can also be determined by the distance of the POI from the camera, see the property mGeometryConstantSizeDistance.

getType

public VgMarkerType getType()

Overrides:

getType in class VgMarkerDescriptor

Returns:

the type of marker