DirectX Media for Animation Java Reference

Previous

Classes

Index

Next

MontageBvr Class

public class MontageBvr extends Behavior {
    // Fields
    public static MontageBvr emptyMontage;

    // Methods
    public ImageBvr render();

    public static MontageBvr imageMontage(ImageBvr image, NumberBvr depth);
    public static MontageBvr newUninitBvr();
    public static MontageBvr union(MontageBvr m1, MontageBvr m2);
    
}

A MontageBvr is an object that represents a montage behavior. A montage is a stack of images in which each image has an explicit depth. Images with larger Z-values are always in front of images with smaller z-values. Rendering a montage creates a new image behavior that is a composite of the images in the montage. The composite is created by overlaying the montage's images by order of depth and applying the same overlay rules as defined by the overlay method in the ImageBvr class.

Because the depth of an image in a montage can vary over time, rendering the montage at different points in time can produce different the images in different orders.

For more information about behaviors, see the Behavior class.

Methods

render

public ImageBvr render()

Creates an image behavior that consists of a composite of all images in the montage behavior. The composite is created by overlaying the montage's images in order of Z-values, with the largest Z-value on top, and applying the same overlay rules as defined by the overlay method in the ImageBvr class. If two images have the same depth, they are overlayed in the order in which they were added to the montage. The bounding box of a rendered montage is simply the union of the bounding boxes of all the images comprising that montage.

Return Value:

Returns the ImageBvr object.

imageMontage

public static MontageBvr imageMontage(ImageBvr image, NumberBvr Z-value);

Creates a montage behavior consisting of a single image behavior at the given Z-value.

Return Value:

Returns the MontageBvr object.

Parameter	Description
image	The ImageBvr object.
Z-value	The NumberBvr object.

newUninitBvr

public static MontageBvr newUninitBvr();

This method allows you to refer to an MontageBvr 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 MontageBvr object.

union

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

Creates a montage behavior by combining the given montage behaviors.

Return Value:

Returns the MontageBvr object.

Parameter	Description
m1 and m2	The MontageBvr objects.

Fields

emptyMontage

A montage behavior (MontageBvr object) that contains no images.