ptolemy.domains.gr.lib
Class GRTransform2D
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
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
- Direct Known Subclasses:
- Rotate2D, Scale2D, Translate2D
public abstract class GRTransform2D
- extends GRActor2D
An abstract base class for a transform operator of two-dimensional
GR shapes.
The parameter accumulate determines whether transformations are
accumulated or reset during firing.
- Since:
- Ptolemy II 4.0
- Version:
- $Id: GRTransform2D.java 57040 2010-01-27 20:52:32Z cxh $
- Author:
- Steve Neuendorffer
- See Also:
- Serialized Form
- Accepted Rating:
- Proposed Rating:
Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
Method Summary |
protected abstract void |
_applyInitialTransform(Figure figure)
Set the initial transform of the given figure. |
protected abstract void |
_applyTransform(Figure figure)
Consume input tokens, and transform the given figure according
to the current state of the transform. |
protected boolean |
_isAccumulating()
Return the value of the accumulate parameter. |
protected void |
_makeSceneGraphConnection()
Setup the scene graph connections of this actor. |
void |
fire()
Consume inputs from any input ports and apply transformation
according to the state of this actor. |
void |
initialize()
Setup the transform object. |
Methods inherited from class ptolemy.domains.gr.kernel.GRActor |
wrapup |
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.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 |
accumulate
public Parameter accumulate
- Boolean value determining whether transformations are
accumulated or reset for each firing.
sceneGraphIn
public TypedIOPort sceneGraphIn
- The input port for connecting to other GR Actors in
the scene graph.
sceneGraphOut
public TypedIOPort sceneGraphOut
- The output port for connecting to other GR Actors in
the scene graph.
_figure
private CompositeFigure _figure
GRTransform2D
public GRTransform2D(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.
fire
public void fire()
throws IllegalActionException
- Consume inputs from any input ports and apply transformation
according to the state of this actor.
- Specified by:
fire
in interface Executable
- Overrides:
fire
in class GRActor
- Throws:
IllegalActionException
- If the value of some parameters
can't be obtained.
initialize
public void initialize()
throws IllegalActionException
- Setup the transform object.
- Specified by:
initialize
in interface Initializable
- Overrides:
initialize
in class GRActor
- Throws:
IllegalActionException
- If the current director
is not a GRDirector.
_isAccumulating
protected boolean _isAccumulating()
throws IllegalActionException
- Return the value of the accumulate parameter.
- Returns:
- the accumulation mode.
- Throws:
IllegalActionException
- If the value of some parameters can't
be obtained
_makeSceneGraphConnection
protected void _makeSceneGraphConnection()
throws IllegalActionException
- Setup the scene graph connections of this actor.
- Specified by:
_makeSceneGraphConnection
in class GRActor
- Throws:
IllegalActionException
- Always thrown for this base class.
_applyInitialTransform
protected abstract 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.
- Parameters:
figure
- The figure to transform.
- Throws:
IllegalActionException
- If the value of some
parameters can't be obtained.
_applyTransform
protected abstract 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. Derived classes
should implement it to provide class-specific behavior.
- Parameters:
figure
- The figure to transform.
- Throws:
IllegalActionException
- If the value of some
parameters can't be obtained.