artisynth.core.inverse

Class QPTermBase

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.inverse.QPTermBase

All Implemented Interfaces:

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

Direct Known Subclasses:

QPConstraintTermBase, QPCostTermBase

public abstract class QPTermBase
extends ModelComponentBase
implements QPTerm

Base implementation for a QPTerm

Nested Class Summary

Nested classes/interfaces inherited from interface artisynth.core.inverse.QPTerm

QPTerm.Type

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

ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLED
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
QPTermBase()
QPTermBase(double weight)

Method Summary

Modifier and Type	Method and Description
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
TrackingController	getController() Returns the controller using this term.
Property	getProperty(java.lang.String pathName) Returns a property associated with a specified path name.
double	getWeight() Queries the weight for this term.
boolean	isEnabled() Queries the enabled status of this term.
boolean	isInternal() Queries whether this term is internal to the controller, as described for setInternal(boolean).
void	setEnabled(boolean enabled)
void	setInternal(boolean internal) Sets a flag indicating that this term is internal to the tracking controller, and should not be directly added or removed by the application using methods such as TrackingController.addConstraintTerm(artisynth.core.inverse.QPConstraintTerm), TrackingController.removeConstraintTerm(artisynth.core.inverse.QPConstraintTerm), TrackingController.addCostTerm(artisynth.core.inverse.QPCostTerm), or TrackingController.removeCostTerm(artisynth.core.inverse.QPCostTerm).
void	setWeight(double w) Sets the weight for this QPTerm.

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, 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.inverse.QPTerm

getType

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

getChildren, hasChildren

Methods inherited from interface artisynth.core.modelbase.PostScannable

postscan

Methods inherited from interface maspack.util.Scannable

isWritable, write

Field Detail

DEFAULT_WEIGHT

public static final double DEFAULT_WEIGHT

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

See Also:

Constant Field Values

myProps

public static PropertyList myProps

Constructor Detail

QPTermBase

public QPTermBase()

QPTermBase

public QPTermBase(double weight)

Method Detail

getAllPropertyInfo

public PropertyList getAllPropertyInfo()

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

getProperty

public Property getProperty(java.lang.String pathName)

Returns a property associated with a specified path name. All properties exported by this object must have a name which is a valid Java identifier. Specifying one of these names causes the corresponding Property to be returned. Handles to subproperties can also be obtained by delimiting the sub-property name(s) by '.' characters. A sub-property exists if the value of a property is itself an object which exports properties. It is only possible to obtain a sub-property handle if each of its ancestor properties exports their values by reference.

Specified by:

getProperty in interface HasProperties

Overrides:

getProperty in class ModelComponentBase

Parameters:

pathName - name of the desired property or sub-property

Returns:

handle to the property

setWeight

public void setWeight(double w)

Sets the weight for this QPTerm.

Specified by:

setWeight in interface QPTerm

Parameters:

w - weight for the term

getWeight

public double getWeight()

Queries the weight for this term.

Specified by:

getWeight in interface QPTerm

Returns:

weight for this term

isEnabled

public boolean isEnabled()

Queries the enabled status of this term. Terms that are not enabled are ignored.

Specified by:

isEnabled in interface QPTerm

Returns:

enabled status of this term

setEnabled

public void setEnabled(boolean enabled)

setInternal

public void setInternal(boolean internal)

Sets a flag indicating that this term is internal to the tracking controller, and should not be directly added or removed by the application using methods such as TrackingController.addConstraintTerm(artisynth.core.inverse.QPConstraintTerm), TrackingController.removeConstraintTerm(artisynth.core.inverse.QPConstraintTerm), TrackingController.addCostTerm(artisynth.core.inverse.QPCostTerm), or TrackingController.removeCostTerm(artisynth.core.inverse.QPCostTerm).

Parameters:

internal - if true, specifies that this term is internal

isInternal

public boolean isInternal()

Queries whether this term is internal to the controller, as described for setInternal(boolean).

Returns:

true if this term is internal

getController

public TrackingController getController()

Returns the controller using this term.

Specified by:

getController in interface QPTerm

Returns:

controller using this term