artisynth.core.gui

Class CoordinatePanel

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.gui.ControlPanel

artisynth.core.gui.CoordinatePanel

All Implemented Interfaces:

ModelComponent, PostScannable, java.awt.event.ActionListener, java.lang.Cloneable, java.util.EventListener, HasProperties, HierarchyNode, Disposable, Scannable, PropertyWindow, ValueChangeListener

public class CoordinatePanel
extends ControlPanel
implements ValueChangeListener

A subclass of ControlPanel with support for widgets that control joint coordinate values. These widgets are instances of CoordinateWidget, which are subclassed of DoubleFieldSlider.

A CoordinatePanel is associated with a MechModel, which is assumed to contain the joints whose coordinates are represented by the panel. When coordinate values are changed through the panel, the MechModel is asked to update various components, including the wrap paths for MultiPointSprings and the positions of attached components.

Nested Class Summary

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

ModelComponent.FilePathSaveType, ModelComponent.NavpanelVisibility

Field Summary

Fields inherited from class artisynth.core.gui.ControlPanel

myProps

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Constructor Summary

Constructors

Constructor and Description
CoordinatePanel()
CoordinatePanel(java.lang.String name, MechModel mech) Creates a CoordinatePanel with a specified name and MechModel.
CoordinatePanel(java.lang.String name, MechModel mech, java.lang.String options) Creates a CoordinatePanel with a specified name, MechModel, and options.

Method Summary

Modifier and Type	Method and Description
CoordinateWidget	addCoordinateWidget(JointBase joint, int cidx) Creates and adds a widget to this panel for the cidx-th coordinate of a specified joint.
CoordinateWidget	addCoordinateWidget(JointBase joint, int cidx, double min, double max) Creates and adds a widget to this panel for the cidx-th coordinate of a specified joint.
CoordinateWidget	addCoordinateWidget(JointBase joint, java.lang.String cname) Creates and adds a widget to this panel for the named coordinate of a specified joint.
CoordinateWidget	addCoordinateWidget(java.lang.String label, JointBase joint, int cidx) Creates and adds a widget to this panel for the cidx-th coordinate of a specified joint.
CoordinateWidget	addCoordinateWidget(java.lang.String label, JointBase joint, int cidx, double min, double max) Creates and adds a widget to this panel for the cidx-th coordinate of a specified joint.
CoordinateWidget	addCoordinateWidget(java.lang.String label, JointBase joint, java.lang.String cname) Creates and adds a widget to this panel for the named coordinate of a specified joint.
java.util.List<CoordinateWidget>	addCoordinateWidgets(JointBase joint) Creates and adds widgets to this panel for all the coordinate of a specified joint.
java.util.List<CoordinateWidget>	getCoordinateWidgets() Returns a list of all the coordinate widgets currently in this panel.
MechModel	getMechModel() Queries the MechModel associated with this panel.
void	postscan(java.util.Deque<ScanToken> tokens, CompositeComponent ancestor) Performs any required post-scanning for this component.
boolean	scanItem(ReaderTokenizer rtok, java.util.Deque<ScanToken> tokens)
void	setMechModel(MechModel mech) Sets the MechModel associated with this panel.
void	updateComponentCaches()
void	updateCoordinateWidgetList()
void	updateWidgetValues() Update the value of all property widgets in this window and its owned windows.
void	updateWrapPaths()
void	valueChange(ValueChangeEvent e)

Methods inherited from class artisynth.core.gui.ControlPanel

actionPerformed, addGlobalValueChangeListener, addLabel, addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidgets, connectToHierarchy, disconnectFromHierarchy, dispose, enableLiveUpdating, getAllPropertyInfo, getFrame, getGlobalValueChangeListeners, getHeight, getLocation, getPropertyPanel, getSize, getSoftReferences, getSynchronizeObject, getWidth, isLiveUpdatingEnabled, isScrollable, isVisible, locateRight, numWidgets, pack, postscanWidget, removeGlobalValueChangeListener, removeStalePropertyWidgets, scanWidget, setDefaultValues, setFocusableWindowState, setLocation, setLocation, setName, setScrollable, setSize, setSize, setSynchronizeObject, setVisible, updateReferences, write, writeWidget

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CoordinatePanel

public CoordinatePanel()

CoordinatePanel

public CoordinatePanel(java.lang.String name,
                       MechModel mech)

Creates a CoordinatePanel with a specified name and MechModel.

Parameters:

name - name of the panel

mech - MechModel associated with the panel

CoordinatePanel

public CoordinatePanel(java.lang.String name,
                       MechModel mech,
                       java.lang.String options)

Creates a CoordinatePanel with a specified name, MechModel, and options.

Parameters:

name - name of the panel

mech - MechModel associated with the panel

options - options for the panel

Method Detail

getMechModel

public MechModel getMechModel()

Queries the MechModel associated with this panel.

Returns:

MechModel associated with this panel

setMechModel

public void setMechModel(MechModel mech)

Sets the MechModel associated with this panel.

Parameters:

mech - MechModel to associate with this panel

addCoordinateWidget

public CoordinateWidget addCoordinateWidget(JointBase joint,
                                            java.lang.String cname)

Creates and adds a widget to this panel for the named coordinate of a specified joint. The widget's label is set to the coordinate name.

Parameters:

joint - joint containing the coordinate

cname - name of the coordinate

Returns:

created widget

addCoordinateWidget

public CoordinateWidget addCoordinateWidget(java.lang.String label,
                                            JointBase joint,
                                            java.lang.String cname)

Creates and adds a widget to this panel for the named coordinate of a specified joint.

Parameters:

label - widget label

joint - joint containing the coordinate

cname - name of the coordinate

Returns:

created widget

addCoordinateWidget

public CoordinateWidget addCoordinateWidget(java.lang.String label,
                                            JointBase joint,
                                            int cidx)

Creates and adds a widget to this panel for the cidx-th coordinate of a specified joint.

Parameters:

label - widget label

joint - joint containing the coordinate

cidx - coordinate index

Returns:

created widget

addCoordinateWidget

public CoordinateWidget addCoordinateWidget(JointBase joint,
                                            int cidx)

Creates and adds a widget to this panel for the cidx-th coordinate of a specified joint. The widget's label is set to the coordinate name.

Parameters:

joint - joint containing the coordinate

cidx - coordinate index

Returns:

created widget

addCoordinateWidget

public CoordinateWidget addCoordinateWidget(java.lang.String label,
                                            JointBase joint,
                                            int cidx,
                                            double min,
                                            double max)

Creates and adds a widget to this panel for the cidx-th coordinate of a specified joint.

Parameters:

label - widget label

joint - joint containing the coordinate

cidx - coordinate index

min - minimum widget value

max - maximum widget value

Returns:

created widget

addCoordinateWidget

public CoordinateWidget addCoordinateWidget(JointBase joint,
                                            int cidx,
                                            double min,
                                            double max)

Creates and adds a widget to this panel for the cidx-th coordinate of a specified joint. The widget's label is set to the coordinate name.

Parameters:

joint - joint containing the coordinate

cidx - coordinate index

min - minimum widget value

max - maximum widget value

Returns:

created widget

addCoordinateWidgets

public java.util.List<CoordinateWidget> addCoordinateWidgets(JointBase joint)

Creates and adds widgets to this panel for all the coordinate of a specified joint. The widget labels are set from the coordinate names.

Parameters:

joint - joint containing the coordinates

Returns:

list of the created widgets

getCoordinateWidgets

public java.util.List<CoordinateWidget> getCoordinateWidgets()

Returns a list of all the coordinate widgets currently in this panel.

Returns:

list of all coordinate widgets

valueChange

public void valueChange(ValueChangeEvent e)

Specified by:

valueChange in interface ValueChangeListener

updateComponentCaches

public void updateComponentCaches()

updateCoordinateWidgetList

public void updateCoordinateWidgetList()

updateWrapPaths

public void updateWrapPaths()

updateWidgetValues

public void updateWidgetValues()

Description copied from interface: PropertyWindow

Update the value of all property widgets in this window and its owned windows.

Specified by:

updateWidgetValues in interface PropertyWindow

Overrides:

updateWidgetValues in class ControlPanel

scanItem

public boolean scanItem(ReaderTokenizer rtok,
                        java.util.Deque<ScanToken> tokens)
                 throws java.io.IOException

Overrides:

scanItem in class ControlPanel

Throws:

java.io.IOException

postscan

public void postscan(java.util.Deque<ScanToken> tokens,
                     CompositeComponent ancestor)
              throws java.io.IOException

Description copied from interface: PostScannable

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 ModelComponentBase

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)