SoNodekitParts.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 SoNodekitParts class. An instance of this class is
 |      created for each instance of an Nodekit.
 |      Its function is to describe which 'parts' the nodekit has created
 |      from its class' SoNodekitCatalog.
 |      An SoNodekitParts contains a pointer to an SoNodekitCatalog and 
 |      a correlated list of nodes.
 |
 |      If a new part is asked for, this class uses the catalog as a 
 |      guide to create the part.
 |
 |   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_PARTS
#define  _SO_NODEKIT_PARTS
 
#include <Inventor/nodekits/SoNodekitCatalog.h>
 
class SoNodeKitListPart;
class SoBaseKit;
class SoNode;
class SoFullPath;
class SoSFNode;
 
SoEXTENDER class INVENTOR_API SoNodekitParts {
 
  SoEXTENDER public:
 
    SoNodekitParts( SoBaseKit *rootOfKit );
 
    ~SoNodekitParts();
 
    friend class SoBaseKit;
 
  private:
    const SoNodekitCatalog *catalog;   
    int                     numEntries;   
    SoBaseKit               *rootPointer; 
    SoSFNode                **fieldList;  
 
    bool makePart( const int partNum );
    bool replacePart( const int partNum, SoNode *newPartNode );
    void   unregisterDescendants( const int partNum );
 
    SoNode *getPartFromThisCatalog( const int partNum, bool makeIfNeeded,
                                      bool leafCheck, bool publicCheck, 
                                      bool &existedBefore );
    SoFullPath *createPathToPartFromThisCatalog( const int partNum, 
                    bool makeIfNeeded, bool leafCheck, 
                    bool publicCheck,  bool &existedBefore );
    bool setPartFromThisCatalog( const int partNum, 
                                     SoNode *newPartNode,
                                     bool anyPart );
 
    SoNode *getSingleNamePart( const SbName &nameOfPart, bool makeIfNeeded,
                                bool leafCheck, bool publicCheck, 
                                bool &existedBefore );
    SoFullPath *getSingleNamePathToPart( const SbName &nameOfPart, 
                                 bool makeIfNeeded, bool leafCheck, 
                                 bool publicCheck, bool &existedBefore );
    bool setSingleNamePart( const SbName &nameOfPart, SoNode *newPartNode,
                                bool anyPart );
 
    SoNode *getAnyPart( const SbName &nameOfPart, bool makeIfNeeded, 
                        bool leafCheck, bool publicCheck );
    SoNode *getAnyPart( const SbName &nameOfPart, bool makeIfNeeded, 
                        bool leafCheck, bool publicCheck, 
                        bool &existedBefore);
    SoFullPath *createPathToAnyPart( const SbName &nameOfPart, 
                    bool makeIfNeeded, bool leafCheck, bool publicCheck );
    SoFullPath *createPathToAnyPart( const SbName &nameOfPart, 
                    bool makeIfNeeded, bool leafCheck, 
                    bool publicCheck,  bool &existedBefore );
    bool setAnyPart(  const SbName &nameOfPart, SoNode *newPartNode, 
                        bool anyPart);
 
    bool parseListItem( char *parseString, int &index );
 
    bool partIsNonLeafAndMayBeDeleted( int partNum );
 
    bool partFoundCheck( int partNum );
    bool partIsLeafCheck( int partNum );
    bool partIsPublicCheck( int partNum );
    bool verifyPartExistence( int partNum );
 
    SoFullPath *createPathDownTo( const SbName &nameOfPart, SoNode *theNode );
 
    SoFullPath *addPaths( const SoFullPath *pathA, 
                            const SoFullPath *pathB ) const;
};
 
#endif  /* _SO_NODEKIT_PARTS */