artisynth.core.fields

Class ScalarFaceField

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.fields.MeshFieldComp

artisynth.core.fields.ScalarMeshField

artisynth.core.fields.ScalarFaceField

All Implemented Interfaces:

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

public class ScalarFaceField
extends ScalarMeshField

A scalar field defined over a triangular polygonal mesh, using values set at the mesh's faces. Values at other points are obtained by finding the faces nearest to those points. Values at faces for which no explicit value has been set are given by the field's default value. Since values are assumed to be constant over a given face, this field is not continuous.

Nested Class Summary

Nested classes/interfaces inherited from class artisynth.core.fields.ScalarMeshField

ScalarMeshField.Visualization

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

ModelComponent.NavpanelVisibility

Field Summary

Fields inherited from class artisynth.core.fields.ScalarMeshField

DEFAULT_COLOR_INTERPOLATION, DEFAULT_VISUALIZATION, 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
ScalarFaceField() This constructor should not be called by applications, unless ModelComponentBase.scan(maspack.util.ReaderTokenizer, java.lang.Object) is called immediately after.
ScalarFaceField(MeshComponent mcomp) Constructs a field for a given mesh, with a default value of 0.
ScalarFaceField(MeshComponent mcomp, double defaultValue) Constructs a field for a given mesh and default value.
ScalarFaceField(java.lang.String name, MeshComponent mcomp) Constructs a named field for a given mesh, with a default value of 0.
ScalarFaceField(java.lang.String name, MeshComponent mcomp, double defaultValue) Constructs a named field for a given mesh and default value.

Method Summary

Modifier and Type	Method and Description
void	clearAllValues() Clear all values defined for the features (e.g., vertices, faces) associated with this field.
void	clearValue(Face face) Clears the value at a given face.
double	getValue(Face face) Returns the value at a face.
double	getValue(int fidx) Returns the value at the face specified by a given index.
double	getValue(MeshFieldPoint fp) Returns the value of the this field at a specified mesh field point.
double	getValue(Point3d pos) Returns the value of the this field at a specified spatial position.
Range	getVisualizationRange()
boolean	isValueSet(Face face) Queries whether a value has been seen at a given face.
void	postscan(java.util.Deque<ScanToken> tokens, CompositeComponent ancestor) Performs any required post-scanning for this component.
void	setValue(Face face, double value) Sets the value at a face.

Methods inherited from class artisynth.core.fields.ScalarMeshField

createDefaultRenderProps, createRenderProps, getAllPropertyInfo, getColorInterpolation, getColorMap, getDefaultValue, getRenderRange, getValue, getValueRange, getVisualization, prerender, render, setColorInterpolation, setColorMap, setDefaultValue, setRenderRange, setVisualization

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, 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.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 maspack.util.Scannable

isWritable, write

Constructor Detail

ScalarFaceField

public ScalarFaceField()

This constructor should not be called by applications, unless ModelComponentBase.scan(maspack.util.ReaderTokenizer, java.lang.Object) is called immediately after.

ScalarFaceField

public ScalarFaceField(MeshComponent mcomp)

Constructs a field for a given mesh, with a default value of 0. At present, the mesh must be a triangular PolygonalMesh.

Parameters:

mcomp - component containing the mesh associated with the field

ScalarFaceField

public ScalarFaceField(MeshComponent mcomp,
                       double defaultValue)

Constructs a field for a given mesh and default value. At present, the mesh must be a triangular PolygonalMesh.

Parameters:

mcomp - component containing the mesh associated with the field

defaultValue - default value for faces which don't have explicitly set values

ScalarFaceField

public ScalarFaceField(java.lang.String name,
                       MeshComponent mcomp)

Constructs a named field for a given mesh, with a default value of 0. At present, the mesh must be a triangular PolygonalMesh.

Parameters:

name - name of the field

mcomp - component containing the mesh associated with the field

ScalarFaceField

public ScalarFaceField(java.lang.String name,
                       MeshComponent mcomp,
                       double defaultValue)

Constructs a named field for a given mesh and default value. At present, the mesh must be a triangular PolygonalMesh.

Parameters:

name - name of the field

mcomp - component containing the mesh associated with the field

defaultValue - default value for faces which don't have explicitly set values

Method Detail

getVisualizationRange

public Range getVisualizationRange()

Overrides:

getVisualizationRange in class ScalarMeshField

getValue

public double getValue(int fidx)

Returns the value at the face specified by a given index. The default value is returned if a value has not been explicitly set for that face.

Parameters:

fidx - face index

Returns:

value at the face

getValue

public double getValue(Face face)

Returns the value at a face. The default value is returned if a value has not been explicitly set for that face.

Parameters:

face - face for which the value is requested

Returns:

value at the face

getValue

public double getValue(Point3d pos)

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

Specified by:

getValue in interface ScalarFieldComponent

Specified by:

getValue in class ScalarMeshField

Parameters:

pos - position at which value is requested

Returns:

value at the position

getValue

public double getValue(MeshFieldPoint fp)

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

Parameters:

fp - point at which value is requested

Returns:

value at the point

setValue

public void setValue(Face face,
                     double value)

Sets the value at a face.

Parameters:

face - face for which the value is to be set

value - new value for the face

isValueSet

public boolean isValueSet(Face face)

Queries whether a value has been seen at a given face.

Parameters:

face - face being queried

Returns:

true if a value has been set at the face

clearValue

public void clearValue(Face face)

Clears the value at a given face. After this call, the face will be associated with the default value.

Parameters:

face - face whose value is to be cleared

clearAllValues

public 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.

Specified by:

clearAllValues in class ScalarMeshField

postscan

public void postscan(java.util.Deque<ScanToken> tokens,
                     CompositeComponent ancestor)
              throws java.io.IOException

Performs any required post-scanning for this component. This involves handling any information whose processing was deferred during the scan() method and stored in the token queue. The most common use of this method is to resolve the paths of component references, which may not have been created at the time of the initial scan() call.

Specified by:

postscan in interface PostScannable

Overrides:

postscan in class ModelComponentBase

Parameters:

tokens - token information that was stored during scan().

ancestor - ancestor component with respect to which reference component paths are defined.

Throws:

java.io.IOException - if an error is encountered (such as a reference to a non-existent component)