EntityClass

java.lang.Object
- java.lang.Enum<EntityClass>
- - msim.model.EntityClass

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<EntityClass>

@ThreadSafe
public enum EntityClass
extends java.lang.Enum<EntityClass>

Classes and subclasses of all model entities.

During topological analysis (Controller.analyze()), every model entity is assigned an EntityClass according to its type and location within the current Linkage topology.

Overall entity class hierarchy:

 NODES
   LINKS
     GROUND_LINK
   JOINTS
     TREE_JOINTS
       TREE_ROOT_JOINTS
     CLOSURE_JOINTS
       UNCONSTRAINED_ROOT_CLOSURE_JOINTS
       GRAVITY_CONSTRAINED_ROOT_CLOSURE_JOINTS
       LOCKED_ROOT_CLOSURE_JOINTS
 WIDGETS
   LINK_WIDGETS
     USER_LINK_WIDGETS
     LINK_AXES
     LINK_LABELS
     LINK_COMS
     LINK_SUBFRAME_ROUTES
   JOINT_WIDGETS
     USER_JOINT_WIDGETS
     MOBILITY_WIDGETS
       MOBILITY_SURFACES
         SLIDER_SURFACES
       MOBILITY_SLIDERS
     ROUTES
       TREE_ROUTES
         DEGENERATE_TREE_ROUTES
       CLOSURE_ROUTES
         DEGENERATE_CLOSURE_ROUTES
     ROUTE_CONES
     JOINT_AXES
     JOINT_LABELS
 GEOMETRIES
 SUBFRAMES 
   LINK_SUBFRAMES
     USER_LINK_SUBFRAMES
   JOINT_SUBFRAMES

Author:: Marsette A. Vona, III

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EntityClass.Visibility
Possible visibility states for a entity, in order from least to most visible.

Nested Classes
Modifier and Type	Class and Description
`static class`	`EntityClass.Visibility` Possible visibility states for a entity, in order from least to most visible.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CLOSURE_JOINTS`
`CLOSURE_ROUTES`
`DEGENERATE_CLOSURE_ROUTES`
`DEGENERATE_TREE_ROUTES`
`GEOMETRIES`
`GRAVITY_CONSTRAINED_ROOT_CLOSURE_JOINTS`
`GROUND_LINK`
`JOINT_AXES`
`JOINT_LABELS`
`JOINT_SUBFRAMES`
`JOINT_WIDGETS`
`JOINTS`
`LINK_AXES`
`LINK_COMS`
`LINK_LABELS`
`LINK_SUBFRAME_ROUTES`
`LINK_SUBFRAMES`
`LINK_WIDGETS`
`LINKS`
`LOCKED_ROOT_CLOSURE_JOINTS`
`MOBILITY_SLIDERS`
`MOBILITY_SURFACES`
`MOBILITY_WIDGETS`
`NODES`
`ROUTE_CONES`
`ROUTES`
`SLIDER_SURFACES`
`SUBFRAMES`
`TREE_JOINTS`
`TREE_ROOT_JOINTS`
`TREE_ROUTES`
`UNCONSTRAINED_ROOT_CLOSURE_JOINTS`
`USER_JOINT_WIDGETS`
`USER_LINK_SUBFRAMES`
`USER_LINK_WIDGETS`
`WIDGETS`

Field Summary

Fields
Modifier and Type	Field and Description
`static EntityClass[]`	`ALL` set of all `EntityClass` of the indicated type
`java.util.List<EntityClass>`	`children` the child entity classes
`protected java.util.List<EntityClass>`	`childrenImpl` mutable impl of `children`
`private static java.lang.String`	`cvsid`
`static EntityClass[]`	`DEF_HIDDEN` override for default `visibility` `EntityClass.Visibility.VISIBLE`
`static EntityClass[]`	`DEF_INDIVIDUALLY_PICKABLE` override for default `individuallyPickable` `false`
`protected boolean`	`individuallyPickable` Whether pick records are generated for entities of this `EntityClass`.
`static int`	`NUM` number of `EntityClass` of the indicated type
`static int`	`NUM_ROOTS` number of `EntityClass` of the indicated type
`static int`	`NUM_TERMINALS` number of `EntityClass` of the indicated type
`EntityClass`	`parent` the parent entity class, null if none
`protected boolean`	`pickable` Current pickability of this `EntityClass`
`static EntityClass[]`	`ROOTS` set of all `EntityClass` of the indicated type
`static EntityClass[]`	`TERMINALS` set of all `EntityClass` of the indicated type
`protected EntityClass.Visibility`	`visibility` current visibility state of this `EntityClass`
`static java.lang.String`	`WP_ENTITY_CLASS` `Widget` property caching most specific `EntityClass`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`dump()` `dump(String, PrintStream)` to System.out, no prefix
`void`	`dump(java.io.PrintStream s)` `dump(String, PrintStream)`, no prefix
`void`	`dump(java.lang.String prefix, java.io.PrintStream s)` dump settings of this `EntityClass`
`static void`	`dumpAll()` `dumpAll(PrintStream)` to System.out
`static void`	`dumpAll(java.io.PrintStream s)` `dumpRecursively(PrintStream)` all `ROOTS`
`void`	`dumpRecursively()` `dumpRecursively(String, PrintStream)` to System.out, no prefix
`void`	`dumpRecursively(java.io.PrintStream s)` `dumpRecursively(String, PrintStream)`, no prefix
`void`	`dumpRecursively(java.lang.String prefix, java.io.PrintStream s)` Recursively `dump(String, PrintStream)` this class and its subclasses.
`boolean`	`getIndividuallyPickable()` get `individuallyPickable`
`static EntityClass`	`getMostSpecificClass(javax.media.j3d.Geometry g)` get the most specific `EntityClass` of g
`static EntityClass`	`getMostSpecificClass(LinkageNode.SubFrame s)` get the most specific `EntityClass` of s
`static EntityClass`	`getMostSpecificClass(LinkageNode n)` get the most specific entity class for node n
`static EntityClass`	`getMostSpecificClass(LinkageNode n, java.lang.String frame)` Impl of `getMostSpecificClass(msim.model.LinkageNode.SubFrame)`.
`static EntityClass`	`getMostSpecificClass(java.lang.Object o)` `getMostSpecificClass(LinkageNode)`, `getMostSpecificClass(msim.model.LinkageNode.SubFrame)`, `getMostSpecificClass(Widget)`, or `getMostSpecificClass(Geometry)`, depending on the type of o.
`static EntityClass`	`getMostSpecificClass(vona.j3d.Widget w)` Covers `getMostSpecificClass(Widget, LinkageNode)`, gets the node from the `LinkageNode.WP_NODE` property.
`static EntityClass`	`getMostSpecificClass(vona.j3d.Widget w, LinkageNode n)` Get the most specific entity class for `Widget` w in node n.
`boolean`	`getPickable()` get `pickable`
`EntityClass.Visibility`	`getVisibility()` get `visibility`
`boolean`	`hasSubclass(EntityClass c)` check if c is this class or a subclass
`boolean`	`isIndividuallyPickable()` Checks if this or any ancestor classes is `individuallyPickable`.
`boolean`	`isInstance(LinkageNode n)` Check if the most specific `EntityClass` of n is this class or a subclass.
`boolean`	`isInstance(java.lang.Object o)` Check if the most specific `EntityClass` of o is this class or a subclass.
`boolean`	`isInstance(vona.j3d.Widget w)` Check if the most specific `EntityClass` of w in its `LinkageNode.WP_NODE` is this class or a subclass.
`boolean`	`isInstance(vona.j3d.Widget w, LinkageNode n)` Check if the most specific `EntityClass` of w in n is this class or a subclass.
`boolean`	`isMasked()` Checks if this or any ancestor classes is `EntityClass.Visibility.MASKED`.
`boolean`	`isPickable()` Checks if this and all ancestor classes is `pickable`.
`boolean`	`isVisible()` Checks if neither this nor any ancestor classes is `EntityClass.Visibility.HIDDEN`.
`void`	`setIndividuallyPickable(boolean p)` set `individuallyPickable`
`void`	`setPickable(boolean p)` set `pickable`
`void`	`setVisibility(EntityClass.Visibility v)` set `visibility`
`static EntityClass`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static EntityClass[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - NODES
```
public static final EntityClass NODES
```
  - WIDGETS
```
public static final EntityClass WIDGETS
```
  - GEOMETRIES
```
public static final EntityClass GEOMETRIES
```
  - SUBFRAMES
```
public static final EntityClass SUBFRAMES
```
  - LINKS
```
public static final EntityClass LINKS
```
  - GROUND_LINK
```
public static final EntityClass GROUND_LINK
```
  - JOINTS
```
public static final EntityClass JOINTS
```
  - TREE_JOINTS
```
public static final EntityClass TREE_JOINTS
```
  - TREE_ROOT_JOINTS
```
public static final EntityClass TREE_ROOT_JOINTS
```
  - CLOSURE_JOINTS
```
public static final EntityClass CLOSURE_JOINTS
```
  - UNCONSTRAINED_ROOT_CLOSURE_JOINTS
```
public static final EntityClass UNCONSTRAINED_ROOT_CLOSURE_JOINTS
```
  - GRAVITY_CONSTRAINED_ROOT_CLOSURE_JOINTS
```
public static final EntityClass GRAVITY_CONSTRAINED_ROOT_CLOSURE_JOINTS
```
  - LOCKED_ROOT_CLOSURE_JOINTS
```
public static final EntityClass LOCKED_ROOT_CLOSURE_JOINTS
```
  - LINK_WIDGETS
```
public static final EntityClass LINK_WIDGETS
```
  - JOINT_WIDGETS
```
public static final EntityClass JOINT_WIDGETS
```
  - USER_LINK_WIDGETS
```
public static final EntityClass USER_LINK_WIDGETS
```
  - USER_JOINT_WIDGETS
```
public static final EntityClass USER_JOINT_WIDGETS
```
  - MOBILITY_WIDGETS
```
public static final EntityClass MOBILITY_WIDGETS
```
  - MOBILITY_SURFACES
```
public static final EntityClass MOBILITY_SURFACES
```
  - MOBILITY_SLIDERS
```
public static final EntityClass MOBILITY_SLIDERS
```
  - SLIDER_SURFACES
```
public static final EntityClass SLIDER_SURFACES
```
  - ROUTES
```
public static final EntityClass ROUTES
```
  - TREE_ROUTES
```
public static final EntityClass TREE_ROUTES
```
  - CLOSURE_ROUTES
```
public static final EntityClass CLOSURE_ROUTES
```
  - DEGENERATE_TREE_ROUTES
```
public static final EntityClass DEGENERATE_TREE_ROUTES
```
  - DEGENERATE_CLOSURE_ROUTES
```
public static final EntityClass DEGENERATE_CLOSURE_ROUTES
```
  - ROUTE_CONES
```
public static final EntityClass ROUTE_CONES
```
  - LINK_AXES
```
public static final EntityClass LINK_AXES
```
  - JOINT_AXES
```
public static final EntityClass JOINT_AXES
```
  - LINK_LABELS
```
public static final EntityClass LINK_LABELS
```
  - JOINT_LABELS
```
public static final EntityClass JOINT_LABELS
```
  - LINK_COMS
```
public static final EntityClass LINK_COMS
```
  - LINK_SUBFRAME_ROUTES
```
public static final EntityClass LINK_SUBFRAME_ROUTES
```
  - LINK_SUBFRAMES
```
public static final EntityClass LINK_SUBFRAMES
```
  - USER_LINK_SUBFRAMES
```
public static final EntityClass USER_LINK_SUBFRAMES
```
  - JOINT_SUBFRAMES
```
public static final EntityClass JOINT_SUBFRAMES
```
- Field Detail
  - cvsid
```
private static final java.lang.String cvsid
```
    See Also:
    Constant Field Values
  - WP_ENTITY_CLASS
```
public static final java.lang.String WP_ENTITY_CLASS
```
    Widget property caching most specific EntityClass
    
    See Also:
    Constant Field Values
  - parent
```
public final EntityClass parent
```
    the parent entity class, null if none
  - childrenImpl
```
protected final java.util.List<EntityClass> childrenImpl
```
    mutable impl of children
  - children
```
public final java.util.List<EntityClass> children
```
    the child entity classes
  - visibility
```
protected EntityClass.Visibility visibility
```
    current visibility state of this EntityClass
  - pickable
```
protected boolean pickable
```
    Current pickability of this EntityClass
    
    An entity's class and all super-classes, plus classes and superclasses of containing entities, must be pickable in order to to be considered for picking at all. However, pick records are only generated for entities whose class or any superclass thereof is individuallyPickable.
    
    Initially, all classes are pickable, but only DEF_INDIVIDUALLY_PICKABLE are individuallyPickable.
  - individuallyPickable
```
protected boolean individuallyPickable
```
    Whether pick records are generated for entities of this EntityClass.
    
    See pickable.
  - DEF_HIDDEN
```
public static final EntityClass[] DEF_HIDDEN
```
    override for default visibility EntityClass.Visibility.VISIBLE
  - DEF_INDIVIDUALLY_PICKABLE
```
public static final EntityClass[] DEF_INDIVIDUALLY_PICKABLE
```
    override for default individuallyPickable false
  - ALL
```
public static final EntityClass[] ALL
```
    set of all EntityClass of the indicated type
  - ROOTS
```
public static final EntityClass[] ROOTS
```
    set of all EntityClass of the indicated type
  - TERMINALS
```
public static final EntityClass[] TERMINALS
```
    set of all EntityClass of the indicated type
  - NUM
```
public static final int NUM
```
    number of EntityClass of the indicated type
  - NUM_ROOTS
```
public static final int NUM_ROOTS
```
    number of EntityClass of the indicated type
  - NUM_TERMINALS
```
public static final int NUM_TERMINALS
```
    number of EntityClass of the indicated type
- Method Detail
  - values
```
public static EntityClass[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (EntityClass c : EntityClass.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EntityClass valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - setVisibility
```
public void setVisibility(EntityClass.Visibility v)
```
    set visibility
  - getVisibility
```
public EntityClass.Visibility getVisibility()
```
    get visibility
  - isVisible
```
public boolean isVisible()
```
    Checks if neither this nor any ancestor classes is EntityClass.Visibility.HIDDEN.
  - isMasked
```
public boolean isMasked()
```
    Checks if this or any ancestor classes is EntityClass.Visibility.MASKED.
  - setPickable
```
public void setPickable(boolean p)
```
    set pickable
  - getPickable
```
public boolean getPickable()
```
    get pickable
  - isPickable
```
public boolean isPickable()
```
    Checks if this and all ancestor classes is pickable.
  - setIndividuallyPickable
```
public void setIndividuallyPickable(boolean p)
```
    set individuallyPickable
  - getIndividuallyPickable
```
public boolean getIndividuallyPickable()
```
    get individuallyPickable
  - isIndividuallyPickable
```
public boolean isIndividuallyPickable()
```
    Checks if this or any ancestor classes is individuallyPickable.
  - getMostSpecificClass
```
public static EntityClass getMostSpecificClass(LinkageNode n)
```
    get the most specific entity class for node n
  - getMostSpecificClass
```
public static EntityClass getMostSpecificClass(vona.j3d.Widget w,
                               LinkageNode n)
```
    Get the most specific entity class for Widget w in node n.
  - getMostSpecificClass
```
public static EntityClass getMostSpecificClass(vona.j3d.Widget w)
```
    Covers getMostSpecificClass(Widget, LinkageNode), gets the node from the LinkageNode.WP_NODE property.
  - getMostSpecificClass
```
public static EntityClass getMostSpecificClass(javax.media.j3d.Geometry g)
```
    get the most specific EntityClass of g
  - getMostSpecificClass
```
public static EntityClass getMostSpecificClass(LinkageNode.SubFrame s)
```
    get the most specific EntityClass of s
  - getMostSpecificClass
```
public static EntityClass getMostSpecificClass(LinkageNode n,
                               java.lang.String frame)
```
    Impl of getMostSpecificClass(msim.model.LinkageNode.SubFrame).
  - getMostSpecificClass
```
public static EntityClass getMostSpecificClass(java.lang.Object o)
```
    getMostSpecificClass(LinkageNode), getMostSpecificClass(msim.model.LinkageNode.SubFrame), getMostSpecificClass(Widget), or getMostSpecificClass(Geometry), depending on the type of o.
  - hasSubclass
```
public boolean hasSubclass(EntityClass c)
```
    check if c is this class or a subclass
  - isInstance
```
public boolean isInstance(LinkageNode n)
```
    Check if the most specific EntityClass of n is this class or a subclass.
  - isInstance
```
public boolean isInstance(vona.j3d.Widget w,
                 LinkageNode n)
```
    Check if the most specific EntityClass of w in n is this class or a subclass.
  - isInstance
```
public boolean isInstance(vona.j3d.Widget w)
```
    Check if the most specific EntityClass of w in its LinkageNode.WP_NODE is this class or a subclass.
  - isInstance
```
public boolean isInstance(java.lang.Object o)
```
    Check if the most specific EntityClass of o is this class or a subclass.
  - dump
```
public void dump(java.lang.String prefix,
        java.io.PrintStream s)
```
    dump settings of this EntityClass
  - dump
```
public void dump(java.io.PrintStream s)
```
    dump(String, PrintStream), no prefix
  - dump
```
public void dump()
```
    dump(String, PrintStream) to System.out, no prefix
  - dumpRecursively
```
public void dumpRecursively(java.lang.String prefix,
                   java.io.PrintStream s)
```
    Recursively dump(String, PrintStream) this class and its subclasses.
  - dumpRecursively
```
public void dumpRecursively(java.io.PrintStream s)
```
    dumpRecursively(String, PrintStream), no prefix
  - dumpRecursively
```
public void dumpRecursively()
```
    dumpRecursively(String, PrintStream) to System.out, no prefix
  - dumpAll
```
public static void dumpAll(java.io.PrintStream s)
```
    dumpRecursively(PrintStream) all ROOTS
  - dumpAll
```
public static void dumpAll()
```
    dumpAll(PrintStream) to System.out

Enum EntityClass

Nested Class Summary

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NODES

WIDGETS

GEOMETRIES

SUBFRAMES

LINKS

GROUND_LINK

JOINTS

TREE_JOINTS

TREE_ROOT_JOINTS

CLOSURE_JOINTS

UNCONSTRAINED_ROOT_CLOSURE_JOINTS

GRAVITY_CONSTRAINED_ROOT_CLOSURE_JOINTS

LOCKED_ROOT_CLOSURE_JOINTS

LINK_WIDGETS

JOINT_WIDGETS

USER_LINK_WIDGETS

USER_JOINT_WIDGETS

MOBILITY_WIDGETS

MOBILITY_SURFACES

MOBILITY_SLIDERS

SLIDER_SURFACES

ROUTES

TREE_ROUTES

CLOSURE_ROUTES

DEGENERATE_TREE_ROUTES

DEGENERATE_CLOSURE_ROUTES

ROUTE_CONES

LINK_AXES

JOINT_AXES

LINK_LABELS

JOINT_LABELS

LINK_COMS

LINK_SUBFRAME_ROUTES

LINK_SUBFRAMES

USER_LINK_SUBFRAMES

JOINT_SUBFRAMES

Field Detail

cvsid

WP_ENTITY_CLASS

parent

childrenImpl

children

visibility

pickable

individuallyPickable

DEF_HIDDEN

DEF_INDIVIDUALLY_PICKABLE

ALL

ROOTS

TERMINALS

NUM

NUM_ROOTS

NUM_TERMINALS

Method Detail

values

valueOf

setVisibility

getVisibility

isVisible

isMasked

setPickable

getPickable

isPickable

setIndividuallyPickable

getIndividuallyPickable

isIndividuallyPickable

getMostSpecificClass

getMostSpecificClass

getMostSpecificClass

getMostSpecificClass

getMostSpecificClass

getMostSpecificClass