ShapeFinder.java

/**
 * Copyright (c) 2003-2009, Xith3D Project Group all rights reserved.
 * 
 * Portions based on the Java3D interface, Copyright by Sun Microsystems.
 * Many thanks to the developers of Java3D and Sun Microsystems for their
 * innovation and design.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * 
 * Neither the name of the 'Xith3D Project Group' nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) A
 * RISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE
 */
package org.xith3d.scenegraph.traversal.impl;

import java.util.ArrayList;
import java.util.List;

import org.xith3d.scenegraph.Node;
import org.xith3d.scenegraph.GroupNode;
import org.xith3d.scenegraph.Shape3D;
import org.xith3d.scenegraph.traversal.TraversalCallback;

/**
 * Traverses the scenegraph and finds shapes.
 *  
 * @author Amos Wenger (aka BlueSky)
 * @author Marvin Froehlich (aka Qudus)
 */
public final class ShapeFinder implements TraversalCallback
{
    private Shape3D shape;
    private List< Shape3D > shapes;
    private boolean isSearchModeAll;
    
    public boolean traversalCheckGroup( GroupNode group )
    {
        return ( shape == null );
    }
    
    public boolean traversalOperation( Node node )
    {
        if ( node instanceof Shape3D )
        {
            if ( !isSearchModeAll )
            {
                this.shape = (Shape3D)node;
                return ( false );
            }
            
            this.shapes.add( (Shape3D)node );
        }
        
        return ( true );
    }
    
    private ShapeFinder( boolean isSearchModeAll )
    {
        this.isSearchModeAll = isSearchModeAll;
        
        if ( isSearchModeAll )
            this.shapes = new ArrayList< Shape3D >();
        else
            this.shape = null;
    }
    
    /**
     * Finds the first Shape3D in the scenegraph
     * 
     * @param group the group to search
     * @return the found Shape3D
     */
    public static Shape3D findFirstShape( GroupNode group )
    {
        ShapeFinder sf = new ShapeFinder( false );
        
        group.traverse( sf );
        
        return ( sf.shape );
    }
    
    /**
     * Finds all Shape3Ds in the scenegraph
     * 
     * @param group the group to search
     * @return the found Shape3Ds
     */
    public static List< Shape3D > findAllShapes( GroupNode group )
    {
        ShapeFinder sf = new ShapeFinder( true );
        
        group.traverse( sf );
        
        return ( sf.shapes );
    }
}