ShaderParameter (Starjava TTOOLS API)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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

Field Summary
- Fields inherited from class uk.ac.starlink.task.Parameter
  BY_NAME

Constructor Summary

Constructors
Constructor and Description

ShaderParameter(java.lang.String name)
Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String[]`	`getDefaultValues(int count)` Returns some suitable default values for a set of related ShaderParameters.
`java.lang.String`	`getName(java.lang.Object option)`
`Shader`	`shaderValue(uk.ac.starlink.task.Environment env)` Returns the value of this parameter as a Shader object.

Methods inherited from class uk.ac.starlink.ttools.plottask.StyleParameter
getOptionList, getUsage, setUsage, stringifyOption

Methods inherited from class uk.ac.starlink.task.ChoiceParameter
addOption, addOption, clearOptions, getOption, getOptionNames, getOptions, getOptionValueList, objectToString, setDefaultOption, stringToObject

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ShaderParameter
```
public ShaderParameter(java.lang.String name)
```
    Constructor.
    
    Parameters:
    
    name - parameter name
- Method Detail
  - shaderValue
```
public Shader shaderValue(uk.ac.starlink.task.Environment env)
                   throws uk.ac.starlink.task.TaskException
```
    Returns the value of this parameter as a Shader object.
    
    Parameters:
    
    env - execution environment
    
    Returns:
    
    shader
    
    Throws:
    
    uk.ac.starlink.task.TaskException
  - getName
```
public java.lang.String getName(java.lang.Object option)
```
    Overrides:
    
    getName in class uk.ac.starlink.task.ChoiceParameter
  - getDefaultValues
```
public static java.lang.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

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.