uk.ac.starlink.ttools.plottask
Class ShaderParameter
java.lang.Object
uk.ac.starlink.task.Parameter<T>
uk.ac.starlink.task.ChoiceParameter<T>
uk.ac.starlink.ttools.plottask.StyleParameter
uk.ac.starlink.ttools.plottask.ShaderParameter
public class ShaderParameter
- extends StyleParameter
Parameter for choosing Shader
objects.
- Since:
- 7 Aug 2008
- Author:
- Mark Taylor
Method Summary |
static String[] |
getDefaultValues(int count)
Returns some suitable default values for a set of related
ShaderParameters. |
String |
getName(Object option)
Converts an option value object to a string which is used to identify
it as a string value of this parameter. |
Shader |
shaderValue(Environment env)
Returns the value of this parameter as a Shader object. |
Methods inherited from class uk.ac.starlink.task.Parameter |
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getValueClass, isNullPermitted, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toString |
ShaderParameter
public ShaderParameter(String name)
- Constructor.
- Parameters:
name
- parameter name
shaderValue
public Shader shaderValue(Environment env)
throws TaskException
- Returns the value of this parameter as a Shader object.
- Parameters:
env
- execution environment
- Returns:
- shader
- Throws:
TaskException
getName
public String getName(Object option)
- Description copied from class:
ChoiceParameter
- Converts an option value object to a string which is used to identify
it as a string value of this parameter.
- Overrides:
getName
in class ChoiceParameter
- Parameters:
option
- option value
- Returns:
- string representation
getDefaultValues
public static String[] getDefaultValues(int count)
- Returns some suitable default values for a set of related
ShaderParameters.
- Parameters:
count
- number of parameters to get defaults for
- Returns:
- array of default values, one for each parameter
Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.