SoPath.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */
 
 
/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.2 $
 |
 |   Description:
 |      This file contains the definition of the SoPath and SoFullPath
 |      classes, and the related class SoLightweightPath
 |
 |   Author(s)          : Paul S. Strauss, Nick Thompson, Alan Norton
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_PATH_
#define  _SO_PATH_
 
#include <Inventor/system/SbSystem.h>
#include <Inventor/misc/SoBase.h>
#include <Inventor/nodes/SoNode.h>
#include <Inventor/SoLists.h>
 
 
class SoPathList;
class SoWriteAction;
class SoTempPath;
 
 
 
class INVENTOR_API SoPath : public SoBase {
 
  public:
 
    SoPath();
 
    SoPath(int approxLength);
 
    SoPath(SoNode *node);
 
    void                setHead(SoNode *node);
 
    void                append(int childIndex);
 
    void                append(SoNode *childNode);
 
    void                append(const SoPath *fromPath);
 
    void                push(int childIndex) { append(childIndex); }
    void                pop()                { truncate(getFullLength() - 1); }
 
    SoNode *            getHead() const { return nodes[0]; }
    SoNode *            getTail() const { return (nodes[getLength() - 1]); }
 
    SoNode *            getNode(int i) const    { return (nodes[i]); }
 
    SoNode *            getNodeFromTail(int i) const
        { return (nodes[getLength() - 1 - i]); }
 
    int                 getIndex(int i) const   { return (indices[i]); }
 
    int                 getIndexFromTail(int i) const
        { return (indices[getLength() - 1 - i]); }
 
    int                 getLength() const;
 
    void                truncate(int start);
 
    bool                containsNode(const SoNode *node) const;
 
    bool                containsPath(const SoPath *path) const;
 
    int                 findFork(const SoPath *path) const;
 
    SoPath *            copy(int startFromNodeIndex = 0,
                             int numNodes = 0) const;
 
    friend INVENTOR_API bool               operator ==(const SoPath &p1, const SoPath &p2);
 
    virtual SoType      getTypeId() const;
 
    static SoType       getClassTypeId()        { return classTypeId; }
 
    static SoPath *     getByName(const SbName &name);
    static int          getByName(const SbName &name, SoPathList &list);
 
  SoINTERNAL public:
    static void         initClass();
 
    void                insertIndex(SoNode *parent, int newIndex);
 
    void                removeIndex(SoNode *parent, int oldIndex);
 
    void                replaceIndex(SoNode *parent, int index,
                                     SoNode *newChild);
 
    virtual void        write(SoWriteAction *writeAction) const;
 
    bool                isRelevantNotification(SoNotList *list) const;
 
  protected:
    void                auditPath(bool flag)  { doAuditors = flag; }
 
    ~SoPath();
 
  private:
    SoNodeList          nodes;          
    SbIntList           indices;        
    int                 numPublic;      
    int                 minNumPublic;   
    bool                doAuditors;     
    static SoType       classTypeId;    
 
    int                 getFullLength() const   { return nodes.getLength(); }
 
    void                append(SoNode *node, int index);
 
    static void *       createInstance();
 
    virtual bool        readInstance(SoInput *in, unsigned short flags);
 
    void                truncate(int start, bool doNotify);
 
friend class SoFullPath;
friend class SoTempPath;
friend class SoAction;
};
 
INVENTOR_API bool               operator ==(const SoPath &p1, const SoPath &p2);
 
 
SoEXTENDER class INVENTOR_API SoFullPath : public SoPath {
 
  public:
 
    void                pop()           { truncate(getFullLength() - 1); }
 
    SoNode *            getTail() const
        { return (nodes[getFullLength() - 1]); }
 
    SoNode *            getNodeFromTail(int i) const
        { return (nodes[getFullLength() - 1 - i]); }
 
    int                 getIndexFromTail(int i) const
        { return (indices[getFullLength() - 1 - i]); }
 
    int                 getLength() const       { return getFullLength(); }
 
  private:
    SoFullPath(int approxLength) : SoPath(approxLength) {}
    virtual ~SoFullPath();
 
friend class SoTempPath;
};
 
 
 
 
 
class INVENTOR_API SoLightweightPath  {
 
  SoINTERNAL public:
 
    SoLightweightPath(int approxLength);
 
 
    void                setHead(SoNode *node);
 
    void                append(int childIndex) 
        { indices.append(childIndex);}
 
 
    void                push(int childIndex)    { append(childIndex); }
    void                push()                  { append(-1);}
    void                pop()           { truncate(getFullLength() - 1); }
    void                setTail(int childIndex) 
                { indices.set(getFullLength()-1,(void *)(size_t)childIndex);}
    SoNode *            getTail()
                { return getNode(getFullLength()-1);}
 
    SoNode *            getHead() const { return headNode; }
 
    SoNode *            getNode(int i) const;   
 
    int                 getFullLength() const {return indices.getLength();}
 
    void                truncate(int start) { indices.truncate(start);}
 
    
    void                makeTempPath(SoTempPath *tmpPath) const;
 
    ~SoLightweightPath();
 
  private:
 
    SoNode *            headNode;       
    SbIntList           indices;        
 
 
  friend class SoAction;
};
 
 
 
#endif /* _SO_PATH_ */