MultiPointSpring.WrapSegment (Artisynth API documentation)

java.lang.Object
- artisynth.core.mechmodels.MultiPointSpring.Segment
- - artisynth.core.mechmodels.MultiPointSpring.WrapSegment

All Implemented Interfaces:

HasNumericState, java.lang.Cloneable, Clonable

Enclosing class:

MultiPointSpring
```
public class MultiPointSpring.WrapSegment
extends MultiPointSpring.Segment
implements HasNumericState
```
Implements a wrappable segment. This is done by dividing the segment into a fixed number of "knots", which are attracted to each other and out of the interior of "wrappable" objects using linear elastic forces. Once per time step, these forces are used to iteratively update the knot positions so as to "shrink wrap" the segment around whatever wrappables it is associated with. The physics used to do this is first-order, and independent of the second order physics of the overall simulation.

Field Summary
- Fields inherited from class artisynth.core.mechmodels.MultiPointSpring.Segment
  myPntA, myPntB

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MultiPointSpring.WrapSegment`	`clone()` Creates a clone of this wrappable segment.
`double`	`computeEnergy()` Computes the elastic energy for the strand, given by the tension between adjacent knots, plus the repulsion forces pushing knots out of any wrappable which they are penetrating.
`MultiPointSpring.SubSegment`	`firstSubSegment()` If this segment has subsegments, return the first subsegment.
`Point`	`getABPoint(int idx)` Return the A/B in this wrappable segment indexed by `idx`, (which should be less than the number of A/B points returned by `numABPoints()`.
`double`	`getForceTol()` Returns the force tolerance for this segment that corresponds to the current convergence tolerance.
`MultiPointSpring.WrapKnot`	`getKnot(int idx)` Returns the `idx`-th knot in this wrappable segment.
`void`	`getState(DataBuffer data)` Saves state information for this component by adding data to the supplied DataBuffer.
`int`	`getStateVersion()` Returns a version number for this component's state.
`boolean`	`hasState()` Returns `true` if this component currently holds state.
`boolean`	`hasSubSegments()` Queries whether this segment has subsegments.
`boolean`	`inContact()` Returns true if this wrappable segment is in contact with one or more wrappables.
`void`	`initializeStrand(java.util.ArrayList<Point3d> pnts)` Initialize the knots in the strand so that they are distributed evenly along a specified list of points.
`void`	`initializeStrand(Point3d[] initialPnts)` Initialize the knots in the strand so that they are distributed evenly along the piecewise-linear path specified by the start and end points and any initialization points that may have been specified.
`MultiPointSpring.SubSegment`	`lastSubSegment()` If this segment has subsegments, return the last subsegment.
`int`	`numABPoints()` Return the number of A/B points currently active in this wrappable segment.
`int`	`numKnots()` Queries the number of knots in this wrappable segment.
`void`	`setState(DataBuffer data)` Restores the state for this component by reading from the supplied data buffer, starting at the current buffer offsets.

Methods inherited from class artisynth.core.mechmodels.MultiPointSpring.Segment
getLength, getPntB

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface artisynth.core.modelbase.HasNumericState
advanceState, getAuxVarDerivative, getAuxVarState, numAuxVars, requiresAdvance, setAuxVarState

- Method Detail
  - getABPoint
```
public Point getABPoint(int idx)
```
    Return the A/B in this wrappable segment indexed by idx, (which should be less than the number of A/B points returned by numABPoints().
  - numABPoints
```
public int numABPoints()
```
    Return the number of A/B points currently active in this wrappable segment.
  - initializeStrand
```
public void initializeStrand(Point3d[] initialPnts)
```
    Initialize the knots in the strand so that they are distributed evenly along the piecewise-linear path specified by the start and end points and any initialization points that may have been specified.
  - initializeStrand
```
public void initializeStrand(java.util.ArrayList<Point3d> pnts)
```
    Initialize the knots in the strand so that they are distributed evenly along a specified list of points. This list is assumed to begin and end with the strand's start point (myPntB) and end point (myPntA).
  - getForceTol
```
public double getForceTol()
```
    Returns the force tolerance for this segment that corresponds to the current convergence tolerance. See MultiPointSpring.setConvergenceTol(double) for details.
  - computeEnergy
```
public double computeEnergy()
```
    Computes the elastic energy for the strand, given by the tension between adjacent knots, plus the repulsion forces pushing knots out of any wrappable which they are penetrating.
  - inContact
```
public boolean inContact()
```
    Returns true if this wrappable segment is in contact with one or more wrappables.
  - numKnots
```
public int numKnots()
```
    Queries the number of knots in this wrappable segment.
    
    Returns:
    
    number of knots
  - getKnot
```
public MultiPointSpring.WrapKnot getKnot(int idx)
```
    Returns the idx-th knot in this wrappable segment.
    
    Parameters:
    
    idx - indexed of the desired knot
    
    Returns:
    
    idx-th knot
  - firstSubSegment
```
public MultiPointSpring.SubSegment firstSubSegment()
```
    If this segment has subsegments, return the first subsegment. Otherwise, return null.
    
    Overrides:
    
    firstSubSegment in class MultiPointSpring.Segment
  - lastSubSegment
```
public MultiPointSpring.SubSegment lastSubSegment()
```
    If this segment has subsegments, return the last subsegment. Otherwise, return null.
    
    Overrides:
    
    lastSubSegment in class MultiPointSpring.Segment
  - hasSubSegments
```
public boolean hasSubSegments()
```
    Queries whether this segment has subsegments.
    
    Overrides:
    
    hasSubSegments in class MultiPointSpring.Segment
    
    Returns:
    
    true if this segment has subsegments.
  - getState
```
public void getState(DataBuffer data)
```
    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)
```
    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()
```
    Returns true if this component currently holds state. This allows the presence of state to depend on the component's configuration.
    
    Specified by:
    
    hasState in interface HasNumericState
    
    Returns:
    
    true if this component holds state
  - getStateVersion
```
public int getStateVersion()
```
    Returns a version number for this component's state. When the version number changes, any previously saved state should be considered no longer compatible. The default implementation of this method always returns 0, indicating that state compatibility never changes.
    
    Specified by:
    
    getStateVersion in interface HasNumericState
  - clone
```
public MultiPointSpring.WrapSegment clone()
```
    Creates a clone of this wrappable segment.
    
    Specified by:
    
    clone in interface Clonable
    
    Overrides:
    
    clone in class MultiPointSpring.Segment

Class MultiPointSpring.WrapSegment

Field Summary

Fields inherited from class artisynth.core.mechmodels.MultiPointSpring.Segment

Method Summary

Methods inherited from class artisynth.core.mechmodels.MultiPointSpring.Segment

Methods inherited from class java.lang.Object

Methods inherited from interface artisynth.core.modelbase.HasNumericState

Method Detail

getABPoint

numABPoints

initializeStrand

initializeStrand

getForceTol

computeEnergy

inContact

numKnots

getKnot

firstSubSegment

lastSubSegment

hasSubSegments

getState

setState

hasState

getStateVersion

clone