hmi.animation
Interface VObject

All Known Implementing Classes:

OdePhysicalSegment, OdeRigidBody, PhysicalSegment, RigidBody, VJoint

public interface VObject

VObjects represent "virtual objects", used within virtual environments. VObjects can have an id, an sid, and a name. An id is meant to uniquely identify some VObject. An sid (scoped id) is assumed to be unique only amongst children of the same parent VObject. A name is a "friendly" name, not required to be unique.

Nested Class Summary

static interface

VObject.Predicate VObject.Predicates are Objects that implement a boolean test on VObjects, in the form of their "valid" method.

Method Summary

void	getAngularVelocity(float[] wa) Returns the angular velocity vector in the form of a float array of length three.
void	getAngularVelocity(float[] wa, int offset) Like getAngularVelocity(wa), but starting at the specified offset.
String	getId() Returns an interned String that specifies the id.
String	getName() Returns an interned String that specifies the name.
void	getRotation(float[] ra) Returns the rotation quaternion in a float array of length four.
void	getRotation(float[] ra, int offset) Like getRotation(ra), but starting at the specified offset.
void	getScale(float[] sa) Returns the scale vector in a float array of length three.
void	getScale(float[] sa, int offset) Like getScale(sa), but starting at the specified offset.
String	getSid() Returns an interned String that specifies the sid.
void	getTranslation(float[] ta) Returns the translation vector in the form of a float array of length three
void	getTranslation(float[] ta, int offset) Like getTranslation(ta), but starting at the specified offset
void	getVelocity(float[] va) Returns the velocity vector in the form of a float array of length three.
void	getVelocity(float[] va, int offset) Like getVelocity(va), but starting at the specified offset.
void	setAngularVelocity(float[] wa) Sets the angular velocity vector from a float array of length three.
void	setAngularVelocity(float[] wa, int offset) Like setAngularVelocity(wa), but starting at the specified offset.
void	setAngularVelocity(float wx, float wy, float wz) Sets the angular velocity vector from three floats.
void	setAxisAngle(float ax, float ay, float az, float angle) Sets the rotation quaternion derived from a rotation axis (ax, ay, az) and a rotation angle angle, specified in radians.
void	setId(String id) Sets the id for this VObject.
void	setName(String name) Sets the name for this VObject.
void	setRotation(float[] ra) Sets the rotation quaternion from a float array of length four.
void	setRotation(float[] ra, int offset) Like setRotation(ra), but starting at the specified offset.
void	setRotation(float qs, float qx, float qy, float qz) Sets the rotation quaternion from four floats.
void	setScale(float[] sa) Sets the scale vector from a float array of lebgth three.
void	setScale(float[] sa, int saIndex) Like setScale(sa), but starting at the specified offset
void	setSid(String sid) Sets the sid for this VObject.
void	setTranslation(float[] ta) Sets the translation vector from a float array of length three.
void	setTranslation(float[] ta, int offset) Like setTranslation(ta), but starting at the specified offset.
void	setTranslation(float tx, float ty, float tz) Sets the current translation vector from three floats.
void	setVelocity(float[] va) Sets the velocity vector from a float array of length three.
void	setVelocity(float[] va, int offset) Like setVelocity(va), but starting at the specified offset.
void	setVelocity(float vx, float vy, float vz) Sets the velocity vector from three floats.

Method Detail

setId

void setId(String id)

Sets the id for this VObject.

setSid

void setSid(String sid)

Sets the sid for this VObject.

setName

void setName(String name)

Sets the name for this VObject.

getId

String getId()

Returns an interned String that specifies the id.

getSid

String getSid()

Returns an interned String that specifies the sid.

getName

String getName()

Returns an interned String that specifies the name.

getTranslation

void getTranslation(float[] ta)

Returns the translation vector in the form of a float array of length three

getTranslation

void getTranslation(float[] ta,
                    int offset)

Like getTranslation(ta), but starting at the specified offset

setTranslation

void setTranslation(float[] ta)

Sets the translation vector from a float array of length three.

setTranslation

void setTranslation(float[] ta,
                    int offset)

Like setTranslation(ta), but starting at the specified offset.

setTranslation

void setTranslation(float tx,
                    float ty,
                    float tz)

Sets the current translation vector from three floats.

setRotation

void setRotation(float[] ra)

Sets the rotation quaternion from a float array of length four. The order is (s, x, y, z), where s is the real part, x, y, z are the imaginary parts.

setRotation

void setRotation(float[] ra,
                 int offset)

Like setRotation(ra), but starting at the specified offset.

getRotation

void getRotation(float[] ra)

Returns the rotation quaternion in a float array of length four. The order is (s, x, y, z), where s is the scalar part, x, y, z are the imaginary parts.

getRotation

void getRotation(float[] ra,
                 int offset)

Like getRotation(ra), but starting at the specified offset.

setRotation

void setRotation(float qs,
                 float qx,
                 float qy,
                 float qz)

Sets the rotation quaternion from four floats. qs is the real part, qx, qy, qz the imaginary parts.

setAxisAngle

void setAxisAngle(float ax,
                  float ay,
                  float az,
                  float angle)

Sets the rotation quaternion derived from a rotation axis (ax, ay, az) and a rotation angle angle, specified in radians. The axis need not have length one. If all parameters are zero, the rotation is set to the identity quaternion (1,0,0,0).

setScale

void setScale(float[] sa)

Sets the scale vector from a float array of lebgth three.

setScale

void setScale(float[] sa,
              int saIndex)

Like setScale(sa), but starting at the specified offset

getScale

void getScale(float[] sa)

Returns the scale vector in a float array of length three.

getScale

void getScale(float[] sa,
              int offset)

Like getScale(sa), but starting at the specified offset.

getVelocity

void getVelocity(float[] va)

Returns the velocity vector in the form of a float array of length three.

getVelocity

void getVelocity(float[] va,
                 int offset)

Like getVelocity(va), but starting at the specified offset.

setVelocity

void setVelocity(float[] va)

Sets the velocity vector from a float array of length three.

setVelocity

void setVelocity(float[] va,
                 int offset)

Like setVelocity(va), but starting at the specified offset.

setVelocity

void setVelocity(float vx,
                 float vy,
                 float vz)

Sets the velocity vector from three floats.

getAngularVelocity

void getAngularVelocity(float[] wa)

Returns the angular velocity vector in the form of a float array of length three.

getAngularVelocity

void getAngularVelocity(float[] wa,
                        int offset)

Like getAngularVelocity(wa), but starting at the specified offset.

setAngularVelocity

void setAngularVelocity(float[] wa)

Sets the angular velocity vector from a float array of length three.

setAngularVelocity

void setAngularVelocity(float[] wa,
                        int offset)

Like setAngularVelocity(wa), but starting at the specified offset.

setAngularVelocity

void setAngularVelocity(float wx,
                        float wy,
                        float wz)

Sets the angular velocity vector from three floats.