org.openmali.vecmath2
Class TexCoord2f

java.lang.Object
  extended by org.openmali.vecmath2.TexCoordf<TexCoord2f>
      extended by org.openmali.vecmath2.TexCoord2f
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable

public class TexCoord2f
extends TexCoordf<TexCoord2f>
implements java.io.Externalizable

A simple Texture-Coordinate implementation for 2 values.
The order is (s, t).

See Also:
Serialized Form

Field Summary
static TexCoord2f LOWER_LEFT
           
static TexCoord2f LOWER_RIGHT
           
static TexCoord2f UPPER_LEFT
           
static TexCoord2f UPPER_RIGHT
           
 
Fields inherited from class org.openmali.vecmath2.TexCoordf
isDirty, N, roTrick, values
 
Constructor Summary
  TexCoord2f()
          Creates a new TexCoord2f instance.
protected TexCoord2f(boolean readOnly)
          Creates a new TexCoord2f instance.
protected TexCoord2f(boolean readOnly, float[] values)
          Creates a new TexCoord2f instance.
protected TexCoord2f(boolean readOnly, float s, float t)
          Creates a new TexCoord2f instance.
protected TexCoord2f(boolean readOnly, TexCoordf<?> texCoord)
          Creates a new TexCoord2f instance.
  TexCoord2f(float[] values)
          Creates a new TexCoord2f instance.
  TexCoord2f(float s, float t)
          Creates a new TexCoord2f instance.
  TexCoord2f(TexCoordf<?> texCoord)
          Creates a new TexCoord2f instance.
 
Method Summary
 TexCoord2f add(float s, float t)
          Adds the given parameters to this tuple's values.
 TexCoord2f addS(float v)
          Adds v to this texCoord's S value.
 TexCoord2f addT(float v)
          Adds v to this texCoord's T value.
 TexCoord2f clone()
          Creates and returns a copy of this object.
 TexCoord2f div(float vs, float vt)
          Divides this texCoord's values by vs, vt.
 TexCoord2f divS(float v)
          Divides this texCoord's S value by v.
 TexCoord2f divT(float v)
          Divides this texCoord's T value by v.
 boolean equals(java.lang.Object o)
          Returns true if the Object t1 is of type Tuple3f and all of the data members of t1 are equal to the corresponding data members in this Tuple3f.
static TexCoord2f fromPool()
          Allocates an TexCoord2f instance from the pool.
static TexCoord2f fromPool(float s, float t)
          Allocates an TexCoord2f instance from the pool.
 float getS()
           
 float getT()
           
 TexCoord2f mul(float factor)
          Sets the value of this tuple to the scalar multiplication of itself.
 TexCoord2f mul(float vs, float vt)
          Multiplies this texCoord's values with vs, vt.
 TexCoord2f mulS(float v)
          Multiplies this texCoord's S value with v.
 TexCoord2f mulT(float v)
          Multiplies this texCoord's T value with v.
static TexCoord2f newReadOnly(float[] values)
          Creates a new TexCoord2f instance.
static TexCoord2f newReadOnly(float s, float t)
          Creates a new TexCoord2f instance.
static TexCoord2f newReadOnly(TexCoordf<?> texCoord)
          Creates a new TexCoord2f instance.
 float s()
           
 TexCoord2f s(float s)
          Sets the S (1st) texCoord component.
 TexCoord2f set(float s, float t)
          Sets all values of this texCoord to the specified ones.
 TexCoord2f setS(float s)
          Sets the S (1st) texCoord component.
 TexCoord2f setT(float t)
          Sets the T (2nd) texCoord component.
 TexCoord2f sub(float s, float t)
          Subtracts the given parameters from this tuple's values.
 TexCoord2f subS(float v)
          Subtracts v from this texCoord's S value.
 TexCoord2f subT(float v)
          Subtracts v from this texCoord's T value.
 float t()
           
 TexCoord2f t(float t)
          Sets the T (2nd) texCoord component.
static void toPool(TexCoord2f o)
          Stores the given TexCoord2f instance in the pool.
 
Methods inherited from class org.openmali.vecmath2.TexCoordf
add, add, clamp, clamp, clampMax, clampMax, clampMin, clampMin, deserialize, epsilonEquals, equals, get, get, get, getSerializationBufferSize, getSize, hashCode, interpolate, interpolate, isDirty, isReadOnly, newArray, readExternal, readFromBuffer, readFromBuffer, readFromBuffer, readFromBuffer, scaleAdd, scaleAdd, serialize, set, set, set, setClean, setZero, sub, sub, toString, writeExternal, writeToBuffer, writeToBuffer, writeToBuffer, writeToBuffer
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.io.Externalizable
readExternal, writeExternal
 

Field Detail

LOWER_LEFT

public static final TexCoord2f LOWER_LEFT

LOWER_RIGHT

public static final TexCoord2f LOWER_RIGHT

UPPER_LEFT

public static final TexCoord2f UPPER_LEFT

UPPER_RIGHT

public static final TexCoord2f UPPER_RIGHT
Constructor Detail

TexCoord2f

protected TexCoord2f(boolean readOnly,
                     float s,
                     float t)
Creates a new TexCoord2f instance.

Parameters:
readOnly -
s - the S element to use
t - the T element to use

TexCoord2f

protected TexCoord2f(boolean readOnly,
                     float[] values)
Creates a new TexCoord2f instance.

Parameters:
readOnly -
values - the values array (must be at least size 2)

TexCoord2f

protected TexCoord2f(boolean readOnly,
                     TexCoordf<?> texCoord)
Creates a new TexCoord2f instance.

Parameters:
readOnly -
texCoord - the TexCoordf to copy the values from

TexCoord2f

protected TexCoord2f(boolean readOnly)
Creates a new TexCoord2f instance.

Parameters:
readOnly -

TexCoord2f

public TexCoord2f(float s,
                  float t)
Creates a new TexCoord2f instance.

Parameters:
s - the S element to use
t - the T element to use

TexCoord2f

public TexCoord2f(float[] values)
Creates a new TexCoord2f instance.

Parameters:
values - the values array (must be at least size 2)

TexCoord2f

public TexCoord2f(TexCoordf<?> texCoord)
Creates a new TexCoord2f instance.

Parameters:
texCoord - the TexCoordf to copy the values from

TexCoord2f

public TexCoord2f()
Creates a new TexCoord2f instance.

Method Detail

set

public final TexCoord2f set(float s,
                            float t)
Sets all values of this texCoord to the specified ones.

Parameters:
s - the s element to use
t - the t element to use
Returns:
itself

setS

public final TexCoord2f setS(float s)
Sets the S (1st) texCoord component.

Parameters:
s -
Returns:
itself

getS

public final float getS()
Returns:
the S (1st) texCoord component.

s

public final TexCoord2f s(float s)
Sets the S (1st) texCoord component.

Parameters:
s -
Returns:
itself

s

public final float s()
Returns:
the S (1st) texCoord component.

setT

public final TexCoord2f setT(float t)
Sets the T (2nd) texCoord component.

Parameters:
t -
Returns:
itself

getT

public final float getT()
Returns:
the T (2nd) texCoord component.

t

public final TexCoord2f t(float t)
Sets the T (2nd) texCoord component.

Parameters:
t -
Returns:
itself

t

public final float t()
Returns:
the T (2nd) texCoord component.

addS

public final TexCoord2f addS(float v)
Adds v to this texCoord's S value.

Parameters:
v -
Returns:
itself

addT

public final TexCoord2f addT(float v)
Adds v to this texCoord's T value.

Parameters:
v -
Returns:
itself

subS

public final TexCoord2f subS(float v)
Subtracts v from this texCoord's S value.

Parameters:
v -
Returns:
itself

subT

public final TexCoord2f subT(float v)
Subtracts v from this texCoord's T value.

Parameters:
v -
Returns:
itself

mulS

public final TexCoord2f mulS(float v)
Multiplies this texCoord's S value with v.

Parameters:
v -
Returns:
itself

mulT

public final TexCoord2f mulT(float v)
Multiplies this texCoord's T value with v.

Parameters:
v -
Returns:
itself

mul

public final TexCoord2f mul(float vs,
                            float vt)
Multiplies this texCoord's values with vs, vt.

Parameters:
vs -
vt -
Returns:
itself

mul

public final TexCoord2f mul(float factor)
Sets the value of this tuple to the scalar multiplication of itself.

Parameters:
factor - the scalar value
Returns:
itself

divS

public final TexCoord2f divS(float v)
Divides this texCoord's S value by v.

Parameters:
v -
Returns:
itself

divT

public final TexCoord2f divT(float v)
Divides this texCoord's T value by v.

Parameters:
v -
Returns:
itself

div

public final TexCoord2f div(float vs,
                            float vt)
Divides this texCoord's values by vs, vt.

Parameters:
vs -
vt -
Returns:
itself

add

public final TexCoord2f add(float s,
                            float t)
Adds the given parameters to this tuple's values.

Parameters:
s -
t -
Returns:
itself

sub

public final TexCoord2f sub(float s,
                            float t)
Subtracts the given parameters from this tuple's values.

Parameters:
s -
t -
Returns:
itself

equals

public boolean equals(java.lang.Object o)
Returns true if the Object t1 is of type Tuple3f and all of the data members of t1 are equal to the corresponding data members in this Tuple3f.

Overrides:
equals in class TexCoordf<TexCoord2f>
Parameters:
o - the Object with which the comparison is made
Returns:
true or false

clone

public TexCoord2f clone()
Creates and returns a copy of this object.

Overrides:
clone in class java.lang.Object
Returns:
a clone of this instance.
Throws:
java.lang.OutOfMemoryError - if there is not enough memory.
See Also:
Cloneable

newReadOnly

public static final TexCoord2f newReadOnly(float s,
                                           float t)
Creates a new TexCoord2f instance.

Parameters:
s - the S element to use
t - the T element to use

newReadOnly

public static final TexCoord2f newReadOnly(float[] values)
Creates a new TexCoord2f instance.

Parameters:
values - the values array (must be at least size 2)

newReadOnly

public static final TexCoord2f newReadOnly(TexCoordf<?> texCoord)
Creates a new TexCoord2f instance.

Parameters:
texCoord - the TexCoordf to copy the values from

fromPool

public static TexCoord2f fromPool()
Allocates an TexCoord2f instance from the pool.


fromPool

public static TexCoord2f fromPool(float s,
                                  float t)
Allocates an TexCoord2f instance from the pool.


toPool

public static void toPool(TexCoord2f o)
Stores the given TexCoord2f instance in the pool.

Parameters:
o -