SoSearchPathAction.h

/*=======================================================================
 *** 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-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Mike Heck (Apr 2000)
**=======================================================================*/
 
 
#ifndef  _SO_SEARCHPATH_ACTION_
#define  _SO_SEARCHPATH_ACTION_
 
// Note: Not necessary to include SoSubAction.h because it is already
//       included by SoSearchAction.h
#include <Inventor/actions/SoSearchAction.h>
 
class  SoSearchPathAction : public SoSearchAction {
 
  SO_ACTION_HEADER(SoSearchPathAction);
 
 public:
 
  SoSearchPathAction();
 
  virtual ~SoSearchPathAction();
 
  void            reset();
 
  void            setSearchString( const char *searchString );
  const SbString& getSearchString() const
    { return m_strSearchString; };
 
  void            setSeparatorChar( const char sepChar )
    { m_cSepChar = sepChar; }
  char            getSeparatorChar() const
    { return m_cSepChar; }
 
  void            setDerivedIsOK( const SbBool derivedIsOK )
    { m_bDerivedIsOK = derivedIsOK; };
  SbBool          getDerivedIsOK() const
    { return m_bDerivedIsOK; };
 
  int             getNumItemsFound() const
    { return m_nItemNum; };
 
 private:
  // Notifies action that the current node satisfies the current search item.
  virtual void    setFound();
 
 private:
  static void     initClass();
  static void     exitClass();
 
  // Static and instance-specific callbacks called during traversal
  static  void    searchStatic(SoAction *action, SoNode *node);
  virtual void    search      (SoNode *node);
 
 private:
  // Initiates action on graph
  virtual void    beginTraversal(SoNode *node);
 
  // Classify search item and call appropriate SearchAction method
  SbBool          setSearchParameters( const char* item );
 
  // Result of setupNextSearchItem
  enum ItemSetupResult {
    NO_MORE_ITEMS,
    VALID_ITEM,
    INVALID_ITEM
  };
 
  // Extract next search item from search string and get ready to go.
  ItemSetupResult setupNextSearchItem();
 
  SbString        m_strSearchString;  // Search string
  char           *m_pStartChar;       // Points to next search item
  char            m_cSepChar;         // Char that separates search items
  SbBool          m_bDerivedIsOK;     // Will type search match derived types
  int             m_nItemNum;         // Which search item is active (for error reporting)
 
 private:
 
};
 
#endif /* _SO_SEARCHPATH_ACTION_ */