artisynth.core.fields

Class VectorFemField<T extends VectorObject<T>>

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.fields.FemFieldComp

artisynth.core.fields.VectorFemField<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

VectorElemFieldBase, VectorNodalField

public abstract class VectorFemField<T extends VectorObject<T>>
extends FemFieldComp
implements VectorFieldComponent<T>, ParameterizedClass, RenderableComponent

Base class for vector fields of type T defined over a mesh, where T is an instance of VectorObject.

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 maspack.render.IsRenderable

TRANSPARENT, TWO_DIMENSIONAL

Constructor Summary

Constructors

Constructor and Description
VectorFemField(java.lang.Class<T> type)
VectorFemField(java.lang.Class<T> type, FemModel3d fem)
VectorFemField(java.lang.Class<T> type, FemModel3d fem, T defaultValue)

Method Summary

Modifier and Type	Method and Description
abstract void	clearAllValues() Clear all values defined for the features (e.g., vertices, faces) associated with this field.
static RenderProps	createDefaultRenderProps()
RenderProps	createRenderProps() Factory method to create render properties appropriate to this object.
T	createTypeInstance() Create an instance of the VectorObject type associated with this field.
boolean	equals(VectorFemField<T> field) Returns true if this field is functionally equal to another field.
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
T	getDefaultValue() Returns the default value for this field.
java.lang.Class<T>	getParameterType() Returns the base type for the class parameterization.
double	getRenderScale() Queries the renderScale property for this vector mesh field.
T	getValue(MeshFieldPoint fp) Returns the value of the this field at a specified mesh field point.
abstract T	getValue(Point3d pos) Returns the value of the this field at a specified spatial position.
boolean	hasParameterizedType() Queries whether this class explicitly utilizes a parameterized type.
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).
void	render(Renderer renderer, int flags) Render this object using the functionality of the supplied Renderer.
void	setDefaultValue(T value) Sets the default value for this field.
void	setRenderScale(double scale) Set the renderScale property for this vector mesh field.

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, 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.VectorFieldComponent

getValue

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 maspack.render.IsSelectable

getSelection, isSelectable, numSelectionQueriesNeeded

Methods inherited from interface maspack.render.IsRenderable

getRenderHints, updateBounds

Methods inherited from interface maspack.render.HasRenderProps

getRenderProps, setRenderProps

Field Detail

myProps

public static PropertyList myProps

Constructor Detail

VectorFemField

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

VectorFemField

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

VectorFemField

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

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 ModelComponentBase

Returns:

static information for all exported properties

getRenderScale

public double getRenderScale()

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

Returns:

render scale property value

setRenderScale

public void setRenderScale(double scale)

Set the renderScale property for this vector mesh 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

getParameterType

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

Returns the base type for the class parameterization.

Specified by:

getParameterType in interface ParameterizedClass

Returns:

parameterization type

hasParameterizedType

public boolean hasParameterizedType()

Queries whether this class explicitly utilizes a parameterized type. This methods allows ParameterizedType subclasses to not be explicitly parameterized.

Specified by:

hasParameterizedType in interface ParameterizedClass

Returns:

true if this class utilizes a parameterized type.

createTypeInstance

public T createTypeInstance()

Create an instance of the VectorObject type associated with this field.

Returns:

new vector type

getValue

public abstract 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>>

Parameters:

pos - position at which value is requested

Returns:

value at the position

getValue

public T getValue(MeshFieldPoint fp)

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

clearAllValues

public abstract 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.

getDefaultValue

public T getDefaultValue()

Returns the default value for this field. See setDefaultValue(T).

Returns:

default value for this field

setDefaultValue

public void setDefaultValue(T value)

Sets the default value for this field. Default values are used at features (e.g., vertices, faces) for which values have not been explicitly specified.

Parameters:

value - new default value for this field

createRenderProps

public RenderProps createRenderProps()

Description copied from interface: HasRenderProps

Factory method to create render properties appropriate to this object.

Specified by:

createRenderProps in interface HasRenderProps

Returns:

new render properties for this object

createDefaultRenderProps

public static RenderProps createDefaultRenderProps()

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

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

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.

equals

public boolean equals(VectorFemField<T> field)

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