DirectX Media for Animation Java Reference

Previous

Classes

Index

Next

MatteBvr Class

public class MatteBvr extends Behavior {
    // Fields
    public static MatteBvr clearMatte;
    public static MatteBvr opaqueMatte;
    
    // Methods
    public MatteBvr transform(Transform2Bvr xf);

    public static MatteBvr difference(MatteBvr m1, MatteBvr m2);
    public static MatteBvr fillMatte(Path2Bvr path);
    public static MatteBvr intersect(MatteBvr m1, MatteBvr m2);
    public static MatteBvr newUninitBvr();
    public static MatteBvr textMatte(TextBvr text);
    public static MatteBvr union(MatteBvr m1, MatteBvr m2);
 }

Creates an object representing a matte behavior. A matte consists of a path and/or text, and is typically used to clip an image to the shape defined by the path and/or text.

For more information about behaviors, see the Behavior class.

Methods

transform

public MatteBvr transform(Transform2Bvr xf);

Creates a new matte behavior that is the result of applying the given transformation behavior to the original matte. The transformation affects each point behavior in the path that defines the matte.

Return Value:

Returns the MatteBvr object.

Parameter	Description
xf	The Transform2Bvr object.

Remarks:

This attribute composes values.

difference

public static MatteBvr difference(MatteBvr m1, MatteBvr m2);

Creates a matte behavior that is the difference between the given mattes. The difference consists of only those elements of the path and/or text in m1 that are not also in m2.

Return Value:

Returns the MatteBvr object.

Parameter	Description
m1 and m2	The MatteBvr objects.

See Also: intersect, union

fillMatte

public static MatteBvr fillMatte(Path2Bvr path);

Creates a matte behavior consisting of the given path behavior. Clipping an image with this matte preserves that portion of the image that is inside the path.

Return Value:

Returns the MatteBvr object.

Parameter	Description
path	The Path2Bvr object. If the path is not closed, the start and end points are implicitly connected to close the path.

See Also: textMatte

intersect

public static MatteBvr intersect(MatteBvr m1, MatteBvr m2);

Creates a matte behavior that is the intersection of the given mattes. The intersection consists of only those elements of the paths and/or text of the original mattes that are the same.

Return Value:

Returns the MatteBvr object.

Parameter	Description
m1 and m2	The MatteBvr objects.

See Also: union, difference

newUninitBvr

public static MatteBvr newUninitBvr();

This method allows you to refer to an MatteBvr behavior before that behavior has been defined. With this method you can create the behavior and use it in the definition of other behaviors, but not actually define its contents until some later point. (This is accomplished with the init method, which is available on all behaviors.) The system generates a run-time error if you initialize a non-uninitialized behavior, initialize an uninitialized behavior that has already been initialized, or run an initialized behavior that has not yet been initialized.

Return Value:

Returns the MatteBvr object.

textMatte

public static MatteBvr textMatte(TextBvr text);

Creates a matte behavior consisting of the given text. Clipping an image with this matte preserves that portion of the image that is inside the text.

Return Value:

Returns the MatteBvr object.

Parameter	Description
text	A character string.

See Also: fillMatte

union

public static MatteBvr union(MatteBvr m1, MatteBvr m2);

Creates a matte behavior that is the union of the given mattes. The union consists of all elements of the paths and/or text in the original mattes.

Return Value:

Returns the MatteBvr object.

Parameter	Description
m1 and m2	The MatteBvr objects.

See Also: intersect, difference

Fields

clearMatte

A matte behavior (MatteBvr object) that when applied to an image preserves the entire image (that is, it clips nothing).

opaqueMatte

A matte behavior (MatteBvr object) that when applied to an image clips the entire image (that is, preserves no part of the image).