SoSearchAction.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Paul S. Strauss (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_SEARCH_ACTION_
#define  _SO_SEARCH_ACTION_
 
#include <Inventor/actions/SoSubAction.h>
 
//
//  Class: SoSearchAction
//
//  For searching for specific nodes in scene graphs. Nodes can be
//  searched for by pointer, by type (exact or derived), by name, or
//  by a combination of these. You can also specify whether you are
//  interested in only the first match, only the last match, or all
//  matches. You can also control whether normal traversal rules are
//  followed (switching, separators, etc.) or whether every single
//  node is to be searched.
//
 
class  SoSearchAction : public SoAction {
 
  SO_ACTION_HEADER(SoSearchAction);
 
 public:
 
  enum LookFor {
      NODE = 0x01,
    TYPE = 0x02,
    NAME = 0x04
  };
 
  enum Interest {
    FIRST,
    LAST,
    ALL
  };
 
  SoSearchAction();
 
  // Destructor
#ifndef HIDDEN_FROM_DOC
  virtual ~SoSearchAction();
#endif // HIDDEN_FROM_DOC
 
  virtual void reset();
 
  virtual void clearApplyResult();
 
  void setFind(int what) { lookingFor = what; }
 
  int getFind() { return lookingFor; }
 
  SoNode *getNode() const { return node; }
 
  void setNode(SoNode *n);
 
  SoType getType(SbBool &derivedIsOk) const
    { derivedIsOk = derivedOk; return type; }     
 
  void setType(SoType t, SbBool derivedIsOk = TRUE);
 
  const SbName &getName() const { return name; }
 
  void setName(const SbName &n);
 
  Interest getInterest() const { return interest; }
 
  void setInterest(Interest i) { interest = i; }
 
  SbBool isSearchingAll() const { return searchingAll; }
 
  void setSearchingAll(SbBool flag) { searchingAll = flag; }
 
  SoPath *getPath() const { return retPath; }
 
  SoPathList &getPaths() { return retPaths; }
  
 private:
 
  // Sets/returns whether action has found all desired nodes
  // (implementation moved into source file for v2.6)
  virtual void setFound();
  SbBool isFound() const { return hasTerminated(); }
  
  // Sets found path or adds to list of found paths (depending on interest)
  void addPath(SoPath *path);
  
 private:
 
  static void initClass();
  static void exitClass();
 
  // This flag is used by the SoSwitch node, which must return a
  // different result from its 'affectsState' method when called
  // during a SearchAction that is searching all children.
  static SbBool duringSearchAll;
  
 private:
 
  // Initiates action on graph
  virtual void beginTraversal(SoNode *node);
  
 private:
 
  // Node type id to search for
  SoType type;
 
  // Exact match or derived ok
  SbBool derivedOk;
 
  // Node to search for
  SoNode *node;
 
  // Name of node to search for 
  SbName name;
 
  // What to search for
  int lookingFor;
 
  // Which paths to return
  Interest interest;
 
  // Search all children or follow normal traversal rules.
  SbBool searchingAll;
 
  // Found node (if interest != ALL)
  SoPath *retPath;
 
  // Found nodes (if interest == ALL)
  SoPathList retPaths;
};
 
#endif /* _SO_SEARCH_ACTION_ */