sim.portrayal3d.simple
Class LabelledPortrayal3D

java.lang.Object
  extended by sim.portrayal3d.SimplePortrayal3D
      extended by sim.portrayal3d.simple.LabelledPortrayal3D
All Implemented Interfaces:
java.io.Serializable, Portrayal, Portrayal3D

public class LabelledPortrayal3D
extends SimplePortrayal3D

A wrapper for other Portrayal3Ds which also draws a textual label. When you create this LabelledPortrayal3D, you will pass in an underlying Portrayal3D which is supposed to represent the actual object; LabelledPortrayal3D will then add on an underlying label. If the object will draw itself (it's its own Portrayal3D), you can signify this by passing in null for the underlying Portrayal3D.

You provide a string label at construction time. The LabelledPortrayal2D will retrieve the label by calling getLabel(Object obj, DrawInfo2D info) at draw time to get the expected label. By default the getLabel function will return the label you had provided at construction; if your provided label was null, then getLabel will by default return the string name of the object. You are free to override this function to provide more specialized label information. Beware that every time you change a label, the object has to generate a new label object and insert it into the system. This is expensive.

There are certain guidelines you can specify for when the label is to be drawn. At construction time you can state that the label should only be drawn when the object is selected. Additionally if you call the setLabelShowing(...) function, you can turn off or on label drawing entirely for this LabelledPortrayal2D.

You may specify a color, or font for the label. You can also provide a scale for the text relative to the labelled object: a scale of 1.0f (the default) is fairly reasonable for small objects. The label is drawn at the (0.5,0.5,0.5) corner of the object by default: you can change this offset in the constructor if you like.

The label will always be drawn directly facing the viewer regardless of the rotation of the model.

Labelled

See Also:
Serialized Form

Field Summary
protected  SimplePortrayal3D child
           
 java.awt.Color color
           
static javax.media.j3d.Transform3D DEFAULT_LABEL_OFFSET
           
 java.awt.Font font
           
 java.lang.String label
           
 javax.media.j3d.Transform3D offset
           
 float scale
           
 
Fields inherited from class sim.portrayal3d.SimplePortrayal3D
DEFAULT_APPEARANCE, parentPortrayal
 
Constructor Summary
LabelledPortrayal3D(SimplePortrayal3D child, float offsetx, float offsety, float offsetz, java.awt.Font font, java.lang.String label, java.awt.Color color, float scale, boolean onlyLabelWhenSelected)
           
LabelledPortrayal3D(SimplePortrayal3D child, java.lang.String label)
           
LabelledPortrayal3D(SimplePortrayal3D child, java.lang.String label, java.awt.Color color, boolean onlyLabelWhenSelected)
           
LabelledPortrayal3D(SimplePortrayal3D child, javax.media.j3d.Transform3D offset, java.awt.Font font, java.lang.String label, java.awt.Color color, float scale, boolean onlyLabelWhenSelected)
           
 
Method Summary
 SimplePortrayal3D getChild(java.lang.Object object)
           
 Inspector getInspector(LocationWrapper wrapper, GUIState state)
          Provide an inspector for an object.
 java.lang.String getLabel(java.lang.Object object, javax.media.j3d.TransformGroup j3dModel)
          Returns a name appropriate for the object.
 javax.media.j3d.TransformGroup getModel(java.lang.Object obj, javax.media.j3d.TransformGroup j3dModel)
          Provides a TransformGroup which defines the node(s) to place in the scenegraph.
 java.lang.String getName(LocationWrapper wrapper)
          Returns a static, one-line name for the given object that is useful for a human to distinguish it from other objects.
 boolean getOnlyLabelWhenSelected()
           
 boolean isLabelShowing()
           
 javax.media.j3d.PolygonAttributes polygonAttributes()
          Provides a PolygonAttributes which can be modified to change the underlying model's attributes (culling, vertex versus point versus fill).
 void setLabelShowing(boolean val)
           
 void setOnlyLabelWhenSelected(boolean val)
           
 void setParentPortrayal(FieldPortrayal3D p)
          Sets the parent portrayal (a FieldPortrayal3D).
 boolean setSelected(LocationWrapper wrapper, boolean selected)
          Change the portrayal state to reflect the fact that you've been selected or not selected.
 void updateSwitch(javax.media.j3d.Switch jswitch)
           
 
Methods inherited from class sim.portrayal3d.SimplePortrayal3D
appearanceForColor, appearanceForImage, clearPickableFlags, getStatus, setPickableFlags, setPickableFlags
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_LABEL_OFFSET

public static final javax.media.j3d.Transform3D DEFAULT_LABEL_OFFSET

scale

public float scale

color

public java.awt.Color color

offset

public javax.media.j3d.Transform3D offset

font

public java.awt.Font font

child

protected SimplePortrayal3D child

label

public java.lang.String label
Constructor Detail

LabelledPortrayal3D

public LabelledPortrayal3D(SimplePortrayal3D child,
                           java.lang.String label)

LabelledPortrayal3D

public LabelledPortrayal3D(SimplePortrayal3D child,
                           java.lang.String label,
                           java.awt.Color color,
                           boolean onlyLabelWhenSelected)

LabelledPortrayal3D

public LabelledPortrayal3D(SimplePortrayal3D child,
                           float offsetx,
                           float offsety,
                           float offsetz,
                           java.awt.Font font,
                           java.lang.String label,
                           java.awt.Color color,
                           float scale,
                           boolean onlyLabelWhenSelected)

LabelledPortrayal3D

public LabelledPortrayal3D(SimplePortrayal3D child,
                           javax.media.j3d.Transform3D offset,
                           java.awt.Font font,
                           java.lang.String label,
                           java.awt.Color color,
                           float scale,
                           boolean onlyLabelWhenSelected)
Method Detail

polygonAttributes

public javax.media.j3d.PolygonAttributes polygonAttributes()
Description copied from interface: Portrayal3D
Provides a PolygonAttributes which can be modified to change the underlying model's attributes (culling, vertex versus point versus fill). This is an optional function: you are free to return null

Specified by:
polygonAttributes in interface Portrayal3D
Overrides:
polygonAttributes in class SimplePortrayal3D

getInspector

public Inspector getInspector(LocationWrapper wrapper,
                              GUIState state)
Description copied from interface: Portrayal
Provide an inspector for an object.

Specified by:
getInspector in interface Portrayal
Overrides:
getInspector in class SimplePortrayal3D

getName

public java.lang.String getName(LocationWrapper wrapper)
Description copied from interface: Portrayal
Returns a static, one-line name for the given object that is useful for a human to distinguish it from other objects. A simple default would be just to return "" + object.

Specified by:
getName in interface Portrayal
Overrides:
getName in class SimplePortrayal3D

setParentPortrayal

public void setParentPortrayal(FieldPortrayal3D p)
Description copied from class: SimplePortrayal3D
Sets the parent portrayal (a FieldPortrayal3D).

Overrides:
setParentPortrayal in class SimplePortrayal3D

getLabel

public java.lang.String getLabel(java.lang.Object object,
                                 javax.media.j3d.TransformGroup j3dModel)
Returns a name appropriate for the object. By default, this returns the label, or if label is null, then returns ("" + object). Override this to make a more customized label to display for the object on-screen. The TransformGroup is the one for the underlying portrayal3d.


setSelected

public boolean setSelected(LocationWrapper wrapper,
                           boolean selected)
Description copied from interface: Portrayal
Change the portrayal state to reflect the fact that you've been selected or not selected. Always return true, except if you've received a setSelected(true) and in fact do not wish to be selectable, in which case return false in that sole situation.

Specified by:
setSelected in interface Portrayal
Overrides:
setSelected in class SimplePortrayal3D

setOnlyLabelWhenSelected

public void setOnlyLabelWhenSelected(boolean val)

getOnlyLabelWhenSelected

public boolean getOnlyLabelWhenSelected()

isLabelShowing

public boolean isLabelShowing()

setLabelShowing

public void setLabelShowing(boolean val)

getChild

public SimplePortrayal3D getChild(java.lang.Object object)

updateSwitch

public void updateSwitch(javax.media.j3d.Switch jswitch)

getModel

public javax.media.j3d.TransformGroup getModel(java.lang.Object obj,
                                               javax.media.j3d.TransformGroup j3dModel)
Description copied from interface: Portrayal3D
Provides a TransformGroup which defines the node(s) to place in the scenegraph. This is the Portrayal3D equivalent of Portrayal2D's draw(object, graphics, drawinfo) method.

You should hang your model off of the TransformGroup provided. You should not transform that TransformGroup in any way -- it is used elsewhere. Instead if you wish to transform your model (rotate it etc.) you should add your own additional TransformGroup as necessary.

The provided TransformGroup can be null; in this case you need to create and return the outer TransformGroup for the object. If the provided TransformGroup is non-null, you should modify it and return the same.

SimplePortrayals should assume the following contract: at the point that getModel(...) is called, the parentPortrayal will have already been set if it exists, else it will be null.

Specified by:
getModel in interface Portrayal3D
Overrides:
getModel in class SimplePortrayal3D