atavism.server.objects

Class Marker

java.lang.Object

atavism.server.objects.Marker

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Marker
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

A marker is a point in space with orientation and properties. Markers are placed using the WorldEditor tool.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectType	OBJECT_TYPE Marker object type.
static long	PROP_ALL Get all marker information (search selection flag).
static long	PROP_ORIENTATION Get the marker orientation (search selection flag).
static long	PROP_POINT Get the marker location (search selection flag).
static long	PROP_PROPERTIES Get the marker properties (search selection flag).

Constructor Summary

Constructors

Constructor and Description
Marker()
Marker(Point point)
Marker(Point point, Quaternion orient) Create a marker.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Copy this marker.
Quaternion	getOrientation() Get marker orientation.
Point	getPoint() Get marker location.
java.io.Serializable	getProperty(java.lang.String key) Get property value.
java.util.Map<java.lang.String,java.io.Serializable>	getPropertyMapRef() Get the property map.
void	setOrientation(Quaternion orient) Set marker orientation.
void	setPoint(Point point) Set marker location.
void	setProperties(java.util.Map<java.lang.String,java.io.Serializable> props) Set the marker property map.
java.io.Serializable	setProperty(java.lang.String key, java.io.Serializable value) Set property value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PROP_POINT

public static final long PROP_POINT

Get the marker location (search selection flag).

See Also:

Constant Field Values

PROP_ORIENTATION

public static final long PROP_ORIENTATION

Get the marker orientation (search selection flag).

See Also:

Constant Field Values

PROP_PROPERTIES

public static final long PROP_PROPERTIES

Get the marker properties (search selection flag).

See Also:

Constant Field Values

PROP_ALL

public static final long PROP_ALL

Get all marker information (search selection flag).

See Also:

Constant Field Values

OBJECT_TYPE

public static final ObjectType OBJECT_TYPE

Marker object type.

Constructor Detail

Marker

public Marker()

Marker

public Marker(Point point)

Marker

public Marker(Point point,
              Quaternion orient)

Create a marker.

Parameters:

point - Marker location.

orient - Marker orientation.

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Copy this marker.

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPoint

public Point getPoint()

Get marker location.

setPoint

public void setPoint(Point point)

Set marker location.

getOrientation

public Quaternion getOrientation()

Get marker orientation.

setOrientation

public void setOrientation(Quaternion orient)

Set marker orientation.

getProperty

public java.io.Serializable getProperty(java.lang.String key)

Get property value.

Parameters:

key - Property name

Returns:

Property value, null if property does not exist.

See Also:

setProperty(String, Serializable)

setProperty

public java.io.Serializable setProperty(java.lang.String key,
                                        java.io.Serializable value)

Set property value.

Parameters:

key - Property name.

value - Property value.

Returns:

Previous property value, or null if did not exist.

getPropertyMapRef

public java.util.Map<java.lang.String,java.io.Serializable> getPropertyMapRef()

Get the property map. Changes to the return value directly affect the marker's properties.

setProperties

public void setProperties(java.util.Map<java.lang.String,java.io.Serializable> props)

Set the marker property map. The map is copied.