Package ptolemy.domains.gr.lib

Class Rectangle2D

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

ptolemy.domains.gr.lib.GRShape2D

ptolemy.domains.gr.lib.RectangularFigure2D

ptolemy.domains.gr.lib.Rectangle2D

All Implemented Interfaces:

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

public class Rectangle2D
extends RectangularFigure2D

An actor that creates a rectangle or a rounded rectangle. The initial size, position, and type of figure are specified in the parameter edit window and can be changed after the figure has been displayed. The arcWidth and arcHeight parameters determine the "roundedness" of the corners, and should be zero for a boring old rectangle.

Since:

Ptolemy II 4.0

Version:

$Id$

Author:

Ismael M. Sarmiento, Steve Neuendorffer

Pt.AcceptedRating:

Yellow (chf)

Pt.ProposedRating:

Green (ismael)

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field	Description
Parameter	arcHeight	The height of the arc rounding the rectangle if applicable.
Parameter	arcWidth	The width of the arc rounding the rectangle if applicable.

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

height, width, xPosition, yPosition

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

_figure, outlineWidth, rgbFillColor, rgbOutlineColor, sceneGraphOut

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

_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
Rectangle2D(CompositeEntity container, java.lang.String name)	Construct an actor with the given container and name.

Method Summary

Modifier and Type	Method	Description
protected BasicFigure	_createFigure()	Implement the base class to create a rectangular shape.
protected void	_updateFigure()	Update the figure's position and size when the user changes the appropriate parameters.

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

_getCenterOffset, _getCenterPoint, _getCornerPoint, attributeChanged

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

_makeSceneGraphConnection, getFigure, initialize, prefire

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

_setViewScreen

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

fire, wrapup

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, 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, preinitialize, 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, preinitialize, removeInitializable

Methods inherited from interface ptolemy.kernel.util.Nameable

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

Field Detail

arcWidth

public Parameter arcWidth

The width of the arc rounding the rectangle if applicable.

arcHeight

public Parameter arcHeight

The height of the arc rounding the rectangle if applicable.

Constructor Detail

Rectangle2D

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

_createFigure

protected BasicFigure _createFigure()
                             throws IllegalActionException

Implement the base class to create a rectangular shape.

Specified by:

_createFigure in class RectangularFigure2D

Returns:

A new Figure.

Throws:

IllegalActionException - If a parameter value is not valid.

_updateFigure

protected void _updateFigure()
                      throws IllegalActionException

Update the figure's position and size when the user changes the appropriate parameters.

Specified by:

_updateFigure in class RectangularFigure2D

Throws:

IllegalActionException - If a parameter value is not valid.