org.jouvieje.fmodex.structures
Class FMOD_VECTOR

java.lang.Object
  org.jouvieje.fmodex.utils.Pointer
      org.jouvieje.fmodex.structures.FMOD_VECTOR

public class FMOD_VECTOR

extends Pointer

Constructor Summary

FMOD_VECTOR()
Create an object that holds a null FMOD_VECTOR.

Method Summary

static FMOD_VECTOR	allocate() Allocate a new FMOD_VECTOR.
static FMOD_VECTOR	allocate(float x, float y, float z) Create a new FMOD_VECTOR.
static FMOD_VECTOR[]	allocate(int length) Allocate and initialize a new FMOD_VECTOR[].
static FMOD_VECTOR	asFMOD_VECTOR(Pointer pointer) Create a view of the Pointer object as a FMOD_VECTOR object.
float	getX() X co-ordinate in 3D space.
float	getY() Y co-ordinate in 3D space.
float	getZ() Z co-ordinate in 3D space.
void	release()
void	set(float x, float y, float z) X, Y & Z co-ordinate in 3D space.
void	set(FMOD_VECTOR vector) X, Y & Z co-ordinate in 3D space.
void	setX(float x) X co-ordinate in 3D space.
void	setY(float y) Y co-ordinate in 3D space.
void	setZ(float z) Z co-ordinate in 3D space.

Methods inherited from class org.jouvieje.fmodex.utils.Pointer

asByteBuffer, asDouble, asFloat, asInt, asLong, asPointer, asString, asString, equals, isNull, shareMemory

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FMOD_VECTOR

public FMOD_VECTOR()

Create an object that holds a null FMOD_VECTOR.
The call isNull() on the object created will returns true.

  FMOD_VECTOR obj = new FMOD_VECTOR();
  (obj == null) <=> false
  obj.isNull() <=> true
 

To creates a new FMOD_VECTOR, use the static "constructor" :

  FMOD_VECTOR obj = FMOD_VECTOR.allocate();

See Also:

allocate()

Method Detail

allocate

public static FMOD_VECTOR allocate(float x,
                                   float y,
                                   float z)

Create a new FMOD_VECTOR.
The call isNull() on the object created will return false.

  FMOD_VECTOR obj = FMOD_VECTOR.allocate();
  (obj == null) <=> obj.isNull() <=> false
 

Parameters:

x - X co-ordinate in 3D space.

y - Y co-ordinate in 3D space.

z - Z co-ordinate in 3D space.

asFMOD_VECTOR

public static FMOD_VECTOR asFMOD_VECTOR(Pointer pointer)

Create a view of the Pointer object as a FMOD_VECTOR object.
This view is valid only if the memory holded by the Pointer holds a FMOD_VECTOR object.

allocate

public static FMOD_VECTOR[] allocate(int length)

Allocate and initialize a new FMOD_VECTOR[].

Parameters:

length - length of the array returned.

allocate

public static FMOD_VECTOR allocate()

Allocate a new FMOD_VECTOR.
The call isNull() on the object created will return false.

  FMOD_VECTOR obj = FMOD_VECTOR.allocate();
  (obj == null) <=> obj.isNull() <=> false
 

release

public void release()

getX

public float getX()

X co-ordinate in 3D space.

setX

public void setX(float x)

X co-ordinate in 3D space.

getY

public float getY()

Y co-ordinate in 3D space.

setY

public void setY(float y)

Y co-ordinate in 3D space.

getZ

public float getZ()

Z co-ordinate in 3D space.

setZ

public void setZ(float z)

Z co-ordinate in 3D space.

set

public void set(FMOD_VECTOR vector)

X, Y & Z co-ordinate in 3D space.

set

public void set(float x,
                float y,
                float z)

X, Y & Z co-ordinate in 3D space.