Package uk.ac.starlink.ttools.plot2.config

Class ShaderConfigKey

  • public class ShaderConfigKey
extends ChoiceConfigKey<Shader>
    ConfigKey for selecting shader objects.
    Since:
    9 Sep 2014
    Author:
    Mark Taylor

    • Constructor Detail

      • ShaderConfigKey

        public ShaderConfigKey​(ConfigMeta meta,
                       Shader[] shaders,
                       Shader dflt)
        Constructor.
        Parameters:
        meta - metadata
        shaders - list of options
        dflt - default value

    • Method Detail

      • decodeString

        public Shader decodeString​(java.lang.String sval)
        Description copied from class: ChoiceConfigKey
        Takes a string, and attempts to turn it into an object which may be a value for this key. If the string is not of a recognised form, null is returned.

        This method should be the opposite of ChoiceConfigKey.stringifyValue(T), but does not need to be consistent with stringToValue or valueToString.

        Specified by:
        decodeString in class ChoiceConfigKey<Shader>
        Parameters:
        sval - string representation
        Returns:
        typed object represented by sval, or null

      • createSpecifier

        public Specifier<Shader> createSpecifier()
        Description copied from class: ConfigKey
        Constructs a graphical control with which the user can specify a suitable value for association with this key.
        Specified by:
        createSpecifier in class ConfigKey<Shader>
        Returns:
        new specifier

      • appendShaderDescription

        public ShaderConfigKey appendShaderDescription()
        Appends a list of the available shaders, as well as rules for naming custom ones, to the end of the existing XML documentation for this key.
        Returns:
        this object, as a convenience

      • createAxisMeta

        public static ConfigMeta createAxisMeta​(java.lang.String shortName,
                                        java.lang.String longName,
                                        java.lang.String axName)
        Creates a key description suitable for a colour map applied to a named axis.
        Parameters:
        shortName - metadata short name
        longName - metadata long name
        axName - user-readable name of axis to which this applies
        Returns:
        new metadata object