Package ptolemy.domains.gr.lib

Class Torus3D

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

ptolemy.domains.gr.kernel.GRActor

ptolemy.domains.gr.kernel.GRActor3D

ptolemy.domains.gr.lib.GRShadedShape

ptolemy.domains.gr.lib.Torus3D

All Implemented Interfaces:

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

public class Torus3D
extends GRShadedShape

This actor contains the geometry and appearance specifications for a GR torus. 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 parameter hullRadius determines the radius of torus ring. The parameter crossSectionRadius determines the radius of the torus cross-section. The parameter slices determines the number of polygonal slices used in the creating the torus.

Since:

Ptolemy II 1.0

Version:

$Id$

Author:

C. Fong

Pt.AcceptedRating:

Red (chf)

Pt.ProposedRating:

Red (chf)

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field	Description
Parameter	angleSpan	The span of torus sweep angle This parameter should contain a DoubleToken.
Parameter	crossSectionRadius	The radius of the torus cross-section This parameter should contain a DoubleToken.
Parameter	hullRadius	The radius of the torus outer hull This parameter should contain a DoubleToken.
Parameter	slices	The number of slices This parameter should contain a IntToken.

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.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _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

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	_createModel()	Create the shape and appearance of the encapsulated torus.
protected javax.media.j3d.Node	_getNodeObject()	Return the encapsulated Java3D node of this 3D actor.

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

_createAppearance, _makeSceneGraphConnection, _setViewScreen, attributeChanged, 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

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, 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

_addPort, _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, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, decorators, 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, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, 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.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

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

Field Detail

crossSectionRadius

public Parameter crossSectionRadius

The radius of the torus cross-section This parameter should contain a DoubleToken.

hullRadius

public Parameter hullRadius

The radius of the torus outer hull This parameter should contain a DoubleToken.

angleSpan

public Parameter angleSpan

The span of torus sweep angle This parameter should contain a DoubleToken.

slices

public Parameter slices

The number of slices This parameter should contain a IntToken.

Constructor Detail

Torus3D

public Torus3D(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

_createModel

protected void _createModel()
                     throws IllegalActionException

Create the shape and appearance of the encapsulated torus.

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 encapsulated Java3D node of this 3D actor. The encapsulated node for this actor is a customized torus.

Specified by:

_getNodeObject in class GRActor3D

Returns:

the torus node