artisynth.core.modelbase

Class ModelBase

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.ComponentList<ModelComponent>

artisynth.core.modelbase.ModelBase

All Implemented Interfaces:

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

Direct Known Subclasses:

RenderableModelBase

public abstract class ModelBase
extends ComponentList<ModelComponent>
implements Model, HasMenuItems, java.awt.event.ActionListener

Base class providing some default implementations of the Model interface.

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 double	DEFAULT_MAX_STEP_SIZE
static PropertyList	myProps

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 artisynth.core.modelbase.Model

STATE_IS_VOLATILE

Constructor Summary

Constructors

Constructor and Description
ModelBase()
ModelBase(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent event) By default, this method does nothing.
abstract StepAdjustment	advance(double t0, double t1, int flags) Advances this model from time t0 to time t1.
ModelBase	copy(java.util.Map<ModelComponent,ModelComponent> copyMap, int flags)
ComponentState	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	dispose() Called when the model is discarded.
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
static double	getDefaultMaxStepSize() Queries the default value used to initialize the maximum step size for a model when it is created.
void	getInitialState(ComponentState newstate, ComponentState oldstate) Gets an initial state for this component and returns the value in state.
double	getMaxStepSize() Returns the maximum step size by which this model should be advanced within a simulation loop.
boolean	getMenuItems(java.util.List<java.lang.Object> items) Returns objects to be displayed under a "Model" menu in the main ArtiSynth frame.
void	getState(ComponentState state) Get the current state of this component.
boolean	hasParameterizedType() Queries whether this class explicitly utilizes a parameterized type.
boolean	hierarchyContainsReferences() Returns true if the component hierarchy formed by this component and its descendents is closed with respect to references.
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.
static void	setDefaultMaxStepSize(double step) Sets default value used to initialize the maximum step size for a model when it is created.
void	setMaxStepSize(double sec) Sets the maximum step size by which this model should be advanced within a simulation loop.
void	setState(ComponentState state) Set the state of this component.

Methods inherited from class artisynth.core.modelbase.ComponentList

add, add, addAll, addComponents, addFixed, addNumbered, clear, clone, componentChanged, contains, contains, containsAll, copy, ensureCapacity, findComponent, get, get, getByNumber, getChildren, getNavpanelDisplay, getNumberLimit, getOneBasedNumbering, getParameterType, getShortName, hasChildren, indexOf, invalidateNumbers, isEditable, isEmpty, iterator, nextComponentNumber, numComponents, postscan, remove, remove, removeAll, removeAll, removeComponents, resetNumbersToIndices, retainAll, scan, set, setEditable, setNavpanelDisplay, setNumbered, setOneBasedNumbering, setShortName, size, toArray, toArray, updateNameMap

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, connectToHierarchy, createTempFlag, disconnectFromHierarchy, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getProperty, getSoftReferences, hasState, isFixed, isMarked, isScanning, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, setFixed, setFlag, setMarked, setName, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setScanning, setSelected, setWritable, updateReferences, write

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, hasState, isFixed, isMarked, isSelected, notifyParentOfChange, scan, 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 artisynth.core.modelbase.PostScannable

postscan

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

DEFAULT_MAX_STEP_SIZE

public static final double DEFAULT_MAX_STEP_SIZE

See Also:

Constant Field Values

myProps

public static PropertyList myProps

Constructor Detail

ModelBase

public ModelBase(java.lang.String name)

ModelBase

public ModelBase()

Method Detail

getDefaultMaxStepSize

public static double getDefaultMaxStepSize()

Queries the default value used to initialize the maximum step size for a model when it is created.

Returns:

default maximum step size

setDefaultMaxStepSize

public static void setDefaultMaxStepSize(double step)

Sets default value used to initialize the maximum step size for a model when it is created.

Parameters:

step - new step size

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 ComponentList<ModelComponent>

Returns:

static information for all exported properties

setState

public void setState(ComponentState state)

Set the state of this component.

Specified by:

setState in interface HasState

Parameters:

state - state to be copied

getState

public void getState(ComponentState state)

Get the current state of this component.

Specified by:

getState in interface HasState

Parameters:

state - receives the state information

getInitialState

public void getInitialState(ComponentState newstate,
                            ComponentState oldstate)

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

Parameters:

newstate - receives the state information

oldstate - previous state information; may be null.

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

Parameters:

t - initialization time (seconds)

preadvance

public 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 Model.STATE_IS_VOLATILE.

Specified by:

preadvance in interface Model

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

public abstract 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 Model.STATE_IS_VOLATILE.

Specified by:

advance in interface Model

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

public double getMaxStepSize()

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

Specified by:

getMaxStepSize in interface Model

Returns:

maximum step size (seconds)

setMaxStepSize

public void setMaxStepSize(double sec)

Sets the maximum step size by which this model should be advanced within a simulation loop.

Parameters:

sec - maximum step size (seconds)

createState

public ComponentState 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

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

dispose

public void dispose()

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

Specified by:

dispose in interface Model

Specified by:

dispose in interface Disposable

hierarchyContainsReferences

public boolean hierarchyContainsReferences()

Returns true if the component hierarchy formed by this component and its descendents is closed with respect to references. In other words, all components referenced by components within the hierarchy are themselves components within the hierarchy.

In particular, this means that one does not need to search outside the hierarchy when looking for dependencies.

Specified by:

hierarchyContainsReferences in interface CompositeComponent

Overrides:

hierarchyContainsReferences in class ComponentList<ModelComponent>

Returns:

true if this component's hierarchy is closed with respect to references.

copy

public ModelBase copy(java.util.Map<ModelComponent,ModelComponent> copyMap,
                      int flags)

getMenuItems

public boolean getMenuItems(java.util.List<java.lang.Object> items)

Returns objects to be displayed under a "Model" menu in the main ArtiSynth frame. The desired objects are added to the list argument. The objects should be be items capable of being added to a JMenu, including Component, JMenuItem, and String. If the method returns false (the default behavior), that is taken to indicate that this component has no menu items.

Specified by:

getMenuItems in interface HasMenuItems

Parameters:

items - collects the objects that should be added

Returns:

false if there are no items to add to the model menu.

See Also:

GuiUtils.createMenuItem(java.awt.event.ActionListener, java.lang.String, java.lang.String)

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

By default, this method does nothing. Subclasses should override this to handle events, such as those generated from menu items such those generated by getMenuItems(java.util.List<java.lang.Object>).

Specified by:

actionPerformed in interface java.awt.event.ActionListener

hasParameterizedType

public boolean hasParameterizedType()

Description copied from interface: ParameterizedClass

Queries whether this class explicitly utilizes a parameterized type. This methods allows ParameterizedType subclasses to not be explicitly parameterized.

Specified by:

hasParameterizedType in interface ParameterizedClass

Overrides:

hasParameterizedType in class ComponentList<ModelComponent>

Returns:

true if this class utilizes a parameterized type.