artisynth.core.modelbase

Interface HasState

All Known Subinterfaces:

Controller, MechSystemModel, Model, ModelAgent, Monitor

All Known Implementing Classes:

ActuatedSkinning, AffineNumericInputProbe, AjlCollisionTest, AllBodySkinning, AnalyticGeometryTests, ArgsTest, ArticulatedBeamBody, ArticulatedDemo, ArticulatedFem, AttachDemo, AttachedBeamBody, AttachedBeamDemo, AttachedMuscleBeam, BallPlateCollide, BeamBodyCollide, BigBeam3d, BlockTest, BlockTestX, BodyBodyAttachment, BodyBodyJoint, BodyFemAttachment, BodyForceRendering, BSpline3dElementTest, CollisionTestBase, ColoredMeshDemo, ColoredSphereTest, CombinedElemFem, CombinedShellFem, CompliantConstraintDemo, ConditionalMarkerDemo, ConnectorBoundsRenderer, ConnectorForceRenderer, ConstrainedParticle, ContactForceMonitor, ContactPressureRender, ControllerBase, ControllerMonitorBase, ControlPanelDemo, CoordinateCouplingDemo, CSGAnimation, CSGCubeTest, CustomJointDemo, CutPlaneProbe, CylinderBounceTest, CylinderWrapping, CylindricalJointDemo, DeformedJointedCollide, DicomLoader, DicomTest, DoubleArmDemo, DrawModeTest, DynamicWrapTest, EdgeEdgeCollisionTest, EditableMeshTest, EFCForceTest, ElasticFoundationContact, EllipsoidJoint3dDemo, EllipsoidJointDemo, EllipsoidWrapTest, EmbeddedCollisionTest, EmbeddedEmbeddedCollide, EmbeddedHeart, EmbeddedSphere, EmbeddedSurface, EmbeddedSurfaceCollide, EmbeddedTest, EmbeddedTongue, EmbeddedWeighting, EquilibriumMuscleDemo, EquilibriumMuscleDemo.LengthController, EquilibriumMuscleTest, EquilibriumMuscleTest.LengthController, ExactForceProbe, ExactMomentProbe, Fem3dBlock, FemBeam, FemBeam3d, FemBeamColored, FemBeamMech, FemBeamTest, FemBeamWithBlock, FemBeamWithFemSphere, FemBeamWithMuscle, FemCollision, FemCollisions, FemCutPlaneDemo, FemDisplayProbe, FemEmbeddedSphere, FemFieldTest, FemFrictionBeam, FemModel, FemModel3d, FemModelDeformer, FemMuscleArm, FemMuscleBeams, FemMuscleDemo, FemMuscleHeart, FemMuscleModel, FemPlaneCollide, FemSelfCollide, FemSkinCollide, FemSkinDemo, FemSkinTest, FemSurfaceTargetDemo, FemSurfaceTargetDemo.SurfaceTargetController, FemWithBeamBody, FishDemo, FixedBallContact, FixedMeshes, ForceErrorProbe, ForceProbe, ForceTargetDemo, FourBar, FourBarLinkage, FrameBodyAttachment, FrameFemAttachment, FrameSpringDemo, FrameSpringPendulum, FrameTargetDemo, FrameTargetDemo.FrameController, FrameTrackingProbe, FrameTrackingTest, GeneralWrapTest, GimbalJointDemo, Hello, Hex3dBlock, HexBeam3d, HexCube, HexFrame, HexTrimTest, HingeJointDemo, HollowSphere, HydrostatDemo, HydrostatInvDemo, HydrostatModel, ImagePlaneProbe, ImageProbe, IncompressDemo, InputProbe, InstancedRenderingTest, IntersectionTest, IntersectionTester, InverseFrameExciterArm, InverseMuscleArm, InverseMuscleFem, InverseMuscleFemGen, InverseParticle, InverseSpringForce, InverseTest, JointedBallCollide, JointedCollide, JointedFemBeams, JointLimitDemo, KnotDensityTest, KnotDensityTest2, KnotDensityTest3, LaymanBowl, LaymanDemo, LaymanModel, LeafBranchDemo, LeafDemo, LegTracking, LinearAuxiliaryTest, LinearPointConstraintTest, LockingDemo, LumbarFEMDisk, LumbarFrameSpring, MappingDemo, MappingTest, MassSpringDemo, MaterialBundleDemo, MaxwellElement, MechModel, MechModelCollide, MechModelDemo, MechSystemBase, MeshBodyTest, MeshEditTest, MeshIntersectingProbe, MeshTestBase, MeshViewer, MFreeModel3d, MFreeMuscleModel, MinimizeAxialSpringForce, MinimizeFrameSpringForce, ModelAgentBase, ModelBase, MomentProbe, MonitorBase, MonteCarloElementTests, MonteCarloTest, MultiCollisionTest, MultiMuscleDemo, MultiSpringDemo, MultiSpringTest, MuscleArm, MyFEMonster, MyFinishedMonster, MyMonster, NetDemo, NetDemoWithPan, NetDemoWithRefs, NewtonsCradle, NumericControlProbe, NumericDataFunctionProbe, NumericDifferenceProbe, NumericInputProbe, NumericMonitorProbe, NumericOutputProbe, NumericProbeBase, OneBasedNumbering, OneStrandWrapBase, OpenSimCustomJointTest, OpenSimCustomJointTest.JointMonitor, OpenSimSpine, OpenSimTest, OutputProbe, PanController, ParametricTestBase, ParametricTestBase.EndpointPenetrationMonitor, ParametricTestBase.ParametricMotionControllerBase, ParticleAttachment, ParticleSpring, PenetrationRender, PhalanxSkinWrapping, PhalanxWrapping, PlanarConnectorDemo, PlanarJointDemo, PlanarTranslationJointDemo, PlaneConstrainedFem, PointFemAttachment, PointForceDemo, PointMeshForces, PointMeshForceTest, PointMeshTest, PointModel, PointModel1d, PointModel2d, PointModel3d, PointPlaneForces, PointPlaneForceTest, PointToPointMuscle, PointTracingProbe, PolygonalMeshTest, PolylineMeshTest, PressureShell, Probe, ProximalHumerusWrapping, PullController, PuppetDemo, PyramidBeam3d, QuadFishDemo, QuadGridTangent, QuadhexBeam3d, QuadpyramidBeam3d, QuadraticLockingDemo, QuadraticTorus, QuadtetBeam3d, QuadwedgeBeam3d, RadialMuscle, RedundantCollisionTest, ReflectedBodies, RegularSamplingElementTests, RenderableModelBase, RenderDemo, RenderProbe, RigidBodyCollision, RigidBodyDemo, RigidBodyJoint, RigidBodySkinning, RigidBodySpring, RigidCollisionTest, RigidCompositeBody, RigidCompositeCollide, RigidTransformInputProbe, RigidVertexCollide, RobustCube, RollingFem, RootModel, ScalarElementFieldDemo, ScalarFaceFieldDemo, ScalarFieldVisualization, ScalarGridFieldDemo, ScalarNodalFieldDemo, ScalarSubElemFieldDemo, ScalarVertexFieldDemo, SDGridTest, SegmentedPlaneDemo, SelfCollision, ShellBlock, ShellMembraneDemo, ShellQuadPatch, ShellShellAttach, ShellTriPatch, ShellVolumeAttach, ShoulderSkinWrapping, ShoulderWrapping, SignedDistanceCollide, SimpleCollide, SimpleMuscle, SimpleMuscleWithController, SimpleMuscleWithInlineProbe, SimpleMuscleWithPanel, SimpleMuscleWithProbes, SimpleMuscleWithProperties, SinCosMonitorProbe, SingleHex, SinglePyramid, SingleQuadhex, SingleQuadpyramid, SingleQuadtet, SingleQuadwedge, SingleShellQuad, SingleShellTri, SingleTet, SingleWedge, SkinBodyCollide, SkinCollisionTest, SkinDemo, SkullParticles, SleepProbe, SliderJointDemo, SlidingFem, SlottedHingeJointDemo, SlottedRevoluteJointDemo, SpecularTest, SphericalJointDemo, SphericalTextureMapping, SpinControlProbe, SpongeDemo, SpongeModel, SpringMeshDemo, TalusWrapping, TalusWrapTest, Template, TetBeam3d, TetCube, TextTest, TorusDemo, TorusWrapping, TorusWrapTest, TorusWrapTest, ToyMuscleArm, ToyMuscleFem, TracingProbe, TrackingController, Trampoline, TransparencyProbe, TransverseIsotropy, TransverseIsotropyTest, TrimmedElements, TubeDemo, TwoStrandWrapBase, TwoStrandWrapBase, UniversalJointDemo, VariableElasticContact, VariableStiffness, VectorElementFieldDemo, VectorFaceFieldDemo, VectorGridFieldDemo, VectorNodalFieldDemo, VectorSubElemFieldDemo, VectorTracingProbe, VectorVertexFieldDemo, ViaPointMuscle, ViscousBeam, WayPointProbe, WedgeBeam3d, WrappedMuscleArm, WrappedShellTest, WrapTestBase, WrapTestBase.ABPointsMonitor, WrapTestBase.HasUpdateFileMonitor, WrapTestBase.PropertyMonitor

public interface HasState

Interface for a model component that can contain state and can save and restore this state to a ComponentState object.

Method Summary

Modifier and Type	Method and Description
ComponentState	createState(ComponentState prevState) Factory routine to create a state object for this component, which can then be used as an argument for setState(artisynth.core.modelbase.ComponentState) and getState(artisynth.core.modelbase.ComponentState).
void	getInitialState(ComponentState state, ComponentState prevstate) Gets an initial state for this component and returns the value in state.
void	getState(ComponentState state) Get the current state of this component.
void	setState(ComponentState state) Set the state of this component.

Method Detail

setState

void setState(ComponentState state)

Set the state of this component.

Parameters:

state - state to be copied

Throws:

java.lang.IllegalArgumentException - if the supplied state object is incompatible with this component

getState

void getState(ComponentState state)

Get the current state of this component.

Parameters:

state - receives the state information

Throws:

java.lang.IllegalArgumentException - if the supplied state object is incompatible with this component

getInitialState

void getInitialState(ComponentState state,
                     ComponentState prevstate)

Gets an initial state for this component and returns the value in state. If prevstate is non-null, then it is assumed to contain a previous initial state value returned by this method, and state should be set to be as consistent with this previous state as possible. For example, suppose that this component currently contains subcomponents A, B, and C, while the prevstate contains the state from a previous time when it had components B, C, and D. Then state should contain substate values for B and C that are taken from prevstate. To facilitate this, the information returned in state should contain additional information such as the identities of all the (current) subcomponents.

Parameters:

state - receives the state information

prevstate - previous state information; may be null.

Throws:

java.lang.IllegalArgumentException - if the supplied state object is incompatible with this component

createState

ComponentState createState(ComponentState prevState)

Factory routine to create a state object for this component, which can then be used as an argument for setState(artisynth.core.modelbase.ComponentState) and getState(artisynth.core.modelbase.ComponentState). The state object does not have to be set to the component's current state. If the component does not have any state information, this method should return an instance of EmptyState.

Parameters:

prevState - If non-null, supplies a previous state that was created by this component and which can be used to provide pre-sizing hints.

Returns:

new object for storing this component's state