Module org.bzdev.anim2d

Package org.bzdev.anim2d

Class AnimationObject2D

java.lang.Object

org.bzdev.devqsim.SimObject

org.bzdev.anim2d.AnimationObject2D

All Implemented Interfaces:

Graph.Graphic, NamedObjectOps

Direct Known Subclasses:

AnimationLayer2D, AnimationPath2D, AnimationShape2D, CartesianGrid2D, ConnectingLine2D, Model3DView, PlacedAnimationObject2D, PolarGrid

public abstract class AnimationObject2D
extends SimObject
implements Graph.Graphic

Base class for animation objects. This class specifies objects' z-order - the stacking order when they are drawn in a frame, and whether an object is currently visible or not. Subclasses will typically implement the method update to update the object's state to one appropriate for the current simulation (or animation) time and must implement the method addTo to draw the object. The subclass DirectedObject2D implements update.

See Also:

• Graph
• Graph.Graphic

Constructor Summary

Constructors

Constructor	Description
AnimationObject2D(Animation2D animation, String name, boolean intern)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addToFrame(Graph g)	Add this object to a graph.
void	addToFrame(Graph g, Graphics2D g2d, Graphics2D g2dGCS)	Add this object to a graph, using caller-supplied graphics contexts.
boolean	canDelete()	Determine if this named object can be deleted.
protected Object	clone()	Creates and returns a copy of this object.
final boolean	delete()	Delete an object.
final boolean	deletePending()	Determine if an object is being deleted.
protected Animation2D	getAnimation()	Get the animation associated with this object.
final String	getName()	Get an object's name.
protected Simulation	getObjectNamer()	Get the object namer for a named object.
long	getZorder()	Return this object's zorder.
final boolean	isDeleted()	Determine if an object has been deleted.
boolean	isInterned()	Determine if an object is interned in a object namer's tables.
boolean	isVisible()	Determine if this object is visible.
void	printConfiguration(String iPrefix, String prefix, boolean printName, PrintWriter out)	Print this simulation object's configuration.
void	printState(String iPrefix, String prefix, boolean printName, PrintWriter out)	Print this simulation object's state.
void	setVisible(boolean visible)	Set the visibility for an AnimationObject2D.
void	setZorder(long zorder)	Set the z-order value for an AnimationObject2D.
void	setZorder(long zorder, boolean visible)	Set the z-order and visibility for an AnimationObject2D.

Methods inherited from class org.bzdev.devqsim.SimObject

addSimulationListener, addTraceSet, bindCallable, bindCallable, bindCallable, bindCallable, bindRunnable, bindRunnable, bindRunnable, bindRunnable, callableObject, callableScript, callScriptFunction, callScriptMethod, clearTraceSets, evalScript, getEventListenerList, getScriptObject, getTraceSets, onDelete, printConfiguration, printConfiguration, printConfiguration, printConfiguration, printConfiguration, printConfiguration, printState, printState, printState, printState, printState, printState, putScriptObject, removeSimulationListener, removeTraceSet, runnableObject, runnableScript, scheduleCall, scheduleCall, scheduleCall, scheduleCall, scheduleCallObject, scheduleScript, scheduleTask, scheduleTask, scheduleTask, scheduleTask, scheduleTaskObject, scheduleTaskScript, startImmediateTask, startImmediateTask, trace, trace, unscheduledTaskThread, unscheduledTaskThread, update, update, usesTraceSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bzdev.graphs.Graph.Graphic

addTo, boundingBox

Methods inherited from interface org.bzdev.obnaming.NamedObjectOps

canDelete, delete, deletePending, getName, isDeleted, isInterned

Constructor Details

AnimationObject2D

public AnimationObject2D(Animation2D animation,
 String name,
 boolean intern)

Constructor.

Parameters:

animation - the animation

name - the name of the object; null for an automatically generated name

intern - true if the object can be looked up by using the methods in Simulation; false otherwise.

Throws:

IllegalArgumentException - typically means a name is already in use

See Also:

• ObjectNamerOps.getObject(String,Class)

Method Details

getAnimation

protected Animation2D getAnimation()

Get the animation associated with this object.

Returns:

the animation

getZorder

public long getZorder()

Return this object's zorder. This determines the stacking order of objects when they are drawn, with lower values being drawn first.

Returns:

the zorder.

isVisible

public boolean isVisible()

Determine if this object is visible. The status depends on the object's configuration, not whether it is within its animation's frame.

Returns:

true if this object is visible; false otherwise

setZorder

public void setZorder(long zorder,
 boolean visible)

Set the z-order and visibility for an AnimationObject2D. The z-order sets the stacking order for AnimationObject2D objects. When multiple objects are displayed, those with smaller values of z-order are drawn first. For those with the same z-order value, the one created first is drawn first (but the implementation uses a long counter to determine creation-order so this order holds only for the first 2⁶³-1 objects created, which should be more than large enough in practice. The visibility of the object determines it should be drawn. Only the portions of the object within the animation's frame will actually be visible to the user, and being visible does not prevent another object from appearing over the current object. This method is more efficient than calling setZorder(zorder) and setVisible(visibility) independently.

Parameters:

zorder - the z-order value

visible - true if the object is visible; false otherwise

setZorder

public void setZorder(long zorder)

Set the z-order value for an AnimationObject2D. When multiple objects are displayed, those with smaller values of z-order are drawn first. For those with the same z-order value, the one created first is drawn first (but the implementation uses a long counter to determine creation-order so this order holds only for the first 2⁶³-1 objects created, which should be more than large enough in practice.

Parameters:

zorder - the z-order value

setVisible

public void setVisible(boolean visible)

Set the visibility for an AnimationObject2D. The visibility of the object determines it should be drawn. Only the portions of the object within the animation's frame will actually be visible to the user, and being visible does not prevent another object from appearing over the current object.

Parameters:

visible - true if the object should be visible; false otherwise

addToFrame

public void addToFrame(Graph g)

Add this object to a graph. This will explicitly call update and will, possibly indirectly, call the addTo(Graph, Graphics2D, Graphics2D method, which must be implemented for non-abstract classes and which is responsible for drawing the object.

Users generally do not have to call this method directly: it will be called at the appropriate point when frames are scheduled.

Parameters:

g - the graph to which this object will be added

See Also:

• Animation2D.scheduleFrames(long,int)

addToFrame

public void addToFrame(Graph g,
 Graphics2D g2d,
 Graphics2D g2dGCS)

Add this object to a graph, using caller-supplied graphics contexts. This will explicitly call update and will, possibly indirectly, call the addTo(Graph, Graphics2D, Graphics2D method, which must be implemented for non-abstract classes and which is responsible for drawing the object.

Users generally do not have to call this method directly: it will be called at the appropriate point when frames are scheduled.

Parameters:

g - the graph to which this object will be added

g2d - the graphics context in user space for the graph g

g2dGCS - the graphics context in graph coordinate space for the graph g

See Also:

• Animation2D.scheduleFrames(long,int)

printConfiguration

public void printConfiguration(String iPrefix,
 String prefix,
 boolean printName,
 PrintWriter out)

Print this simulation object's configuration. Documentation for the use of this method is provided by the documentation for the SimObject method SimObject.printConfiguration(String,String,boolean,PrintWriter).

When the second argument has a value of true, the object name and class name will be printed in a standard format with its indentation provided by the iPrefix argument. In addition, the configuration that is printed includes the following items.

Defined in AnimationObject2D:

• the Z-order.
• whether or not this object is visible.

Overrides:

printConfiguration in class SimObject

Parameters:

iPrefix - the prefix to use for an initial line when printName is true with null treated as an empty string

prefix - a prefix string (typically whitespace) to put at the start of each line other than the initial line that is printed when printName is true

printName - requests printing the name of an object

out - the output print writer

printState

public void printState(String iPrefix,
 String prefix,
 boolean printName,
 PrintWriter out)

Print this simulation object's state. Documentation for the use of this method is provided by the documentation for the SimObject method SimObject.printState(String,String,boolean,PrintWriter).

When the third argument has a value of true, the object name and class name will be printed in a standard format with its indentation provided by the iPrefix argument.

Overrides:

printState in class SimObject

Parameters:

iPrefix - the prefix to use for an initial line when printName is true with null treated as an empty string

prefix - a prefix string (typically whitespace) to put at the start of each line other than the initial line that is printed when printName is true

printName - requests printing the name of an object

out - the output print writer

clone

protected Object clone()
                throws CloneNotSupportedException

Creates and returns a copy of this object. This method will throw the exception CloneNotSupportedException if the object is interned.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException - a clone could not be created

See Also:

• Object.clone()

isInterned

public boolean isInterned()

Determine if an object is interned in a object namer's tables.

Specified by:

isInterned in interface NamedObjectOps

Returns:

true if the object is interned; false if not

getObjectNamer

protected Simulation getObjectNamer()

Get the object namer for a named object.

Returns:

the object namer for this named object

getName

public final String getName()

Get an object's name.

Specified by:

getName in interface NamedObjectOps

Returns:

the name of the object

canDelete

public boolean canDelete()

Determine if this named object can be deleted. A named object can be deleted if the method delete has not been called and if the object is not in a state that prevents the object from being deleted. Subclasses that override this method must call canDelete() for their superclasses and return false if the superclass' canDelete method returns false. The default method returns true if delete() has not been called and returned true.

Specified by:

canDelete in interface NamedObjectOps

Returns:

true if this object can be deleted; false otherwise

delete

public final boolean delete()

Delete an object. An object can only be deleted once. If this method returns true, the object (if interned) will have been removed from the object namer tables.

The implementations provided by DefaultNamedObect and generated because of a @NamedObject annotation provide a protected method named onDelete. A subclass that overrides onDelete() must call the onDelete method of its superclass after it's onDelete method has been called and any cleanup actions performed. In some cases, this may happen at a later time (e.g., if a thread is used for some of the cleanup operations or if it is otherwise necessary to wait).

Specified by:

delete in interface NamedObjectOps

Returns:

true if the deletion request was accepted; false otherwise

isDeleted

public final boolean isDeleted()

Determine if an object has been deleted. An object is deleted if the method delete() has been called and returned true.

Specified by:

isDeleted in interface NamedObjectOps

Returns:

true if deleted; false otherwise

deletePending

public final boolean deletePending()

Determine if an object is being deleted. An deletion is pending if the method delete() has been called and returned true but the deletion has not been completed.

Specified by:

deletePending in interface NamedObjectOps

Returns:

true if deletion is pending; false otherwise