Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> anotherbigidea >> flash >> [ movie overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.anotherbigidea.flash.movie
Class Placement  

java.lang.Object
  com.anotherbigidea.flash.movie.Placement

---

public class Placement

extends java.lang.Object

A Placement holds the transformation and other values relating to the "placement" of a Symbol Instance within a particular frame. They can also denote an "UndefineSymbol" operation.

---

Field Summary
protected  Actions[]	clipActions
protected  int	clipDepth
protected  com.anotherbigidea.flash.structs.AlphaTransform	cxform
protected  int	frameNumber
protected  Instance	instance
protected  boolean	isAlteration
protected  boolean	isRemove
protected  boolean	isReplacement
protected  Transform	matrix
protected  java.lang.String	name
protected  int	ratio
protected  Symbol	symbolToFree

 

Constructor Summary
protected	Placement(Instance instance, int frameNumber)
protected	Placement(Instance instance, Transform matrix, com.anotherbigidea.flash.structs.AlphaTransform cxform, java.lang.String name, int ratio, int clipDepth, int frameNumber, boolean alteration, boolean replacement, Actions[] clipActions)
protected	Placement(Symbol symbol)           An UndefineSymbol operation

 

Method Summary
protected  void	flushDefinitions(Movie movie, com.anotherbigidea.flash.interfaces.SWFTagTypes timelineWriter, com.anotherbigidea.flash.interfaces.SWFTagTypes definitionWriter)
Actions[]	getClipActions()           Get the actions for a movie clip
int	getClipDepth()           The clip depth defines the range of depths which will be clipped by this symbol.
com.anotherbigidea.flash.structs.AlphaTransform	getColorTransform()           The color transform may be null
int	getFrameNumber()           Get the number of the frame within which this placement takes place
Instance	getInstance()           Get the Symbol Instance represented by this Placement
java.lang.String	getName()           The name only relates to MovieClip instances and may be null.
int	getRatio()           The ratio only relates to Morph Shapes and will be -1 otherwise.
Transform	getTransform()           The transform may be null
boolean	isAlteration()           Return true if this placement is an alteration to an Instance that was placed in a previous frame.
boolean	isRemove()           If true then this Placement denotes the removal of the Instance from the stage.
boolean	isReplacement()           Return true if the placement is replacing the symbol at a given depth with a new symbol
boolean	isUndefineSymbol()           Return true if the placement represents an UndefineSymbol operation
void	setClipActions(Actions[] clipActions)           Set the actions for a movie clip
protected  void	write(Movie movie, com.anotherbigidea.flash.interfaces.SWFTagTypes movieTagWriter, com.anotherbigidea.flash.interfaces.SWFTagTypes timelineTagWriter)

 

Methods inherited from class java.lang.Object

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

 

Field Detail

isAlteration

protected boolean isAlteration

---

isReplacement

protected boolean isReplacement

---

frameNumber

protected int frameNumber

---

instance

protected Instance instance

---

matrix

protected Transform matrix

---

cxform

protected com.anotherbigidea.flash.structs.AlphaTransform cxform

---

name

protected java.lang.String name

---

ratio

protected int ratio

---

clipDepth

protected int clipDepth

---

isRemove

protected boolean isRemove

---

clipActions

protected Actions[] clipActions

---

symbolToFree

protected Symbol symbolToFree

Constructor Detail

Placement

protected Placement(Symbol symbol)

An UndefineSymbol operation

---

Placement

protected Placement(Instance instance,
                    int frameNumber)

---

Placement

protected Placement(Instance instance,
                    Transform matrix,
                    com.anotherbigidea.flash.structs.AlphaTransform cxform,
                    java.lang.String name,
                    int ratio,
                    int clipDepth,
                    int frameNumber,
                    boolean alteration,
                    boolean replacement,
                    Actions[] clipActions)

Method Detail

isUndefineSymbol

public boolean isUndefineSymbol()

Return true if the placement represents an UndefineSymbol operation

---

isReplacement

public boolean isReplacement()

Return true if the placement is replacing the symbol at a given depth with a new symbol

---

isAlteration

public boolean isAlteration()

Return true if this placement is an alteration to an Instance that was placed in a previous frame.

---

getFrameNumber

public int getFrameNumber()

Get the number of the frame within which this placement takes place

---

getInstance

public Instance getInstance()

Get the Symbol Instance represented by this Placement

---

getTransform

public Transform getTransform()

The transform may be null

---

getColorTransform

public com.anotherbigidea.flash.structs.AlphaTransform getColorTransform()

The color transform may be null

---

getName

public java.lang.String getName()

The name only relates to MovieClip instances and may be null. The name is only present on the first Placement of an Instance.

---

getRatio

public int getRatio()

The ratio only relates to Morph Shapes and will be -1 otherwise. The ratio is from zero to 65535 and denotes the degree of the morph from the initial shape to the final shape.

---

getClipDepth

public int getClipDepth()

The clip depth defines the range of depths which will be clipped by this symbol. All symbols placed at depths from depth+1 to clipDepth (inclusive) will be clipped. If this symbol is not a clipping symbol then the clip depth will be -1. The clip depth is only present on the first Placement of an Instance.

---

isRemove

public boolean isRemove()

If true then this Placement denotes the removal of the Instance from the stage.

---

getClipActions

public Actions[] getClipActions()

Get the actions for a movie clip

---

setClipActions

public void setClipActions(Actions[] clipActions)

Set the actions for a movie clip

---

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

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> anotherbigidea >> flash >> [ movie overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---