artisynth.core.util

Class ScalarRange

java.lang.Object

artisynth.core.util.ScalarRange

All Implemented Interfaces:

java.lang.Cloneable, CompositeProperty, HasProperties, Clonable, Scannable

public class ScalarRange
extends java.lang.Object
implements CompositeProperty, Scannable, Clonable

Encapsulates scalar range and range updating information. Originally designed to maintain the range for color plots.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScalarRange.Updating

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyList	myProps

Constructor Summary

Constructors

Constructor and Description
ScalarRange()
ScalarRange(double lo, double hi)
ScalarRange(ScalarRange.Updating updating)

Method Summary

Modifier and Type	Method and Description
double	clip(double value)
ScalarRange	clone() Returns a clone of this composite property.
void	expandInterval(DoubleInterval range)
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
DoubleInterval	getInterval()
PropertyMode	getIntervalMode()
double	getLowerBound()
Property	getProperty(java.lang.String name) Returns a property associated with a specified path name.
HasProperties	getPropertyHost() Returns the host for this property
PropertyInfo	getPropertyInfo() If this object is a property, returns the corresponding information
double	getRange()
static java.lang.Class<?>[]	getSubClasses()
ScalarRange.Updating	getUpdating()
PropertyMode	getUpdatingMode()
double	getUpperBound()
boolean	hasProperty(java.lang.String name)
boolean	isWritable() Returns true if this component should in fact be written to secondary storage.
void	scale(double s)
void	scan(ReaderTokenizer rtok, java.lang.Object ref) Scans this element from a ReaderTokenizer.
void	setInterval(DoubleInterval range)
void	setIntervalMode(PropertyMode mode)
void	setPropertyHost(HasProperties newParent) Sets the host for this property.
void	setPropertyInfo(PropertyInfo info) Sets the property information for this property.
void	setUpdating(ScalarRange.Updating updating)
void	setUpdatingMode(PropertyMode mode)
void	updateInterval(double min, double max)
void	updateInterval(DoubleInterval minmax)
void	write(java.io.PrintWriter pw, NumberFormat fmt, java.lang.Object ref) Writes a text description of this element to a PrintWriter.
void	zeroInterval()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

myProps

public static PropertyList myProps

Constructor Detail

ScalarRange

public ScalarRange()

ScalarRange

public ScalarRange(ScalarRange.Updating updating)

ScalarRange

public ScalarRange(double lo,
                   double hi)

Method Detail

getSubClasses

public static java.lang.Class<?>[] getSubClasses()

getPropertyInfo

public PropertyInfo getPropertyInfo()

Description copied from interface: CompositeProperty

If this object is a property, returns the corresponding information

Specified by:

getPropertyInfo in interface CompositeProperty

Returns:

property information for this object

setPropertyInfo

public void setPropertyInfo(PropertyInfo info)

Description copied from interface: CompositeProperty

Sets the property information for this property.

Specified by:

setPropertyInfo in interface CompositeProperty

Parameters:

info - property information

getPropertyHost

public HasProperties getPropertyHost()

Description copied from interface: CompositeProperty

Returns the host for this property

Specified by:

getPropertyHost in interface CompositeProperty

Returns:

host for this property

setPropertyHost

public void setPropertyHost(HasProperties newParent)

Description copied from interface: CompositeProperty

Sets the host for this property.

Specified by:

setPropertyHost in interface CompositeProperty

Parameters:

newParent - host for this property

getProperty

public Property getProperty(java.lang.String name)

Description copied from interface: HasProperties

Returns a property associated with a specified path name. All properties exported by this object must have a name which is a valid Java identifier. Specifying one of these names causes the corresponding Property to be returned. Handles to subproperties can also be obtained by delimiting the sub-property name(s) by '.' characters. A sub-property exists if the value of a property is itself an object which exports properties. It is only possible to obtain a sub-property handle if each of its ancestor properties exports their values by reference.

Specified by:

getProperty in interface HasProperties

Parameters:

name - name of the desired property or sub-property

Returns:

handle to the property

hasProperty

public boolean hasProperty(java.lang.String name)

getAllPropertyInfo

public PropertyList getAllPropertyInfo()

Description copied from interface: HasProperties

Returns a list giving static information about all properties exported by this object.

Specified by:

getAllPropertyInfo in interface HasProperties

Returns:

static information for all exported properties

clone

public ScalarRange clone()

Description copied from interface: CompositeProperty

Returns a clone of this composite property.

Specified by:

clone in interface CompositeProperty

Specified by:

clone in interface Clonable

Overrides:

clone in class java.lang.Object

Returns:

clone of this property

isWritable

public boolean isWritable()

Description copied from interface: Scannable

Returns true if this component should in fact be written to secondary storage. This gives subclasses control over whether or not they are actually written out.

Specified by:

isWritable in interface Scannable

Returns:

true if this component should be written to secondary storage.

getUpdating

public ScalarRange.Updating getUpdating()

setUpdating

public void setUpdating(ScalarRange.Updating updating)

getUpdatingMode

public PropertyMode getUpdatingMode()

setUpdatingMode

public void setUpdatingMode(PropertyMode mode)

getIntervalMode

public PropertyMode getIntervalMode()

setIntervalMode

public void setIntervalMode(PropertyMode mode)

getInterval

public DoubleInterval getInterval()

setInterval

public void setInterval(DoubleInterval range)

expandInterval

public void expandInterval(DoubleInterval range)

updateInterval

public void updateInterval(DoubleInterval minmax)

getUpperBound

public double getUpperBound()

getLowerBound

public double getLowerBound()

clip

public double clip(double value)

getRange

public double getRange()

updateInterval

public void updateInterval(double min,
                           double max)

zeroInterval

public void zeroInterval()

write

public void write(java.io.PrintWriter pw,
                  NumberFormat fmt,
                  java.lang.Object ref)
           throws java.io.IOException

Description copied from interface: Scannable

Writes a text description of this element to a PrintWriter. The text description should be compatable with scan and complete enough to allow full reconstruction of the element.

Specified by:

write in interface Scannable

Parameters:

pw - stream for writing the element

fmt - numeric formating information

ref - optional reference object which can be used for producing references to other objects

Throws:

java.io.IOException - if an I/O error occured

scan

public void scan(ReaderTokenizer rtok,
                 java.lang.Object ref)
          throws java.io.IOException

Description copied from interface: Scannable

Scans this element from a ReaderTokenizer. The expected text format is assumed to be compatible with that produced by write.

Specified by:

scan in interface Scannable

Parameters:

rtok - Tokenizer from which to scan the element

ref - optional reference object which can be used for resolving references to other objects

Throws:

java.io.IOException - if an I/O or formatting error occured

scale

public void scale(double s)