Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
SoPathList.h
Go to the documentation of this file.
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** Modified by : Nick Thompson (MMM yyyy)
26** Modified by : David Mott (MMM yyyy)
27**=======================================================================*/
28/*=======================================================================
29 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
30 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
31 *** ***
32 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
33 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
34 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
35 *** ***
36 *** RESTRICTED RIGHTS LEGEND ***
37 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
38 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
39 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
40 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
41 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
42 *** ***
43 *** COPYRIGHT (C) 1996-2014 BY FEI S.A.S, ***
44 *** BORDEAUX, FRANCE ***
45 *** ALL RIGHTS RESERVED ***
46**=======================================================================*/
47/*=======================================================================
48** Modified by : VSG (MMM YYYY)
49**=======================================================================*/
50
51#ifndef SO_PATH_LIST_H
52#define SO_PATH_LIST_H
53
55
56class SoPath;
57
59
60#ifdef _WIN32
61#pragma warning(push)
62#pragma warning(disable:4251)
63#endif
64
80class SoPathList : public SoBaseList
81{
82 public:
86 SoPathList() : SoBaseList(), m_isSorted(false) {}
87
91 SoPathList(int size) : SoBaseList(size), m_isSorted(false) {}
92
97 m_compactPathList(l.m_compactPathList),
98 m_isSorted(l.m_isSorted)
99 { copy(l); }
100
104 virtual ~SoPathList() {}
105
109 virtual SbBool removePath( const SoPath &path );
110
114 virtual void append(SoPath* ptr)
115 { SoBaseList::append((SoBase*)ptr); }
116
118 SoPath* operator [](int i) const
119 { return ((SoPath *) ((*(const SoBaseList *) this) [i])); }
120
125 { SoBaseList::copy(l) ; return *this; }
126
130 virtual int findPath(const SoPath &path);
131
136 virtual void sort();
137
142 virtual void uniquify();
143
144 // Comparison method for path list sorting.
145 static int comparePaths(const void *p1Ptr, const void *p2Ptr);
146
147 private:
148 // An optional compact representation of the path list.
149 SoRef<SoCompactPathList> m_compactPathList;
150
151 bool isSorted() { return m_isSorted; }
152 void setSorted(bool isSorted) { m_isSorted = isSorted; }
153 private:
154 // sorted status
155 bool m_isSorted;
156};
157
161std::ostream& operator << (std::ostream& os, const SoPathList& pathList);
162
163#ifdef _WIN32
164#pragma warning(pop)
165#endif
166
167#endif
std::ostream & operator<<(std::ostream &os, const SoPathList &pathList)
Writes the list to the specified output stream.
int getLength() const
Returns number of pointers in list.
Definition SbPList.h:125
Base class for all nodes, paths, and engines.
Definition SoBase.h:111
Maintains a list of pointers to instances of the SoBase classes.
Definition SoBaseList.h:79
void copy(const SoBaseList &l)
Copies a list, keeping all reference counts correct.
void append(SoBase *ptr)
Adds a pointer to the end of the list.
Path that points to a list of hierarchical nodes.
Definition SoPath.h:187
Maintains a list of pointers to paths.
Definition SoPathList.h:81
virtual ~SoPathList()
Destructor.
Definition SoPathList.h:104
virtual void uniquify()
Given a sorted list, removes any path that (1) is a duplicate, or (2) goes through a node that is the...
virtual void sort()
Sorts list in place based on (1) increasing address of head node, then (2) increasing indices of chil...
virtual SbBool removePath(const SoPath &path)
Remove a path from the list and return TRUE if removed.
virtual void append(SoPath *ptr)
Adds a path to the end of the list.
Definition SoPathList.h:114
SoPath * operator[](int i) const
Returns pointer with given index.
Definition SoPathList.h:118
static int comparePaths(const void *p1Ptr, const void *p2Ptr)
SoPathList(const SoPathList &l)
Constructor that copies the contents of another list.
Definition SoPathList.h:96
SoPathList()
Constructor.
Definition SoPathList.h:86
SoPathList(int size)
Constructor that pre-allocates storage for size pointers.
Definition SoPathList.h:91
SoPathList & operator=(const SoPathList &l)
Copies a list, keeping all reference counts correct.
Definition SoPathList.h:124
virtual int findPath(const SoPath &path)
Returns the index of the matching path in the list, or -1 if not found.
Smart pointer for any class inheriting SoRefCounter.
Definition SoRef.h:90
int SbBool
Boolean type.
Definition SbBase.h:87
size_t size() const