com.hdcookbook.grin.media
Class Playlist

java.lang.Object
  com.hdcookbook.grin.Feature
      com.hdcookbook.grin.media.Playlist

All Implemented Interfaces:

Node

Direct Known Subclasses:

SEPlaylist

public class Playlist
extends Feature
implements Node

Field Summary

protected boolean	autoStart
protected boolean	autoStop
protected int[]	markTimes
protected Command[]	onActivate
protected Command[]	onDeactivate
protected Command[][]	onEntryCommands
protected Command[]	onMediaEnd
protected Command[]	onMediaStart

Fields inherited from class com.hdcookbook.grin.Feature

name, show

Constructor Summary

Playlist(Show show)

Method Summary

void	addDisplayAreas(RenderContext context) Add all of the areas that are displayed for this feature with the current frame.
void	destroy() Free any resources held by this feature.
protected java.lang.String	getLocator()
int	getX() Get the upper-left hand corner of this feature as presently displayed.
int	getY() Get the upper-left hand corner of this feature as presently displayed Return Integer.MAX_VALUE if this feature has no visible representation.
void	initialize() Initialize this feature.
void	markDisplayAreasChanged() Mark the display areas of this feature as modified for the next call to addDisplayAreas.
boolean	needsMoreSetup() This is where the feaure says whether or not it needs more setup.
void	nextFrame() Called from Segment with the Show lock held, to advance us to the state we should be in for the next frame.
void	paintFrame(java.awt.Graphics2D gr) Paint the current state of this feature to gr.
void	readInstanceData(GrinDataInputStream in, int length) Reads in this node information from the binary file format.
void	resetLocator(java.lang.String locator) Reset the locator.
protected void	setActivateMode(boolean mode) Change the activated mode of this feature.
protected void	setLocator(java.lang.String locator)
protected int	setSetupMode(boolean mode) Change the setup mode of this feature.
void	start() Start video playback.
void	stop() Stop video playback.

Methods inherited from class com.hdcookbook.grin.Feature

activate, addSubgraph, cloneCommands, clonedReference, cloneSubgraph, createClone, deactivate, destroyClonedSubgraph, getName, initializeClone, isSetup, makeNewClone, resetFeature, sendFeatureSetup, setName, setup, toString, unsetup

Methods inherited from class java.lang.Object

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

Field Detail

onActivate

protected Command[] onActivate

onMediaStart

protected Command[] onMediaStart

onMediaEnd

protected Command[] onMediaEnd

onDeactivate

protected Command[] onDeactivate

autoStart

protected boolean autoStart

autoStop

protected boolean autoStop

markTimes

protected int[] markTimes

onEntryCommands

protected Command[][] onEntryCommands

Constructor Detail

Playlist

public Playlist(Show show)

Method Detail

setLocator

protected void setLocator(java.lang.String locator)

getLocator

protected java.lang.String getLocator()

start

public void start()

Start video playback. Please see the xlet version of this class for more complete documentation.

stop

public void stop()

Stop video playback. Please see the xlet version of this class for more complete documentation.

resetLocator

public void resetLocator(java.lang.String locator)

Reset the locator. Please see the xlet version of this class for more complete documentation.

getX

public int getX()

Get the upper-left hand corner of this feature as presently displayed. Return Integer.MAX_VALUE if this feature has no visible representation.

Specified by:

getX in class Feature

Returns:

the x coordinate

getY

public int getY()

Get the upper-left hand corner of this feature as presently displayed Return Integer.MAX_VALUE if this feature has no visible representation.

Specified by:

getY in class Feature

Returns:

the y coordinate

initialize

public void initialize()

Initialize this feature. This is called on show initialization. A show will initialize all of its features after it initializes the segments. Clients of the GRIN framework should never call this method directly. Custom feature extensions must implement this method.

Specified by:

initialize in class Feature

destroy

public void destroy()

Free any resources held by this feature. It is the opposite of initialize().

Features are deactivated before they are destroyed. For example, the last segment a show is in when the show is destroyed will probably be active, but it is deactivated and unsetup() is called in Show.destroy() before the features are destroyed.

Cloned features are handled a little differently. They have destroy() called from within Feature.destroyClonedSubgraph(). Since cloned fetures are exempt from the setup/unsetup lifecycle, the cloned feature will not be activated, but will be in a setup state when destroy() is called. Features that support cloning must therefore release any resources they acquired in createClone() or initializeClone() during the call to destroy().

Clients of the GRIN framework should never call this method directly. Custom feature extensions must implement this method.

Specified by:

destroy in class Feature

setSetupMode

protected int setSetupMode(boolean mode)

Change the setup mode of this feature. The new mode will always be different than the old. Clients of the GRIN framework should never call this method directly. Custom feature extensions must implement this method.

This method must return a guaranteed lower bound for the number of times it will send a feature setup command as a result of this call. That is, it must send at least as many feature setup commands to the segment as the number returned; sending an accurate number makes the setup process more efficient, since the time it takes to process a command scales with the number of features in a segment. When mode is false, 0 should be returned.

Specified by:

setSetupMode in class Feature

setActivateMode

protected void setActivateMode(boolean mode)

Change the activated mode of this feature. The new mode will always be different than the old. Clients of the GRIN framework should never call this method directly. Custom feature extensions must implement this method.

Specified by:

setActivateMode in class Feature

needsMoreSetup

public boolean needsMoreSetup()

This is where the feaure says whether or not it needs more setup. Calls to this are synchronized within the init manager to avoid race conditions. The implementation of this method must not call outside code or call any animation manager methods. For a given setup cycle, this method is called only after setup(). Clients of the GRIN framework should never call this method directly. Custom feature extensions must implement this method.

Specified by:

needsMoreSetup in class Feature

See Also:

SetupClient.needsMoreSetup()

addDisplayAreas

public void addDisplayAreas(RenderContext context)

Add all of the areas that are displayed for this feature with the current frame. This will be called exactly once per frame displayed on each activated feature.

A feature that displays something needs to maintain a record of it in a DrawRecord. The animation framework uses this to track what needs to be erased and drawn from frame to frame.

Clients of the GRIN framework should not call this method directly. Feature subclasses must implement this method.

Specified by:

addDisplayAreas in class Feature

Parameters:

context - The context for tracking rendering state

See Also:

DrawRecord

markDisplayAreasChanged

public void markDisplayAreasChanged()

Mark the display areas of this feature as modified for the next call to addDisplayAreas. This can be called by a parent node on its children, e.g. when the parent is deactivated. This is necessary because a parent node might modify the drawing of its children (e.g. by setting an alpha value), and a parent might be taken out of a render tree when its children are not.

See also Issue 121

Specified by:

markDisplayAreasChanged in class Feature

See Also:

Feature.addDisplayAreas(com.hdcookbook.grin.animator.RenderContext)

paintFrame

public void paintFrame(java.awt.Graphics2D gr)

Paint the current state of this feature to gr. Clients of the GRIN framework should not call this method directly. Feature subclasses must implement this method.

Specified by:

paintFrame in class Feature

Parameters:

gr - The place to paint to.

nextFrame

public void nextFrame()

Called from Segment with the Show lock held, to advance us to the state we should be in for the next frame.

Specified by:

nextFrame in class Feature

readInstanceData

public void readInstanceData(GrinDataInputStream in,
                             int length)
                      throws java.io.IOException

Description copied from interface: Node

Reads in this node information from the binary file format.

An implementation of this method is recommended to call in.readSuperClassData(this) as the first line of the method to read in information that is defined in the base class of this Node type.

This should only be called while initializing this object.

Specified by:

readInstanceData in interface Node

Parameters:

in - InputStream to read data from.

length - the number of bytes that this node's information occupies in the InputStream. The implementation of this method is expected to read exactly this number of bytes from the stream. This can be used for a debugging purpose.

Throws:

java.io.IOException - if error occurs.

See Also:

GrinDataInputStream.readSuperClassData(Feature), GrinDataInputStream.readSuperClassData(RCHandler), GrinDataInputStream.readSuperClassData(Segment), GrinDataInputStream.readSuperClassData(Command)