mil.navy.nps.dis
Class EntityCoordinate

java.lang.Object
  mil.navy.nps.dis.PduElement
      mil.navy.nps.dis.EntityCoordinate

All Implemented Interfaces:

java.lang.Cloneable, SerializationInterface

public class EntityCoordinate

extends PduElement

Entity coordinate system.

Version:

1.0

Author:

Don McGregor (http://www.npsnet.org/~mcgredo)

Location:

Web: http://www.web3d.org/WorkingGroups/vrtp/mil/navy/nps/dis/EntityCoordinate.java

or locally: ~/mil/navy/nps/dis/EntityCoordinate.java

Hierarchy Diagram:

Summary:

Location with respect to a particular entity shall be specified with respect to three orthogonal axes whose origin shall be the center of the bounding volume of the entity excluding its articulated and attached parts.

Explanation:

The EntityCoordinate class describes a position in 32-bit x,y,z coordinates relative to the entity's own coordinate system. The other major position class is "WorldCoordinate", which describes the position in 64-bit x, y, z "world" coords.

Note:

This is not really a record on its own for DIS, but simply a vector.

History:

16Dec96 /Don McGregor /New

10Mar97 /Don McGregor /Cleaned up for javadoc

16Apr97 /Don McGregor /PrintStream passed to printValues

12Aug97 /Don McGregor /elaborated printValues

8Dec97 /Ronan Fauglas /changes for documentation templates + complements in documentation

11Dec97 /Ronan Fauglas /changes access methods names from "variable()" to "getVariable()"

17Dec97 /Ronan Fauglas /bug fixes: changed sizeOf from 24 to 12

References:

DIS Data Dictionary: Entity Coordinate Vector Record

DIS specification : IEEE 1278.1, 5.3.33.1

See Also:

PduElement, SerializationInterface, LinearAcceleration, LinearVelocity, WorldCoordinate

Field Summary

int	sizeOf Constant value--size of a Entity Position Record; here :sizeOf = 12 bytes.
protected float	x First coordinate of the entity, along X axis
protected float	y Second coordinate of the entity, along Y axis
protected float	z Third coordinate of the entity, along Z axis

Constructor Summary

EntityCoordinate()
Constructs an new EntityCoordinate Object; the entity is at the origin.

EntityCoordinate(float pX, float pY, float pZ)

Method Summary

java.lang.Object	clone() Makes deep copies of all the instance variables, so we don't have two objects pointing to the same data.
void	deSerialize(java.io.DataInputStream pInputStream) Deserialize our data from the input stream.
float	getX()
float	getY()
float	getZ()
int	length() Returns the length of the object when serialized in a stream.
void	printValues(int indentLevel, java.io.PrintStream printStream) Prints the generated serialized object for debugging.
void	serialize(java.io.DataOutputStream outputStream) Serialize our data out to the stream.
void	setX(float pX)
void	setY(float pY)
void	setZ(float pZ)

Methods inherited from class java.lang.Object

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

Field Detail

x

protected float x

First coordinate of the entity, along X axis

y

protected float y

Second coordinate of the entity, along Y axis

z

protected float z

Third coordinate of the entity, along Z axis

sizeOf

public final int sizeOf

Constant value--size of a Entity Position Record; here :sizeOf = 12 bytes.

See Also:

Constant Field Values

Constructor Detail

EntityCoordinate

public EntityCoordinate()

Constructs an new EntityCoordinate Object; the entity is at the origin.

EntityCoordinate

public EntityCoordinate(float pX,
                        float pY,
                        float pZ)

Method Detail

clone

public java.lang.Object clone()

Description copied from class: PduElement

Makes deep copies of all the instance variables, so we don't have two objects pointing to the same data. The accessor methods make copies of the objects, rather than returning the objects themselves. The runtime provides the right object type with the call to super.clone(), and we cast it to our type. Subclasses should do the same thing, and all these ivars will be taken care of automatically.

Overrides:

clone in class PduElement

Returns:

a clone of this instance

See Also:

Object

serialize

public void serialize(java.io.DataOutputStream outputStream)

Description copied from class: PduElement

Serialize our data out to the stream. Subclasses of us should call super.Serialize() to make sure the superclasse's data is serialized out. The order in which instance variables are serialized is significant. They must be serialized in the same order they appear in the DIS spec. Prints out some information during execution if debugging flag is set.

Specified by:

serialize in interface SerializationInterface

Specified by:

serialize in class PduElement

Parameters:

outputStream - the stream to which this object is serialized

deSerialize

public void deSerialize(java.io.DataInputStream pInputStream)

Description copied from class: PduElement

Deserialize our data from the input stream. Subclasses of us should call super.deSerialize to make sure the superclass's data are properly affected. The order in which instance variables are serialized is significant. They must be deSerialized in the same order as they have been serialized as specified by the DIS spec.

Specified by:

deSerialize in interface SerializationInterface

Specified by:

deSerialize in class PduElement

Parameters:

pInputStream - the stream from which this object is initialized

length

public int length()

Description copied from class: PduElement

Returns the length of the object when serialized in a stream.

Specified by:

length in class PduElement

Returns:

the length of the object when serialized in a stream

printValues

public void printValues(int indentLevel,
                        java.io.PrintStream printStream)

Description copied from class: PduElement

Prints the generated serialized object for debugging.

Specified by:

printValues in class PduElement

Parameters:

indentLevel - number of spaces to indent for visibility

getX

public float getX()

setX

public void setX(float pX)

getY

public float getY()

setY

public void setY(float pY)

getZ

public float getZ()

setZ

public void setZ(float pZ)