SoPath.h
#ifndef COIN_SOPATH_H
#define COIN_SOPATH_H
/**************************************************************************\
* Copyright (c) Kongsberg Oil & Gas Technologies AS
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\**************************************************************************/
#include <Inventor/misc/SoBase.h>
#include <Inventor/lists/SbList.h>
#include <Inventor/lists/SoNodeList.h>
#ifndef COIN_INTERNAL
// For SGI / TGS Open Inventor compile-time compatibility.
#include <Inventor/SoLists.h>
#endif // !COIN_INTERNAL
class SoWriteAction;
class SoNotList;
class SoInput;
class SoPathList;
class COIN_DLL_API SoPath : public SoBase {
typedef SoBase inherited;
public:
static void initClass(void);
SoPath(const int approxlength = 4);
SoPath(SoNode * const head);
SoPath(const SoPath & rhs);
SoPath & operator=(const SoPath & rhs);
static SoType getClassTypeId(void);
virtual SoType getTypeId(void) const;
void setHead(SoNode * const head);
SoNode * getHead(void) const;
void append(const int childindex);
void append(SoNode * const node);
void append(const SoPath * const frompath);
void push(const int childindex);
void pop(void);
SoNode * getTail(void) const;
SoNode * getNode(const int index) const;
SoNode * getNodeFromTail(const int index) const;
int getIndex(const int index) const;
int getIndexFromTail(const int index) const;
int getLength(void) const;
void truncate(const int length);
int findFork(const SoPath * const path) const;
int findNode(const SoNode * const node) const;
SbBool containsNode(const SoNode * const node) const;
SbBool containsPath(const SoPath * const path) const;
SoPath * copy(const int startfromnodeindex = 0, int numnodes = 0) const;
friend COIN_DLL_API SbBool operator==(const SoPath & lhs, const SoPath & rhs);
friend COIN_DLL_API SbBool operator!=(const SoPath & lhs, const SoPath & rhs);
static SoPath * getByName(const SbName name);
static int getByName(const SbName name, SoPathList & l);
void insertIndex(SoNode * const parent, const int newindex);
void removeIndex(SoNode * const parent, const int oldindex);
void replaceIndex(SoNode * const parent, const int index,
SoNode * const newchild);
SbBool isRelevantNotification(SoNotList * const l) const;
virtual void write(SoWriteAction * action);
protected:
virtual ~SoPath();
void auditPath(const SbBool flag);
private:
static void cleanupClass(void);
static void * createInstance(void);
void append(SoNode * const node, const int index);
int getFullLength(void) const;
void truncate(const int length, const SbBool donotify);
virtual SbBool readInstance(SoInput * in, unsigned short flags);
void setFirstHidden(void);
SoNodeList nodes;
SbList<int> indices;
SbBool isauditing;
int firsthidden;
SbBool firsthiddendirty;
static SoType classTypeId;
friend class SoFullPath;
friend class SoNodeKitPath;
friend class SoAction;
friend class SoTempPath;
};
inline int
SoPath::getFullLength(void) const
{
return this->nodes.getLength();
}
inline void
SoPath::push(const int childindex)
{
this->append(childindex);
}
inline void
SoPath::pop(void)
{
this->truncate(this->getFullLength() - 1);
}
#ifndef COIN_INTERNAL
// For SGI / TGS Open Inventor compile-time compatibility.
#include <Inventor/SoFullPath.h>
#include <Inventor/misc/SoLightPath.h>
#endif // COIN_INTERNAL
#endif // !COIN_SOPATH_H
SbList
The SbList class is a template container class for lists.
Definition SbList.h:70
SbName
The SbName class stores strings by reference.
Definition SbName.h:40
SbPList::getLength
int getLength(void) const
Definition lists/SbPList.h:103
SoBase::SoBase
SoBase(void)
Definition SoBase.cpp:190
SoBase::getClassTypeId
static SoType getClassTypeId(void)
This static method returns the SoType object associated with objects of this class.
Definition SoBase.cpp:641
SoBase::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoBase.cpp:351
SoBase::getTypeId
virtual SoType getTypeId(void) const =0
Returns the type identification of an object derived from a class inheriting SoBase....
SoBase::readInstance
virtual SbBool readInstance(SoInput *input, unsigned short flags)=0
SoInput
The SoInput class is an abstraction of file import functionality.
Definition SoInput.h:61
SoNodeList
The SoNodeList class is a container for pointers to SoNode objects.
Definition SoNodeList.h:40
SoNode
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56
SoNotList
The SoNotList class is a list of SoNotRec notification records.
Definition SoNotification.h:43
SoPathList
The SoPathList class is a container for pointers to SoPath objects.
Definition SoPathList.h:40
SoPath::operator=
SoPath & operator=(const SoPath &rhs)
Definition SoPath.cpp:148
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::getHead
SoNode * getHead(void) const
Definition SoPath.cpp:200
SoPath::write
virtual void write(SoWriteAction *action)
Definition SoPath.cpp:968
SoPath::auditPath
void auditPath(const SbBool flag)
Definition SoPath.cpp:1061
SoPath::push
void push(const int childindex)
Definition SoPath.h:137
SoPath::getByName
static SoPath * getByName(const SbName name)
Definition SoPath.cpp:753
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::copy
SoPath * copy(const int startfromnodeindex=0, int numnodes=0) const
Definition SoPath.cpp:708
SoPath::setHead
void setHead(SoNode *const head)
Definition SoPath.cpp:187
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::isRelevantNotification
SbBool isRelevantNotification(SoNotList *const l) const
Definition SoPath.cpp:1011
SoPath::containsPath
SbBool containsPath(const SoPath *const path) const
Definition SoPath.cpp:646
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::findNode
int findNode(const SoNode *const node) const
Definition SoPath.cpp:622
SoPath::findFork
int findFork(const SoPath *const path) const
Definition SoPath.cpp:600
SoPath::operator!=
friend SbBool operator!=(const SoPath &lhs, const SoPath &rhs)
Definition SoPath.cpp:691
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59
SoWriteAction
The SoWriteAction class writes a scene graph to file.
Definition SoWriteAction.h:42