org.jouvieje.fmoddesigner.structures
Class FMOD_MUSIC_ITERATOR

java.lang.Object
  org.jouvieje.fmodex.utils.Pointer
      org.jouvieje.fmoddesigner.structures.FMOD_MUSIC_ITERATOR

public class FMOD_MUSIC_ITERATOR

extends Pointer

Constructor Summary

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

Method Summary

static FMOD_MUSIC_ITERATOR	allocate() Allocate a new FMOD_MUSIC_ITERATOR.
static FMOD_MUSIC_ITERATOR	asFMOD_MUSIC_ITERATOR(Pointer pointer) Create a view of the Pointer object as a FMOD_MUSIC_ITERATOR object.
java.lang.String	getFilter() The string used to filter music entities.
FMOD_MUSIC_ENTITY	getValue() The music entity the iterator points to.
void	release()
void	setFilter(java.lang.String filter) The string used to filter music entities.
void	setValue(FMOD_MUSIC_ENTITY value) The music entity the iterator points to.

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_MUSIC_ITERATOR

public FMOD_MUSIC_ITERATOR()

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

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

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

  FMOD_MUSIC_ITERATOR obj = FMOD_MUSIC_ITERATOR.allocate();

See Also:

allocate()

Method Detail

asFMOD_MUSIC_ITERATOR

public static FMOD_MUSIC_ITERATOR asFMOD_MUSIC_ITERATOR(Pointer pointer)

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

allocate

public static FMOD_MUSIC_ITERATOR allocate()

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

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

release

public void release()

getValue

public FMOD_MUSIC_ENTITY getValue()

The music entity the iterator points to. A null value indicates an invalid iterator.

setValue

public void setValue(FMOD_MUSIC_ENTITY value)

The music entity the iterator points to. A null value indicates an invalid iterator.

getFilter

public java.lang.String getFilter()

The string used to filter music entities.

setFilter

public void setFilter(java.lang.String filter)

The string used to filter music entities.