Coin Logo http://www.sim.no
http://www.coin3d.org

SoSearchAction.h
1 #ifndef COIN_SOSEARCHACTION_H
2 #define COIN_SOSEARCHACTION_H
3 
4 /**************************************************************************\
5  *
6  * This file is part of the Coin 3D visualization library.
7  * Copyright (C) 1998-2007 by Systems in Motion. All rights reserved.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * ("GPL") version 2 as published by the Free Software Foundation.
12  * See the file LICENSE.GPL at the root directory of this source
13  * distribution for additional information about the GNU GPL.
14  *
15  * For using Coin with software that can not be combined with the GNU
16  * GPL, and for taking advantage of the additional benefits of our
17  * support services, please contact Systems in Motion about acquiring
18  * a Coin Professional Edition License.
19  *
20  * See http://www.coin3d.org/ for more information.
21  *
22  * Systems in Motion, Postboks 1283, Pirsenteret, 7462 Trondheim, NORWAY.
23  * http://www.sim.no/ sales@sim.no coin-support@coin3d.org
24  *
25 \**************************************************************************/
26 
27 #include <Inventor/actions/SoAction.h>
28 #include <Inventor/actions/SoSubAction.h>
29 #include <Inventor/SbName.h>
30 #include <Inventor/lists/SoPathList.h>
31 
32 class COIN_DLL_API SoSearchAction : public SoAction {
33  typedef SoAction inherited;
34 
35  SO_ACTION_HEADER(SoSearchAction);
36 
37 public:
38  SoSearchAction(void);
39  virtual ~SoSearchAction();
40 
41  static void initClass(void);
42 
43  enum LookFor { NODE = 1, TYPE = 2, NAME = 4 };
44  enum Interest { FIRST, LAST, ALL };
45 
46  void setNode(SoNode * const node);
47  SoNode * getNode(void) const;
48  void setType(const SoType type, const SbBool chkderived = TRUE);
49  SoType getType(SbBool & chkderived) const;
50  void setName(const SbName name);
51  SbName getName(void) const;
52  void setFind(const int what);
53  int getFind(void) const;
54  void setInterest(const Interest interest);
55  Interest getInterest(void) const;
56  void setSearchingAll(const SbBool searchall);
57  SbBool isSearchingAll(void) const;
58  SoPath * getPath(void) const;
59  SoPathList & getPaths(void);
60  void reset(void);
61 
62  void setFound(void);
63  SbBool isFound(void) const;
64  void addPath(SoPath * const path);
65 
66  // Obsoleted global flag, only present for compatibility reasons
67  // with old SGI / TGS Inventor application code.
68  static SbBool duringSearchAll;
69 
70 protected:
71  virtual void beginTraversal(SoNode * node);
72 
73 private:
74  int lookfor;
75  Interest interest;
76  SbBool searchall, chkderived;
77  SoNode * node;
78  SoType type;
79  SbName name;
80  SoPath * path;
81  SoPathList paths;
82 };
83 
84 #endif // !COIN_SOSEARCHACTION_H
SoSearchAction::setName
void setName(const SbName name)
Definition: SoSearchAction.cpp:204
SoType::badType
static SoType badType(void)
Definition: SoType.cpp:664
SoSearchAction::setType
void setType(const SoType type, const SbBool chkderived=1)
Definition: SoSearchAction.cpp:175
SoAction::hasTerminated
SbBool hasTerminated(void) const
Definition: SoAction.cpp:1018
SoSearchAction::getFind
int getFind(void) const
Definition: SoSearchAction.cpp:239
SoSearchAction::~SoSearchAction
virtual ~SoSearchAction()
Definition: SoSearchAction.cpp:130
SbName
The SbName class stores strings by reference.
Definition: SbName.h:31
SoSearchAction::setFind
void setFind(const int what)
Definition: SoSearchAction.cpp:230
SoSearchAction::addPath
void addPath(SoPath *const path)
Definition: SoSearchAction.cpp:389
SoBaseList::truncate
void truncate(const int length)
Definition: SoBaseList.cpp:156
SoAction::beginTraversal
virtual void beginTraversal(SoNode *node)
Definition: SoAction.cpp:1208
SoSearchAction::getType
SoType getType(SbBool &chkderived) const
Definition: SoSearchAction.cpp:187
SoSearchAction::setFound
void setFound(void)
Definition: SoSearchAction.cpp:361
SoSearchAction
The SoSearchAction class provides methods for searching through scene graphs.
Definition: SoSearchAction.h:32
SoAction
The SoAction class is the base class for all traversal actions.
Definition: SoAction.h:67
SoSearchAction::setNode
void setNode(SoNode *const node)
Definition: SoSearchAction.cpp:145
SoSearchAction::getNode
SoNode * getNode(void) const
Definition: SoSearchAction.cpp:160
SoPathList
The SoPathList class is a container for pointers to SoPath objects.
Definition: SoPathList.h:31
SoSearchAction::getInterest
Interest getInterest(void) const
Definition: SoSearchAction.cpp:259
SoBase::unref
void unref(void) const
Definition: SoBase.cpp:627
SoSearchAction::getName
SbName getName(void) const
Definition: SoSearchAction.cpp:215
SoPathList::append
void append(SoPath *const path)
Definition: SoPathList.cpp:88
SoPath
The SoPath class is a container class for traversal path descriptions.
Definition: SoPath.h:43
SoType
The SoType class is the basis for the run-time type system in Coin.
Definition: SoType.h:50
SoSearchAction::getPath
SoPath * getPath(void) const
Definition: SoSearchAction.cpp:317
SoBase::ref
void ref(void) const
Definition: SoBase.cpp:574
SoSearchAction::setInterest
void setInterest(const Interest interest)
Definition: SoSearchAction.cpp:249
SoSearchAction::reset
void reset(void)
Definition: SoSearchAction.cpp:341
SoSearchAction::isSearchingAll
SbBool isSearchingAll(void) const
Definition: SoSearchAction.cpp:287
SoSearchAction::getPaths
SoPathList & getPaths(void)
Definition: SoSearchAction.cpp:331
SoSearchAction::beginTraversal
virtual void beginTraversal(SoNode *node)
Definition: SoSearchAction.cpp:423
SoAction::initClass
static void initClass(void)
Definition: SoAction.cpp:392
SoSearchAction::Interest
Interest
Definition: SoSearchAction.h:44
SoSearchAction::duringSearchAll
static SbBool duringSearchAll
Definition: SoSearchAction.h:68
SoNode
The SoNode class is the base class for nodes used in scene graphs.
Definition: SoNode.h:47
SoSearchAction::LookFor
LookFor
Definition: SoSearchAction.h:43
SoAction::traverse
void traverse(SoNode *const node)
Definition: SoAction.cpp:902
SoSearchAction::SoSearchAction
SoSearchAction(void)
Definition: SoSearchAction.cpp:119
SoAction::setTerminated
void setTerminated(const SbBool flag)
Definition: SoAction.cpp:1233
SoSearchAction::setSearchingAll
void setSearchingAll(const SbBool searchall)
Definition: SoSearchAction.cpp:278
SoSearchAction::isFound
SbBool isFound(void) const
Definition: SoSearchAction.cpp:376

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Jul 27 2020 for Coin by Doxygen. 1.8.18