artisynth.core.modelbase

Interface HasNumericState

All Known Subinterfaces:

CollidableDynamicComponent, DynamicAgent, DynamicComponent, MaterialStateObject, MotionTargetComponent

All Known Implementing Classes:

AxialSpring, BackNode3d, BeamBody, BodyConnector, BSpline3dElement, CollisionHandler, CollisionManager, ConstrainerBase, CustomJoint, CylindricalJoint, DeformableBody, DicomPlaneViewer, DicomViewer, DynamicComponentBase, EBBeamBody, FemElement, FemElement3d, FemElement3dBase, FemMarker, FemModel3d, FemModelDeformer, FemModelFrame, FemMuscleModel, FemNode, FemNode3d, FixedAxisJoint, Frame, FrameFem3dConstraint, FrameMarker, FrameNode3d, FreeJoint, GenericMarker, GimbalJoint, HexElement, HingeJoint, HydrostatModel, ImageViewer, JointBase, LinearPointConstraint, Marker, MechSystemBase.ConstraintForceStateSaver, MFreeElement3d, MFreeModel3d, MFreeMuscleModel, MFreeNode3d, MultiPointMuscle, MultiPointMuscleVia, MultiPointSpring, MultiPointSpring.WrapSegment, Muscle, NiftiViewer, OpenSimCustomJoint, Particle, ParticleConstraintBase, ParticleLineConstraint, ParticleMeshConstraint, ParticlePlaneConstraint, PlanarConnector, PlanarJoint, PlanarPoint, PlanarTranslationJoint, Point, PointSpringBase, PointToPointMuscle, PyramidElement, QLVState, QuadhexElement, QuadpyramidElement, QuadtetElement, QuadwedgeElement, RevoluteJoint, RigidBody, RigidCompositeBody, RigidCylinder, RigidEllipsoid, RigidMesh, RigidSphere, RigidTorus, RollPitchJoint, SegmentedPlanarConnector, ShellElement3d, ShellQuadElement, ShellTriElement, SimpleCoordinateCoupler, SkewedUniversalJoint, SkinMarker, SliderJoint, SlottedHingeJoint, SolidJoint, SphericalJoint, SphericalJointBase, SphericalRpyJoint, SpongeModel, TargetFrame, TargetPoint, TetElement, TexturePlaneBase, UniversalJoint, ViscoelasticState, WedgeElement

public interface HasNumericState

Indicates a model component that has state information that can be stored inside a DataBuffer.

Method Summary

Modifier and Type	Method and Description
default void	advanceState(double t0, double t1) Called at the very beginning of the time step (in the system's preadvance() method) to perform any required updating of the component's state before the application in input probes or controllers.
void	getState(DataBuffer data) Saves state information for this component by adding data to the supplied DataBuffer.
default int	getStateVersion() Returns a version number for this component's state.
boolean	hasState() Specifies whether this component currently hold state.
void	setState(DataBuffer data) Restores the state for this component by reading from the supplied data buffer, starting at the current buffer offsets.

Method Detail

advanceState

default void advanceState(double t0,
                          double t1)

Called at the very beginning of the time step (in the system's preadvance() method) to perform any required updating of the component's state before the application in input probes or controllers. If no such updating is required, this method may do nothing.

Parameters:

t0 - beginning time associated with the time step advance

t1 - end time associated with the time step advance

getState

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.

Parameters:

data - buffer for storing the state values.

setState

void setState(DataBuffer data)

Restores the state for this component by reading from the supplied data buffer, starting at the current buffer offsets.

Parameters:

data - buffer containing the state information

hasState

boolean hasState()

Specifies whether this component currently hold state.

getStateVersion

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