artisynth.core.mechmodels

Class DistanceGridComp

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.modelbase.GridCompBase

artisynth.core.mechmodels.DistanceGridComp

All Implemented Interfaces:

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

public class DistanceGridComp
extends GridCompBase

Component that encapsulates a DistanceGrid.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DistanceGridComp.SurfaceType Specfies the type of interpolation that should be used when constructing an iso-surface for the grid.

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

Constructor Summary

Constructors

Constructor and Description
DistanceGridComp()
DistanceGridComp(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	addGeneratingMesh(MeshComponent mcomp)
void	clearGeneratingMeshes()
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
boolean	getFitWithOBB() Queries whether an OBB is used when automatically constructing a grid.
DistanceGrid	getGrid()
double	getMarginFraction() Returns the margin fraction used when automatically constructing a grid.
int	getMaxResolution() Returns the default maximum cell resolution that should be used when automatically constructing a grid.
boolean	getRenderSurface() Queries whether or not iso-surface rendering is enabled for this grid.
Vector3i	getResolution() Returns the cell resolutions (in the x, y, and z directions) that should be used when automatically constructing a grid.
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.
DistanceGridComp.SurfaceType	getSurfaceType() Queries the type of interpolation used when creating the iso-surface for this grid.
boolean	hasGrid()
double	penetrationDistance(Vector3d nrm, Matrix3d Dnrm, Point3d p0)
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	removeGeneratingMesh(MeshComponent mcomp)
void	render(Renderer renderer, int flags) Render this object using the functionality of the supplied Renderer.
void	scaleDistance(double s) Scales all distance coordinates.
void	setFitWithOBB(boolean enable) Enables OBB fitting to be used when automatically constructing a grid.
void	setGeneratingMeshes(java.util.Collection<MeshComponent> meshes)
void	setGrid(DistanceGrid grid) Explicitly sets the grid for this DistanceGridComp.
void	setLocalToWorld(RigidTransform3d TGW)
void	setMarginFraction(double frac) Sets the margin fraction used when automatically constructing a grid.
void	setMaxResolution(int max) Sets the default maximum cell resolution that should be used when automatically constructing a distance grid.
void	setRenderSurface(boolean enable) Sets whether or not iso-surface rendering is enabled for this grid.
void	setResolution(Vector3i res) Sets the cell resolution (in the x, y, and z directions) that should be used when automatically constructing a grid.
void	setSurfaceDistance(double dist) Sets the distance value used for creating this grid's iso-surface.
void	setSurfaceType(DistanceGridComp.SurfaceType type) Sets the type of interpolation used when creating the iso-surface for this grid.
void	surfaceTangent(Point3d pr, Point3d pa, Point3d p1, double lam0, Vector3d sideNrm)
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.modelbase.GridCompBase

addTransformableDependencies, clearCacheIfNecessary, createRenderProps, defaultRenderProps, getLocalToWorld, getLocalToWorld, getRenderGrid, getRenderRanges, getRenderRangesRange, getRenderVertices, scaleMass, setGrid, 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, 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.TransformableGeometry

transformPriority

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

myProps

public static PropertyList myProps

Constructor Detail

DistanceGridComp

public DistanceGridComp()

DistanceGridComp

public DistanceGridComp(java.lang.String name)

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

setGeneratingMeshes

public void setGeneratingMeshes(java.util.Collection<MeshComponent> meshes)

removeGeneratingMesh

public boolean removeGeneratingMesh(MeshComponent mcomp)

addGeneratingMesh

public void addGeneratingMesh(MeshComponent mcomp)

clearGeneratingMeshes

public void clearGeneratingMeshes()

getResolution

public Vector3i getResolution()

Returns the cell resolutions (in the x, y, and z directions) that should be used when automatically constructing a grid. See setResolution(maspack.matrix.Vector3i) for a more detailed description.

Returns:

x, y, and z divisions to be used in constructing a grid

See Also:

setResolution(maspack.matrix.Vector3i)

setResolution

public void setResolution(Vector3i res)

Sets the cell resolution (in the x, y, and z directions) that should be used when automatically constructing a grid. This specifies the number of cells that the grid should have along each axis. If any of the values are <= 0, then all of the values are set to zero and the value returned by getMaxResolution()) is used to determine the grid divisions instead.

Parameters:

res - x, y, and z cell divisions to be used in constructing a grid

See Also:

getResolution()

getMaxResolution

public int getMaxResolution()

Returns the default maximum cell resolution that should be used when automatically constructing a grid. See setMaxResolution(int) for a more detailed description.

Returns:

default maximum cell resolution for constructing a grid

setMaxResolution

public void setMaxResolution(int max)

Sets the default maximum cell resolution that should be used when automatically constructing a distance grid. This is the number of cells that will be used along the maximum length in either the x, y, or z direction, with the number of cells in other directions adjusted accordingly so as to provide cells of uniform size. If max is <= 0, the value will be set to 0. If the values returned by getResolution()) are non-zero, those will be used to specify the cell resolutions instead. If the maximum cell resolution and the values returned by getResolution() are all 0, then no grid will be generated.

Parameters:

max - default maximum cell resolution for constructing a grid

getFitWithOBB

public boolean getFitWithOBB()

Queries whether an OBB is used when automatically constructing a grid. See setFitWithOBB(boolean) for more details.

Returns:

true if grid fitting is done using an OBB

setFitWithOBB

public void setFitWithOBB(boolean enable)

Enables OBB fitting to be used when automatically constructing a grid. This means that rather than aligning the grid with the coordinate axes of the underlying mesh(es), the grid will be aligned with an OBB fit to the mesh(es). This generally means that the grid will around the mesh(es) more tightly.

Parameters:

enable - if true, enables OBB fitting for grid construction

getMarginFraction

public double getMarginFraction()

Returns the margin fraction used when automatically constructing a grid.

Returns:

margin fraction

setMarginFraction

public void setMarginFraction(double frac)

Sets the margin fraction used when automatically constructing a grid.

Parameters:

frac - margin fraction

getSurfaceType

public DistanceGridComp.SurfaceType getSurfaceType()

Queries the type of interpolation used when creating the iso-surface for this grid.

Returns:

iso-surface interpolation

setSurfaceType

public void setSurfaceType(DistanceGridComp.SurfaceType type)

Sets the type of interpolation used when creating the iso-surface for this grid.

Parameters:

type - iso-surface interpolation

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

setLocalToWorld

public void setLocalToWorld(RigidTransform3d TGW)

Overrides:

setLocalToWorld in class GridCompBase

scaleDistance

public void scaleDistance(double s)

Description copied from interface: ScalableUnits

Scales all distance coordinates.

Specified by:

scaleDistance in interface ScalableUnits

Overrides:

scaleDistance in class GridCompBase

Parameters:

s - scaling factor

hasGrid

public boolean hasGrid()

getGrid

public DistanceGrid getGrid()

Specified by:

getGrid in class GridCompBase

setGrid

public void setGrid(DistanceGrid grid)

Explicitly sets the grid for this DistanceGridComp. 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. If the grid is set to be null, then any explicit grid is cleared and automatic generation is reenabled.

Parameters:

grid - grid to set

getSurface

public PolygonalMesh getSurface()

surfaceTangent

public void surfaceTangent(Point3d pr,
                           Point3d pa,
                           Point3d p1,
                           double lam0,
                           Vector3d sideNrm)

penetrationDistance

public double penetrationDistance(Vector3d nrm,
                                  Matrix3d Dnrm,
                                  Point3d p0)

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.

getSoftReferences

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

Description copied from class: ModelComponentBase

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.