Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.anotherbigidea.flash.movie
Class Frame  view Frame download Frame.java

java.lang.Object
  extended bycom.anotherbigidea.flash.movie.Frame

public class Frame
extends java.lang.Object

A Movie or Movie Clip frame


Field Summary
protected  Actions actions
           
protected  int customTag
           
protected  byte[] customTagData
           
protected  int frameNumber
           
protected  java.lang.String label
           
protected  boolean mAnchor
           
protected  java.util.Vector placements
           
protected  byte[] soundData
           
protected  com.anotherbigidea.flash.sound.SoundStreamHead soundHeader
           
protected  Sound soundToStart
           
protected  boolean stop
           
protected  TimeLine timeline
           
 
Constructor Summary
protected Frame(int number, TimeLine timeline)
           
 
Method Summary
 Actions actions(int flashVersion)
          Reset the frame actions (if any) and return the new empty Actions object
 void alter(Instance instance, int x, int y)
          Alter the symbol instance by moving it to the new coordinates.
 void alter(Instance instance, Transform matrix, com.anotherbigidea.flash.structs.AlphaTransform cxform)
          Alter the symbol instance by applying the given transform and/or color transform.
 void alter(Instance instance, Transform matrix, com.anotherbigidea.flash.structs.AlphaTransform cxform, int ratio)
          Alter the symbol instance by applying the given properties.
protected  void flushDefinitions(Movie movie, com.anotherbigidea.flash.interfaces.SWFTagTypes timelineWriter, com.anotherbigidea.flash.interfaces.SWFTagTypes definitionWriter)
           
 Actions getActions()
          Get the frame actions
 int getFrameNumber()
          Get the frame number
 java.lang.String getLabel()
          Get the frame label
 Placement[] getPlacements()
          Get the placements in this frame
 byte[] getSoundData()
           
 com.anotherbigidea.flash.sound.SoundStreamHead getSoundHeader()
           
 boolean isAnchor()
           
 Instance placeMovieClip(Symbol symbol, Transform matrix, com.anotherbigidea.flash.structs.AlphaTransform cxform, java.lang.String name, Actions[] clipActions)
          Place a Movie Clip at the next available depth with the given properties.
 Instance placeSymbol(Symbol symbol, int x, int y)
          Place a symbol at the given coordinates at the next available depth.
 Instance placeSymbol(Symbol symbol, Transform matrix, com.anotherbigidea.flash.structs.AlphaTransform cxform)
          Place a symbol at the next available depth with the given matrix transform and color transform.
 Instance placeSymbol(Symbol symbol, Transform matrix, com.anotherbigidea.flash.structs.AlphaTransform cxform, int ratio, int clipDepth)
          Place a symbol at the next available depth with the given properties.
 void remove(Instance instance)
          Remove the symbol instance from the stage
 Instance replaceMovieClip(Symbol symbol, int depth, Transform matrix, com.anotherbigidea.flash.structs.AlphaTransform cxform, java.lang.String name, Actions[] clipActions)
          Replace the Symbol at the given depth with the new MovieClip
 Instance replaceSymbol(Symbol symbol, int depth, Transform matrix, com.anotherbigidea.flash.structs.AlphaTransform cxform, int ratio, int clipDepth)
          Replace the symbol at the given depth with the new symbol
 void setActions(Actions actions)
          Set the frame actions (or null them out)
 void setAnchor(boolean isAnchor)
           
 void setCustomTag(int tagId, byte[] tagData)
          Set a custom tag to be written at the start of the frame
 void setLabel(java.lang.String label)
          Set the frame label - set to null to clear any label
 void setSoundData(byte[] data)
           
 void setSoundHeader(com.anotherbigidea.flash.sound.SoundStreamHead header)
           
 int startSound(Sound soundToStart, int framesPerSec)
           
 void stop()
          Set the stop flag - if true then the movie will stop at this frame.
 void undefineSymbol(Symbol symbol)
          Free up the given symbol so that it no longer takes up memory.
protected  void write(Movie movie, com.anotherbigidea.flash.interfaces.SWFTagTypes movieTagWriter, com.anotherbigidea.flash.interfaces.SWFTagTypes timelineTagWriter)
          Write the frame
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

frameNumber

protected int frameNumber

label

protected java.lang.String label

placements

protected java.util.Vector placements

stop

protected boolean stop

timeline

protected TimeLine timeline

actions

protected Actions actions

soundHeader

protected com.anotherbigidea.flash.sound.SoundStreamHead soundHeader

soundData

protected byte[] soundData

soundToStart

protected Sound soundToStart

customTag

protected int customTag

customTagData

protected byte[] customTagData

mAnchor

protected boolean mAnchor
Constructor Detail

Frame

protected Frame(int number,
                TimeLine timeline)
Method Detail

getSoundHeader

public com.anotherbigidea.flash.sound.SoundStreamHead getSoundHeader()

setSoundHeader

public void setSoundHeader(com.anotherbigidea.flash.sound.SoundStreamHead header)

getSoundData

public byte[] getSoundData()

setSoundData

public void setSoundData(byte[] data)

isAnchor

public boolean isAnchor()

setAnchor

public void setAnchor(boolean isAnchor)

setCustomTag

public void setCustomTag(int tagId,
                         byte[] tagData)
Set a custom tag to be written at the start of the frame


startSound

public int startSound(Sound soundToStart,
                      int framesPerSec)

getActions

public Actions getActions()
Get the frame actions


setActions

public void setActions(Actions actions)
Set the frame actions (or null them out)


actions

public Actions actions(int flashVersion)
Reset the frame actions (if any) and return the new empty Actions object


getFrameNumber

public int getFrameNumber()
Get the frame number


getPlacements

public Placement[] getPlacements()
Get the placements in this frame


getLabel

public java.lang.String getLabel()
Get the frame label


setLabel

public void setLabel(java.lang.String label)
Set the frame label - set to null to clear any label


stop

public void stop()
Set the stop flag - if true then the movie will stop at this frame. This can be set on the last frame to prevent the movie looping.


placeSymbol

public Instance placeSymbol(Symbol symbol,
                            int x,
                            int y)
Place a symbol at the given coordinates at the next available depth.


placeSymbol

public Instance placeSymbol(Symbol symbol,
                            Transform matrix,
                            com.anotherbigidea.flash.structs.AlphaTransform cxform)
Place a symbol at the next available depth with the given matrix transform and color transform.


placeSymbol

public Instance placeSymbol(Symbol symbol,
                            Transform matrix,
                            com.anotherbigidea.flash.structs.AlphaTransform cxform,
                            int ratio,
                            int clipDepth)
Place a symbol at the next available depth with the given properties.


replaceSymbol

public Instance replaceSymbol(Symbol symbol,
                              int depth,
                              Transform matrix,
                              com.anotherbigidea.flash.structs.AlphaTransform cxform,
                              int ratio,
                              int clipDepth)
Replace the symbol at the given depth with the new symbol


undefineSymbol

public void undefineSymbol(Symbol symbol)
Free up the given symbol so that it no longer takes up memory. All instances of the symbol must be removed first. This is useful with large images when they are no longer required.


placeMovieClip

public Instance placeMovieClip(Symbol symbol,
                               Transform matrix,
                               com.anotherbigidea.flash.structs.AlphaTransform cxform,
                               java.lang.String name,
                               Actions[] clipActions)
Place a Movie Clip at the next available depth with the given properties.


replaceMovieClip

public Instance replaceMovieClip(Symbol symbol,
                                 int depth,
                                 Transform matrix,
                                 com.anotherbigidea.flash.structs.AlphaTransform cxform,
                                 java.lang.String name,
                                 Actions[] clipActions)
Replace the Symbol at the given depth with the new MovieClip


remove

public void remove(Instance instance)
Remove the symbol instance from the stage


alter

public void alter(Instance instance,
                  int x,
                  int y)
Alter the symbol instance by moving it to the new coordinates. Only one alteration may be made to an Instance in any given frame.


alter

public void alter(Instance instance,
                  Transform matrix,
                  com.anotherbigidea.flash.structs.AlphaTransform cxform)
Alter the symbol instance by applying the given transform and/or color transform. Only one alteration may be made to an Instance in any given frame.


alter

public void alter(Instance instance,
                  Transform matrix,
                  com.anotherbigidea.flash.structs.AlphaTransform cxform,
                  int ratio)
Alter the symbol instance by applying the given properties. Only one alteration may be made to an Instance in any given frame.


flushDefinitions

protected void flushDefinitions(Movie movie,
                                com.anotherbigidea.flash.interfaces.SWFTagTypes timelineWriter,
                                com.anotherbigidea.flash.interfaces.SWFTagTypes definitionWriter)
                         throws java.io.IOException

write

protected void write(Movie movie,
                     com.anotherbigidea.flash.interfaces.SWFTagTypes movieTagWriter,
                     com.anotherbigidea.flash.interfaces.SWFTagTypes timelineTagWriter)
              throws java.io.IOException
Write the frame