artisynth.core.modelbase

Class ModelAgentBase

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.ModelAgentBase

All Implemented Interfaces:

HasState, ModelAgent, ModelComponent, PostScannable, java.lang.Cloneable, HasProperties, HierarchyNode, Scannable

Direct Known Subclasses:

ControllerMonitorBase, Probe

public abstract class ModelAgentBase
extends ModelComponentBase
implements ModelAgent

Base class for Probes, Controllers, and Monitors.

Nested Class Summary

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

ModelComponent.FilePathSaveType, ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyList	myProps

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Constructor Summary

Constructors

Constructor and Description
ModelAgentBase()

Method Summary

Modifier and Type	Method and Description
void	dispose() Remove resources used by this agent.
void	finalize()
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
Model	getModel()
void	initialize(double t)
boolean	isActive() Returns true if this agent is active.
void	setActive(boolean enable)
void	setModel(Model model)
void	setModelFromComponent(ModelComponent comp)
void	write(java.io.PrintWriter pw, NumberFormat fmt, java.lang.Object ref) Writes a text description of this element to a PrintWriter.

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

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

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

Methods inherited from interface artisynth.core.modelbase.HasState

createState, getInitialState, getState, setState

Field Detail

myProps

public static PropertyList myProps

Constructor Detail

ModelAgentBase

public ModelAgentBase()

Method Detail

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 ModelComponentBase

Returns:

static information for all exported properties

isActive

public boolean isActive()

Description copied from interface: ModelAgent

Returns true if this agent is active.

Specified by:

isActive in interface ModelAgent

Returns:

true if active

setActive

public void setActive(boolean enable)

initialize

public void initialize(double t)

Specified by:

initialize in interface ModelAgent

setModelFromComponent

public void setModelFromComponent(ModelComponent comp)

setModel

public void setModel(Model model)

Specified by:

setModel in interface ModelAgent

getModel

public Model getModel()

Specified by:

getModel in interface ModelAgent

write

public void write(java.io.PrintWriter pw,
                  NumberFormat fmt,
                  java.lang.Object ref)
           throws java.io.IOException

Description copied from class: ModelComponentBase

Writes a text description of this element to a PrintWriter. The text description should be compatable with scan and complete enough to allow full reconstruction of the element.

Specified by:

write in interface Scannable

Overrides:

write in class ModelComponentBase

Parameters:

pw - stream for writing the element

fmt - numeric formating information

ref - optional reference object which can be used for producing references to other objects

Throws:

java.io.IOException - if an I/O error occured

dispose

public void dispose()

Remove resources used by this agent. Should be overridden by sub-classes as necessary.

Specified by:

dispose in interface ModelAgent

finalize

public void finalize()

Overrides:

finalize in class java.lang.Object