harmonic.mz.data.fields
Class ScalarField

java.lang.Object
  |
  +--harmonic.mz.data.ModelNode
        |
        +--harmonic.mz.data.fields.ScalarField

All Implemented Interfaces:

java.awt.event.ActionListener, DataNode, Documentable, java.util.EventListener, Interpolater, harmonic.meshGeom.math.MarkableObject, NodeListener

public class ScalarField

extends ModelNode

implements Interpolater

This field holdes a scalar value

Field Summary

float	max
float	min
java.lang.String	widgetType

Fields inherited from class harmonic.mz.data.ModelNode

_fileRoot_, _thread_, ATTRIB_CONTROL_WIDGET, ATTRIB_LISTABLE, ATTRIB_PRESENTABLE, ATTRIB_PRIVATE, ATTRIB_REMOVEABLE, ATTRIB_RENAMEABLE, ATTRIB_SHOW_CONTEXT_MENU, ATTRIB_TYPE_FILTER, ATTRIB_USERGROUP, ATTRIB_VALUE_GROUP, ATTRIB_VE_LISTENER, bCustomCS, bDebug, bValid, name

Constructor Summary

ScalarField()
Constructs a ScalarField

ScalarField(float value)
Constructs a ScalarField

ScalarField(java.lang.String name, float value)
Constructs a ScalarField

ScalarField(java.lang.String name, NodeListener listener, float value)
Constructs a ScalarField

ScalarField(java.lang.String name, java.lang.Object listener, java.lang.String callback, float value)
Constructs a ScalarField

Method Summary

void	assignFromXMLString(MVGFileOpener opener, java.lang.String string) Implements XML string in
java.lang.String	assignToXMLString(MVGFileSaver saver) Implements XML string out
java.awt.Component	createControlWidget() Implements abstract control widget creator by returning an AngleEntry
ModelNode	createCopy() Overrideable function to create and return a copy of this node Default version uses introspection to create a new copy using the newInstance() function, which requires a no argument public constructor.
java.lang.String	debugString()
Interpolater	getInterpolater() Override to return an object that implements Interpolater.
float	getScalar() Return scalar value.
java.lang.String	getTypeName()
java.lang.Object	getValue() Returns Float value
void	initControlWidget(java.awt.Component entry) Implements abstract control widget initializer
void	interpolate_Linear(ModelNode _ret, ModelNode _value0, ModelNode _value1, float b0, float b1) Implements linear interpolation
void	interpolate_Quadratic(ModelNode _ret, ModelNode _value0, ModelNode _value1, ModelNode _value2, float b0, float b1, float b2) Implements quadratic interpolation
java.lang.String	pythonString() String for represention in python.
void	set(DataNode f) Implements abstract setting function.
void	setScalar(float f) Set scalar value.
void	setScrollRange(float min, float max)
void	setValue(java.lang.Object value) Sets value from Float
java.lang.String	toString() Prints name for large nodes (with children), the value for small nodes.
java.lang.String	valueString() String to represent value

Methods inherited from class harmonic.mz.data.ModelNode

actionPerformed, addAll, addAlphaed, addField, addField, addField, addFields, addNetworkInput, addNetworkOutput, addNode, addNodeListener, addNodeListener, addNodes, addNodes, addToCurrent, addToGlobals, addToNetworkEditor, addToTemps, addWithUndo, allFieldsAreFinal, applyDataTransfer, areFieldsValid, assignFromMetaFields, assignFromXMLAttributes, assignToMetaFields, assignToXMLAttributes, at, bind, canSelect, castSelection, checkFileRead, checkNetworkInput, childCount, clean, clearAttrib, clearNotified, compare, copyFrom, createXMLElement, deepCopy, defeatNodeEvents, disableEvents, enableEvents, expectedValidationTime, fileRoot, finalize, findFieldElement, findNode, fromXMLNodes, getAttrib, getBound, getCatagory, getControlWidget, getCurrentNames, getDataTransfer, getDataTransferTypes, getDeleted, getDirectInputs, getDirectOutputs, getEffectors, getEntryListener, getErrorState, getFilterType, getFullName, getHandles, getInstanceURL, getIsLeaf, getListable, getMark, getMetaFields, getName, getNodeChildren_V, getNodeChildren, getNodeID, getNodeParent, getObjectRep, getPresentable, getPrivate, getReferencePoolName, getRemoteOwner, getRemoveable, getRenameable, getSaveable, getSavedChildren, getSelect, getSeparateDirectInputs, getSeparateDirectOutputs, getSequenced, getSerialNo, getTags, getTentativeSelect, getTransformable, getTransformableParent, getTransient, getTreeName, getTypeImage, getTypeURL, getUnfoldedChildren, getUpdateTime, getUserGroup, getValidates, getXMLNodes, hasDependants, hasExternalRef, hashKey, hasValidationLock, hideControlWidget, indexOf, initControlWidget, insertNode, invalidate, isField, isFinal, isInSubtree, isInTree, isLinked, isNotified, isPurged, isSet, isTemporary, isValid, linkedTo, linksChildren, makeContextMenu, makeFixed, makePrototype, makeReferenced, makeUnreferenced, makeVisibleInGUI, markNotified, mayValidate, nodeChanged, notifyListeners, postAssignFromXMLElement, preAssignToXMLElement, printChildren, printTags, printTree, printTree, purge, purgeFinal, remove, removeAll, removeAll, removeHandles, removeNetworkInput, removeNetworkOutput, removeNode, removeNode, removeNode, removeNodeListener, replace, selfNodeChanged, setActualName, setAttrib, setBound, setCatagory, setChildrenExcept, setCoordSystem, setCurrentControlWidget, setCurrentNames, setDeleted, setEntryListener, setErrorState, setFromPrototype, setIsField, setIsLeaf, setIsSet, setListable, setMark, setMetaFields, setName, setNodeParent, setPresentable, setPrivate, setRemoteOwner, setRemoveable, setRenameable, setSaveable, setSelect, setSelect, setSequenced, setSerialNo, setTentativeSelect, setTentativeSelect, setToLink, setTransient, setTransientChildren, setUpdateTime, setUserGroup, setValidates, setValidationLock, setValueGroup, showControlWidget, showControlWidget, showControlWidget, showHandles, startRename, tag, unlinkListeners, unmarkNotified, untag, updateBindable, valChanged, valChanged, validate

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

max

public float max

min

public float min

widgetType

public java.lang.String widgetType

Constructor Detail

ScalarField

public ScalarField()

Constructs a ScalarField

ScalarField

public ScalarField(float value)

Constructs a ScalarField

Parameters:

value - Value of field

ScalarField

public ScalarField(java.lang.String name,
                   float value)

Constructs a ScalarField

Parameters:

name - Name of field

value - Value of field

ScalarField

public ScalarField(java.lang.String name,
                   NodeListener listener,
                   float value)

Constructs a ScalarField

Parameters:

name - Name of field

listener - Listener to update

value - Value of field

ScalarField

public ScalarField(java.lang.String name,
                   java.lang.Object listener,
                   java.lang.String callback,
                   float value)

Constructs a ScalarField

Parameters:

name - Name of field

listener - Listener to update

callback - Callback of listener

value - Value of field

Method Detail

getTypeName

public java.lang.String getTypeName()

setScrollRange

public void setScrollRange(float min,
                           float max)

createCopy

public ModelNode createCopy()

Description copied from class: ModelNode

Overrideable function to create and return a copy of this node Default version uses introspection to create a new copy using the newInstance() function, which requires a no argument public constructor. It then uses the set() function to set the pieces of the copy to the original. Note this does not make a deep copy. Use deepCopy() for that.

Overrides:

createCopy in class ModelNode

getScalar

public float getScalar()

Return scalar value.

setScalar

public void setScalar(float f)

Set scalar value.

getValue

public java.lang.Object getValue()

Returns Float value

Overrides:

getValue in class ModelNode

setValue

public void setValue(java.lang.Object value)

Sets value from Float

Overrides:

setValue in class ModelNode

set

public void set(DataNode f)

Implements abstract setting function.

Specified by:

set in interface DataNode

Overrides:

set in class ModelNode

createControlWidget

public java.awt.Component createControlWidget()

Implements abstract control widget creator by returning an AngleEntry

Overrides:

createControlWidget in class ModelNode

initControlWidget

public void initControlWidget(java.awt.Component entry)

Implements abstract control widget initializer

assignToXMLString

public java.lang.String assignToXMLString(MVGFileSaver saver)

Implements XML string out

Overrides:

assignToXMLString in class ModelNode

assignFromXMLString

public void assignFromXMLString(MVGFileOpener opener,
                                java.lang.String string)

Implements XML string in

Overrides:

assignFromXMLString in class ModelNode

toString

public java.lang.String toString()

Description copied from class: ModelNode

Prints name for large nodes (with children), the value for small nodes.

Overrides:

toString in class ModelNode

debugString

public java.lang.String debugString()

valueString

public java.lang.String valueString()

Description copied from class: ModelNode

String to represent value

Specified by:

valueString in interface DataNode

Overrides:

valueString in class ModelNode

pythonString

public java.lang.String pythonString()

Description copied from class: ModelNode

String for represention in python. Thie is deprecated. Use valueString().

Overrides:

pythonString in class ModelNode

getInterpolater

public Interpolater getInterpolater()

Description copied from class: ModelNode

Override to return an object that implements Interpolater.

Overrides:

getInterpolater in class ModelNode

interpolate_Linear

public void interpolate_Linear(ModelNode _ret,
                               ModelNode _value0,
                               ModelNode _value1,
                               float b0,
                               float b1)

Implements linear interpolation

Specified by:

interpolate_Linear in interface Interpolater

Overrides:

interpolate_Linear in class ModelNode

Parameters:

_ret - Return value

_value0 - Value 0

_value1 - Value 1

b0 - Basis function value 0

b1 - Basis function value 1

interpolate_Quadratic

public void interpolate_Quadratic(ModelNode _ret,
                                  ModelNode _value0,
                                  ModelNode _value1,
                                  ModelNode _value2,
                                  float b0,
                                  float b1,
                                  float b2)

Implements quadratic interpolation

Specified by:

interpolate_Quadratic in interface Interpolater

Overrides:

interpolate_Quadratic in class ModelNode

Parameters:

_value0 - Value 0

_value1 - Value 1

_value2 - Value 1

b0 - Basis function value 0

b1 - Basis function value 1