SoLists.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.1.1.1 $
 |
 |   Description:
 |      This file contains the definitions of subclasses of SbPList for
 |      some of the specific Inventor pointer types so that lists of
 |      pointers can be created easily.
 |
 |   Classes:
 |      subclasses of SbPList:
 |              SoBaseList
 |              SoNodeList
 |              SoPathList
 |              SoEngineList
 |              SoTypeList
 |              SoDetailList
 |              SoPickedPointList
 |              SoFieldList
 |              SoEngineOutputList
 |
 |   Author(s)          : Paul S. Strauss, Nick Thompson, David Mott,
 |                        Gavin Bell
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_LISTS_
#define  _SO_LISTS_
 
#include <Inventor/system/SbSystem.h>
#include <Inventor/SbPList.h>
#include <Inventor/SoType.h>
 
class SoBase;
class SoDetail;
class SoEngine;
class SoEngineOutput;
class SoField;
class SoNode;
class SoPath;
class SoPickedPoint;
 
 
 
 
class INVENTOR_API SoBaseList : public SbPList {
  public:
    SoBaseList();
    SoBaseList(int size);
    SoBaseList(const SoBaseList &l);
    ~SoBaseList()                       { truncate(0); }
 
    void                append(SoBase * ptr);
 
    void                insert(SoBase *ptr, int addBefore);
 
    void                remove(int which);
 
    void                truncate(int start);
 
    void                copy(const SoBaseList &l);
    SoBaseList &        operator =(const SoBaseList &l)
        { copy(l) ; return *this; }
 
    SoBase *            operator [](int i) const
        { return ( (SoBase *) ( (*(const SbPList *) this) [i] ) ); }
 
    void                set(int i, SoBase *ptr);
 
    void                addReferences(bool flag)      { addRefs = flag; }
 
  private:
    bool                addRefs;
};
 
 
 
class INVENTOR_API SoNodeList : public SoBaseList {
  public:
    SoNodeList()                        : SoBaseList()  {}
    SoNodeList(int size)                : SoBaseList(size) {}
    SoNodeList(const SoNodeList &l)     : SoBaseList(l) {}
    ~SoNodeList()                       { }
 
    void                append(SoNode * ptr)
        { ((SoBaseList *) this)->append((SoBase *) ptr); }
 
    SoNodeList &        operator =(const SoNodeList &l)
        { SoBaseList::copy(l) ; return *this; }
 
    SoNode *            operator [](int i) const
        { return ( (SoNode *) ( (*(const SoBaseList *) this) [i] ) ); }
};
 
 
 
class INVENTOR_API SoPathList : public SoBaseList {
  public:
    SoPathList()                        : SoBaseList()  {}
    SoPathList(int size)                : SoBaseList(size) {}
    SoPathList(const SoPathList &l)     : SoBaseList(l) {}
    ~SoPathList()                       { }
 
    void                append(SoPath * ptr)
        { ((SoBaseList *) this)->append((SoBase *) ptr); }
 
    SoPathList &        operator =(const SoPathList &l)
        { SoBaseList::copy(l) ; return *this; }
 
    SoPath *            operator [](int i) const
        { return ( (SoPath *) ( (*(const SoBaseList *) this) [i] ) ); }
 
    int                 findPath(const SoPath &path);
 
    void                sort();
 
    void                uniquify();
 
  private:
    static int          comparePaths(const void *p1Ptr, const void *p2Ptr);
};
 
 
 
class INVENTOR_API SoEngineList : public SoBaseList {
  public:
    SoEngineList()                      : SoBaseList()  {}
    SoEngineList(int size)              : SoBaseList(size) {}
    SoEngineList(const SoEngineList &l) : SoBaseList(l) {}
    ~SoEngineList()                     { }
 
    void                append(SoEngine * ptr)
        { ((SoBaseList *) this)->append((SoBase *) ptr); }
 
    SoEngineList &      operator =(const SoEngineList &l)
        { SoBaseList::copy(l) ; return *this; }
 
    SoEngine *          operator [](int i) const
        { return ( (SoEngine *) ( (*(const SoBaseList *) this) [i] ) ); }
};
 
 
 
class INVENTOR_API SoTypeList : public SbPList {
  public:
    SoTypeList()                        : SbPList()     {}
    SoTypeList(int size)                : SbPList(size) {}
    SoTypeList(const SoTypeList &l)     : SbPList(l)    {}
    ~SoTypeList()                       { truncate(0); }
 
    void                append(SoType typeId);
 
    int                 find(SoType typeId) const;
 
    void                insert(SoType typeId, int addBefore);
 
    SoType              operator [](int i) const;
 
    void                set(int i, SoType typeId);
};
 
 
 
class INVENTOR_API SoDetailList : public SbPList {
  public:
    SoDetailList()                      : SbPList()     {}
    SoDetailList(int size)              : SbPList(size) {}
    SoDetailList(const SoDetailList &l);
    ~SoDetailList()                     { truncate(0); }
 
    void                append(SoDetail *detail)
        { SbPList::append((void *) detail); }
 
    void                insert(SoDetail *detail, int addBefore)
        { SbPList::insert((void *) detail, addBefore); }
 
    void                truncate(int start);
 
    void                copy(const SoDetailList &l);
    SoDetailList &      operator =(const SoDetailList &l)
        { copy(l) ; return *this; }
 
    SoDetail *          operator [](int i) const
        { return ( (SoDetail *) ( (* (const SbPList *) this) [i] ) ); }
 
    void                set(int i, SoDetail *detail);
};
 
 
 
class INVENTOR_API SoPickedPointList : public SbPList {
  public:
    SoPickedPointList()                 : SbPList()     {}
    SoPickedPointList(int size)         : SbPList(size) {}
    SoPickedPointList(const SoPickedPointList &l);
    ~SoPickedPointList()                                { truncate(0); }
 
    void                append(SoPickedPoint *pickedPoint)
        { SbPList::append((void *) pickedPoint); }
 
    void                insert(SoPickedPoint *pickedPoint, int addBefore)
        { SbPList::insert((void *) pickedPoint, addBefore); }
 
    void                truncate(int start);
 
    SoPickedPoint *     operator [](int i) const
        { return ( (SoPickedPoint *) ( (* (const SbPList *) this) [i] ) ); }
 
    void                set(int i, SoPickedPoint *pickedPoint);
};
 
 
 
class INVENTOR_API SoFieldList : public SbPList {
  public:
    SoFieldList()                       : SbPList()     {}
    SoFieldList(int size)               : SbPList(size) {}
    SoFieldList(const SoFieldList &l)   : SbPList(l)    {}
    ~SoFieldList()                      { truncate(0); }
 
    void                append(SoField *field)
        { SbPList::append((void *) field); }
 
    void                insert(SoField *field, int addBefore)
        { SbPList::insert((void *) field, addBefore); }
 
    SoField *           operator [](int i) const
        { return ( (SoField *) ( (* (const SbPList *) this) [i] ) ); }
 
    void                set(int i, SoField *Field)
        { (* (const SbPList *) this) [i] = (void *) Field; }
 
  SoINTERNAL public:
    SoField *           get(int i) const
        { return (SoField *)SbPList::get(i); }
};
 
 
 
class INVENTOR_API SoEngineOutputList : public SbPList {
  public:
    SoEngineOutputList()                        : SbPList()     {}
    SoEngineOutputList(int size)                : SbPList(size) {}
    SoEngineOutputList(const SoEngineOutputList &l)     : SbPList(l)    {}
    ~SoEngineOutputList()                       { truncate(0); }
 
    void                append(SoEngineOutput *engineOutput)
        { SbPList::append((void *) engineOutput); }
 
    void                insert(SoEngineOutput *engineOutput, int addBefore)
        { SbPList::insert((void *) engineOutput, addBefore); }
 
    SoEngineOutput *            operator [](int i) const
        { return ( (SoEngineOutput *) ( (* (const SbPList *) this) [i] ) ); }
 
    void                set(int i, SoEngineOutput *engineOutput)
        { (* (const SbPList *) this) [i] = (void *) engineOutput; }
};
 
 
#endif /* _SO_LISTS_ */