Documentation API of the 'vmm3d.core.Parameter' Java class

Class Parameter

  • Direct Known Subclasses:
    ComplexParam, IntegerParam, RealParam

    public abstract class Parameterextends Object
    Represents a settable numeric parameter associated with another object, such as a View or Exhibit. A parameter is meant to be an attribute of a single object, which is its "owner." The owner implements interface Parameterizable, which defines a method Parameterizable.parameterChanged(Parameter, Object, Object). When a Parameter's value is changed, it calls this method in its owner.

    The value of a parameter can be set from a String that represents a constant expression. When the value is set in this way, the String is saved so that it can be returned when the parameter is converted to string form with the getValueAsString method. This allows parameters to have values such as "2*pi".

    In addition to its value, a parameter has a "default value" that is used (in the VMM core) only when the user clicks the "Defaults" button in a ParameterDialog. The default value is set the first time the parameter's value is set, and it can be explicitely reset later.

    Parameters can be (at least) integers, real numbers, or complex numbers. These possibilities are repesented by different subclasses. Some parameters are "animated"; animated parameters implement the interface Animateable.

Warning: You cannot see the full API documentation of this class since the access to the DatMelt documentation for third-party Java classes is denied. Guests can only view jhplot Java API. To view the complete description of this class and its methods, please request the full DataMelt membership.

If you are already a full member, please login to the DataMelt member area before visiting this documentation.