artisynth.core.modelbase

Interface Model

All Superinterfaces:

Disposable, HasProperties, HasState, HierarchyNode, ModelComponent, PostScannable, Scannable

All Known Subinterfaces:

MechSystemModel

All Known Implementing Classes:

ActuatedSkinning, 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, ConstrainedParticle, ContactForceMonitor, ContactPressureRender, ControlPanelDemo, CoordinateCouplingDemo, CSGAnimation, CSGCubeTest, CustomJointDemo, 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, EquilibriumMuscleTest, Fem3dBlock, FemBeam, FemBeam3d, FemBeamColored, FemBeamMech, FemBeamTest, FemBeamWithBlock, FemBeamWithFemSphere, FemBeamWithMuscle, FemCollision, FemCollisions, FemCutPlaneDemo, FemEmbeddedSphere, FemFieldTest, FemFrictionBeam, FemModel, FemModel3d, FemModelDeformer, FemMuscleArm, FemMuscleBeams, FemMuscleDemo, FemMuscleHeart, FemMuscleModel, FemPlaneCollide, FemSelfCollide, FemSkinCollide, FemSkinDemo, FemSkinTest, FemSurfaceTargetDemo, FemWithBeamBody, FishDemo, FixedBallContact, FixedMeshes, ForceTargetDemo, FourBar, FourBarLinkage, FrameBodyAttachment, FrameFemAttachment, FrameSpringDemo, FrameSpringPendulum, FrameTargetDemo, FrameTrackingTest, GeneralWrapTest, GimbalJointDemo, Hello, Hex3dBlock, HexBeam3d, HexCube, HexFrame, HexTrimTest, HingeJointDemo, HollowSphere, HydrostatDemo, HydrostatInvDemo, HydrostatModel, IncompressDemo, InstancedRenderingTest, IntersectionTest, 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, MeshTestBase, MeshViewer, MFreeModel3d, MFreeMuscleModel, MinimizeAxialSpringForce, MinimizeFrameSpringForce, ModelBase, MonteCarloElementTests, MonteCarloTest, MultiCollisionTest, MultiMuscleDemo, MultiSpringDemo, MultiSpringTest, MuscleArm, MyFEMonster, MyFinishedMonster, MyMonster, NetDemo, NetDemoWithPan, NetDemoWithRefs, NewtonsCradle, OneBasedNumbering, OneStrandWrapBase, OpenSimCustomJointTest, OpenSimSpine, OpenSimTest, ParametricTestBase, ParticleAttachment, ParticleSpring, PenetrationRender, PhalanxSkinWrapping, PhalanxWrapping, PlanarConnectorDemo, PlanarJointDemo, PlanarTranslationJointDemo, PlaneConstrainedFem, PointFemAttachment, PointForceDemo, PointMeshForces, PointMeshForceTest, PointMeshTest, PointModel, PointModel1d, PointModel2d, PointModel3d, PointPlaneForces, PointPlaneForceTest, PointToPointMuscle, PolygonalMeshTest, PolylineMeshTest, PressureShell, ProximalHumerusWrapping, PuppetDemo, PyramidBeam3d, QuadFishDemo, QuadGridTangent, QuadhexBeam3d, QuadpyramidBeam3d, QuadraticLockingDemo, QuadraticTorus, QuadtetBeam3d, QuadwedgeBeam3d, RadialMuscle, RedundantCollisionTest, ReflectedBodies, RegularSamplingElementTests, RenderableModelBase, RenderDemo, RigidBodyCollision, RigidBodyDemo, RigidBodyJoint, RigidBodySkinning, RigidBodySpring, RigidCollisionTest, RigidCompositeBody, RigidCompositeCollide, 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, SliderJointDemo, SlidingFem, SlottedHingeJointDemo, SlottedRevoluteJointDemo, SpecularTest, SphericalJointDemo, SphericalTextureMapping, SpinControlProbe, SpongeDemo, SpongeModel, SpringMeshDemo, TalusWrapping, TalusWrapTest, Template, TetBeam3d, TetCube, TextTest, TorusDemo, TorusWrapping, TorusWrapTest, TorusWrapTest, ToyMuscleArm, ToyMuscleFem, Trampoline, TransverseIsotropy, TransverseIsotropyTest, TrimmedElements, TubeDemo, TwoStrandWrapBase, TwoStrandWrapBase, UniversalJointDemo, VariableElasticContact, VariableStiffness, VectorElementFieldDemo, VectorFaceFieldDemo, VectorGridFieldDemo, VectorNodalFieldDemo, VectorSubElemFieldDemo, VectorVertexFieldDemo, ViaPointMuscle, ViscousBeam, WedgeBeam3d, WrappedMuscleArm, WrappedShellTest, WrapTestBase

public interface Model
extends ModelComponent, Disposable, HasState

Basic interface requirements for all Artisynth models

Nested Class Summary

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

ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATE_IS_VOLATILE Flag for advance(double, double, int) indicating that the model's state may have been changed or restored immediately prior to the method call.

Method Summary

Modifier and Type	Method and Description
StepAdjustment	advance(double t0, double t1, int flags) Advances this model from time t0 to time t1.
void	dispose() Called when the model is discarded.
double	getMaxStepSize() Returns the maximum step by which this object should be advanced within a simulation loop.
void	initialize(double t) Causes this model to initialize itself at time t.
StepAdjustment	preadvance(double t0, double t1, int flags) Prepares this model for advance from time t0 to time t1.

Methods inherited from interface artisynth.core.modelbase.ModelComponent

connectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, getSoftReferences, hasState, isFixed, isMarked, isSelected, notifyParentOfChange, scan, setFixed, setMarked, setName, setNumber, setParent, setSelected, setWritable, updateReferences

Methods inherited from interface maspack.properties.HasProperties

getAllPropertyInfo, 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.HasState

createState, getInitialState, getState, setState

Field Detail

STATE_IS_VOLATILE

static final int STATE_IS_VOLATILE

Flag for advance(double, double, int) indicating that the model's state may have been changed or restored immediately prior to the method call. This means that advance(double, double, int) may wish to perform its computations in a way as to ensure precise numeric repeatability if this is the case.

See Also:

Constant Field Values

Method Detail

initialize

void initialize(double t)

Causes this model to initialize itself at time t. This method will be called at the very beginning of the simulation (with t = 0), or immediately after the model's state has been reset using HasState.setState(artisynth.core.modelbase.ComponentState), in which case t may have an arbitrary value.

Parameters:

t - initialization time (seconds)

preadvance

StepAdjustment preadvance(double t0,
                          double t1,
                          int flags)

Prepares this model for advance from time t0 to time t1. Often this method does nothing; it is provided in case a model needs to update internal state at the very beginning a step before input probes and controllers are applied.

If the method determines that the step size should be reduced, it can return a StepAdjustment object indicating the recommended reduction. Otherwise, the method may return null

The flags argument gives additional information that may be relevant when advancing the model. Currently implemented flags include STATE_IS_VOLATILE.

Parameters:

t0 - current time (seconds)

t1 - new time to advance to (seconds)

flags - additional information relevant to the advance

Returns:

null, or a step adjustment recommendation

advance

StepAdjustment advance(double t0,
                       double t1,
                       int flags)

Advances this model from time t0 to time t1.

If the method determines that the step size should be reduced, it can return a StepAdjustment object indicating the recommended reduction. Otherwise, the method may return null

The flags argument gives additional information that may be relevant when advancing the model. Currently implemented flags include STATE_IS_VOLATILE.

Parameters:

t0 - current time (seconds)

t1 - new time to advance to (seconds)

flags - rdditional information relevant to the advance

Returns:

null, or a step adjustment recommendation

getMaxStepSize

double getMaxStepSize()

Returns the maximum step by which this object should be advanced within a simulation loop.

Returns:

maximum step size (seconds)

dispose

void dispose()

Called when the model is discarded. Disposes of any resources used.

Specified by:

dispose in interface Disposable