SoNodekitCatalog.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:
 |      Defines the SoNodekitCatalog class. This class is used to 
 |      describe the subgraphs that make up different classes of 
 |      nodekit.        
 |
 |   Author(s)          : Paul Isaacs, Thad Beier
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
*/
 
#ifndef  _SO_NODEKIT_CATALOG
#define  _SO_NODEKIT_CATALOG
 
#include <Inventor/misc/SoBasic.h>
#include <Inventor/SbString.h>
#include <Inventor/SoLists.h>
#include <Inventor/SoType.h>
 
#define SO_CATALOG_NAME_NOT_FOUND -1
#define SO_CATALOG_THIS_PART_NUM   0
 
SoINTERNAL class INVENTOR_API SoNodekitCatalogEntry {
    private:
        SbName     name;                
        SoType     type;                
        SoType     defaultType;         
        bool       nullByDefault;       
        bool       leafPart;            
        SbName     parentName;          
        SbName     rightSiblingName;    
        bool       listPart;            
        SoType     listContainerType;   
        SoTypeList listItemTypes;       
        bool       publicPart;          
    SoINTERNAL public:
        SoNodekitCatalogEntry(const SbName &theName, 
                    SoType theType, SoType theDefaultType, 
                    bool theNullByDefault,
                    const SbName &theParentName, const SbName &theRightSiblingName, 
                    bool theListPart, SoType theListContainerType,
                    const SoTypeList &theListItemTypes,
                    bool thePublicPart);
 
        SoNodekitCatalogEntry *clone() const;           
        SoNodekitCatalogEntry *clone( SoType newType,
                                      SoType newDefaultType ) const; 
 
        const SbName  &getName() const { return name; };
              SoType  getType() const { return type; };
              SoType  getDefaultType() const { return defaultType; };
              bool    isNullByDefault() const { return nullByDefault; };
              bool    isLeaf() const { return leafPart; };
        const SbName  &getParentName() const { return parentName; };
        const SbName  &getRightSiblingName() const { return rightSiblingName; };
              bool    isList() const { return listPart; };
              SoType  getListContainerType() const {return listContainerType;};
        const SoTypeList &getListItemTypes() const { return listItemTypes; };
              bool    isPublic() const { return publicPart; };
 
        void addListItemType( SoType typeToAdd );
 
        void setNullByDefault( bool newNullByDefault ) 
                { nullByDefault = newNullByDefault; }
        void setPublic( bool newPublic ) { publicPart = newPublic; }
        void setLeaf( bool newLeafPart ) { leafPart = newLeafPart; }
        void setRightSiblingName( const SbName &newN ) { rightSiblingName = newN; }
        void setTypes( SoType newType, SoType newDefaultType )
                            { type = newType; defaultType = newDefaultType; }
 
        bool recursiveSearch( const SbName &nameToFind, 
                                SoTypeList *typesChecked) const;
 
        void printCheck() const; 
};
 
 
 
 
class INVENTOR_API SoNodekitCatalog {
 
  public:
 
    static void initClass();
 
    int        getNumEntries() const { return numEntries; };
 
          int        getPartNumber(      const SbName &theName ) const;
    const SbName     &getName(                 int    thePartNumber ) const;
          SoType     getType(                  int    thePartNumber ) const;
          SoType     getType(            const SbName &theName ) const;
          SoType     getDefaultType(           int    thePartNumber ) const;
          SoType     getDefaultType(     const SbName &theName ) const;
          bool       isNullByDefault(          int    thePartNumber ) const;
          bool       isNullByDefault(            const SbName &theName ) const;
          bool       isLeaf(                   int    thePartNumber ) const;
          bool       isLeaf(             const SbName &theName ) const;
    const SbName     &getParentName(           int    thePartNumber ) const;
    const SbName     &getParentName(     const SbName &theName ) const;
          int        getParentPartNumber(      int    thePartNumber ) const;
          int        getParentPartNumber(const SbName &theName ) const;
    const SbName     &getRightSiblingName(      int    thePartNumber ) const;
    const SbName     &getRightSiblingName(const SbName &theName ) const;
          int        getRightSiblingPartNumber(      int thePartNumber ) const;
          int        getRightSiblingPartNumber(const SbName &theName ) const;
          bool       isList(                   int    thePartNumber ) const;
          bool       isList(             const SbName &theName ) const;
          SoType     getListContainerType(       int    thePartNumber ) const;
          SoType     getListContainerType( const SbName &theName ) const;
    const SoTypeList    &getListItemTypes(       int    thePartNumber ) const;
    const SoTypeList    &getListItemTypes( const SbName &theName ) const;
          bool       isPublic(                 int    thePartNumber ) const;
          bool       isPublic(           const SbName &theName ) const;
 
  SoEXTENDER public:
 
    SoNodekitCatalog();
 
    ~SoNodekitCatalog();
 
    SoNodekitCatalog *clone( SoType typeOfThis ) const;
 
    bool addEntry(const SbName &theName, 
                          SoType theType, SoType theDefaultType,
                          bool    theNullByDefault,
                    const SbName &theParentName, 
                    const SbName &theRightSiblingName, bool theListPart, 
                          SoType theListContainerType,
                          SoType theListItemType,
                          bool thePublicPart);
 
    void addListItemType(int thePartNumber, SoType typeToAdd);
    void addListItemType(const SbName &theName,   SoType typeToAdd);
 
    void narrowTypes( const SbName &theName, SoType newType, 
                      SoType newDefaultType );
 
    void setNullByDefault( const SbName &theName, bool newNullByDefault );
 
  SoINTERNAL public:
    bool recursiveSearch( int partNumber, const SbName &nameToFind, 
                            SoTypeList *typesChecked) const;
 
    void printCheck() const; 
 
  private:
 
    static const SbName  *emptyName;
    static const SoTypeList *emptyList;
    static SoType  *badType;
 
    int                   numEntries;   
    SoNodekitCatalogEntry **entries;    
    SbDict                partNameDict; 
 
    bool      checkName( const SbName &theName );
    bool      checkNewName( const SbName &theName );
    bool      checkNewTypes( SoType theType, 
                             SoType theDefaultType );
    bool      checkAndGetParent(    const SbName &theName, 
                                    const SbName &theParentName, 
                                    SoNodekitCatalogEntry *& parentEntry );
    bool      checkAndGetSiblings(  const SbName &theParentName, 
                                    const SbName &theRightSiblingName, 
                                    SoNodekitCatalogEntry *& leftEntry,
                                    SoNodekitCatalogEntry *& rightEntry );
    bool      checkCanTypesBeList(  SoType theType,
                                    SoType theDefaultType,
                                    SoType theListContainerType );
 
};
 
#endif  /* _SO_NODEKIT_CATALOG */