All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface improv.actor.behavior.Compositable

public interface interface Compositable
The Compositable interface is implemented by classes that provide a setting for compositing behavior (i.e. the setComposite/getComposite methods). This includes CompositingFilter, MultiCompositingFilter, State and Layer.


Variable Index

 o ADD
i.e.
 o DIVIDE
i.e.
 o INHERIT
use parent object's compositing mode
 o MAX
i.e.
 o MIN
i.e.
 o MULTIPLY
i.e.
 o POW
i.e.
 o SET
i.e.
 o SUBTRACT
i.e.

Method Index

 o getComposite()
Returns the current composite mode.
 o inheritComposite()
Returns true if this compositable inherits its compositing mode from its parent (if you do setComposite(INHERIT) this becomes true, and getComposite() will return the parent's composite mode.
 o setComposite(int)
Sets the composite mode used by this compositable object.
 o setComposite(String)
Set the composite mode to the named mode

Variables

 o SET
 public static final int SET
i.e. value = dst

 o ADD
 public static final int ADD
i.e. value = src + dst

 o SUBTRACT
 public static final int SUBTRACT
i.e. value = src - dst

 o MULTIPLY
 public static final int MULTIPLY
i.e. value = src * dst

 o DIVIDE
 public static final int DIVIDE
i.e. value = src / dst

 o MIN
 public static final int MIN
i.e. value = min(src, dst)

 o MAX
 public static final int MAX
i.e. value = max(src, dst)

 o POW
 public static final int POW
i.e. value = src ^^ dst

 o INHERIT
 public static final int INHERIT
use parent object's compositing mode

Methods

 o setComposite
 public abstract void setComposite(int composite)
Sets the composite mode used by this compositable object.

Parameters:
composite - is one of: SET, ADD, SUBTRACT, MULTIPLY, DIVIDE, MIN, MAX, POW, and INHERIT. If composite is INHERIT, the parent object's compositing mode is used instead (in which case, getComposite() will return the parent's composite mode, and inheritsComposite() will return true).
 o setComposite
 public abstract void setComposite(String composite)
Set the composite mode to the named mode

Parameters:
composite - is one of "SET", "ADD", "SUBTRACT", "MULTIPLY", "DIVIDE", "MIN", "MAX", "POW", "INHERIT".
 o getComposite
 public abstract int getComposite()
Returns the current composite mode.

 o inheritComposite
 public abstract boolean inheritComposite()
Returns true if this compositable inherits its compositing mode from its parent (if you do setComposite(INHERIT) this becomes true, and getComposite() will return the parent's composite mode.


All Packages  Class Hierarchy  This Package  Previous  Next  Index