ptolemy.domains.gr.lib
Class Translate2D

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

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

This actor represents a translation of a two-dimensional GR scene.

Since:

Ptolemy II 4.0

Version:

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

Author:

Steve Neuendorffer

See Also:

Serialized Form

Accepted Rating:

Red (chf)

Proposed Rating:

Yellow (chf)

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Parameter	initialXTranslation The initial translation in the x-axis This parameter should contain a DoubleToken.
Parameter	initialYTranslation The initial translation in the y-axis This parameter should contain a DoubleToken.
TypedIOPort	xTranslate The amount of translation in the x-axis during firing.
TypedIOPort	yTranslate The amount of translation in the y-axis during firing.

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

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

Method Summary

protected void	_applyInitialTransform(Figure figure) Set the initial transform of the given figure.
protected void	_applyTransform(Figure figure) Consume input tokens, and transform the given figure according to the current state of the transform.

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

xTranslate

public TypedIOPort xTranslate

The amount of translation in the x-axis during firing. If this transform is in accumulate mode, the translation value is accumulated for each firing.

yTranslate

public TypedIOPort yTranslate

The amount of translation in the y-axis during firing. If this transform is in accumulate mode, the translation value is accumulated for each firing.

initialXTranslation

public Parameter initialXTranslation

The initial translation in the x-axis This parameter should contain a DoubleToken. The default value of this parameter is 0.0.

initialYTranslation

public Parameter initialYTranslation

The initial translation in the y-axis This parameter should contain a DoubleToken. The default value of this parameter is 0.0.

Constructor Detail

Translate2D

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

Set the initial transform of the given figure. This method is invoked by this base class during the initialize() method. Derived classes should implement it to provide class-specific behavior.

Specified by:

_applyInitialTransform in class GRTransform2D

Parameters:

figure - The figure to transform.

Throws:

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

_applyTransform

protected void _applyTransform(Figure figure)
                        throws IllegalActionException

Consume input tokens, and transform the given figure according to the current state of the transform. This method is invoked by this base classes during the fire() method.

Specified by:

_applyTransform in class GRTransform2D

Parameters:

figure - The figure to transform.

Throws:

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