artisynth.core.fields

Class VectorGridField<T extends VectorObject<T>>

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.modelbase.GridCompBase

artisynth.core.fields.GridFieldBase

artisynth.core.fields.VectorGridField<T>

All Implemented Interfaces:

FieldComponent, ModelComponent, PostScannable, RenderableComponent, TransformableGeometry, VectorFieldComponent<T>, ScalableUnits, java.lang.Cloneable, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable

public class VectorGridField<T extends VectorObject<T>>
extends GridFieldBase
implements VectorFieldComponent<T>

A vector 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 VectorGrid component. Vectors are of type T, which must be an instance of VectorObject.

Nested Class Summary

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

ModelComponent.FilePathSaveType, 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
VectorGridField() This constructor should not be called by applications, unless ModelComponentBase.scan(maspack.util.ReaderTokenizer, java.lang.Object) is called immediately after.
VectorGridField(java.lang.String name, VectorGrid<T> grid) Constructs a named field using a given grid.
VectorGridField(VectorGrid<T> grid) Constructs a field using a given grid.

Method Summary

Modifier and Type	Method and Description
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
VectorGrid<T>	getGrid()
double	getRenderScale() Queries the renderScale property for this vector grid field.
T	getValue(FemFieldPoint fp) Returns the value of the this field at a specified FEM field point.
T	getValue(MeshFieldPoint fp) Returns the value of the this field at a specified mesh field point.
T	getValue(Point3d pos) Queries the field value associated with this grid at a specified position.
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.
T	getVertexValue(int vi) Returns the value at the grid vertex indexed by vi.
T	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.
int	numVertices() Returns the number of vertices in the grid.
void	setGrid(VectorGrid<T> grid) Sets the grid for this VectorGridField.
void	setRenderScale(double scale) Set the renderScale property for this vector grid field.
void	setVertexValue(int xi, int yj, int zk, T value) Sets the value at the grid vertex indexed by its indices along the x, y, and z axes.
void	setVertexValue(int vi, T value) Sets the value at the grid vertex indexed by vi, which is computed from the axial vertex indices xi, yj, zk according to

Methods inherited from class artisynth.core.fields.GridFieldBase

getClipToGrid, getUseFemRestPositions, getUseLocalValuesForField, setClipToGrid, setUseFemRestPositions, setUseLocalValuesForField

Methods inherited from class artisynth.core.modelbase.GridCompBase

addTransformableDependencies, clearCacheIfNecessary, createRenderProps, defaultRenderProps, 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.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 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

myProps

public static PropertyList myProps

Constructor Detail

VectorGridField

public VectorGridField()

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

VectorGridField

public VectorGridField(VectorGrid<T> grid)

Constructs a field using a given grid.

Parameters:

grid - vector grid used to implement the field.

VectorGridField

public VectorGridField(java.lang.String name,
                       VectorGrid<T> grid)

Constructs a named field using a given grid.

Parameters:

grid - name name of the field

grid - vector 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

getRenderScale

public double getRenderScale()

Queries the renderScale property for this vector grid field. See setRenderScale(double).

Returns:

render scale property value

setRenderScale

public void setRenderScale(double scale)

Set the renderScale property for this vector grid field. This is used to scale the rendered size of the vector components of this field in subclasses that support rendering of those values. The default value is 0, meaning that the components will not be rendered.

Parameters:

scale - new scale property value

numVertices

public int numVertices()

Returns the number of vertices in the grid.

Returns:

number of grid vertices

getValue

public T 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 GridFieldBase.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 null is returned.

Specified by:

getValue in interface VectorFieldComponent<T extends VectorObject<T>>

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 GridFieldBase.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,VectorObject) 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 T getValue(FemFieldPoint fp)

Description copied from interface: VectorFieldComponent

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

Specified by:

getValue in interface VectorFieldComponent<T extends VectorObject<T>>

Parameters:

fp - point at which value is requested

Returns:

value at the point

getValue

public T getValue(MeshFieldPoint fp)

Description copied from interface: VectorFieldComponent

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

Specified by:

getValue in interface VectorFieldComponent<T extends VectorObject<T>>

Parameters:

fp - point at which value is requested

Returns:

value at the point

getGrid

public VectorGrid<T> getGrid()

Specified by:

getGrid in class GridCompBase

getVertexValue

public T getVertexValue(int vi)

Returns the value at the grid vertex indexed by vi. See setVertexValue(int,VectorObject) 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,
                           T 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,
                           T 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 T 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(VectorGrid<T> grid)

Sets the grid for this VectorGridField. 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