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.
-
ADD
- i.e.
-
DIVIDE
- i.e.
-
INHERIT
- use parent object's compositing mode
-
MAX
- i.e.
-
MIN
- i.e.
-
MULTIPLY
- i.e.
-
POW
- i.e.
-
SET
- i.e.
-
SUBTRACT
- i.e.
-
getComposite()
- Returns the current composite mode.
-
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.
-
setComposite(int)
- Sets the composite mode used by this compositable object.
-
setComposite(String)
- Set the composite mode to the named mode
SET
public static final int SET
- i.e. value = dst
ADD
public static final int ADD
- i.e. value = src + dst
SUBTRACT
public static final int SUBTRACT
- i.e. value = src - dst
MULTIPLY
public static final int MULTIPLY
- i.e. value = src * dst
DIVIDE
public static final int DIVIDE
- i.e. value = src / dst
MIN
public static final int MIN
- i.e. value = min(src, dst)
MAX
public static final int MAX
- i.e. value = max(src, dst)
POW
public static final int POW
- i.e. value = src ^^ dst
INHERIT
public static final int INHERIT
- use parent object's compositing mode
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).
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".
getComposite
public abstract int getComposite()
- Returns the current composite mode.
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