artisynth.core.femmodels

Class FemMarker

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.mechmodels.DynamicComponentBase

artisynth.core.mechmodels.Point

artisynth.core.mechmodels.Marker

artisynth.core.femmodels.FemMarker

All Implemented Interfaces:

AttachingComponent, CollidableDynamicComponent, DynamicAgent, DynamicComponent, ForceEffector, HasAttachments, MotionTargetComponent, CopyableComponent, HasNumericState, HasPosition, ModelComponent, PostScannable, RenderableComponent, Traceable, TransformableGeometry, ScalableUnits, java.lang.Cloneable, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable

public class FemMarker
extends Marker

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.mechmodels.Point

myRenderCoords

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Fields inherited from interface artisynth.core.modelbase.CopyableComponent

COPY_REFERENCES, REST_POSITION

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
FemMarker()
FemMarker(double x, double y, double z)
FemMarker(FemElement elem, double x, double y, double z)
FemMarker(FemElement elem, Point3d pos)
FemMarker(Point3d pos)

Method Summary

Modifier and Type	Method and Description
int	addTargetJacobian(SparseBlockMatrix J, int bi) Add a row to the motion target Jacobian for this motion target.
FemMarker	copy(int flags, java.util.Map<ModelComponent,ModelComponent> copyMap) Create a copy of this component.
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
PointFem3dAttachment	getAttachment() Returns the slave attachment associated with this component, if any.
VectorNd	getCoordinates()
boolean	getCopyReferences(java.util.List<ModelComponent> refs, ModelComponent ancestor) Collects external references which must also be copied in order to duplicate this component.
FemElement	getElement()
FemModel3d	getFemModel()
void	getRestPosition(Point3d pos)
boolean	isDuplicatable() Returns true if this component can be duplicated.
boolean	resetElement(FemModel3d model) Called when the marker is moved (or when we remesh underneath it) and we need to redetermine which element this marker is embedded in.
boolean	resetElement(FemModel3d model, boolean project) Called when the marker is moved (or when we remesh underneath it) and we need to redetermine which element this marker is embedded in.
void	scaleDistance(double s) Scales all distance coordinates.
void	setAttached(DynamicAttachment ax) Attach this component to another via a DynamicAttachment object.
void	setFromElement(FemElement elem) Attaches this marker to the specified FEM element.
void	setFromFem(FemModel3d fem) Attaches this marker to the nearest element in the specified FEM model, projecting the marker's position onto the model surface if it lies outside.
boolean	setFromNodes(java.util.Collection<? extends FemNode> nodes) Attaches this marker to the specified nodes using inverse-distance weighting based on the marker's current position.
void	setFromNodes(java.util.Collection<? extends FemNode> nodes, VectorNd weights) Attaches this marker to a weighted combination of the specified nodes.
boolean	setFromNodes(FemNode[] nodes) Attaches this marker to the specified nodes using inverse-distance weighting based on the marker's current position.
void	setFromNodes(FemNode[] nodes, double[] weights) Attaches this marker to a weighted combination of the specified nodes.
void	updateAttachment()
void	updatePosState()
void	updateState()
void	updateVelState()

Methods inherited from class artisynth.core.mechmodels.Marker

connectAttachment, connectToHierarchy, disconnectFromHierarchy, getAttachments, getHardReferences

Methods inherited from class artisynth.core.mechmodels.Point

addEffectiveMass, addExternalForce, addForce, addForce, addPosImpulse, addPosJacobian, addScaledExternalForce, addScaledForce, addSolveBlock, addSolveBlocks, addToPointVelocity, addToSolveBlockDiagonal, addTransformableDependencies, addVelJacobian, applyExternalForces, applyForces, applyGravity, createMassBlock, createRenderProps, createSolveBlock, defaultRenderPropsAreNull, distance, distance, getEffectiveMass, getEffectiveMass, getEffectiveMassForces, getExternalForce, getForce, getForce, getJacobianType, getMass, getMass, getPointDamping, getPointDampingMode, getPosDerivative, getPosition, getPosition, getPosState, getPosStateSize, getRenderCoords, getRenderProps, getSelection, getState, getTargetActivity, getTargetPos, getTargetPosition, getTargetVel, getTargetVelocity, getTraceablePositionProperty, getTraceables, getVelocity, getVelocity, getVelState, getVelStateSize, hasForce, isMassConstant, isSelectable, mulInverseEffectiveMass, prerender, render, resetEffectiveMass, resetTargets, scaleMass, setContactConstraint, setExternalForce, setForce, setForce, setPointDamping, setPointDampingMode, setPosition, setPosition, setPosState, setRandomForce, setRandomPosState, setRandomVelState, setRenderProps, setScaledExternalForce, setState, setState, setTargetActivity, setTargetPos, setTargetPosition, setTargetVel, setTargetVelocity, setVelocity, setVelocity, setVelState, subForce, transformGeometry, updateBounds, velocityLimitExceeded, zeroExternalForces, zeroForces

Methods inherited from class artisynth.core.mechmodels.DynamicComponentBase

addAttachmentRequest, addConstrainer, addMasterAttachment, getConstrainers, getInverseMass, getMasterAttachments, getSolveIndex, hasState, isActive, isAttached, isControllable, isDynamic, isParametric, removeAttachmentRequest, removeConstrainer, removeMasterAttachment, setSolveIndex, transformGeometry

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase

getRenderHints, isVisible, numSelectionQueriesNeeded, setVisible, updateRenderProps

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, clone, createTempFlag, getChildren, getGrandParent, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getProperty, getSoftReferences, hasChildren, 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.ModelComponent

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.mechmodels.DynamicComponent

addAttachmentRequest, removeAttachmentRequest

Methods inherited from interface artisynth.core.mechmodels.DynamicAgent

addConstrainer, addMasterAttachment, getConstrainers, getInverseMass, getMasterAttachments, getSolveIndex, isActive, isAttached, isControllable, isDynamic, isParametric, removeConstrainer, removeMasterAttachment, setSolveIndex

Methods inherited from interface artisynth.core.modelbase.HasNumericState

advanceState, getAuxVarDerivative, getAuxVarState, getStateVersion, hasState, numAuxVars, requiresAdvance, setAuxVarState

Methods inherited from interface artisynth.core.modelbase.TransformableGeometry

transformGeometry, transformPriority

Field Detail

myProps

public static PropertyList myProps

Constructor Detail

FemMarker

public FemMarker()

FemMarker

public FemMarker(Point3d pos)

FemMarker

public FemMarker(double x,
                 double y,
                 double z)

FemMarker

public FemMarker(FemElement elem,
                 Point3d pos)

FemMarker

public FemMarker(FemElement elem,
                 double x,
                 double y,
                 double z)

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 Point

Returns:

static information for all exported properties

setAttached

public void setAttached(DynamicAttachment ax)

Description copied from class: DynamicComponentBase

Attach this component to another via a DynamicAttachment object. This method is intended for internal use by attachment components.

Specified by:

setAttached in interface DynamicAgent

Overrides:

setAttached in class DynamicComponentBase

Parameters:

ax - Specifies the attachment relationship between this component and its master(s)

getAttachment

public PointFem3dAttachment getAttachment()

Returns the slave attachment associated with this component, if any.

Specified by:

getAttachment in interface AttachingComponent

Specified by:

getAttachment in interface DynamicAgent

Overrides:

getAttachment in class DynamicComponentBase

Returns:

slave attachment, or null if the component is unattached

getCoordinates

public VectorNd getCoordinates()

getElement

public FemElement getElement()

addTargetJacobian

public int addTargetJacobian(SparseBlockMatrix J,
                             int bi)

Add a row to the motion target Jacobian for this motion target. The Jacobian maps state velocities u into motion target velocities vt according to

 vt = J u
 

Specified by:

addTargetJacobian in interface MotionTargetComponent

Overrides:

addTargetJacobian in class Point

Parameters:

J - motion target Jacobian

bi - block row index for the row to be added

Returns:

bi + 1

setFromElement

public void setFromElement(FemElement elem)

Attaches this marker to the specified FEM element. The attachment weights are computed from the marker's current position using natural coordinates within the element.

Parameters:

elem - element to attach the marker to

setFromFem

public void setFromFem(FemModel3d fem)

Attaches this marker to the nearest element in the specified FEM model, projecting the marker's position onto the model surface if it lies outside.

Parameters:

fem - FEM model to attach to

setFromNodes

public void setFromNodes(java.util.Collection<? extends FemNode> nodes,
                         VectorNd weights)

Attaches this marker to a weighted combination of the specified nodes.

Parameters:

nodes - nodes to attach the marker to

weights - weight for each node

setFromNodes

public void setFromNodes(FemNode[] nodes,
                         double[] weights)

Attaches this marker to a weighted combination of the specified nodes.

Parameters:

nodes - nodes to attach the marker to

weights - weight for each node

setFromNodes

public boolean setFromNodes(java.util.Collection<? extends FemNode> nodes)

Attaches this marker to the specified nodes using inverse-distance weighting based on the marker's current position.

Parameters:

nodes - nodes to attach the marker to

Returns:

false if the weighting computation did not fully converge

setFromNodes

public boolean setFromNodes(FemNode[] nodes)

Attaches this marker to the specified nodes using inverse-distance weighting based on the marker's current position.

Parameters:

nodes - nodes to attach the marker to

Returns:

false if the weighting computation did not fully converge

updateState

public void updateState()

Specified by:

updateState in class Marker

updatePosState

public void updatePosState()

Overrides:

updatePosState in class Point

updateVelState

public void updateVelState()

Overrides:

updateVelState in class Point

getRestPosition

public void getRestPosition(Point3d pos)

getFemModel

public FemModel3d getFemModel()

updateAttachment

public void updateAttachment()

resetElement

public boolean resetElement(FemModel3d model)

Called when the marker is moved (or when we remesh underneath it) and we need to redetermine which element this marker is embedded in.

resetElement

public boolean resetElement(FemModel3d model,
                            boolean project)

Called when the marker is moved (or when we remesh underneath it) and we need to redetermine which element this marker is embedded in.

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 Point

Parameters:

s - scaling factor

isDuplicatable

public boolean isDuplicatable()

Returns true if this component can be duplicated. Duplication means that we can expect to be able to make a complete copy of the component along with all it's external references. This method should return true if and only if CopyableComponent.getCopyReferences(java.util.List<artisynth.core.modelbase.ModelComponent>, artisynth.core.modelbase.ModelComponent) returns true.

This method is not currently used. It is intended to provide a faster way of determining if a component can be duplicated, without having to use CopyableComponent.getCopyReferences(java.util.List<artisynth.core.modelbase.ModelComponent>, artisynth.core.modelbase.ModelComponent) to build the list of copy references.

Specified by:

isDuplicatable in interface CopyableComponent

Overrides:

isDuplicatable in class Point

Returns:

true if this component can be duplicated.

getCopyReferences

public boolean getCopyReferences(java.util.List<ModelComponent> refs,
                                 ModelComponent ancestor)

Collects external references which must also be copied in order to duplicate this component. These references should exclude those which are contained within a specified component hierarchy. This method should return true if and only if CopyableComponent.isDuplicatable() returns true.

Specified by:

getCopyReferences in interface CopyableComponent

Overrides:

getCopyReferences in class Point

Parameters:

refs - list to which references are appended

ancestor - root node of the hierarchy from which references are to be excluded

Returns:

false if it is discovered that the component cannot be duplicated

copy

public FemMarker copy(int flags,
                      java.util.Map<ModelComponent,ModelComponent> copyMap)

Description copied from interface: CopyableComponent

Create a copy of this component. If COPY_REFERENCES is set in flags, then any component referenced by this component should itself be set to a copy. This should be done first checking copyMap for an existing copy of the referenced component. If there is no existing copy, then a copy should be created by calling copy recursively and adding the new copy to copyMap.

Specified by:

copy in interface CopyableComponent

Overrides:

copy in class Point

Parameters:

flags - flags to control the copying

copyMap - map to possible existing instances of referenced components

Returns:

copy of this component