LinkageNode

java.lang.Object
- msim.model.LinkageNode

All Implemented Interfaces:

java.lang.Comparable<LinkageNode>

Direct Known Subclasses:

Joint, Link
```
@ThreadSafe
public abstract class LinkageNode
extends java.lang.Object
implements java.lang.Comparable<LinkageNode>
```
Generic base class for MSim model nodes.

See additional description in header doc for Linkage.

Copyright (C) 2008 Marsette A. Vona, III

Author:

Marsette A. Vona, III

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`LinkageNode.ApplyingNodeHandler` Generic `LinkageNode.NodeHandler` impl that delegates to an object implementing an `apply(Object[])` method.
`static interface`	`LinkageNode.NodeHandler` callback interface for `traverseTree(msim.model.LinkageNode.NodeHandler)`
`static class`	`LinkageNode.SubFrame` identifies a specific subframe of a specific node

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`autoNamed` whether this node is automatically named
`vona.math.RX`	`cmt` The Composite Model Transform taking points from the canonical coordinate frame of this node to the ground frame.
`private static java.lang.String`	`cvsid`
`static float`	`DEF_WIDGET_LENGTH` default widget length [m]
`int`	`depth` Current depth of this node from ultimate ground link or -1 if unset.
`EntityClass`	`entityClass` model entity class
`boolean`	`explicitlyHidden` Explicit render state.
`boolean`	`explicitlyHighlighted` Explicit render state.
`boolean`	`explicitlyMasked` Explicit render state.
`boolean`	`explicitlyVisible` Explicit render state.
`Linkage`	`linkage` the `Linkage` to which this node belongs
`protected java.lang.String`	`name` the name of this node
`protected int`	`nextAnonymousWidgetNumber` used to make unique names
`protected java.util.List<java.lang.String>`	`nodeWidgets` names of the current node-internal `Widget`s
`protected int`	`numUserWidgets` number of user widgets as of last `updateWidgets()`
`protected java.util.Map<java.lang.String,java.lang.Object>`	`propertyMap` the property map or null if none
`static java.lang.String`	`SF_CANONICAL` canonical subframe
`static int`	`TM_JOINT_TYPE_START` metrics index for `collectTreeMetrics(int[])`
`static int`	`TM_NUM_CLOSURE_JOINTS` metrics index for `collectTreeMetrics(int[])`
`static int`	`TM_NUM_CONSTRAINED_CLOSURE_JOINTS` metrics index for `collectTreeMetrics(int[])`
`static int`	`TM_NUM_DANGLING_JOINTS` metrics index for `collectTreeMetrics(int[])`
`static int`	`TM_NUM_JOINT_WIDGETS` metrics index for `collectTreeMetrics(int[])`
`static int`	`TM_NUM_JOINTS` metrics index for `collectTreeMetrics(int[])`
`static int`	`TM_NUM_LINK_WIDGETS` metrics index for `collectTreeMetrics(int[])`
`static int`	`TM_NUM_LINKAGES` metrics index for `collectTreeMetrics(int[])`
`static int`	`TM_NUM_LINKS` metrics index for `collectTreeMetrics(int[])`
`static int`	`TM_NUM_LOCKED_LINKS` metrics index for `collectTreeMetrics(int[])`
`static int`	`TM_NUM_NODES` metrics index for `collectTreeMetrics(int[])`
`static int`	`TM_NUM_SUPPORTING_TREE_JOINTS` metrics index for `collectTreeMetrics(int[])`
`static int`	`TM_NUM_TREE_JOINTS` metrics index for `collectTreeMetrics(int[])`
`static int`	`TM_NUM_UNCONSTRAINED_CLOSURE_JOINTS` metrics index for `collectTreeMetrics(int[])`
`static int`	`TM_NUM_UNLOCKED_TREE_JOINTS` metrics index for `collectTreeMetrics(int[])`
`static int`	`TM_NUM_WIDGETS` metrics index for `collectTreeMetrics(int[])`
`static int`	`TM_SIZE` metrics size for `collectTreeMetrics(int[])`
`protected java.util.Collection<vona.j3d.Widget>`	`unmodifiableWidgets` unmodifiable view of `widgets`
`protected float`	`widgetLength` current widget length [m]
`protected java.util.Map<java.lang.String,vona.j3d.Widget>`	`widgetMap` node-referenced `Widget`s, indexed by name
`protected java.util.Collection<vona.j3d.Widget>`	`widgets` value set of `widgetMap`
`protected boolean`	`widgetsDirty` widgets dirty flag, see `updateWidgets()`, initially true
`static java.lang.String`	`WP_CACHED_SUBFRAME` see `getSubFrame(vona.j3d.Widget)`
`static java.lang.String`	`WP_EXPLICIT_HIDDEN` Explicit `Widget` render state.
`static java.lang.String`	`WP_EXPLICIT_HIGHLIGHT` Explicit `Widget` render state.
`static java.lang.String`	`WP_EXPLICIT_MASK` Explicit `Widget` render state.
`static java.lang.String`	`WP_EXPLICIT_VISIBLE` Explicit `Widget` render state.
`static java.lang.String`	`WP_FRAME` `Widget` property that identifies its parent coordinate frame
`static java.lang.String`	`WP_NAME` `Widget` property that gives its name in containing LinkageNode
`static java.lang.String`	`WP_NODE` `Widget` property that references the containing LinkageNode
`static java.lang.String`	`WP_USER_SUBFRAME` `Widget` property that identifies an associated user subframe, if any.

Constructor Summary

Constructors
Modifier Constructor and Description

protected LinkageNode(Linkage linkage, java.lang.String name)
Make a new LinakgeNode.

Constructors
Modifier	Constructor and Description
`protected`	`LinkageNode(Linkage linkage, java.lang.String name)` Make a new LinakgeNode.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`addWidget(java.lang.String type)` `addWidget(Widget, String, String)`, default frame and name
`java.lang.String`	`addWidget(java.lang.String type, java.lang.String name)` `addWidget(Widget, String, String)`, default frame
`java.lang.String`	`addWidget(java.lang.String type, java.lang.String name, java.lang.String frame)` cons `Widget` and `addWidget(Widget, String, String)`
`java.lang.String`	`addWidget(vona.j3d.Widget widget)` `addWidget(Widget, String, String)`, default frame and name
`java.lang.String`	`addWidget(vona.j3d.Widget widget, java.lang.String name)` `addWidget(Widget, String, String)`, default frame
`java.lang.String`	`addWidget(vona.j3d.Widget widget, java.lang.String name, java.lang.String frame)` Add a `Widget`.
`boolean`	`checkName(java.lang.String name)` Check if name would be acceptable for this node.
`static boolean`	`checkNamePattern(java.lang.String name)` Checkif name matches `MSim.VALID_NAME_PATTERN`.
`int[]`	`collectTreeMetrics()` Covers `collectTreeMetrics(int[])`, conses.
`int[]`	`collectTreeMetrics(int[] metrics)` Collect metrics on the subtree rooted at this node.
`int`	`compareTo(LinkageNode o)` Compares this node with the specified node for order by `depth`.
`void`	`dump()` `dump(java.io.PrintStream)` to System.out
`void`	`dump(java.io.PrintStream s)` dump node details
`void`	`dumpSubFrames()` `dumpSubFrames(PrintStream)` to System.out
`void`	`dumpSubFrames(java.io.PrintStream s)` Dump all available subframes.
`void`	`dumpTree()` `dumpTree(PrintStream)` to System.out
`void`	`dumpTree(java.io.PrintStream s)` Recursively `dump(PrintStream)` the sub-tree starting at this node.
`protected void`	`dumpTree(java.lang.String prefix, java.io.PrintStream s)` impl of `dumpTree(PrintStream)`
`void`	`dumpTreeMetrics()` `dumpTreeMetrics(PrintStream)` to System.out
`void`	`dumpTreeMetrics(java.io.PrintStream s)` `collectTreeMetrics(int[])` and dump them
`void`	`enableDBGNormals(boolean enable)` similar to `enableDBGSpheres(boolean)`
`void`	`enableDBGNormalsRecursively(boolean enable)` `enableDBGNormals(boolean)` in recursive tree DFS pre-order from this node.
`void`	`enableDBGSpheres(boolean enable)` Enable/disable debug spheres for all current `widgets`.
`void`	`enableDBGSpheresRecursively(boolean enable)` `enableDBGSpheres(boolean)` in recursive tree DFS pre-order from this node.
`protected <T extends LinkageNode> T`	`findImpl(java.lang.String namePattern, int nth, java.lang.Class<T> type)` Common impl of `findNode(String, int)` and similar.
`Joint`	`findJoint(java.lang.String namePattern)` `findJoint(String, int)`, returning the first `Joint` with the given namePattern.
`Joint`	`findJoint(java.lang.String namePattern, int nth)` Similar to `findNode(String, int)`.
`java.util.ArrayList<Joint>`	`findJoints(java.lang.String namePattern)` `findJoints(String, Collection)`, consing a new `ArrayList`.
`java.util.Collection<Joint>`	`findJoints(java.lang.String namePattern, java.util.Collection<Joint> joints)` Similar to `findLinks(String, Collection)`.
`Link`	`findLink(java.lang.String namePattern)` `findLink(String, int)`, returning the first `Link` with the given namePattern.
`Link`	`findLink(java.lang.String namePattern, int nth)` Similar to `findNode(String, int)`.
`java.util.ArrayList<Link>`	`findLinks(java.lang.String namePattern)` `findLinks(String, Collection)`, consing a new `ArrayList`.
`java.util.Collection<Link>`	`findLinks(java.lang.String namePattern, java.util.Collection<Link> links)` Get all `Link`s with a name matching namePattern in recursive tree DFS pre-order from this node.
`protected <T extends LinkageNode> java.util.Collection<T>`	`findMultipleImpl(java.lang.String namePattern, java.util.Collection<T> ret, java.lang.Class<T> type)` Common impl of `findNodes(String, Collection)` and similar.
`LinkageNode`	`findNode(java.lang.String namePattern)` `findNode(String, int)`, returning the first `LinkageNode` with the given namePattern.
`LinkageNode`	`findNode(java.lang.String namePattern, int nth)` Get the nth `LinkageNode` with a name matching namePattern in recursive tree DFS pre-order from this node.
`java.util.ArrayList<LinkageNode>`	`findNodes(java.lang.String namePattern)` `findNodes(String, Collection)`, consing a new `ArrayList`.
`java.util.Collection<LinkageNode>`	`findNodes(java.lang.String namePattern, java.util.Collection<LinkageNode> nodes)` Get all `LinkageNode`s with a name matching namePattern in recursive tree DFS pre-order from this node.
`abstract LinkageNode`	`getChild(java.lang.String name)` get the named child in the `Linkage` tree, null if none
`abstract java.util.Collection<? extends LinkageNode>`	`getChildren()` get the children of this node in the `Linkage` tree
`vona.math.RX`	`getCMT()` Get a copy of `cmt`, always conses.
`vona.math.RX`	`getCMT(vona.math.RX rx)` Get a copy of `cmt`.
`int`	`getDepth()` get `depth`
`java.lang.String`	`getName()` get the name of this node, even if auto-named
`protected abstract java.lang.String`	`getNodeWidgetProperty()` Return the `Widget` property name that indicates an internal (i.e.
`int`	`getNumUserWidgets()` get the number of user widges
`int`	`getNumWidgets()` get the number of widgets
`abstract LinkageNode`	`getParent()` get the parent of this node in the `Linkage` tree
`java.lang.Object`	`getProperty(java.lang.String key)` get a property
`LinkageNode.SubFrame`	`getSubFrame(java.lang.String name)` Hook to get or cons the indicated `LinkageNode.SubFrame` of this LinkageNode.
`static LinkageNode.SubFrame`	`getSubFrame(vona.j3d.Widget w)` Get the subframe containing w, or null if none.
`vona.math.RX`	`getSubFrameCMT(java.lang.String frame)` `getSubFrameCMT(String, RX)`, always conses
`vona.math.RX`	`getSubFrameCMT(java.lang.String frame, vona.math.RX rx)` Convenience method appends `cmt` to `getSubFrameRX(String, RX)`.
`vona.math.RX`	`getSubFrameCMT(vona.j3d.Widget widget)` Calls `getSubFrameCMT(String, RX)` with the `WP_FRAME` of widget, always conses.
`vona.math.RX`	`getSubFrameCMT(vona.j3d.Widget widget, vona.math.RX rx)` Calls `getSubFrameCMT(String, RX)` with the `WP_FRAME` of widget.
`static java.lang.String`	`getSubFrameName(vona.j3d.Widget w)` get the name of the subframe containing w
`vona.math.RX`	`getSubFrameRX(java.lang.String frame)` `getSubFrameRX(String, RX)`, always conses
`vona.math.RX`	`getSubFrameRX(java.lang.String frame, vona.math.RX rx)` Get the transform taking coordinates in a sub-frame to the canonical (i.e.
`vona.math.RX`	`getSubFrameRX(vona.j3d.Widget widget)` Calls `getSubFrameRX(String, RX)` with the `WP_FRAME` of widget, always conses.
`vona.math.RX`	`getSubFrameRX(vona.j3d.Widget widget, vona.math.RX rx)` Calls `getSubFrameRX(String, RX)` with the `WP_FRAME` of widget.
`vona.j3d.Widget`	`getWidget(java.lang.String name)` Get a `Widget`.
`float`	`getWidgetLength()` get `widgetLength`
`java.util.Collection<vona.j3d.Widget>`	`getWidgets()` Get an unmodifiable view of the collection of `Widget`s.
`boolean`	`hasChildren()` check whether this node has any children
`boolean`	`hasDescendant(LinkageNode other)` check if this node is an ancestor of (or the same as) other
`boolean`	`hasProperty(java.lang.String key)` check existence of a property
`boolean`	`hasSubFrame(java.lang.String frame)` Check if the named subframe is present.
`boolean`	`hasWidgets()` check if this node has any widgets
`boolean`	`isAutoNamed()` check whether this node is auto-named
`static boolean`	`isExplicitlyHidden(vona.j3d.Widget w)` check if w is explicitly hidden
`static boolean`	`isExplicitlyHighlighted(vona.j3d.Widget w)` check if w is explicitly highlighted
`static boolean`	`isExplicitlyMasked(vona.j3d.Widget w)` check if w is explicitly masked
`static boolean`	`isExplicitlyVisible(vona.j3d.Widget w)` check if w is explicitly visible
`boolean`	`isInternalFrame(java.lang.String frame)` Check if frame is an internal (i.e.
`boolean`	`isLive()` check if this node is actually present in its `linkage`
`abstract boolean`	`isLocked()` check if this node is locked
`boolean`	`isTreeLeaf()` Check if this is a leaf in the model tree.
`static boolean`	`isUserWidget(vona.j3d.Widget w)` check if w is a user widget
`LinkageNode`	`lock()` covers `setLocked(boolean)`
`abstract void`	`remove()` Remove this node from the `Linkage` tree.
`int`	`removeAllWidgets()` Remove all `Widget`s.
`java.lang.Object`	`removeProperty(java.lang.String key)` remove a property
`vona.j3d.Widget`	`removeWidget(java.lang.String name)` Remove a `Widget`.
`boolean`	`removeWidget(vona.j3d.Widget widget)` similar to `removeWidget(String)`
`void`	`renameWidget(vona.j3d.Widget w, java.lang.String name)` Rename a widget.
`void`	`reparentUserWidgets(LinkageNode newParent)` `reparentUserWidgets(LinkageNode, boolean)` holding global poses.
`void`	`reparentUserWidgets(LinkageNode newParent, boolean holdAbsolutePose)` `reparentWidget(String, LinkageNode, boolean)` all user `Widget`s.
`void`	`reparentWidget(java.lang.String name, LinkageNode newParent)` `reparentWidget(String, LinkageNode, boolean)`, holding global pose.
`java.lang.String`	`reparentWidget(java.lang.String name, LinkageNode newParent, boolean holdAbsolutePose)` Move a `Widget` from this LinkageNode to another.
`protected java.lang.String`	`reparentWidgetImpl(java.lang.String name, LinkageNode newParent, boolean holdAbsolutePose, boolean iffUserWidget)` Shared impl for `reparentWidget(String, LinkageNode, boolean)` and `reparentWidgets(LinkageNode, boolean)`.
`void`	`reparentWidgets(LinkageNode newParent)` `reparentWidgets(LinkageNode, boolean)` holding global poses
`void`	`reparentWidgets(LinkageNode newParent, boolean holdAbsolutePose)` `reparentWidget(String, LinkageNode, boolean)` all `Widget`s.
`void`	`setAllTreeJointsToGoal(int goal)` Set all tree joints in recursive DFS pre-order from this node to the indicated goal, `Joint.RX_POSTURE` or `Joint.RX_TARGET`, if set.
`void`	`setAllTreeJointsToHighestPrioritySoftGoal()` Set all tree joints in recursive DFS pre-order from this node to their highest-priority soft goal, `Joint.RX_POSTURE` or `Joint.RX_TARGET`, if any.
`void`	`setAllTreeJointsToPosture()` `setAllTreeJointsToGoal(int)` `Joint.RX_POSTURE`
`void`	`setAllTreeJointsToTarget()` `setAllTreeJointsToGoal(int)` `Joint.RX_TARGET`
`static void`	`setExplicitlyHidden(vona.j3d.Widget w, boolean hidden)` Mark a `Widget` to be explicitly hidden.
`static void`	`setExplicitlyHighlighted(vona.j3d.Widget w, boolean highlighted)` Mark a `Widget` to be explicitly highlighted.
`static void`	`setExplicitlyMasked(vona.j3d.Widget w, boolean masked)` Mark a `Widget` to be explicitly masked.
`static void`	`setExplicitlyVisible(vona.j3d.Widget w, boolean visible)` Mark a `Widget` to be explicitly visible.
`abstract LinkageNode`	`setLocked(boolean locked)` lock the state of this node
`void`	`setLockedRecursively(boolean locked)` `setLocked(boolean)` in recursive tree DFS pre-order from this node
`abstract java.lang.String`	`setName(java.lang.String name)` Set the name of this node.
`java.lang.Object`	`setProperty(java.lang.String key, java.lang.Object value)` covers `setProperty(String, Object, boolean)`, replaces
`java.lang.Object`	`setProperty(java.lang.String key, java.lang.Object value, boolean replace)` Set a property.
`boolean`	`setWidgetLength(float widgetLength)` covers `setWidgetLength(float, boolean)`, updates if different
`boolean`	`setWidgetLength(float widgetLength, boolean updateIfDifferent)` Set `widgetLength` [m].
`boolean`	`setWidgetLengthRecursively(float widgetLength)` Covers `setWidgetLengthRecursively(float, boolean)`, updates if different.
`boolean`	`setWidgetLengthRecursively(float widgetLength, boolean updateIfDifferent)` `setWidgetLength(float, boolean)` in recursive tree DFS pre-order from this node.
`protected boolean`	`suppressTreeDump()` Whether to suppress this node in `dumpTree(String, PrintStream)`, default false.
`java.lang.String`	`toString()` `toString(boolean)` without details
`abstract java.lang.String`	`toString(boolean details)` returns a short human-readable identifying string for this node
`boolean`	`traverseTree(LinkageNode.NodeHandler nodeHandler)` DFS the `Linkage` tree starting from this node.
`LinkageNode`	`unlock()` covers `setLocked(boolean)`
`abstract void`	`updateCMTs()` Update this node's `cmt` based on its parent's `cmt`.
`void`	`updateCMTsRecursively()` `updateCMTs()` in recursive tree DFS pre-order from this node
`void`	`updateWidgets()` Defers to `updateWidgetsImpl()` to update `widgetMap`, then counts `numUserWidgets` and clears `widgetsDirty`.
`protected void`	`updateWidgetsImpl()` Hook for lazy `widgetMap` update.
`void`	`updateWidgetsRecursively()` `updateWidgets()` in recursive tree DFS pre-order from this node.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - cvsid
```
private static final java.lang.String cvsid
```
    See Also:
    Constant Field Values
  - DEF_WIDGET_LENGTH
```
public static final float DEF_WIDGET_LENGTH
```
    default widget length [m]
    
    See Also:
    Constant Field Values
  - WP_NODE
```
public static final java.lang.String WP_NODE
```
    Widget property that references the containing LinkageNode
    
    See Also:
    Constant Field Values
  - WP_NAME
```
public static final java.lang.String WP_NAME
```
    Widget property that gives its name in containing LinkageNode
    
    See Also:
    Constant Field Values
  - WP_FRAME
```
public static final java.lang.String WP_FRAME
```
    Widget property that identifies its parent coordinate frame
    
    See Also:
    Constant Field Values
  - WP_USER_SUBFRAME
```
public static final java.lang.String WP_USER_SUBFRAME
```
    Widget property that identifies an associated user subframe, if any.
    
    See Also:
    Constant Field Values
  - WP_CACHED_SUBFRAME
```
public static final java.lang.String WP_CACHED_SUBFRAME
```
    see getSubFrame(vona.j3d.Widget)
    
    See Also:
    Constant Field Values
  - WP_EXPLICIT_VISIBLE
```
public static final java.lang.String WP_EXPLICIT_VISIBLE
```
    Explicit Widget render state.
    
    When set these override the render state of a Widget's EntityClass. If both WP_EXPLICIT_VISIBLE and WP_EXPLICIT_HIDDEN are set the latter is ignored.
    
    See Also:
    Constant Field Values
  - WP_EXPLICIT_HIDDEN
```
public static final java.lang.String WP_EXPLICIT_HIDDEN
```
    Explicit Widget render state.
    
    When set these override the render state of a Widget's EntityClass. If both WP_EXPLICIT_VISIBLE and WP_EXPLICIT_HIDDEN are set the latter is ignored.
    
    See Also:
    Constant Field Values
  - WP_EXPLICIT_HIGHLIGHT
```
public static final java.lang.String WP_EXPLICIT_HIGHLIGHT
```
    Explicit Widget render state.
    
    When set these override the render state of a Widget's EntityClass. If both WP_EXPLICIT_VISIBLE and WP_EXPLICIT_HIDDEN are set the latter is ignored.
    
    See Also:
    Constant Field Values
  - WP_EXPLICIT_MASK
```
public static final java.lang.String WP_EXPLICIT_MASK
```
    Explicit Widget render state.
    
    When set these override the render state of a Widget's EntityClass. If both WP_EXPLICIT_VISIBLE and WP_EXPLICIT_HIDDEN are set the latter is ignored.
    
    See Also:
    Constant Field Values
  - SF_CANONICAL
```
public static final java.lang.String SF_CANONICAL
```
    canonical subframe
    
    See Also:
    Constant Field Values
  - TM_NUM_LINKAGES
```
public static final int TM_NUM_LINKAGES
```
    metrics index for collectTreeMetrics(int[])
    
    See Also:
    Constant Field Values
  - TM_NUM_NODES
```
public static final int TM_NUM_NODES
```
    metrics index for collectTreeMetrics(int[])
    
    See Also:
    Constant Field Values
  - TM_NUM_LINKS
```
public static final int TM_NUM_LINKS
```
    metrics index for collectTreeMetrics(int[])
    
    See Also:
    Constant Field Values
  - TM_NUM_JOINTS
```
public static final int TM_NUM_JOINTS
```
    metrics index for collectTreeMetrics(int[])
    
    See Also:
    Constant Field Values
  - TM_NUM_WIDGETS
```
public static final int TM_NUM_WIDGETS
```
    metrics index for collectTreeMetrics(int[])
    
    See Also:
    Constant Field Values
  - TM_NUM_LOCKED_LINKS
```
public static final int TM_NUM_LOCKED_LINKS
```
    metrics index for collectTreeMetrics(int[])
    
    See Also:
    Constant Field Values
  - TM_NUM_TREE_JOINTS
```
public static final int TM_NUM_TREE_JOINTS
```
    metrics index for collectTreeMetrics(int[])
    
    See Also:
    Constant Field Values
  - TM_NUM_CLOSURE_JOINTS
```
public static final int TM_NUM_CLOSURE_JOINTS
```
    metrics index for collectTreeMetrics(int[])
    
    See Also:
    Constant Field Values
  - TM_NUM_DANGLING_JOINTS
```
public static final int TM_NUM_DANGLING_JOINTS
```
    metrics index for collectTreeMetrics(int[])
    
    See Also:
    Constant Field Values
  - TM_NUM_UNLOCKED_TREE_JOINTS
```
public static final int TM_NUM_UNLOCKED_TREE_JOINTS
```
    metrics index for collectTreeMetrics(int[])
    
    See Also:
    Constant Field Values
  - TM_NUM_SUPPORTING_TREE_JOINTS
```
public static final int TM_NUM_SUPPORTING_TREE_JOINTS
```
    metrics index for collectTreeMetrics(int[])
    
    See Also:
    Constant Field Values
  - TM_NUM_CONSTRAINED_CLOSURE_JOINTS
```
public static final int TM_NUM_CONSTRAINED_CLOSURE_JOINTS
```
    metrics index for collectTreeMetrics(int[])
    
    See Also:
    Constant Field Values
  - TM_NUM_UNCONSTRAINED_CLOSURE_JOINTS
```
public static final int TM_NUM_UNCONSTRAINED_CLOSURE_JOINTS
```
    metrics index for collectTreeMetrics(int[])
    
    See Also:
    Constant Field Values
  - TM_NUM_LINK_WIDGETS
```
public static final int TM_NUM_LINK_WIDGETS
```
    metrics index for collectTreeMetrics(int[])
    
    See Also:
    Constant Field Values
  - TM_NUM_JOINT_WIDGETS
```
public static final int TM_NUM_JOINT_WIDGETS
```
    metrics index for collectTreeMetrics(int[])
    
    See Also:
    Constant Field Values
  - TM_JOINT_TYPE_START
```
public static final int TM_JOINT_TYPE_START
```
    metrics index for collectTreeMetrics(int[])
    
    See Also:
    Constant Field Values
  - TM_SIZE
```
public static final int TM_SIZE
```
    metrics size for collectTreeMetrics(int[])
  - linkage
```
public final Linkage linkage
```
    the Linkage to which this node belongs
  - name
```
protected java.lang.String name
```
    the name of this node
  - autoNamed
```
protected boolean autoNamed
```
    whether this node is automatically named
  - cmt
```
public final vona.math.RX cmt
```
    The Composite Model Transform taking points from the canonical coordinate frame of this node to the ground frame.
    
    see Linkage class header doc for details.
  - widgetsDirty
```
protected volatile boolean widgetsDirty
```
    widgets dirty flag, see updateWidgets(), initially true
  - widgetLength
```
protected volatile float widgetLength
```
    current widget length [m]
  - widgetMap
```
protected java.util.Map<java.lang.String,vona.j3d.Widget> widgetMap
```
    node-referenced Widgets, indexed by name
  - widgets
```
protected java.util.Collection<vona.j3d.Widget> widgets
```
    value set of widgetMap
  - unmodifiableWidgets
```
protected final java.util.Collection<vona.j3d.Widget> unmodifiableWidgets
```
    unmodifiable view of widgets
  - nextAnonymousWidgetNumber
```
protected int nextAnonymousWidgetNumber
```
    used to make unique names
  - numUserWidgets
```
protected int numUserWidgets
```
    number of user widgets as of last updateWidgets()
  - nodeWidgets
```
protected final java.util.List<java.lang.String> nodeWidgets
```
    names of the current node-internal Widgets
  - explicitlyVisible
```
public volatile boolean explicitlyVisible
```
    Explicit render state.
    
    When set these override the render state of a node's EntityClass. explicitlyVisible overrides explicitlyHidden and explicitlyMasked.
  - explicitlyHidden
```
public volatile boolean explicitlyHidden
```
    Explicit render state.
    
    When set these override the render state of a node's EntityClass. explicitlyVisible overrides explicitlyHidden and explicitlyMasked.
  - explicitlyHighlighted
```
public volatile boolean explicitlyHighlighted
```
    Explicit render state.
    
    When set these override the render state of a node's EntityClass. explicitlyVisible overrides explicitlyHidden and explicitlyMasked.
  - explicitlyMasked
```
public volatile boolean explicitlyMasked
```
    Explicit render state.
    
    When set these override the render state of a node's EntityClass. explicitlyVisible overrides explicitlyHidden and explicitlyMasked.
  - entityClass
```
public volatile EntityClass entityClass
```
    model entity class
  - depth
```
public volatile int depth
```
    Current depth of this node from ultimate ground link or -1 if unset.
    
    Set by Controller.analyzeStructure(msim.model.Link, int). Used by compareTo(msim.model.LinkageNode).
  - propertyMap
```
protected java.util.Map<java.lang.String,java.lang.Object> propertyMap
```
    the property map or null if none
- Constructor Detail
  - LinkageNode
```
protected LinkageNode(Linkage linkage,
           java.lang.String name)
```
    Make a new LinakgeNode.
    
    Parameters:
    linkage - the Linkage to which this node belongs
    name - the name of this node or null for auto-name
- Method Detail
  - getSubFrameName
```
public static java.lang.String getSubFrameName(vona.j3d.Widget w)
```
    get the name of the subframe containing w
  - getSubFrame
```
public static LinkageNode.SubFrame getSubFrame(vona.j3d.Widget w)
```
    Get the subframe containing w, or null if none.
    
    The result is cached as WP_CACHED_SUBFRAME.
  - getSubFrame
```
public LinkageNode.SubFrame getSubFrame(java.lang.String name)
```
    Hook to get or cons the indicated LinkageNode.SubFrame of this LinkageNode.
  - setExplicitlyVisible
```
public static void setExplicitlyVisible(vona.j3d.Widget w,
                        boolean visible)
```
    Mark a Widget to be explicitly visible.
    
    Also see explicitlyVisible to explicitly show a whole node.
    
    Adds or removes the WP_EXPLICIT_VISIBLE property.
  - isExplicitlyVisible
```
public static boolean isExplicitlyVisible(vona.j3d.Widget w)
```
    check if w is explicitly visible
  - setExplicitlyHidden
```
public static void setExplicitlyHidden(vona.j3d.Widget w,
                       boolean hidden)
```
    Mark a Widget to be explicitly hidden.
    
    Also see explicitlyHidden to explicitly hide a whole node.
    
    Adds or removes the WP_EXPLICIT_HIDDEN property.
  - isExplicitlyHidden
```
public static boolean isExplicitlyHidden(vona.j3d.Widget w)
```
    check if w is explicitly hidden
  - setExplicitlyHighlighted
```
public static void setExplicitlyHighlighted(vona.j3d.Widget w,
                            boolean highlighted)
```
    Mark a Widget to be explicitly highlighted.
    
    Also see explicitlyHighlighted to explicitly highlight a whole node.
    
    Adds or removes the WP_EXPLICIT_HIGHLIGHT property.
  - isExplicitlyHighlighted
```
public static boolean isExplicitlyHighlighted(vona.j3d.Widget w)
```
    check if w is explicitly highlighted
  - setExplicitlyMasked
```
public static void setExplicitlyMasked(vona.j3d.Widget w,
                       boolean masked)
```
    Mark a Widget to be explicitly masked.
    
    Also see explicitlyMasked to explicitly mask a whole node.
    
    Adds or removes the WP_EXPLICIT_MASK property.
  - isExplicitlyMasked
```
public static boolean isExplicitlyMasked(vona.j3d.Widget w)
```
    check if w is explicitly masked
  - getName
```
public java.lang.String getName()
```
    get the name of this node, even if auto-named
  - isAutoNamed
```
public boolean isAutoNamed()
```
    check whether this node is auto-named
  - setName
```
public abstract java.lang.String setName(java.lang.String name)
```
    Set the name of this node.
    
    Parameters:
    name - the new name of the node, or null to auto-name
    
    Returns:
    the old name
    
    Throws:
    
    java.lang.IllegalArgumentException - if name is non-null and fails checkName(java.lang.String)
  - checkName
```
public boolean checkName(java.lang.String name)
```
    Check if name would be acceptable for this node.
    
    Default impl does checkNamePattern(java.lang.String).
  - checkNamePattern
```
public static boolean checkNamePattern(java.lang.String name)
```
    Checkif name matches MSim.VALID_NAME_PATTERN.
  - getParent
```
public abstract LinkageNode getParent()
```
    get the parent of this node in the Linkage tree
  - getChild
```
public abstract LinkageNode getChild(java.lang.String name)
```
    get the named child in the Linkage tree, null if none
  - getChildren
```
public abstract java.util.Collection<? extends LinkageNode> getChildren()
```
    get the children of this node in the Linkage tree
  - hasChildren
```
public boolean hasChildren()
```
    check whether this node has any children
  - isTreeLeaf
```
public boolean isTreeLeaf()
```
    Check if this is a leaf in the model tree.
    
    Default impl checks if not hasChildren() .
  - hasDescendant
```
public boolean hasDescendant(LinkageNode other)
```
    check if this node is an ancestor of (or the same as) other
  - traverseTree
```
public boolean traverseTree(LinkageNode.NodeHandler nodeHandler)
```
    DFS the Linkage tree starting from this node.
    
    The search is pruned at isTreeLeaf().
    
    Parameters:
    nodeHandler - called in DFS pre-order for each node visited
    
    Returns:
    false iff nodeHandler aborted the traversal
  - updateCMTs
```
public abstract void updateCMTs()
```
    Update this node's cmt based on its parent's cmt.
    
    Implementations may also compute and cache other CMT-related state in this call, such as CMTs for sub-frames.
    
    For details on the semantics of CMTs see the Linkage class header doc.
  - updateCMTsRecursively
```
public void updateCMTsRecursively()
```
    updateCMTs() in recursive tree DFS pre-order from this node
  - getCMT
```
public vona.math.RX getCMT(vona.math.RX rx)
```
    Get a copy of cmt.
  - getCMT
```
public vona.math.RX getCMT()
```
    Get a copy of cmt, always conses.
  - remove
```
public abstract void remove()
```
    Remove this node from the Linkage tree.
    
    All adjacent Joint endpoints are dangled.
    
    Once a node has been removed it cannot be re-added.
  - isLive
```
public boolean isLive()
```
    check if this node is actually present in its linkage
  - setLocked
```
public abstract LinkageNode setLocked(boolean locked)
```
    lock the state of this node
  - lock
```
public LinkageNode lock()
```
    covers setLocked(boolean)
  - unlock
```
public LinkageNode unlock()
```
    covers setLocked(boolean)
  - isLocked
```
public abstract boolean isLocked()
```
    check if this node is locked
  - setLockedRecursively
```
public void setLockedRecursively(boolean locked)
```
    setLocked(boolean) in recursive tree DFS pre-order from this node
  - setAllTreeJointsToHighestPrioritySoftGoal
```
public void setAllTreeJointsToHighestPrioritySoftGoal()
```
    Set all tree joints in recursive DFS pre-order from this node to their highest-priority soft goal, Joint.RX_POSTURE or Joint.RX_TARGET, if any.
  - setAllTreeJointsToGoal
```
public void setAllTreeJointsToGoal(int goal)
```
    Set all tree joints in recursive DFS pre-order from this node to the indicated goal, Joint.RX_POSTURE or Joint.RX_TARGET, if set.
  - setAllTreeJointsToPosture
```
public void setAllTreeJointsToPosture()
```
    setAllTreeJointsToGoal(int) Joint.RX_POSTURE
  - setAllTreeJointsToTarget
```
public void setAllTreeJointsToTarget()
```
    setAllTreeJointsToGoal(int) Joint.RX_TARGET
  - addWidget
```
public java.lang.String addWidget(vona.j3d.Widget widget,
                         java.lang.String name,
                         java.lang.String frame)
```
    Add a Widget.
    
    Parameters:
    widget - the Widget to add, stored by ref, not null
    name - the name of the widget, or null to generate a unique name
    frame - the WP_FRAME, or SF_CANONICAL if null
    
    Returns:
    the name of the newly added Widget
    
    Throws:
    
    java.lang.IllegalArgumentException - if name is not null and not unique
  - addWidget
```
public java.lang.String addWidget(java.lang.String type,
                         java.lang.String name,
                         java.lang.String frame)
```
    cons Widget and addWidget(Widget, String, String)
  - addWidget
```
public java.lang.String addWidget(vona.j3d.Widget widget,
                         java.lang.String name)
```
    addWidget(Widget, String, String), default frame
  - addWidget
```
public java.lang.String addWidget(java.lang.String type,
                         java.lang.String name)
```
    addWidget(Widget, String, String), default frame
  - addWidget
```
public java.lang.String addWidget(vona.j3d.Widget widget)
```
    addWidget(Widget, String, String), default frame and name
  - addWidget
```
public java.lang.String addWidget(java.lang.String type)
```
    addWidget(Widget, String, String), default frame and name
  - removeWidget
```
public vona.j3d.Widget removeWidget(java.lang.String name)
```
    Remove a Widget.
    
    Returns:
    the removed widget or null if not found
  - removeWidget
```
public boolean removeWidget(vona.j3d.Widget widget)
```
    similar to removeWidget(String)
  - removeAllWidgets
```
public int removeAllWidgets()
```
    Remove all Widgets.
    
    Returns:
    the number of widgets that were removed
  - renameWidget
```
public void renameWidget(vona.j3d.Widget w,
                java.lang.String name)
```
    Rename a widget.
    
    Has no effect if the new name is the same as the old name.
    
    Throws:
    
    java.lang.IllegalArgumentException - if name is not a unique widget name in this LinkageNode, or if w is not a widget in this LinkageNode
  - getWidgets
```
public java.util.Collection<vona.j3d.Widget> getWidgets()
```
    Get an unmodifiable view of the collection of Widgets.
    
    First calls updateWidgets() iff widgetsDirty.
    
    Returns:
    the collection, null or empty if none
  - getWidget
```
public vona.j3d.Widget getWidget(java.lang.String name)
```
    Get a Widget.
    
    First calls updateWidgets() iff widgetsDirty.
    
    Returns:
    the widget or null if not found
  - getNodeWidgetProperty
```
protected abstract java.lang.String getNodeWidgetProperty()
```
    Return the Widget property name that indicates an internal (i.e. non-user) Widget.
  - isUserWidget
```
public static boolean isUserWidget(vona.j3d.Widget w)
```
    check if w is a user widget
  - updateWidgets
```
public void updateWidgets()
```
    Defers to updateWidgetsImpl() to update widgetMap, then counts numUserWidgets and clears widgetsDirty.
  - updateWidgetsImpl
```
protected void updateWidgetsImpl()
```
    Hook for lazy widgetMap update.
    
    Default impl updates all widgets to current widgetLength, sets their EntityClass.WP_ENTITY_CLASS, and updates existing dbg geometry iff enabled.
  - updateWidgetsRecursively
```
public void updateWidgetsRecursively()
```
    updateWidgets() in recursive tree DFS pre-order from this node.
  - enableDBGSpheres
```
public void enableDBGSpheres(boolean enable)
```
    Enable/disable debug spheres for all current widgets.
  - enableDBGSpheresRecursively
```
public void enableDBGSpheresRecursively(boolean enable)
```
    enableDBGSpheres(boolean) in recursive tree DFS pre-order from this node.
  - enableDBGNormals
```
public void enableDBGNormals(boolean enable)
```
    similar to enableDBGSpheres(boolean)
  - enableDBGNormalsRecursively
```
public void enableDBGNormalsRecursively(boolean enable)
```
    enableDBGNormals(boolean) in recursive tree DFS pre-order from this node.
  - getSubFrameRX
```
public vona.math.RX getSubFrameRX(java.lang.String frame,
                         vona.math.RX rx)
```
    Get the transform taking coordinates in a sub-frame to the canonical (i.e. cmt) frame of this LinkageNode.
    
    Parameters:
    frame - the sub-frame or null to imply SF_CANONICAL
    rx - the transform is written here on return, consing if null
    
    Returns:
    a reference to rx
  - getSubFrameRX
```
public vona.math.RX getSubFrameRX(java.lang.String frame)
```
    getSubFrameRX(String, RX), always conses
  - getSubFrameRX
```
public vona.math.RX getSubFrameRX(vona.j3d.Widget widget,
                         vona.math.RX rx)
```
    Calls getSubFrameRX(String, RX) with the WP_FRAME of widget.
  - getSubFrameRX
```
public vona.math.RX getSubFrameRX(vona.j3d.Widget widget)
```
    Calls getSubFrameRX(String, RX) with the WP_FRAME of widget, always conses.
  - getSubFrameCMT
```
public vona.math.RX getSubFrameCMT(java.lang.String frame,
                          vona.math.RX rx)
```
    Convenience method appends cmt to getSubFrameRX(String, RX).
  - getSubFrameCMT
```
public vona.math.RX getSubFrameCMT(java.lang.String frame)
```
    getSubFrameCMT(String, RX), always conses
  - getSubFrameCMT
```
public vona.math.RX getSubFrameCMT(vona.j3d.Widget widget,
                          vona.math.RX rx)
```
    Calls getSubFrameCMT(String, RX) with the WP_FRAME of widget.
  - getSubFrameCMT
```
public vona.math.RX getSubFrameCMT(vona.j3d.Widget widget)
```
    Calls getSubFrameCMT(String, RX) with the WP_FRAME of widget, always conses.
  - reparentWidget
```
public java.lang.String reparentWidget(java.lang.String name,
                              LinkageNode newParent,
                              boolean holdAbsolutePose)
```
    Move a Widget from this LinkageNode to another.
    
    First calls updateWidgets() iff widgetsDirty.
    
    Parameters:
    holdAbsolutePose - whether to preserve the current pose of the widget relative to the Linkage.groundLink by appending to the Widget.rx (relies on up-to-date cmt for this node and for newParent)
    
    Returns:
    the name of the widget under newParent, which will be its original name n iff that was unique under newParent, else it will be n-i where i is the first non-negative integer that makes a unique name
  - reparentWidgetImpl
```
protected java.lang.String reparentWidgetImpl(java.lang.String name,
                                  LinkageNode newParent,
                                  boolean holdAbsolutePose,
                                  boolean iffUserWidget)
```
    Shared impl for reparentWidget(String, LinkageNode, boolean) and reparentWidgets(LinkageNode, boolean).
  - reparentWidget
```
public void reparentWidget(java.lang.String name,
                  LinkageNode newParent)
```
    reparentWidget(String, LinkageNode, boolean), holding global pose.
  - reparentWidgets
```
public void reparentWidgets(LinkageNode newParent,
                   boolean holdAbsolutePose)
```
    reparentWidget(String, LinkageNode, boolean) all Widgets.
  - reparentWidgets
```
public void reparentWidgets(LinkageNode newParent)
```
    reparentWidgets(LinkageNode, boolean) holding global poses
  - reparentUserWidgets
```
public void reparentUserWidgets(LinkageNode newParent,
                       boolean holdAbsolutePose)
```
    reparentWidget(String, LinkageNode, boolean) all user Widgets.
  - reparentUserWidgets
```
public void reparentUserWidgets(LinkageNode newParent)
```
    reparentUserWidgets(LinkageNode, boolean) holding global poses.
  - hasWidgets
```
public boolean hasWidgets()
```
    check if this node has any widgets
  - getNumWidgets
```
public int getNumWidgets()
```
    get the number of widgets
  - getNumUserWidgets
```
public int getNumUserWidgets()
```
    get the number of user widges
  - setWidgetLength
```
public boolean setWidgetLength(float widgetLength,
                      boolean updateIfDifferent)
```
    Set widgetLength [m].
    
    Parameters:
    updateIfDifferent - whether to updateWidgets() if the new length differs from old, if not, widgetsDirty is set
    
    Returns:
    true iff new length differs from old
  - setWidgetLength
```
public boolean setWidgetLength(float widgetLength)
```
    covers setWidgetLength(float, boolean), updates if different
  - getWidgetLength
```
public float getWidgetLength()
```
    get widgetLength
  - setWidgetLengthRecursively
```
public boolean setWidgetLengthRecursively(float widgetLength,
                                 boolean updateIfDifferent)
```
    setWidgetLength(float, boolean) in recursive tree DFS pre-order from this node.
    
    Returns:
    true iff the new length differs from the old on any visited widget
  - setWidgetLengthRecursively
```
public boolean setWidgetLengthRecursively(float widgetLength)
```
    Covers setWidgetLengthRecursively(float, boolean), updates if different.
  - findNode
```
public LinkageNode findNode(java.lang.String namePattern,
                   int nth)
```
    Get the nth LinkageNode with a name matching namePattern in recursive tree DFS pre-order from this node.
    
    Parameters:
    nth - 0 to return the first matching LinkageNode, 1 to return the 2nd, etc
    
    Returns:
    the searched Link, null if not found
  - findNode
```
public LinkageNode findNode(java.lang.String namePattern)
```
    findNode(String, int), returning the first LinkageNode with the given namePattern.
  - findLink
```
public Link findLink(java.lang.String namePattern,
            int nth)
```
    Similar to findNode(String, int).
  - findLink
```
public Link findLink(java.lang.String namePattern)
```
    findLink(String, int), returning the first Link with the given namePattern.
  - findJoint
```
public Joint findJoint(java.lang.String namePattern,
              int nth)
```
    Similar to findNode(String, int).
  - findJoint
```
public Joint findJoint(java.lang.String namePattern)
```
    findJoint(String, int), returning the first Joint with the given namePattern.
  - findNodes
```
public java.util.Collection<LinkageNode> findNodes(java.lang.String namePattern,
                                          java.util.Collection<LinkageNode> nodes)
```
    Get all LinkageNodes with a name matching namePattern in recursive tree DFS pre-order from this node.
  - findNodes
```
public java.util.ArrayList<LinkageNode> findNodes(java.lang.String namePattern)
```
    findNodes(String, Collection), consing a new ArrayList.
  - findLinks
```
public java.util.Collection<Link> findLinks(java.lang.String namePattern,
                                   java.util.Collection<Link> links)
```
    Get all Links with a name matching namePattern in recursive tree DFS pre-order from this node.
  - findLinks
```
public java.util.ArrayList<Link> findLinks(java.lang.String namePattern)
```
    findLinks(String, Collection), consing a new ArrayList.
  - findJoints
```
public java.util.Collection<Joint> findJoints(java.lang.String namePattern,
                                     java.util.Collection<Joint> joints)
```
    Similar to findLinks(String, Collection).
  - findJoints
```
public java.util.ArrayList<Joint> findJoints(java.lang.String namePattern)
```
    findJoints(String, Collection), consing a new ArrayList.
  - findImpl
```
protected <T extends LinkageNode> T findImpl(java.lang.String namePattern,
                                 int nth,
                                 java.lang.Class<T> type)
```
    Common impl of findNode(String, int) and similar.
  - findMultipleImpl
```
protected <T extends LinkageNode> java.util.Collection<T> findMultipleImpl(java.lang.String namePattern,
                                                               java.util.Collection<T> ret,
                                                               java.lang.Class<T> type)
```
    Common impl of findNodes(String, Collection) and similar.
  - collectTreeMetrics
```
public int[] collectTreeMetrics(int[] metrics)
```
    Collect metrics on the subtree rooted at this node.
    
    Each metric is an int in the metrics array, as defined by the TM_* constants.
    
    Parameters:
    metrics - the array in which to collect the metrics, or null or smaller than TM_SIZE to cons
    
    Returns:
    the array of collected metrics
  - collectTreeMetrics
```
public int[] collectTreeMetrics()
```
    Covers collectTreeMetrics(int[]), conses.
  - toString
```
public abstract java.lang.String toString(boolean details)
```
    returns a short human-readable identifying string for this node
  - toString
```
public java.lang.String toString()
```
    toString(boolean) without details
    
    Overrides:
    
    toString in class java.lang.Object
  - dump
```
public void dump(java.io.PrintStream s)
```
    dump node details
  - dump
```
public void dump()
```
    dump(java.io.PrintStream) to System.out
  - dumpTree
```
public void dumpTree(java.io.PrintStream s)
```
    Recursively dump(PrintStream) the sub-tree starting at this node.
  - dumpTree
```
public void dumpTree()
```
    dumpTree(PrintStream) to System.out
  - dumpTree
```
protected void dumpTree(java.lang.String prefix,
            java.io.PrintStream s)
```
    impl of dumpTree(PrintStream)
  - suppressTreeDump
```
protected boolean suppressTreeDump()
```
    Whether to suppress this node in dumpTree(String, PrintStream), default false.
  - dumpTreeMetrics
```
public void dumpTreeMetrics(java.io.PrintStream s)
```
    collectTreeMetrics(int[]) and dump them
  - dumpTreeMetrics
```
public void dumpTreeMetrics()
```
    dumpTreeMetrics(PrintStream) to System.out
  - getDepth
```
public int getDepth()
```
    get depth
  - compareTo
```
public int compareTo(LinkageNode o)
```
    Compares this node with the specified node for order by depth.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<LinkageNode>
    
    Returns:
    a negative integer, zero, or a positive integer as depth is less than, equal to, or greater than o.depth
  - hasSubFrame
```
public boolean hasSubFrame(java.lang.String frame)
```
    Check if the named subframe is present.
    
    Default impl just checks for SF_CANONICAL.
  - dumpSubFrames
```
public void dumpSubFrames(java.io.PrintStream s)
```
    Dump all available subframes.
    
    Default impl just dumps SF_CANONICAL.
  - dumpSubFrames
```
public void dumpSubFrames()
```
    dumpSubFrames(PrintStream) to System.out
  - isInternalFrame
```
public boolean isInternalFrame(java.lang.String frame)
```
    Check if frame is an internal (i.e. non-user) subframe.
    
    Default impl checks SF_CANONICAL.
  - setProperty
```
public java.lang.Object setProperty(java.lang.String key,
                           java.lang.Object value,
                           boolean replace)
```
    Set a property.
    
    Parameters:
    replace - whether to replace the value if the key is already present
    
    Returns:
    the prior value
  - setProperty
```
public java.lang.Object setProperty(java.lang.String key,
                           java.lang.Object value)
```
    covers setProperty(String, Object, boolean), replaces
  - removeProperty
```
public java.lang.Object removeProperty(java.lang.String key)
```
    remove a property
  - getProperty
```
public java.lang.Object getProperty(java.lang.String key)
```
    get a property
  - hasProperty
```
public boolean hasProperty(java.lang.String key)
```
    check existence of a property

Class LinkageNode

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cvsid

DEF_WIDGET_LENGTH

WP_NODE

WP_NAME

WP_FRAME

WP_USER_SUBFRAME

WP_CACHED_SUBFRAME

WP_EXPLICIT_VISIBLE

WP_EXPLICIT_HIDDEN

WP_EXPLICIT_HIGHLIGHT

WP_EXPLICIT_MASK

SF_CANONICAL

TM_NUM_LINKAGES

TM_NUM_NODES

TM_NUM_LINKS

TM_NUM_JOINTS

TM_NUM_WIDGETS

TM_NUM_LOCKED_LINKS

TM_NUM_TREE_JOINTS

TM_NUM_CLOSURE_JOINTS

TM_NUM_DANGLING_JOINTS

TM_NUM_UNLOCKED_TREE_JOINTS

TM_NUM_SUPPORTING_TREE_JOINTS

TM_NUM_CONSTRAINED_CLOSURE_JOINTS

TM_NUM_UNCONSTRAINED_CLOSURE_JOINTS

TM_NUM_LINK_WIDGETS

TM_NUM_JOINT_WIDGETS

TM_JOINT_TYPE_START

TM_SIZE

linkage

name

autoNamed

cmt

widgetsDirty

widgetLength

widgetMap

widgets

unmodifiableWidgets

nextAnonymousWidgetNumber

numUserWidgets

nodeWidgets

explicitlyVisible

explicitlyHidden

explicitlyHighlighted

explicitlyMasked

entityClass

depth

propertyMap

Constructor Detail

LinkageNode

Method Detail

getSubFrameName

getSubFrame

getSubFrame

setExplicitlyVisible

isExplicitlyVisible

setExplicitlyHidden

isExplicitlyHidden

setExplicitlyHighlighted

isExplicitlyHighlighted

setExplicitlyMasked

isExplicitlyMasked

getName

isAutoNamed

setName

checkName

checkNamePattern

getParent

getChild

getChildren

hasChildren

isTreeLeaf

hasDescendant