Coin: SoNodeKitPath.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoNodeKitPath.h
1#ifndef COIN_SONODEKITPATH_H
2#define COIN_SONODEKITPATH_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36#include <Inventor/SoPath.h>
37
38class SoNode;
39class SoBaseKit;
40class SoSearchAction;
41
42 class COIN_DLL_API SoNodeKitPath : public SoPath {
43 typedef SoPath inherited;
44
45public:
46 int getLength(void) const;
47 SoNode * getTail(void) const;
48 SoNode * getNode(const int idx) const;
49 SoNode * getNodeFromTail(const int idx) const;
50 void truncate(const int length);
51 void pop(void);
52 void append(SoBaseKit * childKit);
53 void append(const SoNodeKitPath * fromPath);
54 SbBool containsNode(SoBaseKit * node) const;
55 int findFork(const SoNodeKitPath * path) const;
56
57 friend COIN_DLL_API int operator==(const SoNodeKitPath & p1, const SoNodeKitPath & p2);
58
59protected:
60 SoNodeKitPath(const int approxLength);
61 virtual ~SoNodeKitPath();
62
63private:
64
65 static void clean(void);
66 static SoSearchAction *searchAction;
67 SoSearchAction *getSearchAction(void);
68
69 // these methods should not be used on an SoNodeKitPath
70 void append(const int childIndex);
71 void append(SoNode *childNode);
72 void append(const SoPath *fromPath);
73 void push(const int childIndex);
74 int getIndex(const int i) const;
75 int getIndexFromTail(const int i) const;
76 void insertIndex(SoNode *parent,const int newIndex);
77 void removeIndex(SoNode *parent,const int oldIndex);
78 void replaceIndex(SoNode *parent,const int index,SoNode *newChild);
79};
80
81COIN_DLL_API int operator==(const SoNodeKitPath & p1, const SoNodeKitPath & p2);
82
83#endif // !COIN_SONODEKITPATH_H
SoBaseKit
The SoBaseKit class is the top level superclass for nodekits.
Definition SoBaseKit.h:66
SoNodeKitPath
The SoNodeKitPath class is a path that contains only nodekit nodes.
Definition SoNodeKitPath.h:42
SoNodeKitPath::SoNodeKitPath
SoNodeKitPath(const int approxLength)
Definition SoNodeKitPath.cpp:70
SoNode
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56
SoPath::getNode
SoNode * getNode(const int index) const
Definition SoPath.cpp:434
SoPath::getIndex
int getIndex(const int index) const
Definition SoPath.cpp:468
SoPath::SoPath
SoPath(const int approxlength=4)
Definition SoPath.cpp:118
SoPath::push
void push(const int childindex)
Definition SoPath.h:137
SoPath::removeIndex
void removeIndex(SoNode *const parent, const int oldindex)
Definition SoPath.cpp:814
SoPath::getTail
SoNode * getTail(void) const
Definition SoPath.cpp:405
SoPath::getNodeFromTail
SoNode * getNodeFromTail(const int index) const
Definition SoPath.cpp:451
SoPath::replaceIndex
void replaceIndex(SoNode *const parent, const int index, SoNode *const newchild)
Definition SoPath.cpp:852
SoPath::getIndexFromTail
int getIndexFromTail(const int index) const
Definition SoPath.cpp:487
SoPath::append
void append(const int childindex)
Definition SoPath.cpp:211
SoPath::pop
void pop(void)
Definition SoPath.h:143
SoPath::operator==
friend SbBool operator==(const SoPath &lhs, const SoPath &rhs)
Definition SoPath.cpp:669
SoPath::getLength
int getLength(void) const
Definition SoPath.cpp:508
SoPath::insertIndex
void insertIndex(SoNode *const parent, const int newindex)
Definition SoPath.cpp:785
SoPath::containsNode
SbBool containsNode(const SoNode *const node) const
Definition SoPath.cpp:636
SoPath::truncate
void truncate(const int length)
Definition SoPath.cpp:528
SoPath::findFork
int findFork(const SoPath *const path) const
Definition SoPath.cpp:600
SoSearchAction
The SoSearchAction class provides methods for searching through scene graphs.
Definition SoSearchAction.h:44