Package sim.portrayal3d

Class SparseFieldPortrayal3D

java.lang.Object

sim.portrayal.FieldPortrayal

sim.portrayal3d.FieldPortrayal3D

sim.portrayal3d.SparseFieldPortrayal3D

All Implemented Interfaces:

Portrayal, Portrayal3D

Direct Known Subclasses:

ContinuousPortrayal3D, SparseGridPortrayal3D

public abstract class SparseFieldPortrayal3D
extends FieldPortrayal3D

An abstract superclass for all FieldPortrayal3Ds which display SparseFields. This class handles the createModel() and updateModel() methods for you; all you need to implement are the setField(), completedWrapper(), and getLocationOfObjectAsVector3d() methods.

SparseFieldPortrayal3D presently takes the TransformGroups of the models of its children and wraps them into BranchGroups so that they can be removed and added dynamically.

Field Summary

Fields inherited from class sim.portrayal.FieldPortrayal

classPortrayals, field, immutableField, portrayalForAll, portrayalForNonNull, portrayalForNull, portrayalForRemainder, portrayals

Constructor Summary

Constructors

Constructor	Description
SparseFieldPortrayal3D()

Method Summary

Modifier and Type	Method	Description
javax.media.j3d.TransformGroup	createModel()	Returns a tree structure of the form InternalTransformGroup[model info].
abstract javax.vecmath.Vector3d	getLocationOfObjectAsVector3d(Object location, javax.vecmath.Vector3d putInHere)	Converts a given location (perhaps a Double3D, Double2D, Int3D, or Int2D) into a Vector3d, placing it in the given Vector3d, and returning that Vector3d.
void	updateModel(javax.media.j3d.TransformGroup globalTG)	Returns a tree structure of the form InternalTransformGroup[model info].
protected javax.media.j3d.BranchGroup	wrapModelForNewObject(Object o, javax.media.j3d.Transform3D localT)	This function is called from createModel for each object in the field and from the updateModel part of getModel for the new objects.

Methods inherited from class sim.portrayal3d.FieldPortrayal3D

completedWrapper, getCurrentDisplay, getCurrentGUIState, getDefaultPortrayal, getDefaultTransform, getModel, getObjectLocation, getTransform, polygonAttributes, resetTransform, rotateX, rotateY, rotateZ, scale, scale, setCurrentDisplay, setObjectLocation, setTransform, transform, translate

Methods inherited from class sim.portrayal.FieldPortrayal

getAlternatePortrayalOrdering, getDefaultNullPortrayal, getField, getInspector, getName, getPortrayalForAll, getPortrayalForNonNull, getPortrayalForNull, getPortrayalForObject, getPortrayalForRemainder, getStatus, isDirtyField, isImmutableField, reset, setAlternatePortrayalOrdering, setDirtyField, setField, setImmutableField, setPortrayalForAll, setPortrayalForClass, setPortrayalForNonNull, setPortrayalForNull, setPortrayalForObject, setPortrayalForRemainder, setSelected, setSelected

Methods inherited from class java.lang.Object

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

Methods inherited from interface sim.portrayal.Portrayal

getInspector, getName, getStatus, setSelected

Constructor Details

SparseFieldPortrayal3D

public SparseFieldPortrayal3D()

Method Details

getLocationOfObjectAsVector3d

public abstract javax.vecmath.Vector3d getLocationOfObjectAsVector3d(Object location,
 javax.vecmath.Vector3d putInHere)

Converts a given location (perhaps a Double3D, Double2D, Int3D, or Int2D) into a Vector3d, placing it in the given Vector3d, and returning that Vector3d. Double2D and Int2D should convert to a Vector3d with a zero Z value.

createModel

public javax.media.j3d.TransformGroup createModel()

Description copied from class: FieldPortrayal3D

Returns a tree structure of the form InternalTransformGroup[model info].

...where InternalTransformGroup is an identity transformgroup whose transform will be modified elsewhere (create it but don't play with it).

Specified by:

createModel in class FieldPortrayal3D

wrapModelForNewObject

protected javax.media.j3d.BranchGroup wrapModelForNewObject(Object o,
 javax.media.j3d.Transform3D localT)

This function is called from createModel for each object in the field and from the updateModel part of getModel for the new objects.

In order to dynamically add/remove the subtrees associated with children, this function wraps their TransformGroups into BranchGroups.

updateModel

public void updateModel(javax.media.j3d.TransformGroup globalTG)

Description copied from class: FieldPortrayal3D

Returns a tree structure of the form InternalTransformGroup[model info].

...where InternalTransformGroup is an identity transformgroup whose transform will be modified elsewhere (don't play with it). By default, this function does nothing. Override it to update the model when it's called.

Overrides:

updateModel in class FieldPortrayal3D