org.odejava
Interface Placeable

All Known Implementing Classes:
Body, GeomBox, GeomCapsule, GeomCone, GeomCylinder, GeomSphere, GeomTransform, GeomTriMesh, PlaceableGeom

public interface Placeable

Defines a common interface which several ode objects that deal with transforms such as Body and Geom can implement.

Author:
William Denniss

Method Summary
 boolean fixed()
          Returns true if this Placeable is dynamic and false if it is static.
 org.openmali.vecmath2.AxisAngle3f getAxisAngle()
          Returns the axis and angle of rotation which makes up the rotational component of the transform
 org.openmali.vecmath2.AxisAngle3f getAxisAngle(org.openmali.vecmath2.AxisAngle3f result)
          Returns the axis and angle of rotation which makes up the rotational component of the transform using the provided AxisAngle3f.
 String getName()
          Returns the name of the Odejava Transformable.
 org.openmali.vecmath2.Tuple3f getPosition()
          Returns the current position.
 org.openmali.vecmath2.Tuple3f getPosition(org.openmali.vecmath2.Tuple3f result)
          Returns the current position using the provided Vector3f
 org.openmali.vecmath2.Quaternion4f getQuaternion()
          Returns the quaternion.
 org.openmali.vecmath2.Quaternion4f getQuaternion(org.openmali.vecmath2.Quaternion4f result)
          Returns the quaternion using the provided Quad4f
 org.openmali.vecmath2.Matrix3f getRotation()
           
 void setAxisAndAngle(org.openmali.vecmath2.AxisAngle3f axisAngle)
          Sets the rotation using the given axis and angle.
 void setPosition(float posX, float posY, float posZ)
          Sets the position of this transformable
 void setPosition(org.openmali.vecmath2.Tuple3f position)
          Sets the position of this transformable
 void setQuaternion(org.openmali.vecmath2.Quaternion4f quaternion)
          Sets the quaternion.
 void setRotation(org.openmali.vecmath2.Matrix3f matrix)
          Sets the rotation.
 

Method Detail

setPosition

void setPosition(float posX,
                 float posY,
                 float posZ)
Sets the position of this transformable

Parameters:
posX - the x-position to set
posY - the y-position to set
posZ - the z-position to set

setPosition

void setPosition(org.openmali.vecmath2.Tuple3f position)
Sets the position of this transformable

Parameters:
position - to set

getPosition

org.openmali.vecmath2.Tuple3f getPosition()
Returns the current position.

Returns:
the current position.

getPosition

org.openmali.vecmath2.Tuple3f getPosition(org.openmali.vecmath2.Tuple3f result)
Returns the current position using the provided Vector3f

Parameters:
result - The result Vector3f
Returns:
the current position

setAxisAndAngle

void setAxisAndAngle(org.openmali.vecmath2.AxisAngle3f axisAngle)
Sets the rotation using the given axis and angle.

Parameters:
axisAngle - the axis and angle.

getAxisAngle

org.openmali.vecmath2.AxisAngle3f getAxisAngle()
Returns the axis and angle of rotation which makes up the rotational component of the transform

Returns:
the axis and angle of rotation

getAxisAngle

org.openmali.vecmath2.AxisAngle3f getAxisAngle(org.openmali.vecmath2.AxisAngle3f result)
Returns the axis and angle of rotation which makes up the rotational component of the transform using the provided AxisAngle3f.

Parameters:
result - the result AxisAngle3f
Returns:
the axis and angle of rotation

setRotation

void setRotation(org.openmali.vecmath2.Matrix3f matrix)
Sets the rotation.

Parameters:
matrix - the matrix

getRotation

org.openmali.vecmath2.Matrix3f getRotation()
Returns:
the rotation.

setQuaternion

void setQuaternion(org.openmali.vecmath2.Quaternion4f quaternion)
Sets the quaternion.

Parameters:
quaternion - the quaternion

getQuaternion

org.openmali.vecmath2.Quaternion4f getQuaternion()
Returns the quaternion.

Returns:
the quaternion.

getQuaternion

org.openmali.vecmath2.Quaternion4f getQuaternion(org.openmali.vecmath2.Quaternion4f result)
Returns the quaternion using the provided Quad4f

Parameters:
result - the result Quad4f.
Returns:
the quaternion.

getName

String getName()
Returns the name of the Odejava Transformable.

Returns:
the name of the Odejava Transformable.

fixed

boolean fixed()
Returns true if this Placeable is dynamic and false if it is static. Dynamic Placeable's have changing transform's whereas static ones are fixed.

Returns:
rue if this Placeable is dynamic and false if it is static