artisynth.core.inverse

Class ForceEffectorTarget

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.inverse.ForceEffectorTarget

All Implemented Interfaces:

TrackingTarget, ModelComponent, PostScannable, java.lang.Cloneable, HasProperties, HierarchyNode, Scannable

public class ForceEffectorTarget
extends ModelComponentBase
implements TrackingTarget

Contains information a single force effector target for the ForceMinimizationTerm.

Author:

John E Lloyd

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 boolean	DEFAULT_STATIC_ONLY
static double	DEFAULT_WEIGHT
static PropertyList	myProps

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Constructor Summary

Constructors

Constructor and Description
ForceEffectorTarget()
ForceEffectorTarget(ForceTargetComponent comp, boolean staticOnly)

Method Summary

Modifier and Type	Method and Description
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
ForceTargetComponent	getForceComp()
ForceTargetComponent	getSourceComp() Returns the source component associated with this target.
boolean	getStaticOnly()
VectorNd	getSubWeights() Queries the subweights of this target.
VectorNd	getTargetForce()
int	getTargetSize() Queries the number of DOFs in the target.
double	getWeight() Queries the weight of this target.
void	setForceComp(ForceTargetComponent comp)
void	setStaticOnly(boolean enable)
void	setSubWeights(VectorNd weights) Sets the subweights for this target.
void	setTargetForce(VectorNd force)
void	setWeight(double w) Sets the weight for this target.

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

Field Detail

DEFAULT_STATIC_ONLY

public static final boolean DEFAULT_STATIC_ONLY

See Also:

Constant Field Values

DEFAULT_WEIGHT

public static final double DEFAULT_WEIGHT

See Also:

Constant Field Values

myProps

public static PropertyList myProps

Constructor Detail

ForceEffectorTarget

public ForceEffectorTarget()

ForceEffectorTarget

public ForceEffectorTarget(ForceTargetComponent comp,
                           boolean staticOnly)

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

getWeight

public double getWeight()

Description copied from interface: TrackingTarget

Queries the weight of this target.

Specified by:

getWeight in interface TrackingTarget

Returns:

target weight

See Also:

TrackingTarget.setWeight(double)

setWeight

public void setWeight(double w)

Description copied from interface: TrackingTarget

Sets the weight for this target. Target weights have a default value of 1, and are used to prioritize this target in the tracking computation. Targets with higher weights will be tracked more accurately; targets with a weight of 0 will not be tracked at all.

Specified by:

setWeight in interface TrackingTarget

Parameters:

w - new target weight

See Also:

TrackingTarget.getWeight()

getStaticOnly

public boolean getStaticOnly()

setStaticOnly

public void setStaticOnly(boolean enable)

getSubWeights

public VectorNd getSubWeights()

Description copied from interface: TrackingTarget

Queries the subweights of this target.

Specified by:

getSubWeights in interface TrackingTarget

Returns:

target subweights

See Also:

TrackingTarget.setSubWeights(maspack.matrix.VectorNd)

setSubWeights

public void setSubWeights(VectorNd weights)

Description copied from interface: TrackingTarget

Sets the subweights for this target. The number of subweights is equal to TrackingTarget.getTargetSize(), and each has a default value of 1. Subweights are multiplied by the target weight (returned by TrackingTarget.getWeight()) to yield a net weight used to prioritize each degree of freedom in the tracking computation, with higher weights resulting in more accurate tracking and a weight of 0 resulting in no tracking at all.

Specified by:

setSubWeights in interface TrackingTarget

Parameters:

weights - new target subweights

See Also:

TrackingTarget.getSubWeights()

setForceComp

public void setForceComp(ForceTargetComponent comp)

getSourceComp

public ForceTargetComponent getSourceComp()

Description copied from interface: TrackingTarget

Returns the source component associated with this target. This is the component whose positions or forces are intended to track the desired target.

Specified by:

getSourceComp in interface TrackingTarget

Returns:

target source component

getForceComp

public ForceTargetComponent getForceComp()

getTargetForce

public VectorNd getTargetForce()

setTargetForce

public void setTargetForce(VectorNd force)

getTargetSize

public int getTargetSize()

Description copied from interface: TrackingTarget

Queries the number of DOFs in the target.

Specified by:

getTargetSize in interface TrackingTarget

Returns:

number of target DOFs