artisynth.core.fields

Class ScalarFemField

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.fields.FemFieldComp

artisynth.core.fields.ScalarFemField

All Implemented Interfaces:

FieldComponent, ModelComponent, PostScannable, RenderableComponent, ScalarFieldComponent, java.lang.Cloneable, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable

Direct Known Subclasses:

ScalarElementField, ScalarNodalField, ScalarSubElemField

public abstract class ScalarFemField
extends FemFieldComp
implements RenderableComponent, ScalarFieldComponent

Base class for scalar field defined over an FEM model.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScalarFemField.Visualization

Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent

ModelComponent.FilePathSaveType, ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static Renderer.ColorInterpolation	DEFAULT_COLOR_INTERPOLATION
static ScalarFemField.Visualization	DEFAULT_VISUALIZATION
static PropertyList	myProps

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Fields inherited from interface maspack.render.IsRenderable

TRANSPARENT, TWO_DIMENSIONAL

Constructor Summary

Constructors

Constructor and Description
ScalarFemField()
ScalarFemField(FemModel3d fem)
ScalarFemField(FemModel3d fem, double defaultValue)

Method Summary

Modifier and Type	Method and Description
void	addRenderMeshComp(FemMesh mcomp)
abstract void	clearAllValues() Clear all values defined for the features (e.g., nodes, elements) associated with this field.
void	clearRenderMeshComps()
static RenderProps	createDefaultRenderProps()
RenderProps	createRenderProps() Factory method to create render properties appropriate to this object.
boolean	equals(ScalarFemField field) Returns true if this field is functionally equal to another field.
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
Renderer.ColorInterpolation	getColorInterpolation()
ColorMapBase	getColorMap()
double	getDefaultValue() Returns the default value for this field.
FemMesh	getRenderMeshComp(int idx)
ScalarRange	getRenderRange()
void	getSelection(java.util.LinkedList<java.lang.Object> list, int qid) Append to list the component (or components) associated with the qid-th selection query issued by this component's render method.
void	getSoftReferences(java.util.List<ModelComponent> refs) Appends all soft references for this component to a list.
double	getValue(MeshFieldPoint fp) Returns the value of the this field at a specified mesh field point.
abstract double	getValue(Point3d pos) Returns the value of the this field at a specified spatial position.
DoubleInterval	getValueRange() Returns the range of all values in this field, including the default value.
ScalarFemField.Visualization	getVisualization()
Range	getVisualizationRange()
int	numRenderMeshComps()
int	numSelectionQueriesNeeded() If this selectable manages its own selection (by issuing selection queries within its render method), then this method should return the maximum number of selection queries that will be required.
void	prerender(RenderList list) Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates).
boolean	removeRenderMeshComp(FemMesh mcomp)
void	render(Renderer renderer, int flags) Render this object using the functionality of the supplied Renderer.
void	setColorInterpolation(Renderer.ColorInterpolation interp)
void	setColorMap(ColorMapBase map)
void	setDefaultValue(double value) Sets the default value for this field.
void	setRenderRange(ScalarRange range)
void	setVisualization(ScalarFemField.Visualization vis)
void	updateReferences(boolean undo, java.util.Deque<java.lang.Object> undoInfo) May be called by the system if any of the soft references for this component are removed from the the component hierarchy.

Methods inherited from class artisynth.core.fields.FemFieldComp

clearCacheIfNecessary, equals, getFemModel, getRenderHints, getRenderProps, isSelectable, setRenderProps, updateBounds

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, clone, connectToHierarchy, copy, createTempFlag, disconnectFromHierarchy, getChildren, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getProperty, hasChildren, hasState, isFixed, isMarked, isScanning, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, postscan, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, scan, setFixed, setFlag, setMarked, setName, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setScanning, setSelected, setWritable, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface maspack.render.IsSelectable

isSelectable

Methods inherited from interface maspack.render.IsRenderable

getRenderHints, updateBounds

Methods inherited from interface maspack.render.HasRenderProps

getRenderProps, setRenderProps

Methods inherited from interface artisynth.core.modelbase.ScalarFieldComponent

getValue

Methods inherited from interface artisynth.core.modelbase.FieldComponent

clearCacheIfNecessary

Methods inherited from interface artisynth.core.modelbase.ModelComponent

connectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, hasState, isFixed, isMarked, isSelected, notifyParentOfChange, scan, setFixed, setMarked, setName, setNumber, setParent, setSelected, setWritable

Methods inherited from interface maspack.properties.HasProperties

getProperty

Methods inherited from interface maspack.properties.HierarchyNode

getChildren, hasChildren

Methods inherited from interface artisynth.core.modelbase.PostScannable

postscan

Methods inherited from interface maspack.util.Scannable

isWritable, write

Field Detail

DEFAULT_COLOR_INTERPOLATION

public static final Renderer.ColorInterpolation DEFAULT_COLOR_INTERPOLATION

DEFAULT_VISUALIZATION

public static ScalarFemField.Visualization DEFAULT_VISUALIZATION

myProps

public static PropertyList myProps

Constructor Detail

ScalarFemField

public ScalarFemField()

ScalarFemField

public ScalarFemField(FemModel3d fem)

ScalarFemField

public ScalarFemField(FemModel3d fem,
                      double defaultValue)

Method Detail

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

Overrides:

getAllPropertyInfo in class ModelComponentBase

Returns:

static information for all exported properties

getVisualization

public ScalarFemField.Visualization getVisualization()

setVisualization

public void setVisualization(ScalarFemField.Visualization vis)

getVisualizationRange

public Range getVisualizationRange()

getColorInterpolation

public Renderer.ColorInterpolation getColorInterpolation()

setColorInterpolation

public void setColorInterpolation(Renderer.ColorInterpolation interp)

getColorMap

public ColorMapBase getColorMap()

setColorMap

public void setColorMap(ColorMapBase map)

setRenderRange

public void setRenderRange(ScalarRange range)

getRenderRange

public ScalarRange getRenderRange()

addRenderMeshComp

public void addRenderMeshComp(FemMesh mcomp)

removeRenderMeshComp

public boolean removeRenderMeshComp(FemMesh mcomp)

getRenderMeshComp

public FemMesh getRenderMeshComp(int idx)

numRenderMeshComps

public int numRenderMeshComps()

clearRenderMeshComps

public void clearRenderMeshComps()

getValue

public double getValue(MeshFieldPoint fp)

Returns the value of the this field at a specified mesh field point.

Specified by:

getValue in interface ScalarFieldComponent

Parameters:

fp - point at which value is requested

Returns:

value at the point

getValue

public abstract double getValue(Point3d pos)

Returns the value of the this field at a specified spatial position.

Specified by:

getValue in interface ScalarFieldComponent

Parameters:

pos - position at which value is requested

Returns:

value at the position

getValueRange

public DoubleInterval getValueRange()

Returns the range of all values in this field, including the default value.

clearAllValues

public abstract void clearAllValues()

Clear all values defined for the features (e.g., nodes, elements) associated with this field. After this call, the field will have a uniform value defined by its defaultValue.

getDefaultValue

public double getDefaultValue()

Returns the default value for this field. See setDefaultValue(double).

Returns:

default value for this field

setDefaultValue

public void setDefaultValue(double value)

Sets the default value for this field. Default values are used at features (e.g., nodes, elements) for which values have not been explicitly specified.

Parameters:

value - new default value for this field

equals

public boolean equals(ScalarFemField field)

Returns true if this field is functionally equal to another field. Intended mainly for testing and debugging.

createRenderProps

public RenderProps createRenderProps()

Description copied from interface: HasRenderProps

Factory method to create render properties appropriate to this object.

Specified by:

createRenderProps in interface HasRenderProps

Returns:

new render properties for this object

createDefaultRenderProps

public static RenderProps createDefaultRenderProps()

prerender

public void prerender(RenderList list)

Description copied from interface: IsRenderable

Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates). The object may add internal objects to the list of objects being rendered, by calling

list.addIfVisible (obj);

for each of the objects in question.

Specified by:

prerender in interface IsRenderable

Parameters:

list - list of objects to be rendered

render

public void render(Renderer renderer,
                   int flags)

Description copied from interface: IsRenderable

Render this object using the functionality of the supplied Renderer.

Specified by:

render in interface IsRenderable

Parameters:

renderer - provides the functionality used to perform the rendering.

flags - flags that may be used to control different aspects of the rendering. Flags are defined in Renderer and currently include Renderer.HIGHLIGHT and Renderer.SORT_FACES.

numSelectionQueriesNeeded

public int numSelectionQueriesNeeded()

Description copied from interface: IsSelectable

If this selectable manages its own selection (by issuing selection queries within its render method), then this method should return the maximum number of selection queries that will be required. Otherwise, this method should return -1.

Specified by:

numSelectionQueriesNeeded in interface IsSelectable

Overrides:

numSelectionQueriesNeeded in class FemFieldComp

Returns:

maximum number of selection queries needed by this component, or -1 if this component does not manage its own selection.

getSelection

public void getSelection(java.util.LinkedList<java.lang.Object> list,
                         int qid)

Description copied from interface: IsSelectable

Append to list the component (or components) associated with the qid-th selection query issued by this component's render method. This will only be called if this component manages its own selection (i.e., the number nums returned by IsSelectable.numSelectionQueriesNeeded() is positive), and qid will in turn be a number between 0 and nums-1.

Specified by:

getSelection in interface IsSelectable

Overrides:

getSelection in class FemFieldComp

Parameters:

list - selected objects are appended to the end of this list

qid - index of the selection query

getSoftReferences

public void getSoftReferences(java.util.List<ModelComponent> refs)

Appends all soft references for this component to a list. References are other components, outside of this component's immediate ancestry, on which this component depends. For example, an ExcitationComponent may refer to one or more other ExcitationComponents to act as excitation sources. A soft reference is one which can be removed from the referring component. In particular, if any soft references for a component are deleted, then that component's updateReferences() method will be called to update its internal reference information.

Specified by:

getSoftReferences in interface ModelComponent

Overrides:

getSoftReferences in class ModelComponentBase

Parameters:

refs - list to which soft references are appended

updateReferences

public void updateReferences(boolean undo,
                             java.util.Deque<java.lang.Object> undoInfo)

May be called by the system if any of the soft references for this component are removed from the the component hierarchy. If called with undo equal to false, this component should then examine its soft references and use ComponentUtils.areConnected() to determine which of them have been disconnected from the hierarchy. Disconnected references should be removed, and sufficient information should be appended to undoInfo to allow this update to be undone if this method is called later with undo equal to true. When undoing an update, the undo information should be removed from the front of undoInfo.

Specified by:

updateReferences in interface ModelComponent

Overrides:

updateReferences in class ModelComponentBase

Parameters:

undo - if true, indicates that the most recent reference update should be undone, using the supplied undo information.

undoInfo - if undo is false, should be used to store information allowing the reference update to be undone. Otherwise, if undo is true, then this supplied information to undo the most recent update.