alternateappearance.java

JAVA3D矩陈的相关类

/*
 * $RCSfile: AlternateAppearance.java,v $
 *
 * Copyright (c) 2007 Sun Microsystems, Inc. All rights reserved.
 *
 * Use is subject to license terms.
 *
 * $Revision: 1.5 $
 * $Date: 2007/02/09 17:17:49 $
 * $State: Exp $
 */

package javax.media.j3d;

import java.util.Enumeration;


/**
 * The AlternateAppearance leaf node is used for overriding the
 * Appearance component of selected nodes.  It defines an Appearance
 * component object and a region of influence in which this
 * AlternateAppearance node is active.  An AlternateAppearance node
 * also contains a list of Group nodes that specifies the hierarchical
 * scope of this AlternateAppearance.  If the scope list is empty,
 * then the AlternateAppearance node has universe scope: all nodes
 * within the region of influence are affected by this
 * AlternateAppearance node.  If the scope list is non-empty, then
 * only those Leaf nodes under the Group nodes in the scope list are
 * affected by this AlternateAppearance node (subject to the
 * influencing bounds).
 *
 * <p>
 * An AlternateAppearance node affects Shape3D and Morph nodes by
 * overriding their appearance component with the appearance
 * component in this AlternateAppearance node.  Only those Shape3D and
 * Morph nodes that explicitly allow their appearance to be
 * overridden are affected.  The AlternateAppearance node has no
 * effect on Shape3D and Morph nodes that do not allow their
 * appearance to be overridden.
 *
 * <p>
 * If the regions of influence of multiple AlternateAppearance nodes
 * overlap, the Java 3D system will choose a single alternate
 * appearance for those objects that lie in the intersection.  This is
 * done in an implementation-dependent manner, but in general, the
 * AlternateAppearance node that is "closest" to the object is chosen.
 *
 * @since Java 3D 1.2
 */

public class AlternateAppearance extends Leaf {
    /**
     * Specifies that this AlternateAppearance node allows read access to its
     * influencing bounds and bounds leaf information.
     */
    public static final int ALLOW_INFLUENCING_BOUNDS_READ =
	CapabilityBits.ALTERNATE_APPEARANCE_ALLOW_INFLUENCING_BOUNDS_READ;

    /**
     * Specifies that this AlternateAppearance node allows write access to its
     * influencing bounds and bounds leaf information.
     */
    public static final int ALLOW_INFLUENCING_BOUNDS_WRITE =
	CapabilityBits.ALTERNATE_APPEARANCE_ALLOW_INFLUENCING_BOUNDS_WRITE;

    /**
     * Specifies that this AlternateAppearance node allows read access to
     * its appearance information.
     */
    public static final int ALLOW_APPEARANCE_READ =
	CapabilityBits.ALTERNATE_APPEARANCE_ALLOW_APPEARANCE_READ;

    /**
     * Specifies that this AlternateAppearance node allows write access to
     * its appearance information.
     * information.
     */
    public static final int ALLOW_APPEARANCE_WRITE =
	CapabilityBits.ALTERNATE_APPEARANCE_ALLOW_APPEARANCE_WRITE;

    /**
     * Specifies that this AlternateAppearance node allows read access
     * to its scope information at runtime.
     */
    public static final int ALLOW_SCOPE_READ =
	CapabilityBits.ALTERNATE_APPEARANCE_ALLOW_SCOPE_READ;

    /**
     * Specifies that this AlternateAppearance node allows write access
     * to its scope information at runtime.
     */
    public static final int ALLOW_SCOPE_WRITE =
	CapabilityBits.ALTERNATE_APPEARANCE_ALLOW_SCOPE_WRITE;

   // Array for setting default read capabilities
    private static final int[] readCapabilities = {
        ALLOW_INFLUENCING_BOUNDS_READ,
        ALLOW_APPEARANCE_READ,
        ALLOW_SCOPE_READ
    };
    
    /**
     * Constructs an AlternateAppearance node with default
     * parameters.  The default values are as follows:
     *
     * <ul>
     * appearance : null<br>
     * scope : empty (universe scope)<br>
     * influencing bounds : null<br>
     * influencing bounding leaf : null<br>
     * </ul>
     */
    public AlternateAppearance() {
	// Just use the defaults
        // set default read capabilities
        setDefaultReadCapabilities(readCapabilities);
        
    }

    /**
     * Constructs an AlternateAppearance node with the specified appearance.
     * @param appearance the appearance that is used for those nodes affected
     * by this AlternateAppearance node.
     */
    public AlternateAppearance(Appearance appearance) {
        // set default read capabilities
        setDefaultReadCapabilities(readCapabilities);
	((AlternateAppearanceRetained)retained).initAppearance(appearance);
    }

    /**
     * Creates the retained mode AlternateAppearanceRetained object that this
     * Alternate Appearance component object will point to.
     */
    void createRetained() {
	this.retained = new AlternateAppearanceRetained();
	this.retained.setSource(this);
    }

    /**
     * Sets the appearance of this AlternateAppearance node.
     * This appearance overrides the appearance in those Shape3D and
     * Morph nodes affected by this AlternateAppearance node.
     * @param appearance the new appearance.
     * @exception CapabilityNotSetException if appropriate capability is
     * not set and this object is part of live or compiled scene graph
     */
    public void setAppearance(Appearance appearance) {
    	if (isLiveOrCompiled())
	    if(!this.getCapability(ALLOW_APPEARANCE_WRITE))
	    	throw new CapabilityNotSetException(J3dI18N.getString("AlternateAppearance0"));

	if (isLive()) 
	    ((AlternateAppearanceRetained)this.retained).setAppearance(appearance);
	else
	    ((AlternateAppearanceRetained)this.retained).initAppearance(appearance);
    }


    /**
     * Retrieves the appearance from this AlternateAppearance node.
     * @return the current appearance.
     * @exception CapabilityNotSetException if appropriate capability is
     * not set and this object is part of live or compiled scene graph
     */
    public Appearance getAppearance() {
    	if (isLiveOrCompiled())
	    if(!this.getCapability(ALLOW_APPEARANCE_READ))
	    	throw new CapabilityNotSetException(J3dI18N.getString("AlternateAppearance2"));

	return ((AlternateAppearanceRetained)this.retained).getAppearance();

    }

    /**
     * Sets the AlternateAppearance's influencing region to the specified
     * bounds.
     * This is used when the influencing bounding leaf is set to null.
     * @param region the bounds that contains the AlternateAppearance's
     * new influencing region.
     * @exception CapabilityNotSetException if appropriate capability is
     * not set and this object is part of live or compiled scene graph
     */
    public void setInfluencingBounds(Bounds region) {
    	if (isLiveOrCompiled())
	    if(!this.getCapability(ALLOW_INFLUENCING_BOUNDS_WRITE))
	    	throw new CapabilityNotSetException(J3dI18N.getString("AlternateAppearance3"));


	if (isLive()) 
	    ((AlternateAppearanceRetained)this.retained).setInfluencingBounds(region);
	else
	    ((AlternateAppearanceRetained)this.retained).initInfluencingBounds(region);
    }

    /**
     * Retrieves the AlternateAppearance node's influencing bounds.
     * @return this AlternateAppearance's influencing bounds information
     * @exception CapabilityNotSetException if appropriate capability is
     * not set and this object is part of live or compiled scene graph
     */
    public Bounds getInfluencingBounds() {
    	if (isLiveOrCompiled())
	    if(!this.getCapability(ALLOW_INFLUENCING_BOUNDS_READ))
	    	throw new CapabilityNotSetException(J3dI18N.getString("AlternateAppearance4"));


	return ((AlternateAppearanceRetained)this.retained).getInfluencingBounds();
    }


    /**
     * Sets the AlternateAppearance's influencing region to the specified
     * bounding leaf.
     * When set to a value other than null, this overrides the influencing
     * bounds object.
     * @param region the bounding leaf node used to specify the
     * AlternateAppearance node's new influencing region.
     * @exception CapabilityNotSetException if appropriate capability is
     * not set and this object is part of live or compiled scene graph
     */
    public void setInfluencingBoundingLeaf(BoundingLeaf region) {
    	if (isLiveOrCompiled())
	    if(!this.getCapability(ALLOW_INFLUENCING_BOUNDS_WRITE))
	    	throw new CapabilityNotSetException(J3dI18N.getString("AlternateAppearance3"));


	if (isLive())
	    ((AlternateAppearanceRetained)this.retained).setInfluencingBoundingLeaf(region);
	else
	    ((AlternateAppearanceRetained)this.retained).initInfluencingBoundingLeaf(region);
    }


    /**
     * Retrieves the AlternateAppearance node's influencing bounding leaf.
     * @return this AlternateAppearance's influencing bounding leaf information
     * @exception CapabilityNotSetException if appropriate capability is
     * not set and this object is part of live or compiled scene graph
     */
    public BoundingLeaf getInfluencingBoundingLeaf() {
    	if (isLiveOrCompiled())
	    if(!this.getCapability(ALLOW_INFLUENCING_BOUNDS_READ))
	    	throw new CapabilityNotSetException(J3dI18N.getString("AlternateAppearance4"));


	return ((AlternateAppearanceRetained)this.retained).getInfluencingBoundingLeaf();
    }


    /**
     * Replaces the node at the specified index in this
     * AlternateAppearance node's
     * list of scopes with the specified Group node.
     * By default, AlternateAppearance nodes are scoped only by their
     * influencing
     * bounds.  This allows them to be further scoped by a list of
     * nodes in the hierarchy.
     * @param scope the Group node to be stored at the specified index.
     * @param index the index of the Group node to be replaced.
     * @exception CapabilityNotSetException if appropriate capability is
     * not set and this object is part of live or compiled scene graph
     * @exception RestrictedAccessException if the specified group node
     * is part of a compiled scene graph
     */
    public void setScope(Group scope, int index) {
	if (isLiveOrCompiled())
	    if(!this.getCapability(ALLOW_SCOPE_WRITE))
		throw new CapabilityNotSetException(J3dI18N.getString("AlternateAppearance7"));



	if (isLive())
	    ((AlternateAppearanceRetained)this.retained).setScope(scope, index);
	else
	    ((AlternateAppearanceRetained)this.retained).initScope(scope, index);
    }


    /**
     * Retrieves the Group node at the specified index from
     * this AlternateAppearance node's list of scopes.
     * @param index the index of the Group node to be returned.
     * @return the Group node at the specified index.
     * @exception CapabilityNotSetException if appropriate capability is
     * not set and this object is part of live or compiled scene graph
     */
    public Group getScope(int index) {
	if (isLiveOrCompiled())
	    if(!this.getCapability(ALLOW_SCOPE_READ))
		throw new CapabilityNotSetException(J3dI18N.getString("AlternateAppearance8"));


	return ((AlternateAppearanceRetained)this.retained).getScope(index);
    }


    /**
     * Inserts the specified Group node into this AlternateAppearance node's
     * list of scopes at the specified index.
     * By default, AlternateAppearance nodes are scoped only by their
     * influencing