MuscleBundle (Artisynth API documentation)

java.lang.Object
- artisynth.core.modelbase.ModelComponentBase
- - artisynth.core.modelbase.CompositeComponentBase
  - - artisynth.core.femmodels.MuscleBundle

All Implemented Interfaces:

ExcitationComponent, ComponentChangeListener, CompositeComponent, HasNumericState, IndexedComponentList, ModelComponent, PostScannable, PropertyChangeListener, RenderableComponent, TransformableGeometry, java.lang.Cloneable, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable
```
public class MuscleBundle
extends CompositeComponentBase
implements ExcitationComponent, RenderableComponent, TransformableGeometry, PropertyChangeListener, HasNumericState
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MuscleBundle.DirectionRenderType
- Nested classes/interfaces inherited from interface artisynth.core.mechmodels.ExcitationComponent
  ExcitationComponent.CombinationRule
- Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent
  ModelComponent.NavpanelVisibility
- Nested classes/interfaces inherited from interface artisynth.core.modelbase.CompositeComponent
  CompositeComponent.NavpanelDisplay

Nested Classes
Modifier and Type	Class and Description
`static class`	`MuscleBundle.DirectionRenderType`

Field Summary

Fields
Modifier and Type Field and Description

static PropertyList myProps
- Fields inherited from class artisynth.core.modelbase.ModelComponentBase
  enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames
- Fields inherited from interface maspack.render.IsRenderable
  TRANSPARENT, TWO_DIMENSIONAL
- Fields inherited from interface artisynth.core.modelbase.TransformableGeometry
  TG_ARTICULATED, TG_DRAGGER, TG_PRESERVE_ORIENTATION, TG_SIMULATING

Fields
Modifier and Type	Field and Description
`static PropertyList`	`myProps`

Constructor Summary

Constructors
Constructor and Description

MuscleBundle()

MuscleBundle(java.lang.String name)

Constructors
Constructor and Description
`MuscleBundle()`
`MuscleBundle(java.lang.String name)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MuscleElementDesc`	`addElement(FemElement3dBase elem, Vector3d dir)`
`MuscleElementDesc`	`addElement(FemElement3dBase elem, Vector3d[] dirs)`
`void`	`addElement(MuscleElementDesc desc)`
`void`	`addElementsNearFibres(double dist)`
`void`	`addExcitationSource(ExcitationComponent ex, double gain)` Adds a new excitation source to this Excitable with a specified gain.
`void`	`addFascicle(java.util.LinkedList<Muscle> fascicle)`
`void`	`addFiberMeshElements(double rad, PolylineMesh mesh)`
`void`	`addFibre(Muscle fibre)`
`Muscle`	`addFibre(Point p0, Point p1, AxialMaterial mat)`
`Muscle`	`addFibre(Point p0, Point p1, AxialMaterial mat, double l0)`
`void`	`addPosJacobian(SparseNumberedBlockMatrix M, double h)`
`void`	`addSolveBlocks(SparseNumberedBlockMatrix S)`
`void`	`addTransformableDependencies(TransformGeometryContext context, int flags)` Adds to `context` any transformable components which should be transformed as the same time as this component.
`void`	`addVelJacobian(SparseNumberedBlockMatrix M, double h)`
`void`	`applyForce(double t)`
`void`	`applyForces(double t)` Apply forces due to fibres in bundle, consistent with force-effector
`void`	`clearElements()`
`void`	`clearFascicles()`
`void`	`clearFibres()`
`void`	`computeElementDirections()` Computes the directions within individual elements based on the directions of the muscle fibres.
`void`	`computeElementIpntDirections()` Computes the directions within individual elements based on the directions of the muscle fibres.
`MuscleMaterial`	`createMuscleMaterial()`
`RenderProps`	`createRenderProps()` Factory method to create render properties appropriate to this object.
`PropertyList`	`getAllPropertyInfo()` Returns a list giving static information about all properties exported by this object.
`static FemModel3d`	`getAncestorFem(ModelComponent comp)`
`ExcitationComponent.CombinationRule`	`getCombinationRule()` Return the combination rule for excitations.
`double`	`getDirectionRenderLen()`
`PropertyMode`	`getDirectionRenderLenMode()`
`MuscleBundle.DirectionRenderType`	`getDirectionRenderType()`
`PropertyMode`	`getDirectionRenderTypeMode()`
`MuscleElementDescList`	`getElements()`
`double`	`getElementWidgetSize()`
`PropertyMode`	`getElementWidgetSizeMode()`
`double`	`getExcitation()` Returns the primary excitation for this component.
`java.awt.Color`	`getExcitationColor()`
`PropertyMode`	`getExcitationColorMode()`
`double`	`getExcitationGain(ExcitationComponent ex)` Gets the gain for an excitation source in this component.
`java.util.ArrayList<java.util.LinkedList<Muscle>>`	`getFascicles()`
`Vector3d[]`	`getFibreRestDirections()`
`static Vector3d[]`	`getFibreRestDirections(MuscleBundle... bundles)` Utility method to create a list of fibre rest directions for one or more muscle bundles.
`DelaunayInterpolator`	`getFibreRestDistanceInterpolator()`
`static DelaunayInterpolator`	`getFibreRestDistanceInterpolator(MuscleBundle... bundles)` Utility method to create a rest distance interpolator for one or more muscle bundles.
`AxialSpringList<Muscle>`	`getFibres()`
`boolean`	`getFibresActive()`
`int`	`getJacobianType()` Return Jacobian type for use as force effector
`double`	`getMaxColoredExcitation()`
`PropertyMode`	`getMaxColoredExcitationMode()`
`MuscleMaterial`	`getMuscleMaterial()`
`double`	`getNetExcitation()` Returns the net excitation for this Excitable.
`java.util.LinkedList<MuscleElementDesc>`	`getNewElementsNearFibres(double dist)` Returns a list of MuscleElementDesc identifying all elements that are (a) within a specified distance of the fibres, and (b) not already referenced by this bundle.
`int`	`getRenderHints()` Returns a bit code giving rendering hints about this renderable.
`RenderProps`	`getRenderProps()` Returns the render properities for this object.
`void`	`getSelection(java.util.LinkedList<java.lang.Object> list, int qid)` Append to `list` the component (or components) associated with the `qid`-th selection query issued by this component's render method.
`void`	`getSoftReferences(java.util.List<ModelComponent> refs)` Appends all soft references for this component to a list.
`void`	`getState(DataBuffer data)` Saves state information for this component by adding data to the supplied DataBuffer.
`boolean`	`hasState()` Queries if this component has state.
`void`	`initialize(double t)`
`boolean`	`isSelectable()` Returns true if this object is in fact selectable.
`int`	`numSelectionQueriesNeeded()` If this selectable manages its own selection (by issuing selection queries within its `render` method), then this method should return the maximum number of selection queries that will be required.
`void`	`prerender(RenderList list)` Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates).
`void`	`propertyChanged(PropertyChangeEvent e)`
`boolean`	`removeElement(MuscleElementDesc desc)`
`boolean`	`removeExcitationSource(ExcitationComponent ex)` Removes an excitation source from this Excitable.
`boolean`	`removeFibre(Muscle fibre)`
`void`	`render(Renderer renderer, int flags)` Render this object using the functionality of the supplied `Renderer`.
`void`	`scaleDistance(double s)`
`void`	`scaleMass(double s)`
`void`	`setCombinationRule(ExcitationComponent.CombinationRule rule)` Sets the rule for combining excitations.
`void`	`setDefaultValues()` Sets the attributes of this component to their default values.
`void`	`setDirectionRenderLen(double size)`
`void`	`setDirectionRenderLenMode(PropertyMode mode)`
`void`	`setDirectionRenderType(MuscleBundle.DirectionRenderType type)`
`void`	`setDirectionRenderTypeMode(PropertyMode mode)`
`void`	`setElementWidgetSize(double size)`
`void`	`setElementWidgetSizeMode(PropertyMode mode)`
`void`	`setExcitation(double a)` SetsJust reiterating the primary excitation for this component.
`void`	`setExcitationColor(java.awt.Color color)`
`void`	`setExcitationColorMode(PropertyMode mode)`
`boolean`	`setExcitationGain(ExcitationComponent ex, double gain)` Sets the gain for an excitation source in this component.
`void`	`setFibresActive(boolean active)`
`void`	`setMaxColoredExcitation(double excitation)`
`void`	`setMaxColoredExcitationMode(PropertyMode mode)`
`void`	`setMaxForce(double maxForce)`
`<T extends MuscleMaterial> void`	`setMuscleMaterial(T mat)`
`void`	`setRenderProps(RenderProps props)` Assigns a new set of render properties to this object.
`void`	`setState(DataBuffer data)` Restores the state for this component by reading from the supplied data buffer, starting at the current buffer offsets.
`void`	`transformGeometry(AffineTransform3dBase X)` Applies an affine transformation to the geometry of this component.
`void`	`transformGeometry(GeometryTransformer gtr, TransformGeometryContext context, int flags)` Transforms the geometry of this component, using the geometry transformer `gtr` to transform its individual attributes.
`void`	`updateBounds(Vector3d pmin, Vector3d pmax)` Update the minimum and maximum points for this object.
`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.CompositeComponentBase
componentChanged, copy, findComponent, get, get, getByNumber, getChildren, getNavpanelDisplay, getNumberLimit, hasChildren, hierarchyContainsReferences, indexOf, iterator, numComponents, postscan, scan, setDisplayMode, updateNameMap

Methods inherited from class artisynth.core.modelbase.ModelComponentBase
checkFlag, checkName, checkNameUniqueness, clearFlag, clone, connectToHierarchy, createTempFlag, disconnectFromHierarchy, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getProperty, isFixed, isMarked, isScanning, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, setFixed, setFlag, setMarked, setName, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setScanning, setSelected, setWritable, 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, isFixed, isMarked, isSelected, notifyParentOfChange, scan, setFixed, setMarked, setName, setNumber, setParent, setSelected, setWritable

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.modelbase.HasNumericState
advanceState, getAuxVarDerivative, getAuxVarState, getStateVersion, numAuxVars, requiresAdvance, setAuxVarState

- Field Detail
  - myProps
```
public static PropertyList myProps
```
- Constructor Detail
  - MuscleBundle
```
public MuscleBundle()
```
  - MuscleBundle
```
public MuscleBundle(java.lang.String name)
```
- Method Detail
  - setDefaultValues
```
public void setDefaultValues()
```
    Description copied from class: ModelComponentBase
    
    Sets the attributes of this component to their default values.
  - getExcitationColor
```
public java.awt.Color getExcitationColor()
```
  - setExcitationColor
```
public void setExcitationColor(java.awt.Color color)
```
  - getExcitationColorMode
```
public PropertyMode getExcitationColorMode()
```
  - setExcitationColorMode
```
public void setExcitationColorMode(PropertyMode mode)
```
  - getMaxColoredExcitation
```
public double getMaxColoredExcitation()
```
  - setMaxColoredExcitation
```
public void setMaxColoredExcitation(double excitation)
```
  - getMaxColoredExcitationMode
```
public PropertyMode getMaxColoredExcitationMode()
```
  - setMaxColoredExcitationMode
```
public void setMaxColoredExcitationMode(PropertyMode mode)
```
  - getFibresActive
```
public boolean getFibresActive()
```
  - setFibresActive
```
public void setFibresActive(boolean active)
```
  - 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
  - setElementWidgetSize
```
public void setElementWidgetSize(double size)
```
  - getElementWidgetSize
```
public double getElementWidgetSize()
```
  - setElementWidgetSizeMode
```
public void setElementWidgetSizeMode(PropertyMode mode)
```
  - getElementWidgetSizeMode
```
public PropertyMode getElementWidgetSizeMode()
```
  - setDirectionRenderLen
```
public void setDirectionRenderLen(double size)
```
  - getDirectionRenderLen
```
public double getDirectionRenderLen()
```
  - setDirectionRenderLenMode
```
public void setDirectionRenderLenMode(PropertyMode mode)
```
  - getDirectionRenderLenMode
```
public PropertyMode getDirectionRenderLenMode()
```
  - setDirectionRenderType
```
public void setDirectionRenderType(MuscleBundle.DirectionRenderType type)
```
  - getDirectionRenderType
```
public MuscleBundle.DirectionRenderType getDirectionRenderType()
```
  - setDirectionRenderTypeMode
```
public void setDirectionRenderTypeMode(PropertyMode mode)
```
  - getDirectionRenderTypeMode
```
public PropertyMode getDirectionRenderTypeMode()
```
  - getExcitation
```
public double getExcitation()
```
    Returns the primary excitation for this component.
    
    Specified by:
    
    getExcitation in interface ExcitationComponent
    
    Returns:
    
    primary excitation value
  - initialize
```
public void initialize(double t)
```
  - setExcitation
```
public void setExcitation(double a)
```
    SetsJust reiterating the primary excitation for this component.
    
    Specified by:
    
    setExcitation in interface ExcitationComponent
    
    Parameters:
    
    a - excitation value
  - setCombinationRule
```
public void setCombinationRule(ExcitationComponent.CombinationRule rule)
```
    Sets the rule for combining excitations.
    
    Specified by:
    
    setCombinationRule in interface ExcitationComponent
    
    Parameters:
    
    rule - rule for combining excitations
  - getCombinationRule
```
public ExcitationComponent.CombinationRule getCombinationRule()
```
    Return the combination rule for excitations.
    
    Specified by:
    
    getCombinationRule in interface ExcitationComponent
    
    Returns:
    
    combination rule for excitations
  - addExcitationSource
```
public void addExcitationSource(ExcitationComponent ex,
                                double gain)
```
    Adds a new excitation source to this Excitable with a specified gain.
    
    Specified by:
    
    addExcitationSource in interface ExcitationComponent
    
    Parameters:
    
    ex - excitatation source to be added
    
    gain - gain for the source
  - removeExcitationSource
```
public boolean removeExcitationSource(ExcitationComponent ex)
```
    Removes an excitation source from this Excitable. Returns false if the source was not present.
    
    Specified by:
    
    removeExcitationSource in interface ExcitationComponent
    
    Parameters:
    
    ex - excitatation source to be removed
    
    Returns:
    
    true if the source was present and removed
  - getExcitationGain
```
public double getExcitationGain(ExcitationComponent ex)
```
    Gets the gain for an excitation source in this component.
    
    Specified by:
    
    getExcitationGain in interface ExcitationComponent
    
    Parameters:
    
    ex - excitatation source whose gain is to be queried
    
    Returns:
    
    source gain value, or -1 if the source is not present in this component.
  - setExcitationGain
```
public boolean setExcitationGain(ExcitationComponent ex,
                                 double gain)
```
    Sets the gain for an excitation source in this component.
    
    Specified by:
    
    setExcitationGain in interface ExcitationComponent
    
    Parameters:
    
    ex - excitatation source whose gain is to be modified
    
    gain - new gain for the source
    
    Returns:
    
    false if the source is not present in this component.
  - getNetExcitation
```
public double getNetExcitation()
```
    Returns the net excitation for this Excitable. The net excitation is the combination of the primary excitation and the net excitations of all the excitation sources.
    
    Specified by:
    
    getNetExcitation in interface ExcitationComponent
    
    Returns:
    
    net excitation for this Excitable
  - getSoftReferences
```
public void getSoftReferences(java.util.List<ModelComponent> refs)
```
    Appends all soft references for this component to a list. References are other components, outside of this component's immediate ancestry, on which this component depends. For example, an ExcitationComponent may refer to one or more other ExcitationComponents to act as excitation sources. A soft reference is one which can be removed from the referring component. In particular, if any soft references for a component are deleted, then that component's updateReferences() method will be called to update its internal reference information.
    
    Specified by:
    
    getSoftReferences in interface ModelComponent
    
    Overrides:
    
    getSoftReferences in class ModelComponentBase
    
    Parameters:
    
    refs - list to which soft references are appended
  - updateReferences
```
public 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. If called with undo equal to false, this component should then examine its soft references and use ComponentUtils.areConnected() 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.
    
    Specified by:
    
    updateReferences in interface ModelComponent
    
    Overrides:
    
    updateReferences in class ModelComponentBase
    
    Parameters:
    
    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.
  - getMuscleMaterial
```
public MuscleMaterial getMuscleMaterial()
```
  - createMuscleMaterial
```
public MuscleMaterial createMuscleMaterial()
```
  - setMuscleMaterial
```
public <T extends MuscleMaterial> void setMuscleMaterial(T mat)
```
  - applyForce
```
public void applyForce(double t)
```
  - applyForces
```
public void applyForces(double t)
```
    Apply forces due to fibres in bundle, consistent with force-effector
    
    Parameters:
    
    t - time at which force is applied
  - getJacobianType
```
public int getJacobianType()
```
    Return Jacobian type for use as force effector
    
    Returns:
    
    type code
  - setMaxForce
```
public void setMaxForce(double maxForce)
```
  - addPosJacobian
```
public void addPosJacobian(SparseNumberedBlockMatrix M,
                           double h)
```
  - addVelJacobian
```
public void addVelJacobian(SparseNumberedBlockMatrix M,
                           double h)
```
  - addSolveBlocks
```
public void addSolveBlocks(SparseNumberedBlockMatrix S)
```
  - getFibres
```
public AxialSpringList<Muscle> getFibres()
```
  - addFibre
```
public Muscle addFibre(Point p0,
                       Point p1,
                       AxialMaterial mat)
```
  - addFibre
```
public Muscle addFibre(Point p0,
                       Point p1,
                       AxialMaterial mat,
                       double l0)
```
  - addFibre
```
public void addFibre(Muscle fibre)
```
  - removeFibre
```
public boolean removeFibre(Muscle fibre)
```
  - clearFibres
```
public void clearFibres()
```
  - getElements
```
public MuscleElementDescList getElements()
```
  - addElement
```
public void addElement(MuscleElementDesc desc)
```
  - addElement
```
public MuscleElementDesc addElement(FemElement3dBase elem,
                                    Vector3d dir)
```
  - addElement
```
public MuscleElementDesc addElement(FemElement3dBase elem,
                                    Vector3d[] dirs)
```
  - removeElement
```
public boolean removeElement(MuscleElementDesc desc)
```
  - clearElements
```
public void clearElements()
```
  - getAncestorFem
```
public static FemModel3d getAncestorFem(ModelComponent comp)
```
  - getNewElementsNearFibres
```
public java.util.LinkedList<MuscleElementDesc> getNewElementsNearFibres(double dist)
```
    Returns a list of MuscleElementDesc identifying all elements that are (a) within a specified distance of the fibres, and (b) not already referenced by this bundle.
  - addElementsNearFibres
```
public void addElementsNearFibres(double dist)
```
  - addFiberMeshElements
```
public void addFiberMeshElements(double rad,
                                 PolylineMesh mesh)
```
  - getFibreRestDistanceInterpolator
```
public DelaunayInterpolator getFibreRestDistanceInterpolator()
```
  - getFibreRestDirections
```
public Vector3d[] getFibreRestDirections()
```
  - computeElementDirections
```
public void computeElementDirections()
```
    Computes the directions within individual elements based on the directions of the muscle fibres.
  - computeElementIpntDirections
```
public void computeElementIpntDirections()
```
    Computes the directions within individual elements based on the directions of the muscle fibres.
  - createRenderProps
```
public RenderProps createRenderProps()
```
    Description copied from interface: HasRenderProps
    
    Factory method to create render properties appropriate to this object.
    
    Specified by:
    
    createRenderProps in interface HasRenderProps
    
    Returns:
    
    new render properties for this object
  - getRenderProps
```
public RenderProps getRenderProps()
```
    Description copied from interface: HasRenderProps
    
    Returns the render properities for this object. If no render properties are assigned, this routines returns null.
    
    Specified by:
    
    getRenderProps in interface HasRenderProps
    
    Returns:
    
    current render properties for this object
  - setRenderProps
```
public void setRenderProps(RenderProps props)
```
    Description copied from interface: HasRenderProps
    
    Assigns a new set of render properties to this object. An argument of null will remove render properties from this object.
    
    Specified by:
    
    setRenderProps in interface HasRenderProps
    
    Parameters:
    
    props - new render properties for this object
  - prerender
```
public void prerender(RenderList list)
```
    Description copied from interface: IsRenderable
    
    Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates). The object may add internal objects to the list of objects being rendered, by calling
    list.addIfVisible (obj);
    for each of the objects in question.
    
    Specified by:
    
    prerender in interface IsRenderable
    
    Parameters:
    
    list - list of objects to be rendered
  - render
```
public void render(Renderer renderer,
                   int flags)
```
    Description copied from interface: IsRenderable
    
    Render this object using the functionality of the supplied Renderer.
    
    Specified by:
    
    render in interface IsRenderable
    
    Parameters:
    
    renderer - provides the functionality used to perform the rendering.
    
    flags - flags that may be used to control different aspects of the rendering. Flags are defined in Renderer and currently include Renderer.HIGHLIGHT and Renderer.SORT_FACES.
  - isSelectable
```
public boolean isSelectable()
```
    Returns true if this object is in fact selectable.
    
    Specified by:
    
    isSelectable in interface IsSelectable
    
    Returns:
    
    true if this object is selectable
  - numSelectionQueriesNeeded
```
public int numSelectionQueriesNeeded()
```
    Description copied from interface: IsSelectable
    
    If this selectable manages its own selection (by issuing selection queries within its render method), then this method should return the maximum number of selection queries that will be required. Otherwise, this method should return -1.
    
    Specified by:
    
    numSelectionQueriesNeeded in interface IsSelectable
    
    Returns:
    
    maximum number of selection queries needed by this component, or -1 if this component does not manage its own selection.
  - updateBounds
```
public void updateBounds(Vector3d pmin,
                         Vector3d pmax)
```
    Description copied from interface: IsRenderable
    
    Update the minimum and maximum points for this object. In an x-y-z coordinate system with x directed to the right and y directed upwards, the minimum and maximum points can be thought of as defining the left-lower-far and right-upper-near corners of a bounding cube. This method should only reduce the elements of the minimum point and increase the elements of the maximum point, since it may be used as part of an iteration to determine the bounding cube for several different objects.
    
    Specified by:
    
    updateBounds in interface IsRenderable
    
    Parameters:
    
    pmin - minimum point
    
    pmax - maximum point
  - getRenderHints
```
public int getRenderHints()
```
    Description copied from interface: IsRenderable
    
    Returns a bit code giving rendering hints about this renderable. Current bit codes include TRANSPARENT and TWO_DIMENSIONAL.
    
    Specified by:
    
    getRenderHints in interface IsRenderable
    
    Returns:
    
    bit code of rendering hints.
  - getSelection
```
public void getSelection(java.util.LinkedList<java.lang.Object> list,
                         int qid)
```
    Description copied from interface: IsSelectable
    
    Append to list the component (or components) associated with the qid-th selection query issued by this component's render method. This will only be called if this component manages its own selection (i.e., the number nums returned by IsSelectable.numSelectionQueriesNeeded() is positive), and qid will in turn be a number between 0 and nums-1.
    
    Specified by:
    
    getSelection in interface IsSelectable
    
    Parameters:
    
    list - selected objects are appended to the end of this list
    
    qid - index of the selection query
  - scaleDistance
```
public void scaleDistance(double s)
```
  - scaleMass
```
public void scaleMass(double s)
```
  - addFascicle
```
public void addFascicle(java.util.LinkedList<Muscle> fascicle)
```
  - getFascicles
```
public java.util.ArrayList<java.util.LinkedList<Muscle>> getFascicles()
```
  - clearFascicles
```
public void clearFascicles()
```
  - transformGeometry
```
public void transformGeometry(AffineTransform3dBase X)
```
    Description copied from interface: TransformableGeometry
    Applies an affine transformation to the geometry of this component. This method should be equivalent to
```
 TransformGeometryContext.transform (this, X, 0);
 
```
    Specified by:
    
    transformGeometry in interface TransformableGeometry
    
    Parameters:
    
    X - affine transformation to apply to the component
  - transformGeometry
```
public void transformGeometry(GeometryTransformer gtr,
                              TransformGeometryContext context,
                              int flags)
```
    Description copied from interface: TransformableGeometry
    
    Transforms the geometry of this component, using the geometry transformer gtr to transform its individual attributes. The context argument supplies information about what other components are currently being transformed, and also allows the requesting of update actions to be performed after all transform called have completed. The context is also the usual entity that calls this method, from within its TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int) method. The argument flags provides flags to specify various conditions associated with the the transformation. At present, the available flags are TransformableGeometry.TG_SIMULATING and TransformableGeometry.TG_ARTICULATED.
    This method is not usually called directly by applications. Instead, it is typically called from within the TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int) method of the context, which takes care of the various operations needed for a complete transform operation, including calling TransformableGeometry.addTransformableDependencies(artisynth.core.modelbase.TransformGeometryContext, int) to collect other components that should be transformed, calling TransformableGeometry.transformGeometry(maspack.matrix.AffineTransform3dBase) for each component, notifying component parents that the geometry has changed, and calling any requested TransformGeometryActions. More details are given in the documentation for TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int).
    TransformGeometryContext provides a number of static convenience transform methods which take care of building the context and calling apply() for a specified set of components.
    This method should not generally call transformGeometry() for its descendant components. Instead, descendants needing transformation should be specified by adding them to the context in the method TransformableGeometry.addTransformableDependencies(artisynth.core.modelbase.TransformGeometryContext, int).
    
    Specified by:
    
    transformGeometry in interface TransformableGeometry
    
    Parameters:
    
    gtr - transformer implementing the transform
    
    context - context information, including what other components are being transformed
    
    flags - specifies conditions associated with the transformation
  - addTransformableDependencies
```
public void addTransformableDependencies(TransformGeometryContext context,
                                         int flags)
```
    Description copied from interface: TransformableGeometry
    
    Adds to context any transformable components which should be transformed as the same time as this component. This will generally include descendant components, and may also include other components to which this component is connected in some way.
    This method is generally called from with the TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int) method of a TransformGeometryContext.
    
    Specified by:
    
    addTransformableDependencies in interface TransformableGeometry
    
    Parameters:
    
    context - context information, to which the dependent components are added.
    
    flags - specifies conditions associated with the transformation
  - propertyChanged
```
public void propertyChanged(PropertyChangeEvent e)
```
    Specified by:
    
    propertyChanged in interface PropertyChangeListener
  - getFibreRestDistanceInterpolator
```
public static DelaunayInterpolator getFibreRestDistanceInterpolator(MuscleBundle... bundles)
```
    Utility method to create a rest distance interpolator for one or more muscle bundles.
  - getFibreRestDirections
```
public static Vector3d[] getFibreRestDirections(MuscleBundle... bundles)
```
    Utility method to create a list of fibre rest directions for one or more muscle bundles.
  - getState
```
public void getState(DataBuffer data)
```
    Description copied from interface: HasNumericState
    
    Saves state information for this component by adding data to the supplied DataBuffer. Existing data in the buffer should not be disturbed.
    
    Specified by:
    
    getState in interface HasNumericState
    
    Parameters:
    
    data - buffer for storing the state values.
  - setState
```
public void setState(DataBuffer data)
```
    Description copied from interface: HasNumericState
    
    Restores the state for this component by reading from the supplied data buffer, starting at the current buffer offsets.
    
    Specified by:
    
    setState in interface HasNumericState
    
    Parameters:
    
    data - buffer containing the state information
  - hasState
```
public boolean hasState()
```
    Description copied from interface: ModelComponent
    
    Queries if this component has state. Structure change events involving components that have state will cause the current state history of of the system to be cleared.
    
    Specified by:
    
    hasState in interface HasNumericState
    
    Specified by:
    
    hasState in interface ModelComponent
    
    Overrides:
    
    hasState in class CompositeComponentBase
    
    Returns:
    
    true if this component has state

Class MuscleBundle

Nested Class Summary

Nested classes/interfaces inherited from interface artisynth.core.mechmodels.ExcitationComponent

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

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

Field Summary

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

Fields inherited from interface maspack.render.IsRenderable

Fields inherited from interface artisynth.core.modelbase.TransformableGeometry

Constructor Summary

Method Summary

Methods inherited from class artisynth.core.modelbase.CompositeComponentBase

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

Methods inherited from class java.lang.Object

Methods inherited from interface artisynth.core.modelbase.ModelComponent

Methods inherited from interface maspack.properties.HasProperties

Methods inherited from interface maspack.properties.HierarchyNode

Methods inherited from interface artisynth.core.modelbase.PostScannable

Methods inherited from interface maspack.util.Scannable

Methods inherited from interface artisynth.core.modelbase.HasNumericState

Field Detail

myProps

Constructor Detail

MuscleBundle

MuscleBundle

Method Detail

setDefaultValues

getExcitationColor

setExcitationColor

getExcitationColorMode

setExcitationColorMode

getMaxColoredExcitation

setMaxColoredExcitation

getMaxColoredExcitationMode

setMaxColoredExcitationMode

getFibresActive

setFibresActive

getAllPropertyInfo

setElementWidgetSize

getElementWidgetSize

setElementWidgetSizeMode

getElementWidgetSizeMode

setDirectionRenderLen

getDirectionRenderLen

setDirectionRenderLenMode

getDirectionRenderLenMode

setDirectionRenderType

getDirectionRenderType

setDirectionRenderTypeMode

getDirectionRenderTypeMode

getExcitation

initialize

setExcitation

setCombinationRule

getCombinationRule

addExcitationSource

removeExcitationSource

getExcitationGain

setExcitationGain

getNetExcitation

getSoftReferences

updateReferences

getMuscleMaterial

createMuscleMaterial

setMuscleMaterial

applyForce

applyForces

getJacobianType

setMaxForce

addPosJacobian

addVelJacobian

addSolveBlocks

getFibres

addFibre

addFibre

addFibre

removeFibre

clearFibres

getElements

addElement