org.vizzini.math
Interface IState

All Superinterfaces:
Cloneable, Serializable
All Known Subinterfaces:
IDynamicState
All Known Implementing Classes:
DynamicState, State

public interface IState
extends Cloneable, Serializable

Defines methods required by a simple state of an object. The orientation and position relate object coordinates to world coordinates. Units should be consistent: length, time.

Since:
v0.2
Version:
v0.2
Author:
Jeffrey M. Thompson

Method Summary
 Object clone()
          Return a clone of this instance.
 Vector convertLocalToWorld(Vector v)
          Convert the given vector from local coordinates to world coordinates.
 Vector convertWorldToLocal(Vector v)
          Convert the given vector from world coordinates to local coordinates.
 Quaternion getOrientation()
          Return the orientation quaternion.
 Vector getPosition()
          Return the position vector.
 Vector getPreviousPosition()
          Return the previous position vector.
 void move(Vector movement)
          Move using the given vector.
 Vector orientLocalToWorld(Vector v)
          Orient the given vector from local coordinates to world coordinates.
 Vector orientWorldToLocal(Vector v)
          Orient the given vector from world coordinates to local coordinates.
 void rotate(Quaternion rotation)
          Rotate using the given quaternion.
 void setOrientation(Quaternion orientation)
          Set the orientation.
 void setPosition(Vector position)
          Set the position.
 

Method Detail

setOrientation

void setOrientation(Quaternion orientation)
Set the orientation.

Since:
v0.2

getOrientation

Quaternion getOrientation()
Return the orientation quaternion.

Since:
v0.2

setPosition

void setPosition(Vector position)
Set the position.

Since:
v0.2

getPosition

Vector getPosition()
Return the position vector.

Since:
v0.2

getPreviousPosition

Vector getPreviousPosition()
Return the previous position vector.

Since:
v0.2

clone

Object clone()
Return a clone of this instance.

Since:
v0.2

convertLocalToWorld

Vector convertLocalToWorld(Vector v)
Convert the given vector from local coordinates to world coordinates.

Parameters:
v - Vector in local coordinates.
Since:
v0.2

convertWorldToLocal

Vector convertWorldToLocal(Vector v)
Convert the given vector from world coordinates to local coordinates.

Parameters:
v - Vector in local coordinates.
Since:
v0.2

move

void move(Vector movement)
Move using the given vector.

Since:
v0.2

orientLocalToWorld

Vector orientLocalToWorld(Vector v)
Orient the given vector from local coordinates to world coordinates.

Parameters:
v - Vector in local coordinates.
Since:
v0.2

orientWorldToLocal

Vector orientWorldToLocal(Vector v)
Orient the given vector from world coordinates to local coordinates.

Parameters:
v - Vector in world coordinates.
Since:
v0.2

rotate

void rotate(Quaternion rotation)
Rotate using the given quaternion.

Since:
v0.2


Copyright 2007 Vizzini.org. All Rights Reserved. 2007.12.25.03.00.02