Package org.sunflow.core
Class ParameterList
java.lang.Object
org.sunflow.core.ParameterList
- Direct Known Subclasses:
Options
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
Nested ClassesModifier and TypeClassDescriptionstatic final class
Represents an array of floating point values.static enum
protected static final class
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addBoolean
(String name, boolean value) Add the specified boolean as a parameter.void
Add the specified color as a parameter.void
Add the specified float as a parameter.void
addFloats
(String name, ParameterList.InterpolationType interp, float[] data) Add the specified floats as a parameter.void
addInteger
(String name, int value) Add the specified integer as a parameter.void
addIntegerArray
(String name, int[] array) Add the specified array of integers as a parameter.void
addMatrices
(String name, ParameterList.InterpolationType interp, float[] data) Add the specified matrices as a parameter.void
addPoints
(String name, ParameterList.InterpolationType interp, float[] data) Add the specified points as a parameter.void
Add the specified string as a parameter.void
addStringArray
(String name, String[] array) Add the specified array of integers as a parameter.void
addTexCoords
(String name, ParameterList.InterpolationType interp, float[] data) Add the specified texture coordinates as a parameter.void
addVectors
(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
(String name, boolean defaultValue) Get the specified boolean parameter from this list.Get the specified color parameter from this list.float
Get the specified float parameter from this list.getFloatArray
(String name) Get the specified float array parameter from this list.int
Get the specified integer parameter from this list.int[]
getIntArray
(String name) Get the specified integer array parameter from this list.Get the specified matrix parameter from this list.getMatrixArray
(String name) Get the specified matrix array parameter from this list.final MovingMatrix4
getMovingMatrix
(String name, MovingMatrix4 defaultValue) Get the specified point parameter from this list.getPointArray
(String name) Get the specified point array parameter from this list.Get the specified string parameter from this list.String[]
getStringArray
(String name, String[] defaultValue) Get the specified string array parameter from this list.getTexCoord
(String name, Point2 defaultValue) Get the specified texture coordinate parameter from this list.getTexCoordArray
(String name) Get the specified texture coordinate array parameter from this list.Get the specified vector parameter from this list.getVectorArray
(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.
-
Field Details
-
list
-
-
Constructor Details
-
ParameterList
public ParameterList()Creates an empty ParameterList.
-
-
Method Details
-
clear
public void clear(boolean showUnused) Clears the list of all its members. If some members were never used, a warning will be printed to remind the user something may be wrong. -
setFaceCount
public void setFaceCount(int numFaces) Setup how many faces should be used to check member count on "face" interpolated parameters.- Parameters:
numFaces
- number of faces
-
setVertexCount
public void setVertexCount(int numVerts) Setup how many vertices should be used to check member count of "vertex" interpolated parameters.- Parameters:
numVerts
- number of vertices
-
setFaceVertexCount
public void setFaceVertexCount(int numFaceVerts) Setup how many "face-vertices" should be used to check member count of "facevarying" interpolated parameters. This should be equal to the sum of the number of vertices on each face.- Parameters:
numFaceVerts
- number of "face-vertices"
-
addString
Add the specified string as a parameter.null
values are not permitted.- Parameters:
name
- parameter namevalue
- parameter value
-
addInteger
Add the specified integer as a parameter.null
values are not permitted.- Parameters:
name
- parameter namevalue
- parameter value
-
addBoolean
Add the specified boolean as a parameter.null
values are not permitted.- Parameters:
name
- parameter namevalue
- parameter value
-
addFloat
Add the specified float as a parameter.null
values are not permitted.- Parameters:
name
- parameter namevalue
- parameter value
-
addColor
Add the specified color as a parameter.null
values are not permitted.- Parameters:
name
- parameter namevalue
- parameter value
-
addIntegerArray
Add the specified array of integers as a parameter.null
values are not permitted.- Parameters:
name
- parameter namearray
- parameter value
-
addStringArray
Add the specified array of integers as a parameter.null
values are not permitted.- Parameters:
name
- parameter namearray
- parameter value
-
addFloats
Add the specified floats as a parameter.null
values are not permitted.- Parameters:
name
- parameter nameinterp
- interpolation typedata
- parameter value
-
addPoints
Add the specified points as a parameter.null
values are not permitted.- Parameters:
name
- parameter nameinterp
- interpolation typedata
- parameter value
-
addVectors
Add the specified vectors as a parameter.null
values are not permitted.- Parameters:
name
- parameter nameinterp
- interpolation typedata
- parameter value
-
addTexCoords
Add the specified texture coordinates as a parameter.null
values are not permitted.- Parameters:
name
- parameter nameinterp
- interpolation typedata
- parameter value
-
addMatrices
Add the specified matrices as a parameter.null
values are not permitted.- Parameters:
name
- parameter nameinterp
- interpolation typedata
- parameter value
-
getString
Get the specified string parameter from this list.- Parameters:
name
- name of the parameterdefaultValue
- value to return if not found- Returns:
- the value of the parameter specified or default value if not found
-
getStringArray
Get the specified string array parameter from this list.- Parameters:
name
- name of the parameterdefaultValue
- value to return if not found- Returns:
- the value of the parameter specified or default value if not found
-
getInt
Get the specified integer parameter from this list.- Parameters:
name
- name of the parameterdefaultValue
- value to return if not found- Returns:
- the value of the parameter specified or default value if not found
-
getIntArray
Get the specified integer array parameter from this list.- Parameters:
name
- name of the parameter- Returns:
- the value of the parameter specified or
null
if not found
-
getBoolean
Get the specified boolean parameter from this list.- Parameters:
name
- name of the parameterdefaultValue
- value to return if not found- Returns:
- the value of the parameter specified or default value if not found
-
getFloat
Get the specified float parameter from this list.- Parameters:
name
- name of the parameterdefaultValue
- value to return if not found- Returns:
- the value of the parameter specified or default value if not found
-
getColor
Get the specified color parameter from this list.- Parameters:
name
- name of the parameterdefaultValue
- value to return if not found- Returns:
- the value of the parameter specified or default value if not found
-
getPoint
Get the specified point parameter from this list.- Parameters:
name
- name of the parameterdefaultValue
- value to return if not found- Returns:
- the value of the parameter specified or default value if not found
-
getVector
Get the specified vector parameter from this list.- Parameters:
name
- name of the parameterdefaultValue
- value to return if not found- Returns:
- the value of the parameter specified or default value if not found
-
getTexCoord
Get the specified texture coordinate parameter from this list.- Parameters:
name
- name of the parameterdefaultValue
- value to return if not found- Returns:
- the value of the parameter specified or default value if not found
-
getMatrix
Get the specified matrix parameter from this list.- Parameters:
name
- name of the parameterdefaultValue
- value to return if not found- Returns:
- the value of the parameter specified or default value if not found
-
getFloatArray
Get the specified float array parameter from this list.- Parameters:
name
- name of the parameter- Returns:
- the value of the parameter specified or
null
if not found
-
getPointArray
Get the specified point array parameter from this list.- Parameters:
name
- name of the parameter- Returns:
- the value of the parameter specified or
null
if not found
-
getVectorArray
Get the specified vector array parameter from this list.- Parameters:
name
- name of the parameter- Returns:
- the value of the parameter specified or
null
if not found
-
getTexCoordArray
Get the specified texture coordinate array parameter from this list.- Parameters:
name
- name of the parameter- Returns:
- the value of the parameter specified or
null
if not found
-
getMatrixArray
Get the specified matrix array parameter from this list.- Parameters:
name
- name of the parameter- Returns:
- the value of the parameter specified or
null
if not found
-
getMovingMatrix
-