VisualSim.simulators.gr.lib
Class Image2D

java.lang.Object
  VisualSim.kernel.util.NamedObj
      VisualSim.kernel.InstantiableNamedObj
          VisualSim.kernel.Entity
              VisualSim.kernel.ComponentEntity
                  VisualSim.actor.AtomicActor
                      VisualSim.actor.TypedAtomicActor
                          VisualSim.simulators.gr.kernel.GRActor
                              VisualSim.simulators.gr.kernel.GRActor2D
                                  VisualSim.simulators.gr.lib.Image2D

All Implemented Interfaces:

VisualSim.actor.Actor, VisualSim.kernel.util.Changeable, java.lang.Cloneable, VisualSim.kernel.util.Debuggable, VisualSim.kernel.util.DebugListener, VisualSim.kernel.util.Derivable, VisualSim.actor.Executable, VisualSim.kernel.util.Instantiable, VisualSim.kernel.util.ModelErrorHandler, VisualSim.kernel.util.MoMLExportable, VisualSim.kernel.util.Moveable, VisualSim.kernel.util.Nameable, java.io.Serializable, VisualSim.actor.TypedActor

public class Image2D

extends VisualSim.simulators.gr.kernel.GRActor2D

Create a figure from a user specified image file in GIF, JPEG, or PNG format.

Since:

VisualSim4.0

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class VisualSim.kernel.Entity

VisualSim.kernel.Entity.ContainedObjectsIterator

Field Summary

protected diva.canvas.toolbox.ImageFigure	_figure The figure which contains the image file.
VisualSim.data.expr.FileParameter	fileOrURL The location of the image file upon which to base the figure.
VisualSim.actor.TypedIOPort	sceneGraphOut The output port that produces the figure.

Fields inherited from class VisualSim.simulators.gr.kernel.GRActor2D

_viewScreen

Fields inherited from class VisualSim.simulators.gr.kernel.GRActor

_allowAttributeChanges, _isSceneGraphInitialized

Fields inherited from class VisualSim.actor.AtomicActor

_stopRequested, Block_Documentation

Fields inherited from class VisualSim.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface VisualSim.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

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

Method Summary

protected diva.canvas.toolbox.ImageFigure	_createFigure() Create the figure for this actor based on the user specified image file.
protected void	_makeSceneGraphConnection() Set up the scene graph connections of this actor.
void	initialize() Create the imageFigure.

Methods inherited from class VisualSim.simulators.gr.kernel.GRActor2D

_setViewScreen

Methods inherited from class VisualSim.simulators.gr.kernel.GRActor

fire, wrapup

Methods inherited from class VisualSim.actor.TypedAtomicActor

_addPort, attributeTypeChanged, clone, newPort, typeConstraintList

Methods inherited from class VisualSim.actor.AtomicActor

_createReceivers, clone, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, removeDependency, setContainer, stop, stopFire, terminate

Methods inherited from class VisualSim.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class VisualSim.kernel.Entity

_description, _exportMoMLContents, _removePort, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName, validateSettables

Methods inherited from class VisualSim.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition

Methods inherited from class VisualSim.kernel.util.NamedObj

_addAttribute, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setNormalDebugging, setPersistent, setSource, setVerboseDebugging, sortContainedObjects, toplevel, toString, workspace

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface VisualSim.actor.Actor

getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface VisualSim.actor.Executable

iterate, postfire, prefire, preinitialize, stop, stopFire, terminate

Methods inherited from interface VisualSim.kernel.util.Nameable

description, getContainer, getFullName, getName, getName, setName

Methods inherited from interface VisualSim.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

fileOrURL

public VisualSim.data.expr.FileParameter fileOrURL

The location of the image file upon which to base the figure.

sceneGraphOut

public VisualSim.actor.TypedIOPort sceneGraphOut

The output port that produces the figure.

_figure

protected diva.canvas.toolbox.ImageFigure _figure

The figure which contains the image file.

Constructor Detail

Image2D

public Image2D(VisualSim.kernel.CompositeEntity container,
               java.lang.String name)
        throws VisualSim.kernel.util.IllegalActionException,
               VisualSim.kernel.util.NameDuplicationException

Construct an actor with the given container and name.

Parameters:

container - The container.

name - The name of this actor.

Throws:

VisualSim.kernel.util.IllegalActionException - If the actor cannot be contained by the proposed container.

VisualSim.kernel.util.NameDuplicationException - If the container already has an actor with this name.

Method Detail

initialize

public void initialize()
                throws VisualSim.kernel.util.IllegalActionException

Create the imageFigure.

Throws:

VisualSim.kernel.util.IllegalActionException - If the base class throws such an exception.

_createFigure

protected diva.canvas.toolbox.ImageFigure _createFigure()
                                                 throws VisualSim.kernel.util.IllegalActionException

Create the figure for this actor based on the user specified image file.

Returns:

The ImageFigure containing the image.

Throws:

VisualSim.kernel.util.IllegalActionException - If the selected file does not exist.

_makeSceneGraphConnection

protected void _makeSceneGraphConnection()
                                  throws VisualSim.kernel.util.IllegalActionException

Set up the scene graph connections of this actor.

Throws:

VisualSim.kernel.util.IllegalActionException - Always thrown for this base class.