artisynth.core.fields

Class ScalarGridField

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.modelbase.GridCompBase

artisynth.core.fields.GridFieldBase

artisynth.core.fields.ScalarGridField

All Implemented Interfaces:

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

public class ScalarGridField
extends GridFieldBase
implements ScalarFieldComponent

A scalar field defined over a regular 3D grid, using values set at the grid's vertices, with values at other points obtained using trilinear interpolation. The field is implemented using an embedded ScalarGrid component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScalarGridField.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 ScalarGridField.Visualization	DEFAULT_VISUALIZATION
static PropertyList	myProps
static double	OUTSIDE_GRID Special value indicating that a query point is outside the grid.

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Fields inherited from interface artisynth.core.modelbase.TransformableGeometry

TG_ARTICULATED, TG_DRAGGER, TG_PRESERVE_ORIENTATION, TG_SIMULATING

Fields inherited from interface maspack.render.IsRenderable

TRANSPARENT, TWO_DIMENSIONAL

Constructor Summary

Constructors

Constructor and Description
ScalarGridField() This constructor should not be called by applications, unless ModelComponentBase.scan(maspack.util.ReaderTokenizer, java.lang.Object) is called immediately after.
ScalarGridField(ScalarGrid grid) Constructs a field using a given grid.
ScalarGridField(java.lang.String name, ScalarGrid grid) Constructs a named field using a given grid.

Method Summary

Modifier and Type	Method and Description
void	addRenderMeshComp(FixedMeshBody mcomp)
void	clearRenderMeshComps()
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()
ScalarGrid	getGrid()
FixedMeshBody	getRenderMeshComp(int idx)
ScalarRange	getRenderRange()
boolean	getRenderSurface() Queries whether or not iso-surface rendering is enabled for this grid.
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.
PolygonalMesh	getSurface()
double	getSurfaceDistance() Returns the distance value used for creating this grid's iso-surface.
double	getValue(FemFieldPoint fp) Returns the value of the this field at a specified FEM field point.
double	getValue(MeshFieldPoint fp) Returns the value of the this field at a specified mesh field point.
double	getValue(Point3d pos) Queries the field value associated with this grid at a specified position.
DoubleInterval	getValueRange() Returns the range of all values in this field, including the default value.
Point3d	getVertexPosition(int vi) Gets the position of the vertex indexed by vi.
Point3d	getVertexPosition(int xi, int yj, int zk) Gets the position of the vertex indexed by its indices along the x, y, and z axes.
double	getVertexValue(int vi) Returns the value at the grid vertex indexed by vi.
double	getVertexValue(int xi, int yj, int zk) Returns the value at the grid vertex indexed by its indices along the x, y, and z axes.
ScalarGridField.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.
int	numVertices() Returns the number of vertices in the grid.
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(FixedMeshBody 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	setGrid(ScalarGrid grid) Sets the grid for this ScalarGridField.
void	setLocalToWorld(RigidTransform3d TGW)
void	setRenderRange(ScalarRange range)
void	setRenderSurface(boolean enable) Sets whether or not iso-surface rendering is enabled for this grid.
void	setSurfaceDistance(double dist) Sets the distance value used for creating this grid's iso-surface.
void	setVertexValue(int vi, double value) Sets the value at the grid vertex indexed by vi, which is computed from the axial vertex indices xi, yj, zk according to
void	setVertexValue(int xi, int yj, int zk, double value) Sets the value at the grid vertex indexed by its indices along the x, y, and z axes.
void	setVisualization(ScalarGridField.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.GridFieldBase

getClipToGrid, getUseFemRestPositions, getUseLocalValuesForField, setClipToGrid, setUseFemRestPositions, setUseLocalValuesForField

Methods inherited from class artisynth.core.modelbase.GridCompBase

addTransformableDependencies, clearCacheIfNecessary, defaultRenderProps, getLocalToWorld, getLocalToWorld, getRenderGrid, getRenderRanges, getRenderRangesRange, getRenderVertices, scaleDistance, scaleMass, setGrid, setRenderGrid, setRenderRanges, setRenderVertices, transformGeometry, transformGeometry, updateBounds

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase

copy, defaultRenderPropsAreNull, getRenderHints, getRenderProps, isSelectable, isVisible, setRenderProps, setVisible, updateRenderProps

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, clone, connectToHierarchy, 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 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

Methods inherited from interface artisynth.core.modelbase.TransformableGeometry

transformPriority

Field Detail

DEFAULT_COLOR_INTERPOLATION

public static final Renderer.ColorInterpolation DEFAULT_COLOR_INTERPOLATION

DEFAULT_VISUALIZATION

public static ScalarGridField.Visualization DEFAULT_VISUALIZATION

OUTSIDE_GRID

public static double OUTSIDE_GRID

Special value indicating that a query point is outside the grid.

myProps

public static PropertyList myProps

Constructor Detail

ScalarGridField

public ScalarGridField()

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

ScalarGridField

public ScalarGridField(ScalarGrid grid)

Constructs a field using a given grid.

Parameters:

grid - scalar grid used to implement the field.

ScalarGridField

public ScalarGridField(java.lang.String name,
                       ScalarGrid grid)

Constructs a named field using a given grid.

Parameters:

grid - name name of the field

grid - scalar grid used to implement the field

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 GridFieldBase

Returns:

static information for all exported properties

numVertices

public int numVertices()

Returns the number of vertices in the grid.

Returns:

number of grid vertices

getVisualization

public ScalarGridField.Visualization getVisualization()

setVisualization

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

getSurfaceDistance

public double getSurfaceDistance()

Returns the distance value used for creating this grid's iso-surface.

Returns:

iso-surface distance value

setSurfaceDistance

public void setSurfaceDistance(double dist)

Sets the distance value used for creating this grid's iso-surface.

Parameters:

dist - iso-surface distance value

getRenderSurface

public boolean getRenderSurface()

Queries whether or not iso-surface rendering is enabled for this grid.

Returns:

true if iso-surface rendering is enabled

setRenderSurface

public void setRenderSurface(boolean enable)

Sets whether or not iso-surface rendering is enabled for this grid. If enabled, the iso-surface associated with the grid is rendered in the viewer.

Parameters:

enable - if true, enables iso-surface rendering

addRenderMeshComp

public void addRenderMeshComp(FixedMeshBody mcomp)

removeRenderMeshComp

public boolean removeRenderMeshComp(FixedMeshBody mcomp)

getRenderMeshComp

public FixedMeshBody getRenderMeshComp(int idx)

numRenderMeshComps

public int numRenderMeshComps()

clearRenderMeshComps

public void clearRenderMeshComps()

setLocalToWorld

public void setLocalToWorld(RigidTransform3d TGW)

Overrides:

setLocalToWorld in class GridCompBase

getValue

public double getValue(Point3d pos)

Queries the field value associated with this grid at a specified position. The position is assumed to be in either local or world coordinates depending on whether getUseLocalValuesForField returns true.

If the query point is outside the grid, then the value for the nearest grid point is returned if the property cliptoGrid is true; otherwise the special value OUTSIDE_GRID is returned.

Specified by:

getValue in interface ScalarFieldComponent

Parameters:

pos - query position

Returns:

value at the query position

getVertexPosition

public Point3d getVertexPosition(int xi,
                                 int yj,
                                 int zk)

Gets the position of the vertex indexed by its indices along the x, y, and z axes. The position is in either local or world coordinates depending on whether #getUseLocalValuesForField} returns true.

Parameters:

xi - x vertex index

yj - y vertex index

zk - z vertex index

Returns:

position of the vertex

getVertexPosition

public Point3d getVertexPosition(int vi)

Gets the position of the vertex indexed by vi. See setVertexValue(int,double) for a description of how vi is computed. The position is in either local or world coordinates depending on whether GridFieldBase.getUseLocalValuesForField() returns true.

Parameters:

vi - vertex index

Returns:

position of the vertex

getValue

public double getValue(FemFieldPoint fp)

Description copied from interface: ScalarFieldComponent

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 double getValue(MeshFieldPoint fp)

Description copied from interface: ScalarFieldComponent

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

getGrid

public ScalarGrid getGrid()

Specified by:

getGrid in class GridCompBase

getVertexValue

public double getVertexValue(int vi)

Returns the value at the grid vertex indexed by vi. See setVertexValue(int,double) for a description of how vi is computed.

Parameters:

vi - index of the vertex

Returns:

value at the vertex

setVertexValue

public void setVertexValue(int xi,
                           int yj,
                           int zk,
                           double value)

Sets the value at the grid vertex indexed by its indices along the x, y, and z axes.

Parameters:

xi - x vertex index

yj - y vertex index

zk - z vertex index

value - new vertex value

setVertexValue

public void setVertexValue(int vi,
                           double value)

Sets the value at the grid vertex indexed by vi, which is computed from the axial vertex indices xi, yj, zk according to

 vi = xi + nx*yj + (nx*ny)*zk
 

where nx and ny are the number of vertices along x and y axes.

Parameters:

vi - index of the vertex

value - new vertex value

getVertexValue

public double getVertexValue(int xi,
                             int yj,
                             int zk)

Returns the value at the grid vertex indexed by its indices along the x, y, and z axes.

Parameters:

xi - x vertex index

yj - y vertex index

zk - z vertex index

Returns:

value for the vertex

setGrid

public void setGrid(ScalarGrid grid)

Sets the grid for this ScalarGridField. The grid is set by reference (i.e., it is not copied). The grid's renderRanges and localToWorld transform are updated from the current renderRanges and gridtoWorld transform values for this component.

Parameters:

grid - grid to set

getSurface

public PolygonalMesh getSurface()

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

Overrides:

createRenderProps in class GridCompBase

Returns:

new render properties for this object

getValueRange

public DoubleInterval getValueRange()

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

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

Overrides:

prerender in class GridCompBase

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

Overrides:

render in class GridCompBase

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 RenderableComponentBase

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 RenderableComponentBase

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.