com.luciad.view.lightspeed.layer

LuciadLightspeedClass TLspPaintRepresentation

java.lang.Object

com.luciad.view.lightspeed.layer.TLspPaintRepresentation

public final class TLspPaintRepresentation
extends Object

Identifies a single visual representation of an object. The two commonly used representations are the geometries of objects (BODY) and textual representations (LABEL).

Note that paint representations have a sort order property, which is used by TLspPaintingOrder to determine the order in which representations are painted in a view. This property can be used to insert custom new representations at the desired position in the paint cycle, without having to implement a new ILspPaintingOrder.

Since:

2012.0

See Also:

ILspLayer.getPaintRepresentations()

Field Summary

Fields

Modifier and Type	Field and Description
static TLspPaintRepresentation	BODY Identifies all paint representations (regular, selected, edited) for the regular body or graphical representation of an object.
static TLspPaintRepresentation	HANDLE Identifies paint representations for the handles of an object that is being edited.
static TLspPaintRepresentation	LABEL Identifies all paint representations (regular, selected, edited) for the regular label or textual representation of an object.

Method Summary

Modifier and Type	Method and Description
static TLspPaintRepresentation	getInstance(String aName, int aSortOrder) Returns the paint representation with the specified name and sort order.
String	getName()
int	getSortOrder()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

BODY

public static final TLspPaintRepresentation BODY

Identifies all paint representations (regular, selected, edited) for the regular body or graphical representation of an object. The default sort order is 100.

LABEL

public static final TLspPaintRepresentation LABEL

Identifies all paint representations (regular, selected, edited) for the regular label or textual representation of an object. The default sort order is 200.

HANDLE

public static final TLspPaintRepresentation HANDLE

Identifies paint representations for the handles of an object that is being edited. The default sort order is 300.

Method Detail

getInstance

public static TLspPaintRepresentation getInstance(String aName,
                                                  int aSortOrder)

Returns the paint representation with the specified name and sort order.

Parameters:

aName - the name of the paint representation

aSortOrder - the sort order that can be used by ILspPaintingOrder

Returns:

the paint representation

getName

public String getName()

Returns:

the unique name of this paint representation

getSortOrder

public int getSortOrder()

Returns:

the sort order of this paint representation

toString

public String toString()

Overrides:

toString in class Object