artisynth.core.fields

Class GridFieldBase

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.modelbase.GridCompBase

artisynth.core.fields.GridFieldBase

All Implemented Interfaces:

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

Direct Known Subclasses:

ScalarGridField, VectorGridField

public abstract class GridFieldBase
extends GridCompBase

Base component for grid-based fields

Nested Class Summary

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

ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyList	myProps

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

Method Summary

Modifier and Type	Method and Description
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
boolean	getClipToGrid() Queries whether clip-to-grid is enabled for this grid field.
boolean	getUseFemRestPositions() Queries whether or not rest positions are used when determining values for points within an FEM mesh.
boolean	getUseLocalValuesForField() Queries whether or local values should be used for field queries.
void	setClipToGrid(boolean enable) Sets whether clip-to-grid is enabled for this grid field.
void	setUseFemRestPositions(boolean enable) Sets whether or not rest positions are used when determining values for points within an FEM mesh.
void	setUseLocalValuesForField(boolean enable) Sets whether or not local values should be used for field queries.

Methods inherited from class artisynth.core.modelbase.GridCompBase

addTransformableDependencies, clearCacheIfNecessary, createRenderProps, defaultRenderProps, getGrid, getLocalToWorld, getLocalToWorld, getRenderGrid, getRenderRanges, getRenderRangesRange, getRenderVertices, prerender, render, scaleDistance, scaleMass, setGrid, setLocalToWorld, setRenderGrid, setRenderRanges, setRenderVertices, transformGeometry, transformGeometry, updateBounds

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase

copy, defaultRenderPropsAreNull, getRenderHints, getRenderProps, getSelection, isSelectable, isVisible, numSelectionQueriesNeeded, 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, 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 artisynth.core.modelbase.TransformableGeometry

transformPriority

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

myProps

public static PropertyList myProps

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 GridCompBase

Returns:

static information for all exported properties

getUseLocalValuesForField

public boolean getUseLocalValuesForField()

Queries whether or local values should be used for field queries.

Returns:

true if local values should be used for field queries

setUseLocalValuesForField

public void setUseLocalValuesForField(boolean enable)

Sets whether or not local values should be used for field queries.

Parameters:

enable - if true, enables using local values for field queries

getUseFemRestPositions

public boolean getUseFemRestPositions()

Queries whether or not rest positions are used when determining values for points within an FEM mesh. See setUseFemRestPositions(boolean).

Returns:

true if rest positions are used for values within an FEM mesh

setUseFemRestPositions

public void setUseFemRestPositions(boolean enable)

Sets whether or not rest positions are used when determining values for points within an FEM mesh. If rest positions are not used, the point's current spatial position is used instead. The default value is true. (Values within an FEM mesh are determined using special methods of the form getValue(FieldPoint), where FemFieldPoint contains both spatial and rest positions.)

Parameters:

enable - if true, enables using rest positions for values within an FEM mesh

getClipToGrid

public boolean getClipToGrid()

Queries whether clip-to-grid is enabled for this grid field. See setClipToGrid(boolean).

Returns:

true if clip-to-grid is enabled

setClipToGrid

public void setClipToGrid(boolean enable)

Sets whether clip-to-grid is enabled for this grid field. If enabled, queries for points that are outside the grid return the value for the nearest grid point; i.e., the query point is clipped to the grid. If not enabled, queries for points outside the grid return ScalarGridField.OUTSIDE_GRID for scalar grids and null for vector grids. The default value is true.

Parameters:

enable - if true, enable clip-to-grid