ptolemy.domains.gr.lib
Class Scale2D

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.GRActor2D
                                  ptolemy.domains.gr.lib.GRTransform2D
                                      ptolemy.domains.gr.lib.Scale2D

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 Scale2D
extends GRTransform2D

Scale a two-dimensional figure by the x and y factor provided by the user. If accumulate is set to true, any changes to the scale will be be relative to the figure's current size. Otherwise, the scaling factor specified will be relative to the original size of the figure.

Since:

Ptolemy II 4.0

Version:

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

Author:

Ismael M. Sarmiento, Steve Neuendorffer

See Also:

Serialized Form

Accepted Rating:

Yellow (chf)

Proposed Rating:

Green (ismael)

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

private double	_oldScaleFactorX
private double	_oldScaleFactorY
(package private) Parameter	initialScaleFactorX The initial scale factor of the figure in the x direction.
(package private) Parameter	initialScaleFactorY The initial scale factor of the figure in the y direction.
(package private) TypedIOPort	scaleFactorX The factor by which to increase the figure size on the x-axis.
(package private) TypedIOPort	scaleFactorY The factor by which to increase the figure size on the y-axis.

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

accumulate, sceneGraphIn, 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.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

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

Method Summary

protected void	_applyInitialTransform(Figure figure) Apply the initial scaling transformation to the figure.
protected void	_applyTransform(Figure figure) Apply the current scaling transformation to the figure.

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

_isAccumulating, _makeSceneGraphConnection, fire, initialize

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

_setViewScreen

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

wrapup

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, clone, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, prefire, 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

_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, attributeChanged, 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, prefire, 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

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

initialScaleFactorX

Parameter initialScaleFactorX

The initial scale factor of the figure in the x direction.

initialScaleFactorY

Parameter initialScaleFactorY

The initial scale factor of the figure in the y direction.

scaleFactorX

TypedIOPort scaleFactorX

The factor by which to increase the figure size on the x-axis.

scaleFactorY

TypedIOPort scaleFactorY

The factor by which to increase the figure size on the y-axis.

_oldScaleFactorX

private double _oldScaleFactorX

_oldScaleFactorY

private double _oldScaleFactorY

Constructor Detail

Scale2D

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

_applyInitialTransform

protected void _applyInitialTransform(Figure figure)
                               throws IllegalActionException

Apply the initial scaling transformation to the figure.

Specified by:

_applyInitialTransform in class GRTransform2D

Parameters:

figure - The figure the transformation is to be applied to.

Throws:

IllegalActionException - If the getToken() method throws such an exception.

_applyTransform

protected void _applyTransform(Figure figure)
                        throws IllegalActionException

Apply the current scaling transformation to the figure.

Specified by:

_applyTransform in class GRTransform2D

Parameters:

figure - The figure the transformation is to be applied to.

Throws:

IllegalActionException - If the getToken() method throws such an exception.