SoSearchAction.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */
 
 
/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.1.1.1 $
 |
 |   Description:
 |      Defines the SoSearchAction class
 |
 |   Author(s)          : Paul S. Strauss
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_SEARCH_ACTION_
#define  _SO_SEARCH_ACTION_
 
#include <Inventor/system/SbSystem.h>
#include <Inventor/actions/SoSubAction.h>
 


 
class INVENTOR_API SoSearchAction : public SoAction {
 
    SO_ACTION_HEADER(SoSearchAction);
 
  public:

    enum LookFor {
        NODE = 0x01,    
        TYPE = 0x02,    
        NAME = 0x04     
    };

    enum Interest {
        FIRST,          
        LAST,           
        ALL             
    };

    SoSearchAction();

    virtual ~SoSearchAction();

    void                reset();

    void                setFind(int what)       { lookingFor = what; }
    int                 getFind()               { return lookingFor; }

    SoNode *            getNode() const         { return node; }
    void                setNode(SoNode *n);

    SoType              getType(bool &derivedIsOk) const
        { derivedIsOk = derivedOk; return type; }       

    void                setType(SoType t, bool derivedIsOk = TRUE);

    const SbName &      getName() const { return name; }
    void                setName(const SbName &n);

    Interest            getInterest() const     { return interest; }
    void                setInterest(Interest i) { interest = i;    }

    bool                isSearchingAll() const  { return searchingAll; }
    void                setSearchingAll(bool flag) { searchingAll = flag; }

    SoPath *            getPath() const         { return retPath; }

    SoPathList &        getPaths()              { return retPaths; }
 
  SoEXTENDER public:
    void                setFound()              { setTerminated(TRUE); }
    bool                isFound() const         { return hasTerminated(); }

    void                addPath(SoPath *path);
 
  SoINTERNAL public:
    static void         initClass();

    static bool         duringSearchAll;
 
  protected:
    virtual void        beginTraversal(SoNode *node);
 
  private:
 
    SoType              type;           
    bool                derivedOk;      
    SoNode              *node;          
    SbName              name;           
    int                 lookingFor;     
    Interest            interest;       
    bool                searchingAll;   
    SoPath              *retPath;       
    SoPathList          retPaths;       
};
 
#endif /* _SO_SEARCH_ACTION_ */