com.visioglobe.libVisioDevKit

Class VgIconMarkerDescriptor

java.lang.Object

com.visioglobe.libVisioDevKit.VgReferenced

com.visioglobe.libVisioDevKit.VgMarkerDescriptor

com.visioglobe.libVisioDevKit.VgIconMarkerDescriptor

public class VgIconMarkerDescriptor
extends VgMarkerDescriptor

Describes an icon marker. The icon will be displayed at the point associated. This descriptor will instanciate a VgIconMarker after the call to VgEngine::VgInstanceFactory::instantiate(VgPointDescriptor const&) n* mVgApplication;

Method Summary

Methods

Modifier and Type	Method and Description
static VgIconMarkerDescriptorRefPtr	create() This static method returns a new heap-allocated descriptor.
void	delete()
VgITextureRefPtr	getMIcon() The icon's texture.
float	getMScale() Scales the icon (which sides always mesure 1x1 meter), by default 70.0.
VgMarkerType	getType()
void	setMIcon(VgITextureRefPtr value) The icon's texture.
void	setMScale(float value) Scales the icon (which sides always mesure 1x1 meter), by default 70.0.

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 VgMarkerDescriptor

create

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

setMIcon

public void setMIcon(VgITextureRefPtr value)

The icon's texture.

Note:

When added to the screen, the icon's pixel size is independant from its distance to the camera.

getMIcon

public VgITextureRefPtr getMIcon()

The icon's texture.

Note:

When added to the screen, the icon's pixel size is independant from its distance to the camera.

setMScale

public void setMScale(float value)

Scales the icon (which sides always mesure 1x1 meter), by default 70.0. The visible size can also be determined by the distance of the VgPoint from the camera, see the property VgPointDescriptor::mGeometryConstantSizeDistance for further explanation.

getMScale

public float getMScale()

Scales the icon (which sides always mesure 1x1 meter), by default 70.0. The visible size can also be determined by the distance of the VgPoint from the camera, see the property VgPointDescriptor::mGeometryConstantSizeDistance for further explanation.

getType

public VgMarkerType getType()

Overrides:

getType in class VgMarkerDescriptor

Returns:

the type of marker