Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
SoCompactPathList.h
1/*=======================================================================
2 * Copyright 1991-1996, Silicon Graphics, Inc.
3 * ALL RIGHTS RESERVED
4 *
5 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
6 * States. Use of a copyright notice is precautionary only and does not
7 * imply publication or disclosure.
8 *
9 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
10 * Use, duplication or disclosure by the Government is subject to restrictions
11 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
12 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
13 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
14 * Supplement. Contractor/manufacturer is Silicon Graphics, Inc.,
15 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
16 *
17 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
18 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
19 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
20 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
21 * GRAPHICS, INC.
22**=======================================================================*/
23/*=======================================================================
24** Author : Paul S. Strauss (MMM yyyy)
25**=======================================================================*/
26/*=======================================================================
27 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
28 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
29 *** ***
30 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
31 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
32 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
33 *** ***
34 *** RESTRICTED RIGHTS LEGEND ***
35 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
36 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
37 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
38 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
39 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
40 *** ***
41 *** COPYRIGHT (C) 1996-2014 BY FEI S.A.S, ***
42 *** BORDEAUX, FRANCE ***
43 *** ALL RIGHTS RESERVED ***
44**=======================================================================*/
45/*=======================================================================
46** Modified by : VSG (MMM YYYY)
47**=======================================================================*/
48
49
50
51#ifndef _SO_COMPACT_PATH_LIST_
52#define _SO_COMPACT_PATH_LIST_
53
54#include <Inventor/misc/SoRefCounter.h>
55
56// forward declaration of implementation class
57class SoCompactPathListImpl;
58class SoPathList;
59
61//
62// Class: SoCompactPathList (internal)
63//
64// This class represents a list of paths (like an SoPathList) in a
65// more compact form. Since many paths in a path list may share
66// common sub-paths from common head nodes, this class stores them
67// with less redundancy.
68//
69// The SoCompactPathList constructor is passed an SoPathList. It is
70// assumed that the SoPathList is not empty and that all paths in the
71// SoPathList have a common head node; an error will occur otherwise.
72// It is also assumed that no two paths are identical, and that if
73// one path goes through node X, then no other path will end at node
74// X.
75//
76// While an SoPathList provides random access to any node in any
77// path, an SoCompactPathList provides only sequential access. That
78// is, you can only access the paths in the list in order. Each
79// instance maintains the notion of the "current node" - the node
80// that traversal has last reached - to support this access.
81//
83
84
85{
86
87 public:
88 // Constructor given path list
89 SoCompactPathList(const SoPathList &list);
90 ~SoCompactPathList();
91
92 // Resets traversal to the beginning. This allows an instance to
93 // be traversed more than once.
94 void reset();
95
96 // Returns the indices of the current node that are in paths in
97 // the list. The number of indices is returned in "numIndices",
98 // and the indices are returned in "indices". numIndices will be 0
99 // if the current node has no children in any path.
100 void getChildren(int &numIndices, const int *&indices);
101
102 // Traverses the child with given index of the current node. The
103 // child becomes the new current node. If the child is on a path
104 // in the list, then getChildren() can be called to get the next
105 // set of children. Otherwise, it will always return no children.
106 // This method returns TRUE if the given childIndex is in one of
107 // the paths in the list, and FALSE otherwise.
108 //
109 // lastFound is an inout parameter that contains the last indices found in the compactPathList
110 // for the current separator. When iterating over children of a separator it
111 // should be set to 0 on first call then the returned result has to be reused until the last
112 // call for the separator.
113 SbBool push(int childIndex, int &lastFound);
114
115 // Restores current node to what it was before the most recent push()
116 void pop();
117
118 private:
119 // implementation class
120 SoCompactPathListImpl* m_impl;
121};
122
123#endif // _SO_COMPACT_PATH_LIST_
124
Maintains a list of pointers to paths.
Definition SoPathList.h:81
int SbBool
Boolean type.
Definition SbBase.h:87