|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectartisynth.core.modelbase.ModelComponentBase
artisynth.core.mechmodels.MuscleExciter
public class MuscleExciter
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface artisynth.core.mechmodels.ExcitationComponent |
---|
ExcitationComponent.CombinationRule |
Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent |
---|
ModelComponent.NavpanelVisibility |
Field Summary | |
---|---|
static PropertyList |
myProps
|
Fields inherited from class artisynth.core.modelbase.ModelComponentBase |
---|
enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames |
Constructor Summary | |
---|---|
MuscleExciter()
|
|
MuscleExciter(java.lang.String name)
|
Method Summary | |
---|---|
void |
addExcitationSource(ExcitationComponent ex)
Adds a new excitation source to this Excitable, with an assumed gain of 1. |
void |
addExcitationSource(ExcitationComponent ex,
double gain)
Adds a new excitation source to this Excitable with a specified gain. |
void |
addTarget(ExcitationComponent ex,
double gain)
|
int |
findTarget(ExcitationComponent ex)
|
PropertyList |
getAllPropertyInfo()
Returns a list giving static information about all properties exported by this object. |
ExcitationComponent.CombinationRule |
getCombinationRule()
Return the combination rule for excitations. |
double |
getDefaultActivationWeight()
Returns the default weight that should be used when this excitation component is being used for inverse actuation control. |
double |
getExcitation()
Returns the primary excitation for this component. |
double |
getExcitationGain(ExcitationComponent ex)
Gets the gain for an excitation source in this component. |
double |
getGain(int idx)
|
double |
getNetExcitation()
Returns the net excitation for this Excitable. |
void |
getSoftReferences(java.util.List<ModelComponent> refs)
Appends all soft references for this component to a list. |
ExcitationComponent |
getTarget(int idx)
|
ListView<ExcitationComponent> |
getTargetView()
|
void |
initialize(double t)
Called from within the model's initialize() method. |
int |
numTargets()
|
void |
removeAllTargets()
|
boolean |
removeExcitationSource(ExcitationComponent ex)
Removes an excitation source from this Excitable. |
int |
removeTarget(ExcitationComponent ex)
|
void |
setCombinationRule(ExcitationComponent.CombinationRule rule)
Sets the rule for combining excitations. |
void |
setExcitation(double a)
Sets the primary excitation for this component. |
boolean |
setExcitationGain(ExcitationComponent ex,
double gain)
Sets the gain for an excitation source in this component. |
void |
setGain(ExcitationComponent ex,
double gain)
|
void |
setGain(int idx,
int gain)
|
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.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, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, postscan, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, scan, setFixed, setFlag, setMarked, setName, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setSelected, 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, hasState, isFixed, isMarked, isSelected, notifyParentOfChange, postscan, scan, setFixed, setMarked, setName, setNumber, setParent, setSelected |
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 |
Field Detail |
---|
public static PropertyList myProps
Constructor Detail |
---|
public MuscleExciter()
public MuscleExciter(java.lang.String name)
Method Detail |
---|
public PropertyList getAllPropertyInfo()
HasProperties
getAllPropertyInfo
in interface HasProperties
getAllPropertyInfo
in class ModelComponentBase
public int findTarget(ExcitationComponent ex)
public double getExcitation()
getExcitation
in interface ExcitationComponent
public void initialize(double t)
initialize()
method.
initialize
in interface RequiresInitialize
t
- initialization time (seconds)public void setExcitation(double a)
setExcitation
in interface ExcitationComponent
a
- excitation valuepublic void setCombinationRule(ExcitationComponent.CombinationRule rule)
setCombinationRule
in interface ExcitationComponent
rule
- rule for combining excitationspublic ExcitationComponent.CombinationRule getCombinationRule()
getCombinationRule
in interface ExcitationComponent
public void addExcitationSource(ExcitationComponent ex)
addExcitationSource
in interface ExcitationComponent
ex
- excitatation source to be addedpublic void addExcitationSource(ExcitationComponent ex, double gain)
addExcitationSource
in interface ExcitationComponent
ex
- excitatation source to be addedgain
- gain for the sourcepublic boolean removeExcitationSource(ExcitationComponent ex)
removeExcitationSource
in interface ExcitationComponent
ex
- excitatation source to be removed
public double getExcitationGain(ExcitationComponent ex)
getExcitationGain
in interface ExcitationComponent
ex
- excitatation source whose gain is to be queried
public boolean setExcitationGain(ExcitationComponent ex, double gain)
setExcitationGain
in interface ExcitationComponent
ex
- excitatation source whose gain is to be modifiedgain
- new gain for the source
public double getNetExcitation()
getNetExcitation
in interface ExcitationComponent
public int numTargets()
public void addTarget(ExcitationComponent ex, double gain)
public int removeTarget(ExcitationComponent ex)
public void removeAllTargets()
public ExcitationComponent getTarget(int idx)
public ListView<ExcitationComponent> getTargetView()
public double getGain(int idx)
public void setGain(int idx, int gain)
public void setGain(ExcitationComponent ex, double gain)
public double getDefaultActivationWeight()
ExcitationComponent
getDefaultActivationWeight
in interface ExcitationComponent
public void getSoftReferences(java.util.List<ModelComponent> refs)
ModelComponentBase
updateReferences()
method will
be called to update its internal reference information.
getSoftReferences
in interface ModelComponent
getSoftReferences
in class ModelComponentBase
refs
- list to which soft references are appendedpublic void updateReferences(boolean undo, java.util.Deque<java.lang.Object> undoInfo)
undo
equal to false
,
this component should then examine its soft references and
use ComponentUtils.isConnected()
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
.
updateReferences
in interface ModelComponent
updateReferences
in class ModelComponentBase
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |