ptolemy.domains.gr.lib
Class Cone3D

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.InstantiableNamedObj
          ptolemy.kernel.Entity
              ptolemy.kernel.ComponentEntity
                  ptolemy.actor.AtomicActor
                      ptolemy.actor.TypedAtomicActor
                          ptolemy.domains.gr.kernel.GRActor
                              ptolemy.domains.gr.kernel.GRActor3D
                                  ptolemy.domains.gr.lib.GRShadedShape
                                      ptolemy.domains.gr.lib.Cone3D

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class Cone3D
extends GRShadedShape

This actor contains the geometry and appearance specifications for a cone. The output port is used to connect this actor to the Java3D scene graph. This actor will only have meaning in the GR domain. The radius parameter specifies the radius of the circular base. The height parameter specifies the height of the cone.

Since:

Ptolemy II 1.0

Version:

$Id: Cone3D.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Chamberlain Fong, Edward A. Lee

See Also:

Serialized Form

Accepted Rating:

Green (liuxj)

Proposed Rating:

Green (eal)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

private javax.media.j3d.Node	_containedNode The cone.
private javax.media.j3d.Transform3D	_scaleTransform If changes to the dimensions are allowed, this is the transform that applies them.
Parameter	circleDivisions The number of divisions in the circle forming the base of the cone.
Parameter	height The height of the cone.
Parameter	radius The radius of the base of the cone.
Parameter	sideDivisions The number of divisions on the side of the cone.

Fields inherited from class ptolemy.domains.gr.lib.GRShadedShape

_appearance, _changesAllowedNow, _coloringAttributes, _material, _polygonAttributes, _transparencyAttributes, allowRuntimeChanges, diffuseColor, emissiveColor, flat, sceneGraphOut, shininess, specularColor, texture, transparency, wireFrame

Fields inherited from class ptolemy.domains.gr.kernel.GRActor3D

_viewScreen

Fields inherited from class ptolemy.domains.gr.kernel.GRActor

_allowAttributeChanges, _isSceneGraphInitialized

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Cone3D(CompositeEntity container, java.lang.String name)
Construct an actor with the given container and name.

Method Summary

protected void	_createModel() Create the shape and appearance of the cone.
protected javax.media.j3d.Node	_getNodeObject() Return the cone.
void	attributeChanged(Attribute attribute) If the dimensions change, then update the cone.

Methods inherited from class ptolemy.domains.gr.lib.GRShadedShape

_createAppearance, _makeSceneGraphConnection, _setViewScreen, clone, initialize, prefire, preinitialize, wrapup

Methods inherited from class ptolemy.domains.gr.kernel.GRActor3D

_addChild

Methods inherited from class ptolemy.domains.gr.kernel.GRActor

fire

Methods inherited from class ptolemy.actor.TypedAtomicActor

_addPort, _fireAt, _fireAt, attributeTypeChanged, clone, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.actor.Executable

isFireFunctional, isStrict, iterate, postfire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, removeInitializable

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

circleDivisions

public Parameter circleDivisions

The number of divisions in the circle forming the base of the cone. This is an integer with default value "max(6, roundToInt(radius * 100))". This parameter determines the resolution of the cone, which is approximated as a surface composed of triangular facets. Increasing this value makes the surface smoother, but also increases the cost of rendering.

height

public Parameter height

The height of the cone. This is a double that defaults to 0.5.

sideDivisions

public Parameter sideDivisions

The number of divisions on the side of the cone. This is an integer with default value "1". This parameter probably only needs to change when the wireFrame parameter is set to true.

radius

public Parameter radius

The radius of the base of the cone. This is a double that defaults to 0.7.

_scaleTransform

private javax.media.j3d.Transform3D _scaleTransform

If changes to the dimensions are allowed, this is the transform that applies them.

_containedNode

private javax.media.j3d.Node _containedNode

The cone.

Constructor Detail

Cone3D

public Cone3D(CompositeEntity container,
              java.lang.String name)
       throws IllegalActionException,
              NameDuplicationException

Construct an actor with the given container and name.

Parameters:

container - The container.

name - The name of this actor.

Throws:

IllegalActionException - If the actor cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

If the dimensions change, then update the cone.

Overrides:

attributeChanged in class GRShadedShape

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the change is not acceptable to this container (not thrown in this base class).

_createModel

protected void _createModel()
                     throws IllegalActionException

Create the shape and appearance of the cone.

Overrides:

_createModel in class GRShadedShape

Throws:

IllegalActionException - If the value of some parameters can't be obtained.

_getNodeObject

protected javax.media.j3d.Node _getNodeObject()

Return the cone.

Specified by:

_getNodeObject in class GRActor3D

Returns:

The Java3D cone.