|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.sunflow.core.ParameterList
public class ParameterList
This class holds a list of "parameters". These are defined and then passed onto rendering objects through the API. They can hold arbitrary typed and named variables as a unified way of getting data into user objects.
Nested Class Summary | |
---|---|
static class |
ParameterList.FloatParameter
Represents an array of floating point values. |
static class |
ParameterList.InterpolationType
|
protected static class |
ParameterList.Parameter
|
Field Summary | |
---|---|
protected FastHashMap<java.lang.String,ParameterList.Parameter> |
list
|
Constructor Summary | |
---|---|
ParameterList()
Creates an empty ParameterList. |
Method Summary | |
---|---|
void |
addBoolean(java.lang.String name,
boolean value)
Add the specified boolean as a parameter. |
void |
addColor(java.lang.String name,
Color value)
Add the specified color as a parameter. |
void |
addFloat(java.lang.String name,
float value)
Add the specified float as a parameter. |
void |
addFloats(java.lang.String name,
ParameterList.InterpolationType interp,
float[] data)
Add the specified floats as a parameter. |
void |
addInteger(java.lang.String name,
int value)
Add the specified integer as a parameter. |
void |
addIntegerArray(java.lang.String name,
int[] array)
Add the specified array of integers as a parameter. |
void |
addMatrices(java.lang.String name,
ParameterList.InterpolationType interp,
float[] data)
Add the specified matrices as a parameter. |
void |
addPoints(java.lang.String name,
ParameterList.InterpolationType interp,
float[] data)
Add the specified points as a parameter. |
void |
addString(java.lang.String name,
java.lang.String value)
Add the specified string as a parameter. |
void |
addStringArray(java.lang.String name,
java.lang.String[] array)
Add the specified array of integers as a parameter. |
void |
addTexCoords(java.lang.String name,
ParameterList.InterpolationType interp,
float[] data)
Add the specified texture coordinates as a parameter. |
void |
addVectors(java.lang.String name,
ParameterList.InterpolationType interp,
float[] data)
Add the specified vectors as a parameter. |
void |
clear(boolean showUnused)
Clears the list of all its members. |
boolean |
getBoolean(java.lang.String name,
boolean defaultValue)
Get the specified boolean parameter from this list. |
Color |
getColor(java.lang.String name,
Color defaultValue)
Get the specified color parameter from this list. |
float |
getFloat(java.lang.String name,
float defaultValue)
Get the specified float parameter from this list. |
ParameterList.FloatParameter |
getFloatArray(java.lang.String name)
Get the specified float array parameter from this list. |
int |
getInt(java.lang.String name,
int defaultValue)
Get the specified integer parameter from this list. |
int[] |
getIntArray(java.lang.String name)
Get the specified integer array parameter from this list. |
Matrix4 |
getMatrix(java.lang.String name,
Matrix4 defaultValue)
Get the specified matrix parameter from this list. |
ParameterList.FloatParameter |
getMatrixArray(java.lang.String name)
Get the specified matrix array parameter from this list. |
MovingMatrix4 |
getMovingMatrix(java.lang.String name,
MovingMatrix4 defaultValue)
|
Point3 |
getPoint(java.lang.String name,
Point3 defaultValue)
Get the specified point parameter from this list. |
ParameterList.FloatParameter |
getPointArray(java.lang.String name)
Get the specified point array parameter from this list. |
java.lang.String |
getString(java.lang.String name,
java.lang.String defaultValue)
Get the specified string parameter from this list. |
java.lang.String[] |
getStringArray(java.lang.String name,
java.lang.String[] defaultValue)
Get the specified string array parameter from this list. |
Point2 |
getTexCoord(java.lang.String name,
Point2 defaultValue)
Get the specified texture coordinate parameter from this list. |
ParameterList.FloatParameter |
getTexCoordArray(java.lang.String name)
Get the specified texture coordinate array parameter from this list. |
Vector3 |
getVector(java.lang.String name,
Vector3 defaultValue)
Get the specified vector parameter from this list. |
ParameterList.FloatParameter |
getVectorArray(java.lang.String name)
Get the specified vector array parameter from this list. |
void |
setFaceCount(int numFaces)
Setup how many faces should be used to check member count on "face" interpolated parameters. |
void |
setFaceVertexCount(int numFaceVerts)
Setup how many "face-vertices" should be used to check member count of "facevarying" interpolated parameters. |
void |
setVertexCount(int numVerts)
Setup how many vertices should be used to check member count of "vertex" interpolated parameters. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final FastHashMap<java.lang.String,ParameterList.Parameter> list
Constructor Detail |
---|
public ParameterList()
Method Detail |
---|
public void clear(boolean showUnused)
public void setFaceCount(int numFaces)
numFaces
- number of facespublic void setVertexCount(int numVerts)
numVerts
- number of verticespublic void setFaceVertexCount(int numFaceVerts)
numFaceVerts
- number of "face-vertices"public void addString(java.lang.String name, java.lang.String value)
null
values are
not permitted.
name
- parameter namevalue
- parameter valuepublic void addInteger(java.lang.String name, int value)
null
values are
not permitted.
name
- parameter namevalue
- parameter valuepublic void addBoolean(java.lang.String name, boolean value)
null
values are
not permitted.
name
- parameter namevalue
- parameter valuepublic void addFloat(java.lang.String name, float value)
null
values are
not permitted.
name
- parameter namevalue
- parameter valuepublic void addColor(java.lang.String name, Color value)
null
values are
not permitted.
name
- parameter namevalue
- parameter valuepublic void addIntegerArray(java.lang.String name, int[] array)
null
values are not permitted.
name
- parameter namearray
- parameter valuepublic void addStringArray(java.lang.String name, java.lang.String[] array)
null
values are not permitted.
name
- parameter namearray
- parameter valuepublic void addFloats(java.lang.String name, ParameterList.InterpolationType interp, float[] data)
null
values are
not permitted.
name
- parameter nameinterp
- interpolation typedata
- parameter valuepublic void addPoints(java.lang.String name, ParameterList.InterpolationType interp, float[] data)
null
values are
not permitted.
name
- parameter nameinterp
- interpolation typedata
- parameter valuepublic void addVectors(java.lang.String name, ParameterList.InterpolationType interp, float[] data)
null
values are
not permitted.
name
- parameter nameinterp
- interpolation typedata
- parameter valuepublic void addTexCoords(java.lang.String name, ParameterList.InterpolationType interp, float[] data)
null
values are not permitted.
name
- parameter nameinterp
- interpolation typedata
- parameter valuepublic void addMatrices(java.lang.String name, ParameterList.InterpolationType interp, float[] data)
null
values are
not permitted.
name
- parameter nameinterp
- interpolation typedata
- parameter valuepublic java.lang.String getString(java.lang.String name, java.lang.String defaultValue)
name
- name of the parameterdefaultValue
- value to return if not found
public java.lang.String[] getStringArray(java.lang.String name, java.lang.String[] defaultValue)
name
- name of the parameterdefaultValue
- value to return if not found
public int getInt(java.lang.String name, int defaultValue)
name
- name of the parameterdefaultValue
- value to return if not found
public int[] getIntArray(java.lang.String name)
name
- name of the parameter
null
if
not foundpublic boolean getBoolean(java.lang.String name, boolean defaultValue)
name
- name of the parameterdefaultValue
- value to return if not found
public float getFloat(java.lang.String name, float defaultValue)
name
- name of the parameterdefaultValue
- value to return if not found
public Color getColor(java.lang.String name, Color defaultValue)
name
- name of the parameterdefaultValue
- value to return if not found
public Point3 getPoint(java.lang.String name, Point3 defaultValue)
name
- name of the parameterdefaultValue
- value to return if not found
public Vector3 getVector(java.lang.String name, Vector3 defaultValue)
name
- name of the parameterdefaultValue
- value to return if not found
public Point2 getTexCoord(java.lang.String name, Point2 defaultValue)
name
- name of the parameterdefaultValue
- value to return if not found
public Matrix4 getMatrix(java.lang.String name, Matrix4 defaultValue)
name
- name of the parameterdefaultValue
- value to return if not found
public ParameterList.FloatParameter getFloatArray(java.lang.String name)
name
- name of the parameter
null
if
not foundpublic ParameterList.FloatParameter getPointArray(java.lang.String name)
name
- name of the parameter
null
if
not foundpublic ParameterList.FloatParameter getVectorArray(java.lang.String name)
name
- name of the parameter
null
if
not foundpublic ParameterList.FloatParameter getTexCoordArray(java.lang.String name)
name
- name of the parameter
null
if
not foundpublic ParameterList.FloatParameter getMatrixArray(java.lang.String name)
name
- name of the parameter
null
if
not foundpublic final MovingMatrix4 getMovingMatrix(java.lang.String name, MovingMatrix4 defaultValue)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |