artisynth.core.fields

Class VectorElementField<T extends VectorObject<T>>

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.fields.FemFieldComp

artisynth.core.fields.VectorFemField<T>

artisynth.core.fields.VectorElemFieldBase<T>

artisynth.core.fields.VectorElementField<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

MatrixNdElementField, Vector3dElementField, VectorNdElementField

public class VectorElementField<T extends VectorObject<T>>
extends VectorElemFieldBase<T>

A vector field defined over an FEM model, using values set at the elements. Values at other points are obtained by finding the elements nearest to those points. Values at element for which no explicit value has been set are given by the field's default value. Since values are assumed to be constant over a given element, this field is not continuous. 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.NavpanelVisibility

Field Summary

Fields inherited from class artisynth.core.fields.VectorElemFieldBase

DEFAULT_SHELL_ELEMS_VISIBLE, DEFAULT_VOLUME_ELEMS_VISIBLE, myProps

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Fields inherited from interface maspack.render.IsRenderable

TRANSPARENT, TWO_DIMENSIONAL

Constructor Summary

Constructors

Constructor and Description
VectorElementField(java.lang.Class<T> type) This constructor should not be called by applications, unless ModelComponentBase.scan(maspack.util.ReaderTokenizer, java.lang.Object) is called immediately after.
VectorElementField(java.lang.Class<T> type, FemModel3d fem) Constructs a field for a given FEM model, with a default value of 0.
VectorElementField(java.lang.Class<T> type, FemModel3d fem, T defaultValue) Constructs a field for a given FEM model and default value.
VectorElementField(java.lang.String name, java.lang.Class<T> type, FemModel3d fem) Constructs a named field for a given FEM model, with a default value of 0.
VectorElementField(java.lang.String name, java.lang.Class<T> type, FemModel3d fem, T defaultValue) Constructs a named field for a given FEM model and default value.

Method Summary

Modifier and Type	Method and Description
void	clearAllValues() Clear all values defined for the features (e.g., vertices, faces) associated with this field.
void	clearValue(FemElement3dBase elem) Clears the value at a given element (either volumetric or shell).
boolean	equals(VectorElementField<T> field) Returns true if this field is functionally equal to another field.
T	getElementValue(int elemNum) Returns the value at the volumetric element specified by the given number.
T	getShellElementValue(int elemNum) Returns the value at the shell element specified by the given number.
void	getSoftReferences(java.util.List<ModelComponent> refs) Appends all soft references for this component to a list.
T	getValue(FemElement3dBase elem) Returns the value at an element (either volumetric or shell).
T	getValue(FemFieldPoint fp) Returns the value of the this field at a specified FEM field point.
T	getValue(Point3d pos) Returns the value of the this field at a specified spatial position.
boolean	isValueSet(FemElement3dBase elem) Queries whether a value has been seen at a given element (either volumetric or shell).
void	postscan(java.util.Deque<ScanToken> tokens, CompositeComponent ancestor) Performs any required post-scanning for this component.
void	setValue(FemElement3dBase elem, T value) Sets the value at an element (either volumetric or shell).
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.VectorElemFieldBase

getAllPropertyInfo, getShellElemsVisible, getVolumeElemsVisible, setShellElemsVisible, setVolumeElemsVisible

Methods inherited from class artisynth.core.fields.VectorFemField

createDefaultRenderProps, createRenderProps, createTypeInstance, equals, getDefaultValue, getParameterType, getRenderScale, getValue, hasParameterizedType, prerender, render, setDefaultValue, setRenderScale

Methods inherited from class artisynth.core.fields.FemFieldComp

clearCacheIfNecessary, equals, getFemModel, getRenderHints, getRenderProps, getSelection, isSelectable, numSelectionQueriesNeeded, setRenderProps, updateBounds

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, clone, connectToHierarchy, copy, createTempFlag, disconnectFromHierarchy, getChildren, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getProperty, hasChildren, hasState, isFixed, isMarked, isScanning, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, 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 maspack.util.Scannable

isWritable, write

Methods inherited from interface maspack.render.IsSelectable

getSelection, isSelectable, numSelectionQueriesNeeded

Methods inherited from interface maspack.render.IsRenderable

getRenderHints, updateBounds

Methods inherited from interface maspack.render.HasRenderProps

getRenderProps, setRenderProps

Constructor Detail

VectorElementField

public VectorElementField(java.lang.Class<T> type)

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

VectorElementField

public VectorElementField(java.lang.Class<T> type,
                          FemModel3d fem)

Constructs a field for a given FEM model, with a default value of 0.

Parameters:

type - class type of the VectorObject describing the field's

fem - FEM model over which the field is defined

VectorElementField

public VectorElementField(java.lang.Class<T> type,
                          FemModel3d fem,
                          T defaultValue)

Constructs a field for a given FEM model and default value.

Parameters:

type - class type of the VectorObject describing the field's values

fem - FEM model over which the field is defined

defaultValue - default value for elements which don't have explicitly set values

VectorElementField

public VectorElementField(java.lang.String name,
                          java.lang.Class<T> type,
                          FemModel3d fem)

Constructs a named field for a given FEM model, with a default value of 0.

Parameters:

name - name of the field

type - class type of the VectorObject describing the field's values

fem - FEM model over which the field is defined

VectorElementField

public VectorElementField(java.lang.String name,
                          java.lang.Class<T> type,
                          FemModel3d fem,
                          T defaultValue)

Constructs a named field for a given FEM model and default value.

Parameters:

name - name of the field

type - class type of the VectorObject describing the field's values

fem - FEM model over which the field is defined

defaultValue - default value for elements which don't have explicitly set values

Method Detail

getElementValue

public T getElementValue(int elemNum)

Returns the value at the volumetric element specified by the given number. The default value is returned if a value has not been explicitly set for that element. Element numbers are used instead of indices as they are more persistent if the FEM model is modified.

Parameters:

elemNum - volumetric element number

Returns:

value at the element

getShellElementValue

public T getShellElementValue(int elemNum)

Returns the value at the shell element specified by the given number. The default value is returned if a value has not been explicitly set for that element. Element numbers are used instead of indices as they are more persistent if the FEM model is modified.

Parameters:

elemNum - shell element number

Returns:

value at the element

getValue

public T getValue(FemElement3dBase elem)

Returns the value at an element (either volumetric or shell). The default value is returned if a value has not been explicitly set for that element.

Parameters:

elem - element for which the value is requested

Returns:

value at the element

getValue

public T getValue(FemFieldPoint fp)

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

Parameters:

fp - point at which value is requested

Returns:

value at the point

getValue

public T getValue(Point3d pos)

Returns the value of the this field at a specified spatial position.

Specified by:

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

Specified by:

getValue in class VectorFemField<T extends VectorObject<T>>

Parameters:

pos - position at which value is requested

Returns:

value at the position

setValue

public void setValue(FemElement3dBase elem,
                     T value)

Sets the value at an element (either volumetric or shell).

Parameters:

elem - element for which the value is to be set

value - new value for the element

isValueSet

public boolean isValueSet(FemElement3dBase elem)

Queries whether a value has been seen at a given element (either volumetric or shell).

Parameters:

elem - element being queried

Returns:

true if a value has been set at the element

clearValue

public void clearValue(FemElement3dBase elem)

Clears the value at a given element (either volumetric or shell). After this call, the element will be associated with the default value.

Parameters:

elem - element whose value is to be cleared

clearAllValues

public void clearAllValues()

Clear all values defined for the features (e.g., vertices, faces) associated with this field. After this call, the field will have a uniform value defined by its defaultValue.

Specified by:

clearAllValues in class VectorFemField<T extends VectorObject<T>>

postscan

public void postscan(java.util.Deque<ScanToken> tokens,
                     CompositeComponent ancestor)
              throws java.io.IOException

Performs any required post-scanning for this component. This involves handling any information whose processing was deferred during the scan() method and stored in the token queue. The most common use of this method is to resolve the paths of component references, which may not have been created at the time of the initial scan() call.

Specified by:

postscan in interface PostScannable

Overrides:

postscan in class ModelComponentBase

Parameters:

tokens - token information that was stored during scan().

ancestor - ancestor component with respect to which reference component paths are defined.

Throws:

java.io.IOException - if an error is encountered (such as a reference to a non-existent component)

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.

equals

public boolean equals(VectorElementField<T> field)

Returns true if this field is functionally equal to another field. Intended mainly for testing and debugging.