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

Modifier and Type	Class and Description
static class	CoordinatePanel.SettingsPanel

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

ModelComponent.FilePathSaveType, ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_USE_DEGREES
static PropertyList	myProps

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Constructor Summary

Constructors

Constructor and Description
CoordinatePanel() No-args constructor required for write/scan.
CoordinatePanel(MechModel mech) Creates a CoordinatePanel with a specified MechModel.
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
void	actionPerformed(java.awt.event.ActionEvent e)
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, java.lang.String cname) Creates and adds a widget to this panel for the named coordinate of a specified joint.
CoordinateWidget	addCoordinateWidget(JointCoordinateHandle handle) Creates and adds a widget to this panel for the coordinate specified by a handle.
CoordinateWidget	addCoordinateWidget(JointCoordinateHandle handle, double min, double max) Creates and adds a widget to this panel for the coordinate specified by a handle.
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, JointCoordinateHandle handle) Creates and adds a widget to this panel for the coordinate specified by a handle.
CoordinateWidget	addCoordinateWidget(java.lang.String label, JointCoordinateHandle handle, double min, double max) Creates and adds a widget to this panel for the coordinate specified by a handle.
java.util.List<CoordinateWidget>	addCoordinateWidgets(JointBase joint) Creates and adds widgets to this panel for all the coordinate of a specified joint.
void	addSettingsPanel() Adds a settings panel to this coordinate panel that exposes various settings, including: use degrees, controlling whether rotatary coordinates values are expressed in degrees or radians; multiset mode, allowing multiple coordinate values to be set simultaneously.
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
double	getCoordinate(java.lang.String label) Queries the coordinate associated with the specified widget label.
double	getCoordinateDeg(java.lang.String label) Queries the coordinate associated with the specified widget label.
CoordinateSetter	getCoordinateSetter() Returns the coordinate setter used by this panel.
CoordinateWidget	getCoordinateWidget(java.lang.String label) Gets the coordinate widget with the specified label, or null if no such widget is present.
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.
boolean	getUseDegrees() Queries whether this coordinate panel uses degrees or radians for rotary coordinate values.
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)
CoordinateSetter.SetStatus	setCoordinate(java.lang.String label, double value) Sets the coordinate associated with the specified widget label to a given value.
CoordinateSetter.SetStatus	setCoordinateDeg(java.lang.String label, double value) Sets the coordinate associated with the specified widget label to a given value.
CoordinateSetter.SetStatus	setCoordinates() Applies all outstanding coordinate set requests.
void	setMechModel(MechModel mech) Sets the MechModel associated with this panel.
void	setRequest(java.lang.String label, double value) Queues a request to set the coordinate associated with the specified widget label to a given value.
void	setRequestDeg(java.lang.String label, double value) Queues a request to set the coordinate associated with the specified widget label to a given value.
void	setUseDegrees(boolean enable) Sets whether this coordinate panel uses degrees or radians for rotary coordinate values.
void	updateComponentCaches()
void	updateCoordinateWidgetList()
void	updateWidgetValues() Update the value of all property widgets in this window and its owned windows.
void	valueChange(ValueChangeEvent e)

Methods inherited from class artisynth.core.gui.ControlPanel

addGlobalValueChangeListener, addLabel, addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidgets, connectToHierarchy, disconnectFromHierarchy, dispose, enableLiveUpdating, 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

Field Detail

DEFAULT_USE_DEGREES

public static boolean DEFAULT_USE_DEGREES

myProps

public static PropertyList myProps

Constructor Detail

CoordinatePanel

public CoordinatePanel()

No-args constructor required for write/scan.

CoordinatePanel

public CoordinatePanel(MechModel mech)

Creates a CoordinatePanel with a specified MechModel.

Parameters:

mech - MechModel associated with the panel

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

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 ControlPanel

Returns:

static information for all exported properties

getUseDegrees

public boolean getUseDegrees()

Queries whether this coordinate panel uses degrees or radians for rotary coordinate values.

Returns:

true if the panel uses degrees

setUseDegrees

public void setUseDegrees(boolean enable)

Sets whether this coordinate panel uses degrees or radians for rotary coordinate values.

Parameters:

enable - if true, the panel will use degrees

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(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)

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

Parameters:

label - label optional widget label; if null, the label is set to the coordinate name

joint - joint containing the coordinate

cidx - coordinate index

Returns:

created widget

addCoordinateWidget

public CoordinateWidget addCoordinateWidget(JointCoordinateHandle handle)

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

Parameters:

handle - handle specifying the coordinate's joint and index

Returns:

created widget

addCoordinateWidget

public CoordinateWidget addCoordinateWidget(java.lang.String label,
                                            JointCoordinateHandle handle)

Creates and adds a widget to this panel for the coordinate specified by a handle.

Parameters:

label - optional widget label; if null, the label is set to the coordinate name

handle - handle specifying the coordinate's joint and index

Returns:

created widget

addCoordinateWidget

public CoordinateWidget addCoordinateWidget(JointCoordinateHandle handle,
                                            double min,
                                            double max)

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

Parameters:

handle - handle specifying the coordinate's joint and index

min - minimum widget value

max - maximum widget value

Returns:

created widget

addCoordinateWidget

public CoordinateWidget addCoordinateWidget(java.lang.String label,
                                            JointCoordinateHandle handle,
                                            double min,
                                            double max)

Creates and adds a widget to this panel for the coordinate specified by a handle.

Parameters:

label - optional widget label; if null, the label is set to the coordinate name

handle - handle specifying the coordinate's joint and 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

getCoordinateWidget

public CoordinateWidget getCoordinateWidget(java.lang.String label)

Gets the coordinate widget with the specified label, or null if no such widget is present.

Parameters:

label - label of the widget being sought

Returns:

coordinate widget

setCoordinate

public CoordinateSetter.SetStatus setCoordinate(java.lang.String label,
                                                double value)

Sets the coordinate associated with the specified widget label to a given value.

Parameters:

label - label of the widget associated with the coordinate

value - desired coordinate value

getCoordinate

public double getCoordinate(java.lang.String label)

Queries the coordinate associated with the specified widget label.

Parameters:

label - label of the widget associated with the coordinate

Returns:

coordinate value

setCoordinateDeg

public CoordinateSetter.SetStatus setCoordinateDeg(java.lang.String label,
                                                   double value)

Sets the coordinate associated with the specified widget label to a given value. For rotary coordinates, the value should be given in degrees.

Parameters:

label - label of the widget associated with the coordinate

value - desired coordinate value

getCoordinateDeg

public double getCoordinateDeg(java.lang.String label)

Queries the coordinate associated with the specified widget label. For rotary coordinates, the value is given in degrees.

Parameters:

label - label of the widget associated with the coordinate

Returns:

coordinate value

setRequest

public void setRequest(java.lang.String label,
                       double value)

Queues a request to set the coordinate associated with the specified widget label to a given value.

Parameters:

label - label of the widget associated with the coordinate

value - desired coordinate value

setRequestDeg

public void setRequestDeg(java.lang.String label,
                          double value)

Queues a request to set the coordinate associated with the specified widget label to a given value. For rotary coordinates, the value should be given in degrees.

Parameters:

label - label of the widget associated with the coordinate

value - desired coordinate value

setCoordinates

public CoordinateSetter.SetStatus setCoordinates()

Applies all outstanding coordinate set requests.

addSettingsPanel

public void addSettingsPanel()

Adds a settings panel to this coordinate panel that exposes various settings, including:

1. use degrees, controlling whether rotatary coordinates values are expressed in degrees or radians;
2. multiset mode, allowing multiple coordinate values to be set simultaneously. In multiset mode, changes to coordinate widget values do not result in actual coordinate changes until the panel's Set button is clicked, at which point all coordinates are set at once.

getCoordinateSetter

public CoordinateSetter getCoordinateSetter()

Returns the coordinate setter used by this panel.

actionPerformed

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

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Overrides:

actionPerformed in class ControlPanel

valueChange

public void valueChange(ValueChangeEvent e)

Specified by:

valueChange in interface ValueChangeListener

updateComponentCaches

public void updateComponentCaches()

updateCoordinateWidgetList

public void updateCoordinateWidgetList()

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

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)