maspack.geometry

Class ScalarGridBase

java.lang.Object

maspack.geometry.InterpolatingGridBase

maspack.geometry.ScalarGridBase

All Implemented Interfaces:

HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable

Direct Known Subclasses:

DistanceGrid, ScalarGrid

public class ScalarGridBase
extends InterpolatingGridBase

Base class for a regular 3D grid that interpolates scalar values using trilinear interpolation. Both DistanceGrid and ScalarGrid derive from this class.

Field Summary

Fields

Modifier and Type	Field and Description
static double	OUTSIDE_GRID Special value indicating that a query point is outside the grid.

Fields inherited from interface maspack.render.IsRenderable

TRANSPARENT, TWO_DIMENSIONAL

Constructor Summary

Constructors

Constructor and Description
ScalarGridBase()

Method Summary

Modifier and Type	Method and Description
PolygonalMesh	createDistanceSurface() Creates a triangular mesh approximating the surface on which the linearly interpolated distance function equals 0.
PolygonalMesh	createDistanceSurface(double val) Creates a triangular mesh approximating the surface on which the linearly interpolated distance function equals val.
PolygonalMesh	createDistanceSurface(double val, int res) Creates a triangular mesh approximating the surface on which the linearly interpolated distance function equals val.
boolean	epsilonEquals(ScalarGridBase grid, double tol) Returns true if this grid equals another within a prescribed tolerance.
java.lang.Class<?>	getParameterType() For subclasses with parameterized typing, returns the type parameter.
void	setVertexValue(int xi, int yj, int zk, double value) Sets the value for the vertex indexed by its x, y, z indices.

Methods inherited from class maspack.geometry.InterpolatingGridBase

clearColors, createRenderProps, epsilonEquals, getCellVertex, getCellWidths, getCenter, getCenterAndOrientation, getClosestVertex, getDebug, getDefaultVertexColor, getGridToLocalTransformer, getLocalToWorld, getLocalToWorldTransformer, getLocalVertexCoords, getLocalVertexCoords, getOrientation, getRadius, getRenderHints, getRenderProps, getRenderRanges, getRenderVector, getRenderVectorScale, getResolution, getSelection, getVertexColor, getWidths, getWidths, getWorldCenter, getWorldOrientation, getWorldVertexCoords, getWorldVertexCoords, hasLocalToWorld, isSelectable, isVertexRenderingEnabled, isWritable, numSelectionQueriesNeeded, numVertices, parseRenderRanges, prerender, prerender, render, render, scaleDistance, scan, set, setCenter, setCenterAndOrientation, setDebug, setDefaultVertexColor, setLocalToWorld, setOrientation, setRenderProps, setRenderRanges, setResolution, setVertexColor, setVertexRenderingEnabled, updateBounds, vertexToXyzIndices, write, xyzIndicesToVertex

Methods inherited from class java.lang.Object

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

Field Detail

OUTSIDE_GRID

public static double OUTSIDE_GRID

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

Constructor Detail

ScalarGridBase

public ScalarGridBase()

Method Detail

getParameterType

public java.lang.Class<?> getParameterType()

For subclasses with parameterized typing, returns the type parameter. Othewise, returns null.

Specified by:

getParameterType in class InterpolatingGridBase

Returns:

type parameter, or null

setVertexValue

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

Sets the value for the vertex indexed by its x, y, z indices.

Parameters:

xi - x vertex index

yj - y vertex index

zk - z vertex index

value - new value for the vertex

createDistanceSurface

public PolygonalMesh createDistanceSurface()

Creates a triangular mesh approximating the surface on which the linearly interpolated distance function equals 0.

Returns:

iso surface for linear interpolation

createDistanceSurface

public PolygonalMesh createDistanceSurface(double val)

Creates a triangular mesh approximating the surface on which the linearly interpolated distance function equals val.

Parameters:

val - iso surface value

Returns:

iso surface for linear interpolation

createDistanceSurface

public PolygonalMesh createDistanceSurface(double val,
                                           int res)

Creates a triangular mesh approximating the surface on which the linearly interpolated distance function equals val.

Parameters:

val - iso surface value

Returns:

iso surface for linear interpolation

epsilonEquals

public boolean epsilonEquals(ScalarGridBase grid,
                             double tol)

Returns true if this grid equals another within a prescribed tolerance. The grids are equal if the resolution, widths, center, orientation and values are equal. Specifying tol = 0 requires exact equality.

Parameters:

grid - grid to compare against

tol - floating point tolerance (absolute)