j3d.org Code

org.j3d.loaders.c3d
Class C3DByteParameter

java.lang.Object
  extended by org.j3d.loaders.c3d.C3DParameter
      extended by org.j3d.loaders.c3d.C3DByteParameter

public class C3DByteParameter
extends C3DParameter

A single parameter instance that represents String (character) data.

Version:
$Revision: 1.2 $
Author:
Justin Couch

Field Summary
 
Fields inherited from class org.j3d.loaders.c3d.C3DParameter
BYTE_TYPE, CHAR_TYPE, data, description, dimensions, FLOAT_TYPE, id, INT_TYPE, locked, LOCKED_PARAM_MSG, name
 
Constructor Summary
C3DByteParameter(java.lang.String name, boolean locked, int id)
          Construct a new group that represents the given name
 
Method Summary
 void setValue(byte d)
          Set the parameter value as a single value.
 void setValue(byte[][][][][][][] d, int[] dim)
          Set the parameter value as a six dimensioned array value.
 void setValue(byte[][][][][][] d, int[] dim)
          Set the parameter value as a five dimensioned array value.
 void setValue(byte[][][][][] d, int[] dim)
          Set the parameter value as a four dimensioned array value.
 void setValue(byte[][][][] d, int[] dim)
          Set the parameter value as a three dimensioned array value.
 void setValue(byte[][][] d, int[] dim)
          Set the parameter value as a two dimensioned array value.
 void setValue(byte[][] d, int[] dim)
          Set the parameter value as a single dimensioned array value.
 void setValue(byte[] d, int[] dim)
          Set the parameter value as a single array value.
 java.lang.String toString()
          Generate a string representation of this header.
 
Methods inherited from class org.j3d.loaders.c3d.C3DParameter
equals, getDescription, getDimensions, getId, getName, getType, getValue, isLocked, numDimensions, setDescription, setLocked
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

C3DByteParameter

public C3DByteParameter(java.lang.String name,
                        boolean locked,
                        int id)
Construct a new group that represents the given name

Parameters:
name - The name this parameter represents
locked - true if this is a locked group
id - The ID of this parameter
Method Detail

toString

public java.lang.String toString()
Generate a string representation of this header.

Overrides:
toString in class java.lang.Object
Returns:
Information about the header

setValue

public void setValue(byte d)
              throws java.lang.IllegalStateException
Set the parameter value as a single value.

Parameters:
d - The byte value to use as the value
Throws:
java.lang.IllegalStateException - The object is locked and cannot be changed

setValue

public void setValue(byte[] d,
                     int[] dim)
              throws java.lang.IllegalStateException
Set the parameter value as a single array value.

Parameters:
d - The byte values to use as the value
dim - The dimensions of each value length
Throws:
java.lang.IllegalStateException - The object is locked and cannot be changed

setValue

public void setValue(byte[][] d,
                     int[] dim)
              throws java.lang.IllegalStateException
Set the parameter value as a single dimensioned array value. When setting the value, all items are assumed to be the same length as the first elements of the array.

Parameters:
d - The byte values to use as the value
dim - The dimensions of each value length
Throws:
java.lang.IllegalStateException - The object is locked and cannot be changed

setValue

public void setValue(byte[][][] d,
                     int[] dim)
              throws java.lang.IllegalStateException
Set the parameter value as a two dimensioned array value. When setting the value, all items are assumed to be the same length as the first elements of the array.

Parameters:
d - The byte values to use as the value
dim - The dimensions of each value length
Throws:
java.lang.IllegalStateException - The object is locked and cannot be changed

setValue

public void setValue(byte[][][][] d,
                     int[] dim)
              throws java.lang.IllegalStateException
Set the parameter value as a three dimensioned array value. When setting the value, all items are assumed to be the same length as the first elements of the array.

Parameters:
d - The byte values to use as the value
dim - The dimensions of each value length
Throws:
java.lang.IllegalStateException - The object is locked and cannot be changed

setValue

public void setValue(byte[][][][][] d,
                     int[] dim)
              throws java.lang.IllegalStateException
Set the parameter value as a four dimensioned array value. When setting the value, all items are assumed to be the same length as the first elements of the array.

Parameters:
d - The byte values to use as the value
dim - The dimensions of each value length
Throws:
java.lang.IllegalStateException - The object is locked and cannot be changed

setValue

public void setValue(byte[][][][][][] d,
                     int[] dim)
              throws java.lang.IllegalStateException
Set the parameter value as a five dimensioned array value. When setting the value, all items are assumed to be the same length as the first elements of the array.

Parameters:
d - The byte values to use as the value
dim - The dimensions of each value length
Throws:
java.lang.IllegalStateException - The object is locked and cannot be changed

setValue

public void setValue(byte[][][][][][][] d,
                     int[] dim)
              throws java.lang.IllegalStateException
Set the parameter value as a six dimensioned array value. When setting the value, all items are assumed to be the same length as the first elements of the array.

Parameters:
d - The byte values to use as the value
dim - The dimensions of each value length
Throws:
java.lang.IllegalStateException - The object is locked and cannot be changed

j3d.org Code

Latest Info from http://code.j3d.org/
Copyright © 2001 - j3d.org