org.havi.ui.HMatteLayer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ocap Show documentation
The newest version!
package org.havi.ui;

/*
 * Copyright 2000-2003 by HAVi, Inc. Java is a trademark of Sun
 * Microsystems, Inc. All rights reserved.  
 */

/**
 * This    {@link org.havi.ui.HMatteLayer    HMatteLayer}    interface enables the presentation of components, together with an associated    {@link org.havi.ui.HMatte    HMatte}   , for matte compositing.
 * @see  HMatte
 */

public interface HMatteLayer 
{
    /**
	 * Applies an  {@link org.havi.ui.HMatte  HMatte}  to this component, for matte compositing. Any existing animated matte must be stopped before this method is called or an HMatteException will be thrown.
	 * @param m  The  {@link org.havi.ui.HMatte  HMatte}  to be applied to  this component -- note that only one matte may be associated  with the component, thus any previous matte will be replaced.  If m is null, then any matte associated with the component is  removed and further calls to getMatte() shall return null. The  component shall behave as if it had a fully opaque  {@link org.havi.ui.HFlatMatte  HFlatMatte}  associated with it (i.e an  HFlatMatte with the default value of 1.0.)
	 * @exception HMatteException  if the  {@link org.havi.ui.HMatte  HMatte}  cannot be associated with the component. This can occur:     if the specific matte type is not supported  
 if the platform does not support any matte type  
 if the component is associated with an already running {@link org.havi.ui.HFlatEffectMatte  HFlatEffectMatte}  or  {@link org.havi.ui.HImageEffectMatte  HImageEffectMatte}  . The exception  is thrown even if m is null.  
	 * @see  HMatte
	 * @uml.property  name="matte"
	 */
    public void setMatte(HMatte m) throws HMatteException;

    /**
     * Get any {@link org.havi.ui.HMatte HMatte} currently associated
     * with this component.
     * 
     * @return the {@link org.havi.ui.HMatte HMatte} currently
     * associated with this component or null if there is no
     * associated matte.  
     */
    public HMatte getMatte();
}