artisynth.core.fields

Class ScalarMeshField

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.fields.MeshFieldComp

artisynth.core.fields.ScalarMeshField

All Implemented Interfaces:

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

Direct Known Subclasses:

ScalarFaceField, ScalarVertexField

public abstract class ScalarMeshField
extends MeshFieldComp
implements RenderableComponent, ScalarFieldComponent

Base class for scalar field defined over a mesh.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScalarMeshField.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 ScalarMeshField.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
ScalarMeshField()
ScalarMeshField(MeshComponent mcomp)
ScalarMeshField(MeshComponent mcomp, double defaultValue)

Method Summary

Modifier and Type	Method and Description
abstract void	clearAllValues() Clear all values defined for the features (e.g., vertices, faces) associated with this field.
static RenderProps	createDefaultRenderProps()
RenderProps	createRenderProps() Factory method to create render properties appropriate to this object.
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.
ScalarRange	getRenderRange()
double	getValue(FemFieldPoint fp) Returns the value of the this field at a specified FEM 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.
ScalarMeshField.Visualization	getVisualization()
Range	getVisualizationRange()
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).
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(ScalarMeshField.Visualization vis)

Methods inherited from class artisynth.core.fields.MeshFieldComp

clearCacheIfNecessary, createFieldPoint, getHardReferences, getMesh, getMeshComp, getRenderHints, getRenderProps, getSelection, isSelectable, numSelectionQueriesNeeded, setRenderProps, updateBounds

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, clone, connectToHierarchy, copy, createTempFlag, disconnectFromHierarchy, getChildren, getGrandParent, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getProperty, getSoftReferences, 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, updateReferences, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface maspack.render.IsSelectable

getSelection, isSelectable, numSelectionQueriesNeeded

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, getSoftReferences, hasState, isFixed, isMarked, isSelected, notifyParentOfChange, scan, setFixed, setMarked, setName, setNumber, setParent, setSelected, setWritable, updateReferences

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_VISUALIZATION

public static ScalarMeshField.Visualization DEFAULT_VISUALIZATION

DEFAULT_COLOR_INTERPOLATION

public static final Renderer.ColorInterpolation DEFAULT_COLOR_INTERPOLATION

myProps

public static PropertyList myProps

Constructor Detail

ScalarMeshField

public ScalarMeshField()

ScalarMeshField

public ScalarMeshField(MeshComponent mcomp)

ScalarMeshField

public ScalarMeshField(MeshComponent mcomp,
                       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 ScalarMeshField.Visualization getVisualization()

setVisualization

public void setVisualization(ScalarMeshField.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()

getValue

public double getValue(FemFieldPoint fp)

Returns the value of the this field at a specified FEM 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., vertices, faces) 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., vertices, faces) for which values have not been explicitly specified.

Parameters:

value - new default value for this field

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.