RootModel (Artisynth API documentation)

java.lang.Object
- artisynth.core.modelbase.ModelComponentBase
- - artisynth.core.modelbase.ComponentList<ModelComponent>
  - - artisynth.core.modelbase.ModelBase
    - - artisynth.core.modelbase.RenderableModelBase
      - artisynth.core.workspace.RootModel

All Implemented Interfaces:

ComponentChangeListener, ComponentListView<ModelComponent>, CompositeComponent, HasMenuItems, HasState, IndexedComponentList, Model, ModelComponent, MutableCompositeComponent<ModelComponent>, PostScannable, RenderableComponent, java.awt.event.ActionListener, java.lang.Cloneable, java.lang.Iterable<ModelComponent>, java.util.Collection<ModelComponent>, java.util.EventListener, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Disposable, ListView<ModelComponent>, ParameterizedClass, Scannable

Direct Known Subclasses:

AjlCollisionTest, AllBodySkinning, ArgsTest, ArticulatedBeamBody, ArticulatedDemo, ArticulatedFem, AttachDemo, AttachedBeamBody, AttachedBeamDemo, AttachedMuscleBeam, BallPlateCollide, BeamBodyCollide, BlockTest, BlockTestX, BodyBodyAttachment, BodyBodyJoint, BodyFemAttachment, BSpline3dElementTest, CollisionTestBase, ColoredMeshDemo, ColoredSphereTest, CombinedElemFem, CombinedShellFem, CompliantConstraintDemo, ConditionalMarkerDemo, ConstrainedParticle, ContactForceMonitor, ContactPressureRender, ControlPanelDemo, CoordinateCouplingDemo, CSGAnimation, CSGCubeTest, CustomJointDemo, CylinderWrapping, CylindricalJointDemo, DicomLoader, DicomTest, DoubleArmDemo, DrawModeTest, EdgeEdgeCollisionTest, EditableMeshTest, EFCForceTest, ElasticFoundationContact, EllipsoidJoint3dDemo, EllipsoidJointDemo, EmbeddedEmbeddedCollide, EmbeddedHeart, EmbeddedSphere, EmbeddedTongue, EquilibriumMuscleDemo, EquilibriumMuscleTest, Fem3dBlock, FemBeam, FemBeam3d, FemBeamMech, FemBeamTest, FemCollision, FemCollisions, FemCutPlaneDemo, FemEmbeddedSphere, FemFieldTest, FemFrictionBeam, FemMuscleBeams, FemMuscleDemo, FemMuscleHeart, FemPlaneCollide, FemSelfCollide, FemSkinDemo, FemSkinTest, FemSurfaceTargetDemo, FemWithBeamBody, FishDemo, FixedBallContact, FixedMeshes, ForceTargetDemo, FourBar, FourBarLinkage, FrameBodyAttachment, FrameFemAttachment, FrameSpringDemo, FrameSpringPendulum, FrameTargetDemo, FrameTrackingTest, GimbalJointDemo, Hello, Hex3dBlock, HexCube, HexFrame, HexTrimTest, HingeJointDemo, HollowSphere, HydrostatDemo, InstancedRenderingTest, IntersectionTest, InverseParticle, InverseSpringForce, InverseTest, JointedFemBeams, JointLimitDemo, KnotDensityTest, KnotDensityTest2, KnotDensityTest3, LaymanBowl, LaymanDemo, LeafBranchDemo, LeafDemo, LegTracking, LinearAuxiliaryTest, LinearPointConstraintTest, LockingDemo, LumbarFEMDisk, LumbarFrameSpring, MappingDemo, MassSpringDemo, MaterialBundleDemo, MaxwellElement, MechModelCollide, MechModelDemo, MeshBodyTest, MeshEditTest, MeshTestBase, MeshViewer, MinimizeFrameSpringForce, MonteCarloElementTests, MonteCarloTest, MultiCollisionTest, MultiSpringDemo, MultiSpringTest, MuscleArm, MyFEMonster, MyFinishedMonster, MyMonster, NetDemo, NewtonsCradle, OneBasedNumbering, OneStrandWrapBase, OpenSimCustomJointTest, OpenSimSpine, OpenSimTest, ParticleAttachment, ParticleSpring, PenetrationRender, PhalanxSkinWrapping, PhalanxWrapping, PlanarConnectorDemo, PlanarJointDemo, PlanarTranslationJointDemo, PointFemAttachment, PointMeshForces, PointMeshForceTest, PointModel, PointPlaneForces, PointPlaneForceTest, PressureShell, ProximalHumerusWrapping, QuadFishDemo, QuadGridTangent, QuadraticLockingDemo, QuadraticTorus, RadialMuscle, RedundantCollisionTest, ReflectedBodies, RegularSamplingElementTests, RenderDemo, RigidBodyCollision, RigidBodyDemo, RigidBodyJoint, RigidBodySkinning, RigidBodySpring, RigidCompositeBody, RigidCompositeCollide, RigidVertexCollide, RollingFem, ScalarFaceFieldDemo, ScalarFieldVisualization, ScalarGridFieldDemo, ScalarNodalFieldDemo, ScalarVertexFieldDemo, SDGridTest, SegmentedPlaneDemo, ShellBlock, ShellMembraneDemo, ShellQuadPatch, ShellShellAttach, ShellTriPatch, ShellVolumeAttach, ShoulderWrapping, SignedDistanceCollide, SimpleCollide, SimpleMuscle, SinCosMonitorProbe, SingleHex, SinglePyramid, SingleQuadhex, SingleQuadpyramid, SingleQuadtet, SingleQuadwedge, SingleShellQuad, SingleShellTri, SingleTet, SingleWedge, SkinDemo, SkullParticles, SliderJointDemo, SlidingFem, SlottedHingeJointDemo, SlottedRevoluteJointDemo, SphericalJointDemo, SphericalTextureMapping, SpinControlProbe, SpongeDemo, SpringMeshDemo, TalusWrapping, Template, TetCube, TextTest, TorusDemo, TorusWrapping, TorusWrapTest, TorusWrapTest, ToyMuscleArm, ToyMuscleFem, Trampoline, TransverseIsotropy, TransverseIsotropyTest, TrimmedElements, TubeDemo, TwoStrandWrapBase, TwoStrandWrapBase, UniversalJointDemo, VariableElasticContact, VariableStiffness, VectorFaceFieldDemo, VectorGridFieldDemo, VectorNodalFieldDemo, VectorVertexFieldDemo, ViaPointMuscle, WrappedMuscleArm, WrappedShellTest, WrapTestBase
```
public class RootModel
extends RenderableModelBase
implements Disposable
```
RootModel is the top-most model of an ArtiSynth model hierarchy. It contains a list of models, plus a number of other workspace components such as probes, controller, monitors, and control panels.

Nested Class Summary
- Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent
  ModelComponent.NavpanelVisibility
- Nested classes/interfaces inherited from interface artisynth.core.modelbase.CompositeComponent
  CompositeComponent.NavpanelDisplay

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String DEFAULT_MODEL_TITLE

static PropertyList myProps

static boolean testSaveAndRestoreState
- Fields inherited from class artisynth.core.modelbase.ModelBase
  DEFAULT_MAX_STEP_SIZE
- Fields inherited from class artisynth.core.modelbase.ComponentList
  DEFAULT_NAVPANEL_DISPLAY
- 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.Model
  STATE_IS_VOLATILE

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_MODEL_TITLE`
`static PropertyList`	`myProps`
`static boolean`	`testSaveAndRestoreState`

Constructor Summary

Constructors
Constructor and Description

RootModel()
Empty constructor, for creating a basic class instance

RootModel(java.lang.String name)
Constructor used to build the model

Constructors
Constructor and Description
`RootModel()` Empty constructor, for creating a basic class instance
`RootModel(java.lang.String name)` Constructor used to build the model

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WayPoint`	`addBreakPoint(double t)`
`void`	`addComponentChangeListener(ComponentChangeListener l)`
`void`	`addController(Controller controller)`
`void`	`addController(Controller controller, Model model)`
`void`	`addControlPanel(ControlPanel panel)`
`void`	`addControlPanel(ControlPanel panel, int idx)`
`void`	`addInputProbe(Probe probe)`
`void`	`addInputProbe(Probe probe, int idx)`
`void`	`addModel(Model model)`
`void`	`addMonitor(Monitor monitor)`
`void`	`addMonitor(Monitor monitor, Model model)`
`void`	`addOutputProbe(Probe probe)`
`void`	`addOutputProbe(Probe probe, int idx)`
`IsRenderableHolder`	`addRenderable(Renderable renderable)`
`void`	`addRenderable(RenderableComponent comp)`
`TracingProbe`	`addTracingProbe(Traceable traceable, java.lang.String traceName, double startTime, double stopTime)` Convenience routine to add a tracing probe to this RootModel.
`WayPoint`	`addWayPoint(double t)`
`void`	`addWayPoint(WayPoint way)`
`StepAdjustment`	`advance(double t0, double t1, int flags)` Advances this model from time t0 to time t1.
`void`	`applyControllers(java.util.List<Controller> list, double t0, double t1)`
`void`	`applyInputProbes(java.util.List<Probe> list, double t)`
`void`	`applyMonitors(java.util.List<Monitor> list, double t0, double t1)`
`void`	`applyOutputProbes(java.util.List<Probe> list, double t1, artisynth.core.workspace.RootModel.ModelInfo info)`
`void`	`attach(DriverInterface driver)` Attach this root model to a driver program
`void`	`build(java.lang.String[] args)`
`void`	`checkWrite(java.lang.String str)`
`void`	`clear()`
`void`	`clearRenderables()`
`void`	`clearTraces()`
`void`	`clearTracing(Traceable tr)`
`void`	`componentChanged(ComponentChangeEvent e)` Notifies this composite component that a change has occured within one or more of its descendants.
`CompositeState`	`createState(ComponentState prevState)` Factory routine to create a state object for this component, which can then be used as an argument for `HasState.setState(artisynth.core.modelbase.ComponentState)` and `HasState.getState(artisynth.core.modelbase.ComponentState)`.
`void`	`detach(DriverInterface driver)` Detach this root model from a driver program.
`void`	`disableAllTracing()`
`boolean`	`disableTracing(Traceable tr)`
`void`	`dispose()` Called when the model is discarded.
`void`	`enableTracing(Traceable tr)`
`java.lang.String`	`findSourceDir()` Finds and returns the path name of the source directory for this RootModel.
`java.lang.String`	`getAbout()` Returns a text string giving a short description of this model.
`boolean`	`getAdaptiveStepping()`
`PropertyList`	`getAllPropertyInfo()` Returns a list giving static information about all properties exported by this object.
`ComponentListView<Controller>`	`getControllers()`
`ComponentListView<ControlPanel>`	`getControlPanels()`
`javax.swing.JTabbedPane`	`getControlPanelTabs()`
`AxisAngle`	`getDefaultViewOrientation()` Obtains the default orientation that should be used for viewing this model.
`void`	`getInitialState(ComponentState newstate, ComponentState oldstate)` Gets an initial state for this component and returns the value in `state`.
`ComponentList<Probe>`	`getInputProbes()`
`javax.swing.JFrame`	`getMainFrame()`
`GLViewer`	`getMainViewer()`
`double`	`getMinStepSize()`
`java.lang.String`	`getModelTitle()`
`ComponentListView<Monitor>`	`getMonitors()`
`double`	`getNextAdvanceTime(java.util.List<Probe> probes, double stepSize, double t0, double t1)`
`int`	`getNumTraceables()`
`RenderableComponentList<Probe>`	`getOutputProbes()`
`static RootModel`	`getRoot(ModelComponent comp)` Find the most immediate RootModel, if any, that is an ancestor of a specified component.
`java.lang.String`	`getSourceRelativePath(java.lang.String relpath)` Finds and returns the path name of a file whose location is specified relative to the source directory for this RootModel.
`double`	`getStartTime()` In development: specifies the simulation start time for a root model.
`CompositeState`	`getState(boolean annotated)` Convenience method that creates and returns a `CompositeState` containing the current state of the root model.
`void`	`getState(ComponentState state)` Get the current state of this component.
`boolean`	`getStopRequest()`
`TaskManager`	`getTaskManager()` Returns the task manager associated with this root model, if any.
`static boolean`	`getTestSaveRestoreState()`
`java.util.Collection<Traceable>`	`getTraceSet()`
`TracingProbe`	`getTracingProbe(Traceable tr, java.lang.String propName)`
`java.util.LinkedList<TracingProbe>`	`getTracingProbes()`
`Point3d`	`getViewerCenter()`
`Point3d`	`getViewerEye()`
`Vector3d`	`getViewerUp()`
`WayPoint`	`getWayPoint(double t)`
`boolean`	`getWayPointChecking()`
`WayPointProbe`	`getWayPoints()`
`java.io.File`	`getWorkingFolder()` Returns the working folder for this root model.
`static boolean`	`hasRoot(ModelComponent comp)` Queries if a specified component has a RootModel as an ancestor.
`boolean`	`hasState()` Queries if this component has state.
`boolean`	`hasTracingProbes()`
`void`	`initialize(double t)` Causes this model to initialize itself at time t.
`void`	`invalidateInitialState()`
`static boolean`	`isBaseProperty(java.lang.String name)` Returns true if a given property name is a property of the RootModel class proper.
`boolean`	`isCheckEnabled()`
`static boolean`	`isFocusable()`
`boolean`	`isTracing(Traceable tr)`
`ControlPanel`	`loadControlPanel(java.lang.String filename)`
`void`	`mergeAllControlPanels(boolean combine)`
`void`	`mergeControlPanel(boolean combine, ControlPanel panel)`
`ComponentListView<Model>`	`models()`
`void`	`notifyParentOfChange(ComponentChangeEvent e)` Notifies the parent of this component (if any) of changes within in its descendants.
`void`	`notifyStructureChanged(java.lang.Object comp)`
`void`	`postscan(java.util.Deque<ScanToken> tokens, CompositeComponent ancestor)` Performs any required post-scanning for this component.
`void`	`postscanInitialize()`
`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`	`removeAllControllers()`
`void`	`removeAllControlPanels()`
`void`	`removeAllInputProbes()`
`void`	`removeAllModels()`
`void`	`removeAllMonitors()`
`void`	`removeAllOutputProbes()`
`void`	`removeAllWayPoints()`
`boolean`	`removeComponentChangeListener(ComponentChangeListener l)`
`boolean`	`removeController(Controller controller)`
`boolean`	`removeControlPanel(ControlPanel panel)`
`boolean`	`removeInputProbe(Probe probe)`
`boolean`	`removeModel(Model model)`
`boolean`	`removeMonitor(Monitor monitor)`
`boolean`	`removeOutputProbe(Probe probe)`
`boolean`	`removeRenderable(Renderable renderable)`
`boolean`	`removeRenderable(RenderableComponent comp)`
`boolean`	`removeWayPoint(WayPoint way)`
`void`	`render(Renderer renderer, int flags)` Render this object using the functionality of the supplied `Renderer`.
`RenderableComponentList<RenderableComponent>`	`renderables()`
`void`	`rerender()`
`void`	`resetInitialState()`
`void`	`scan(ReaderTokenizer rtok, java.lang.Object ref)` Scans this element from a ReaderTokenizer.
`void`	`scanProbes(ReaderTokenizer rtok)`
`void`	`setAdaptiveStepping(boolean enable)`
`void`	`setCheckEnabled(boolean enable)`
`void`	`setDefaultValues()` Sets the attributes of this component to their default values.
`void`	`setDefaultViewOrientation(AxisAlignedRotation REW)` Sets the default orientation that should be used for viewing this model to `REW`, where `REW` is specified as an `AxisAlignedRotation`.
`void`	`setDefaultViewOrientation(AxisAngle REW)` Sets the default orientation that should be used for viewing this model to `REW`.
`static void`	`setFocusable(boolean focusable)`
`void`	`setMainViewer(GLViewer v)`
`void`	`setMaxStepSize(double step)` Sets the maximum step size by which this model should be advanced within a simulation loop.
`void`	`setMinStepSize(double step)`
`void`	`setModelTitle(java.lang.String title)` Sets a title for this model.
`void`	`setStartTime(double time)` In development: specifies the simulation start time for a root model.
`void`	`setState(ComponentState state)` Set the state of this component.
`void`	`setStopRequest(boolean req)` If set true, tells the scheduler to stop simulating this root model.
`void`	`setTaskManager(TaskManager tm)` Experimental method that sets a task manager for this root model.
`static void`	`setTestSaveRestoreState(boolean enable)`
`void`	`setTracingProbesVisible(boolean visible)`
`void`	`setViewerCenter(Point3d c)`
`void`	`setViewerEye(Point3d e)`
`void`	`setViewerUp(Vector3d up)`
`void`	`setWayPointChecking(boolean enable)`
`void`	`setWorkingFolder(java.io.File dir)` Explicitly sets the working folder for this root model.
`void`	`stopAdvance()` This is used by the scheduler to interrupts the current call to advance and cause state to be restored to that of the start time for the advance.
`void`	`updateBounds(Vector3d pmin, Vector3d pmax)` Update the minimum and maximum points for this object.
`static void`	`write(RootModel root, java.io.PrintWriter pw, NumberFormat fmt)` Special write method which allows us to write a root model using only the information known to the RootModel class.

Methods inherited from class artisynth.core.modelbase.RenderableModelBase
createRenderProps, getRenderHints, getRenderProps, getSelection, isSelectable, numSelectionQueriesNeeded, setRenderProps

Methods inherited from class artisynth.core.modelbase.ModelBase
actionPerformed, copy, getDefaultMaxStepSize, getMaxStepSize, getMenuItems, hasParameterizedType, hierarchyContainsReferences, preadvance, setDefaultMaxStepSize

Methods inherited from class artisynth.core.modelbase.ComponentList
add, add, addAll, addComponents, addFixed, addNumbered, clone, contains, contains, containsAll, copy, ensureCapacity, findComponent, get, get, getByNumber, getChildren, getNavpanelDisplay, getNumberLimit, getOneBasedNumbering, getParameterType, getShortName, hasChildren, indexOf, invalidateNumbers, isEditable, isEmpty, iterator, nextComponentNumber, numComponents, remove, remove, removeAll, removeAll, removeComponents, resetNumbersToIndices, retainAll, set, setEditable, setNavpanelDisplay, setNumbered, setOneBasedNumbering, setShortName, size, toArray, toArray, updateNameMap

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, getSoftReferences, isFixed, isMarked, isSelected, setFixed, setMarked, setName, setNumber, setParent, setSelected, setWritable, updateReferences

Methods inherited from interface maspack.properties.HasProperties
getProperty

Methods inherited from interface maspack.properties.HierarchyNode
getChildren, hasChildren

Methods inherited from interface maspack.util.Scannable
isWritable, write

Methods inherited from interface artisynth.core.modelbase.ComponentListView
getName

Methods inherited from interface java.util.Collection
equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - testSaveAndRestoreState
```
public static boolean testSaveAndRestoreState
```
  - DEFAULT_MODEL_TITLE
```
public static java.lang.String DEFAULT_MODEL_TITLE
```
  - myProps
```
public static PropertyList myProps
```
- Constructor Detail
  - RootModel
```
public RootModel()
```
    Empty constructor, for creating a basic class instance
  - RootModel
```
public RootModel(java.lang.String name)
```
    Constructor used to build the model
    
    Parameters:
    
    name - the name of the new model
- Method Detail
  - getTestSaveRestoreState
```
public static boolean getTestSaveRestoreState()
```
  - setTestSaveRestoreState
```
public static void setTestSaveRestoreState(boolean enable)
```
  - setFocusable
```
public static void setFocusable(boolean focusable)
```
  - isFocusable
```
public static boolean isFocusable()
```
  - build
```
public void build(java.lang.String[] args)
           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - postscanInitialize
```
public void postscanInitialize()
                        throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getAbout
```
public java.lang.String getAbout()
```
    Returns a text string giving a short description of this model.
    
    Returns:
    
    text description of this model
  - setDefaultValues
```
public void setDefaultValues()
```
    Description copied from class: ModelComponentBase
    
    Sets the attributes of this component to their default values.
  - getAdaptiveStepping
```
public boolean getAdaptiveStepping()
```
  - setAdaptiveStepping
```
public void setAdaptiveStepping(boolean enable)
```
  - getMinStepSize
```
public double getMinStepSize()
```
  - setMinStepSize
```
public void setMinStepSize(double step)
```
  - setMaxStepSize
```
public void setMaxStepSize(double step)
```
    Description copied from class: ModelBase
    
    Sets the maximum step size by which this model should be advanced within a simulation loop.
    
    Overrides:
    
    setMaxStepSize in class ModelBase
    
    Parameters:
    
    step - maximum step size (seconds)
  - getModelTitle
```
public java.lang.String getModelTitle()
```
  - setModelTitle
```
public void setModelTitle(java.lang.String title)
```
    Sets a title for this model. The title is displayed in the application panel and used for the default movie name.
  - 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 RenderableModelBase
    
    Returns:
    
    static information for all exported properties
  - isBaseProperty
```
public static boolean isBaseProperty(java.lang.String name)
```
    Returns true if a given property name is a property of the RootModel class proper. This allows us to determine if it is safe to use a given RootModel property when saving a model using only core components.
  - models
```
public ComponentListView<Model> models()
```
  - addModel
```
public void addModel(Model model)
```
  - removeModel
```
public boolean removeModel(Model model)
```
  - removeAllModels
```
public void removeAllModels()
```
  - addMonitor
```
public void addMonitor(Monitor monitor)
```
  - addController
```
public void addController(Controller controller)
```
  - addRenderable
```
public IsRenderableHolder addRenderable(Renderable renderable)
```
  - removeRenderable
```
public boolean removeRenderable(Renderable renderable)
```
  - addRenderable
```
public void addRenderable(RenderableComponent comp)
```
  - removeRenderable
```
public boolean removeRenderable(RenderableComponent comp)
```
  - clearRenderables
```
public void clearRenderables()
```
  - renderables
```
public RenderableComponentList<RenderableComponent> renderables()
```
  - getMainViewer
```
public GLViewer getMainViewer()
```
  - setMainViewer
```
public void setMainViewer(GLViewer v)
```
  - getMainFrame
```
public javax.swing.JFrame getMainFrame()
```
  - setViewerCenter
```
public void setViewerCenter(Point3d c)
```
  - getViewerCenter
```
public Point3d getViewerCenter()
```
  - setViewerEye
```
public void setViewerEye(Point3d e)
```
  - getViewerEye
```
public Point3d getViewerEye()
```
  - setViewerUp
```
public void setViewerUp(Vector3d up)
```
  - getViewerUp
```
public Vector3d getViewerUp()
```
  - getDefaultViewOrientation
```
public AxisAngle getDefaultViewOrientation()
```
    Obtains the default orientation that should be used for viewing this model. A value equal to AxisAngle.ZERO indicates that no orientation is specified.
    
    Returns:
    
    default rotational transform from eye to world coordinates
  - setDefaultViewOrientation
```
public void setDefaultViewOrientation(AxisAngle REW)
```
    Sets the default orientation that should be used for viewing this model to REW. Setting a value equal to AxisAngle.ZERO indicates that no orientation is specified and so the viewer should use its default view.
    
    Parameters:
    
    REW - rotational transform from eye to world coordinates
  - setDefaultViewOrientation
```
public void setDefaultViewOrientation(AxisAlignedRotation REW)
```
    Sets the default orientation that should be used for viewing this model to REW, where REW is specified as an AxisAlignedRotation. Typical values are AxisAlignedRotation.X_Y (y axis pointing up), and AxisAlignedRotation.X_Z (z axis pointing up). If REW is passed as null, then no orientation is specified and so the viewer will use its default view.
    
    Parameters:
    
    REW - rotational transform from eye to world coordinates
  - addMonitor
```
public void addMonitor(Monitor monitor,
                       Model model)
```
  - removeMonitor
```
public boolean removeMonitor(Monitor monitor)
```
  - removeAllMonitors
```
public void removeAllMonitors()
```
  - getMonitors
```
public ComponentListView<Monitor> getMonitors()
```
  - addController
```
public void addController(Controller controller,
                          Model model)
```
  - removeController
```
public boolean removeController(Controller controller)
```
  - removeAllControllers
```
public void removeAllControllers()
```
  - getControllers
```
public ComponentListView<Controller> getControllers()
```
  - addControlPanel
```
public void addControlPanel(ControlPanel panel)
```
  - addControlPanel
```
public void addControlPanel(ControlPanel panel,
                            int idx)
```
  - removeControlPanel
```
public boolean removeControlPanel(ControlPanel panel)
```
  - removeAllControlPanels
```
public void removeAllControlPanels()
```
  - getControlPanels
```
public ComponentListView<ControlPanel> getControlPanels()
```
  - loadControlPanel
```
public ControlPanel loadControlPanel(java.lang.String filename)
```
  - addInputProbe
```
public void addInputProbe(Probe probe)
```
  - addInputProbe
```
public void addInputProbe(Probe probe,
                          int idx)
```
  - removeInputProbe
```
public boolean removeInputProbe(Probe probe)
```
  - removeAllInputProbes
```
public void removeAllInputProbes()
```
  - getInputProbes
```
public ComponentList<Probe> getInputProbes()
```
  - getStartTime
```
public double getStartTime()
```
    In development: specifies the simulation start time for a root model.
  - setStartTime
```
public void setStartTime(double time)
```
    In development: specifies the simulation start time for a root model.
  - addTracingProbe
```
public TracingProbe addTracingProbe(Traceable traceable,
                                    java.lang.String traceName,
                                    double startTime,
                                    double stopTime)
```
    Convenience routine to add a tracing probe to this RootModel. The probe is created for a specified trace of a Traceable component. Start and stop times are given in seconds. The probe's update interval is set to the maximum step size of this RootModel, and the render interval is set to 50 msec.
    
    Parameters:
    
    traceable - component to be traced
    
    traceName - name of the trace
    
    startTime - start time (seconds)
    
    stopTime - stop time (seconds)
    
    Returns:
    
    created tracing probe
  - addOutputProbe
```
public void addOutputProbe(Probe probe)
```
  - addOutputProbe
```
public void addOutputProbe(Probe probe,
                           int idx)
```
  - removeOutputProbe
```
public boolean removeOutputProbe(Probe probe)
```
  - removeAllOutputProbes
```
public void removeAllOutputProbes()
```
  - getOutputProbes
```
public RenderableComponentList<Probe> getOutputProbes()
```
  - hasTracingProbes
```
public boolean hasTracingProbes()
```
  - setTracingProbesVisible
```
public void setTracingProbesVisible(boolean visible)
```
  - getWayPoints
```
public WayPointProbe getWayPoints()
```
  - addWayPoint
```
public void addWayPoint(WayPoint way)
```
  - addWayPoint
```
public WayPoint addWayPoint(double t)
```
  - addBreakPoint
```
public WayPoint addBreakPoint(double t)
```
  - removeWayPoint
```
public boolean removeWayPoint(WayPoint way)
```
  - getWayPoint
```
public WayPoint getWayPoint(double t)
```
  - removeAllWayPoints
```
public void removeAllWayPoints()
```
  - getTracingProbe
```
public TracingProbe getTracingProbe(Traceable tr,
                                    java.lang.String propName)
```
  - enableTracing
```
public void enableTracing(Traceable tr)
```
  - isTracing
```
public boolean isTracing(Traceable tr)
```
  - disableTracing
```
public boolean disableTracing(Traceable tr)
```
  - clearTracing
```
public void clearTracing(Traceable tr)
```
  - getTracingProbes
```
public java.util.LinkedList<TracingProbe> getTracingProbes()
```
  - disableAllTracing
```
public void disableAllTracing()
```
  - clearTraces
```
public void clearTraces()
```
  - getTraceSet
```
public java.util.Collection<Traceable> getTraceSet()
```
  - getNumTraceables
```
public int getNumTraceables()
```
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection<ModelComponent>
    
    Overrides:
    
    clear in class ComponentList<ModelComponent>
  - getTaskManager
```
public TaskManager getTaskManager()
```
    Returns the task manager associated with this root model, if any.
    
    Returns:
    
    task manager, or null if there is none.
    
    See Also:
    
    setTaskManager
  - setTaskManager
```
public void setTaskManager(TaskManager tm)
```
    Experimental method that sets a task manager for this root model. This is a simulation control thread that will be started immediately after the model is loaded.
    This method will typically be called from the build(java.lang.String[]) method. Currently, task managers are not saved when a model is written to a file.
    
    Parameters:
    
    tm - task manager, or null to remove a task manager
    
    See Also:
    
    getTaskManager
  - 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
    
    Overrides:
    
    prerender in class RenderableModelBase
    
    Parameters:
    
    list - list of objects to be rendered
  - 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
    
    Overrides:
    
    updateBounds in class RenderableModelBase
    
    Parameters:
    
    pmin - minimum point
    
    pmax - maximum point
  - 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
    
    Specified by:
    
    render in class RenderableModelBase
    
    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.
  - rerender
```
public void rerender()
```
  - initialize
```
public 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.
    
    Specified by:
    
    initialize in interface Model
    
    Overrides:
    
    initialize in class ModelBase
    
    Parameters:
    
    t - initialization time (seconds)
  - attach
```
public void attach(DriverInterface driver)
```
    Attach this root model to a driver program
    
    Parameters:
    
    driver - Interface giving access to the frame and viewer
  - detach
```
public void detach(DriverInterface driver)
```
    Detach this root model from a driver program.
    
    Parameters:
    
    driver - Interface giving access to the frame and viewer
  - addComponentChangeListener
```
public void addComponentChangeListener(ComponentChangeListener l)
```
  - removeComponentChangeListener
```
public boolean removeComponentChangeListener(ComponentChangeListener l)
```
  - componentChanged
```
public void componentChanged(ComponentChangeEvent e)
```
    Description copied from class: ComponentList
    
    Notifies this composite component that a change has occured within one or more of its descendants. When this occurs, the composite may need to invalidate cached information that depends on the descendants.
    This method should propagate the notification up the component hierarchy by calling notifyParentOfChange.
    
    Specified by:
    
    componentChanged in interface ComponentChangeListener
    
    Specified by:
    
    componentChanged in interface CompositeComponent
    
    Overrides:
    
    componentChanged in class ComponentList<ModelComponent>
    
    Parameters:
    
    e - optional argument giving specific information about the change
  - notifyStructureChanged
```
public void notifyStructureChanged(java.lang.Object comp)
```
  - 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 ModelComponent
    
    Overrides:
    
    hasState in class ModelComponentBase
    
    Returns:
    
    true if this component has state
  - createState
```
public CompositeState createState(ComponentState prevState)
```
    Factory routine to create a state object for this component, which can then be used as an argument for HasState.setState(artisynth.core.modelbase.ComponentState) and HasState.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.
    
    Specified by:
    
    createState in interface HasState
    
    Overrides:
    
    createState in class ModelBase
    
    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
  - setState
```
public void setState(ComponentState state)
```
    Set the state of this component.
    
    Specified by:
    
    setState in interface HasState
    
    Overrides:
    
    setState in class ModelBase
    
    Parameters:
    
    state - state to be copied
  - resetInitialState
```
public void resetInitialState()
```
  - invalidateInitialState
```
public void invalidateInitialState()
```
  - getState
```
public void getState(ComponentState state)
```
    Get the current state of this component.
    
    Specified by:
    
    getState in interface HasState
    
    Overrides:
    
    getState in class ModelBase
    
    Parameters:
    
    state - receives the state information
  - getInitialState
```
public void getInitialState(ComponentState newstate,
                            ComponentState oldstate)
```
    Description copied from class: ModelBase
    
    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.
    
    Specified by:
    
    getInitialState in interface HasState
    
    Overrides:
    
    getInitialState in class ModelBase
    
    Parameters:
    
    newstate - receives the state information
    
    oldstate - previous state information; may be null.
  - getState
```
public CompositeState getState(boolean annotated)
```
    Convenience method that creates and returns a CompositeState containing the current state of the root model.
    
    Parameters:
    
    annotated - specifies if the state should be annotated
    
    Returns:
    
    current state of the root model
  - advance
```
public StepAdjustment advance(double t0,
                              double t1,
                              int flags)
```
    Description copied from class: ModelBase
    
    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 Model.STATE_IS_VOLATILE.
    
    Specified by:
    
    advance in interface Model
    
    Specified by:
    
    advance in class ModelBase
    
    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
  - applyInputProbes
```
public void applyInputProbes(java.util.List<Probe> list,
                             double t)
```
  - applyControllers
```
public void applyControllers(java.util.List<Controller> list,
                             double t0,
                             double t1)
```
  - applyMonitors
```
public void applyMonitors(java.util.List<Monitor> list,
                          double t0,
                          double t1)
```
  - applyOutputProbes
```
public void applyOutputProbes(java.util.List<Probe> list,
                              double t1,
                              artisynth.core.workspace.RootModel.ModelInfo info)
```
  - getNextAdvanceTime
```
public double getNextAdvanceTime(java.util.List<Probe> probes,
                                 double stepSize,
                                 double t0,
                                 double t1)
```
  - stopAdvance
```
public void stopAdvance()
```
    This is used by the scheduler to interrupts the current call to advance and cause state to be restored to that of the start time for the advance.
  - setStopRequest
```
public void setStopRequest(boolean req)
```
    If set true, tells the scheduler to stop simulating this root model. Will be set to false by the scheduler when simulation is started.
    
    Parameters:
    
    req - if true, requests a simulation stop
  - getStopRequest
```
public boolean getStopRequest()
```
  - write
```
public static void write(RootModel root,
                         java.io.PrintWriter pw,
                         NumberFormat fmt)
                  throws java.io.IOException
```
    Special write method which allows us to write a root model using only the information known to the RootModel class. This is used when writing components using core compatibility.
    
    Parameters:
    
    root - model to write
    
    pw - print writer to write the model to
    
    fmt - format for floating point values
    
    Throws:
    
    java.io.IOException
  - scanProbes
```
public void scanProbes(ReaderTokenizer rtok)
                throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - scan
```
public void scan(ReaderTokenizer rtok,
                 java.lang.Object ref)
          throws java.io.IOException
```
    Scans this element from a ReaderTokenizer. The expected text format is assumed to be compatible with that produced by write.
    
    Specified by:
    
    scan in interface ModelComponent
    
    Specified by:
    
    scan in interface Scannable
    
    Overrides:
    
    scan in class ComponentList<ModelComponent>
    
    Parameters:
    
    rtok - Tokenizer from which to scan the element
    
    ref - optional reference object which can be used for resolving references to other objects
    
    Throws:
    
    java.io.IOException - if an I/O or formatting error occured
  - postscan
```
public void postscan(java.util.Deque<ScanToken> tokens,
                     CompositeComponent ancestor)
              throws java.io.IOException
```
    Performs any required post-scanning for this component. This involves handling any information whose processing was deferred during the scan() method and stored in the token queue. The most common use of this method is to resolve the paths of component references, which may not have been created at the time of the initial scan() call.
    
    Specified by:
    
    postscan in interface PostScannable
    
    Overrides:
    
    postscan in class ComponentList<ModelComponent>
    
    Parameters:
    
    tokens - token information that was stored during scan().
    
    ancestor - ancestor component with respect to which reference component paths are defined.
    
    Throws:
    
    java.io.IOException - if an error is encountered (such as a reference to a non-existent component)
  - dispose
```
public void dispose()
```
    Description copied from class: ModelBase
    
    Called when the model is discarded. Disposes of any resources used.
    
    Specified by:
    
    dispose in interface Model
    
    Specified by:
    
    dispose in interface Disposable
    
    Overrides:
    
    dispose in class ModelBase
  - setWayPointChecking
```
public void setWayPointChecking(boolean enable)
```
  - getWayPointChecking
```
public boolean getWayPointChecking()
```
  - isCheckEnabled
```
public boolean isCheckEnabled()
```
  - setCheckEnabled
```
public void setCheckEnabled(boolean enable)
```
  - checkWrite
```
public void checkWrite(java.lang.String str)
```
  - mergeAllControlPanels
```
public void mergeAllControlPanels(boolean combine)
```
  - getControlPanelTabs
```
public javax.swing.JTabbedPane getControlPanelTabs()
```
  - mergeControlPanel
```
public void mergeControlPanel(boolean combine,
                              ControlPanel panel)
```
  - notifyParentOfChange
```
public void notifyParentOfChange(ComponentChangeEvent e)
```
    Notifies the parent of this component (if any) of changes within in its descendants. This is done by calling the parent's componentChanged method.
    
    Specified by:
    
    notifyParentOfChange in interface ModelComponent
    
    Overrides:
    
    notifyParentOfChange in class ModelComponentBase
    
    Parameters:
    
    e - optional argument giving specific information about the change
  - getRoot
```
public static RootModel getRoot(ModelComponent comp)
```
    Find the most immediate RootModel, if any, that is an ancestor of a specified component.
    
    Parameters:
    
    comp - component to seek RootModel for
    
    Returns:
    
    Most immediate RootModel ancestor, or null
  - hasRoot
```
public static boolean hasRoot(ModelComponent comp)
```
    Queries if a specified component has a RootModel as an ancestor.
    
    Parameters:
    
    comp - component to query
    
    Returns:
    
    true if comp has a RootModel as an ancestor.
  - findSourceDir
```
public java.lang.String findSourceDir()
```
    Finds and returns the path name of the source directory for this RootModel.
    
    Returns:
    
    path name for the root model source directory
  - getSourceRelativePath
```
public java.lang.String getSourceRelativePath(java.lang.String relpath)
```
    Finds and returns the path name of a file whose location is specified relative to the source directory for this RootModel. This is created by appending {\tt relpath} to the path name returned by findSourceDir().
    
    Parameters:
    
    relpath - path giving the location of the file relative to the root model source directory
    
    Returns:
    
    path name for the specified file
  - getWorkingFolder
```
public java.io.File getWorkingFolder()
```
    Returns the working folder for this root model. If not explicitly set via setWorkingFolder(java.io.File), the folder defaults to the source folder for the Java class, or, if that is not found, the current working folder specified by ".".
    
    Returns:
    
    working folder for this root model.
  - setWorkingFolder
```
public void setWorkingFolder(java.io.File dir)
```
    Explicitly sets the working folder for this root model. Specifying a value of null causes the working folder to revert to its default definition.

Class RootModel

Nested Class Summary

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

Fields inherited from class artisynth.core.modelbase.ComponentList

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

Fields inherited from interface maspack.render.IsRenderable

Fields inherited from interface artisynth.core.modelbase.Model

Constructor Summary

Method Summary

Methods inherited from class artisynth.core.modelbase.RenderableModelBase

Methods inherited from class artisynth.core.modelbase.ModelBase

Methods inherited from class artisynth.core.modelbase.ComponentList

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 maspack.util.Scannable

Methods inherited from interface artisynth.core.modelbase.ComponentListView

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

testSaveAndRestoreState

DEFAULT_MODEL_TITLE

myProps

Constructor Detail

RootModel

RootModel

Method Detail

getTestSaveRestoreState

setTestSaveRestoreState

setFocusable

isFocusable

build

postscanInitialize

getAbout

setDefaultValues

getAdaptiveStepping

setAdaptiveStepping

getMinStepSize

setMinStepSize

setMaxStepSize

getModelTitle

setModelTitle

getAllPropertyInfo

isBaseProperty

models

addModel

removeModel

removeAllModels

addMonitor

addController

addRenderable

removeRenderable

addRenderable

removeRenderable

clearRenderables

renderables

getMainViewer

setMainViewer

getMainFrame

setViewerCenter

getViewerCenter

setViewerEye

getViewerEye

setViewerUp

getViewerUp

getDefaultViewOrientation

setDefaultViewOrientation

setDefaultViewOrientation

addMonitor

removeMonitor

removeAllMonitors

getMonitors

addController

removeController

removeAllControllers