|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ExcitationComponent
Defines an object that can emit and recieve muscle control excitations.
Nested Class Summary | |
---|---|
static class |
ExcitationComponent.CombinationRule
Combination rules for excitations. |
Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent |
---|
ModelComponent.NavpanelVisibility |
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. |
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 |
getNetExcitation()
Returns the net excitation for this Excitable. |
boolean |
removeExcitationSource(ExcitationComponent ex)
Removes an excitation source from this Excitable. |
void |
setCombinationRule(ExcitationComponent.CombinationRule rule)
Sets the rule for combining excitations. |
void |
setExcitation(double e)
Sets the primary excitation for this component. |
boolean |
setExcitationGain(ExcitationComponent ex,
double gain)
Sets the gain for an excitation source in this component. |
Methods inherited from interface artisynth.core.modelbase.ModelComponent |
---|
connectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, getSoftReferences, hasState, isFixed, isMarked, isSelected, notifyParentOfChange, postscan, scan, setFixed, setMarked, setName, setNumber, setParent, setSelected, updateReferences |
Methods inherited from interface maspack.properties.HasProperties |
---|
getAllPropertyInfo, getProperty |
Methods inherited from interface maspack.properties.HierarchyNode |
---|
getChildren, hasChildren |
Methods inherited from interface maspack.util.Scannable |
---|
isWritable, write |
Methods inherited from interface artisynth.core.mechmodels.RequiresInitialize |
---|
initialize |
Method Detail |
---|
void setCombinationRule(ExcitationComponent.CombinationRule rule)
rule
- rule for combining excitationsExcitationComponent.CombinationRule getCombinationRule()
void setExcitation(double e)
e
- excitation valuedouble getExcitation()
void addExcitationSource(ExcitationComponent ex)
ex
- excitatation source to be addedvoid addExcitationSource(ExcitationComponent ex, double gain)
ex
- excitatation source to be addedgain
- gain for the sourceboolean setExcitationGain(ExcitationComponent ex, double gain)
ex
- excitatation source whose gain is to be modifiedgain
- new gain for the source
double getExcitationGain(ExcitationComponent ex)
ex
- excitatation source whose gain is to be queried
boolean removeExcitationSource(ExcitationComponent ex)
ex
- excitatation source to be removed
double getNetExcitation()
double getDefaultActivationWeight()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |