SoBaseKit.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 SoBaseKit class. A base class for all
 |      of the SoNodeKit classes
 |
 |   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_BASE_KIT_
#define  _SO_BASE_KIT_
 
#include <Inventor/misc/SoChildList.h>
#include <Inventor/fields/SoFieldData.h>
#include <Inventor/nodes/SoSubNode.h>
#include <Inventor/fields/SoSFName.h>
#include <Inventor/nodes/SoNode.h>
#include <Inventor/nodekits/SoNodekitParts.h>
#include <Inventor/nodekits/SoSubKit.h>
#include <Inventor/SoNodeKitPath.h>
 
class SoSeparator;
class SbBox3f;
class SbDict;
class SoGroup;
 
 
 
 
class INVENTOR_API SoBaseKit : public SoNode {
 
    SO_NODE_HEADER(SoBaseKit);
 
  private:
    static SoNodekitCatalog *nodekitCatalog; /* design of this class */
    static const SoNodekitCatalog **parentNodekitCatalogPtr; /* parent design */
  public:
    static const SoNodekitCatalog *getClassNodekitCatalog()
        { return nodekitCatalog; }
 
    /* Returns an SoNodekitCatalog for the node */
    virtual const SoNodekitCatalog *getNodekitCatalog() const;
 
  protected:
    static const SoNodekitCatalog **getClassNodekitCatalogPtr()
        { return (const SoNodekitCatalog **)&nodekitCatalog; }
 
    SO_KIT_CATALOG_ENTRY_HEADER(callbackList);
 
  public:
 
    SoBaseKit();
 
    virtual SoNode *getPart( const SbName &partName, bool makeIfNeeded );
 
    SbString getPartString( const SoBase *part );
 
    virtual SoNodeKitPath *createPathToPart( const SbName &partName, 
                    bool makeIfNeeded, const SoPath *pathToExtend = NULL );
 
    virtual bool setPart( const SbName &partName, SoNode *from );
 
    bool set(char *nameValuePairListString);
    bool set(char *partNameString, char *parameterString);
 
    static bool isSearchingChildren() { return searchingChildren; }
    static void   setSearchingChildren( bool newVal );
 
  SoEXTENDER public:
    virtual void doAction( SoAction *action );
    virtual void callback( SoCallbackAction *action );
    virtual void GLRender( SoGLRenderAction *action );
    virtual void getBoundingBox( SoGetBoundingBoxAction *action );
    virtual void getMatrix(SoGetMatrixAction *action );
    virtual void handleEvent( SoHandleEventAction *action );
    virtual void rayPick( SoRayPickAction *action );
    virtual void search( SoSearchAction *action );
    virtual void write( SoWriteAction *action );
 
  SoINTERNAL public:
    static void initClass();
 
    virtual SoChildList *getChildren() const;
 
    static SoNode *typeCheck( const SbName &partName, const SoType &partType, 
                              SoNode *node );
 
    void printDiagram();
    void printSubDiagram( const SbName &rootName, int level );
    void printTable();
 
    virtual void        addWriteReference(SoOutput *out,
                                          bool isFromField = FALSE);
 
    friend class SoNodekitCatalogEntry;
    friend class SoNodekitParts;
    friend class SoV1BaseKit;
 
    bool forceChildDrivenWriteRefs( SoOutput *out );
 
  protected:
 
    SoChildList *children;
 
    virtual SoNode *    addToCopyDict() const;
 
    virtual void        copyContents(const SoFieldContainer *fromFC,
                                     bool copyConnections);
 
    SoGroup *getContainerNode( const SbName &listName,
                               bool makeIfNeeded = TRUE );
 
    virtual SoNode *getAnyPart( const SbName &partName, bool makeIfNeeded, 
                        bool leafCheck = FALSE, bool publicCheck = FALSE );
    virtual SoNodeKitPath *createPathToAnyPart(const SbName &partName, 
                    bool makeIfNeeded, 
                    bool leafCheck = FALSE, bool publicCheck = FALSE,
                   const SoPath *pathToExtend = NULL );
    virtual bool setAnyPart( const SbName &partName, SoNode *from, 
                       bool anyPart = TRUE );
 
    SoNodekitParts      *nodekitPartsList;
 
    void createNodekitPartsList();
    virtual void createDefaultParts();
 
    const SoNodekitParts *getNodekitPartsList() const 
                            { return nodekitPartsList; };
 
    void catalogError();
 
    virtual bool setUpConnections( bool onOff, bool doItAlways = FALSE );
    bool connectionsSetUp;
 
    virtual bool readInstance(SoInput *in, unsigned short flags);
    
    virtual void setDefaultOnNonWritingFields();
 
    void countMyFields(SoOutput *out);
 
    virtual ~SoBaseKit();
 
  private:
    void skipWhiteSpace(char *&string);
 
    bool isNodeFieldValuesImportant( SoNode *n );
 
    void createFieldDataForWriting();
    SoFieldData *fieldDataForWriting;
 
    bool readMyFields(SoInput *in, SoFieldData *&unknownFieldData );
 
    void undoSetDefaultOnFieldsThatMustWrite();
 
    int  getNumChildren() const { return (children->getLength()); }
    void removeChild( int index );
    void removeChild( SoNode *child  ) { removeChild(findChild(child)); }
    void addChild( SoNode *child );
    int  findChild( const SoNode *child ) const;
    void insertChild( SoNode *child, int newChildIndex );
    SoNode *getChild( int index) const { return (*children)[index]; }
    void replaceChild( int index, SoNode *newChild);
    void replaceChild( SoNode *oldChild, SoNode *newChild)
        { replaceChild(findChild(oldChild),newChild); }
 
    static bool searchingChildren;
};
 
 
 
#ifdef DEBUG
#define SO_GET_PART( kitContainingPart, partName, partClassName )              \
        ((partClassName *) SoBaseKit::typeCheck( partName,                     \
                               partClassName::getClassTypeId(),               \
                               kitContainingPart->getPart( partName, TRUE )))
 
#define SO_CHECK_PART( kitContainingPart, partName, partClassName )            \
        ((partClassName *) SoBaseKit::typeCheck( partName,                    \
                               partClassName::getClassTypeId(),               \
                               kitContainingPart->getPart( partName, FALSE )))
 
#define SO_GET_ANY_PART( kitContainingPart, partName, partClassName )         \
        ((partClassName *) SoBaseKit::typeCheck( partName,                    \
                partClassName::getClassTypeId(),                              \
                kitContainingPart->getAnyPart( partName, TRUE, FALSE, FALSE )))
 
#define SO_CHECK_ANY_PART( kitContainingPart, partName, partClassName )       \
        ((partClassName *) SoBaseKit::typeCheck( partName,                    \
                partClassName::getClassTypeId(),                              \
                kitContainingPart->getAnyPart( partName, FALSE, FALSE, FALSE )))
#else
 
#define SO_GET_PART( kitContainingPart, partName, partClassName )             \
        ((partClassName *) kitContainingPart->getPart( partName, TRUE ))
#define SO_CHECK_PART( kitContainingPart, partName, partClassName )           \
        ((partClassName *) kitContainingPart->getPart( partName, FALSE ))
#define SO_GET_ANY_PART( kitContainingPart, partName, partClassName )        \
        ((partClassName *) kitContainingPart->getAnyPart( partName, TRUE,    \
                                                          FALSE, FALSE ))
#define SO_CHECK_ANY_PART( kitContainingPart, partName, partClassName )      \
        ((partClassName *) kitContainingPart->getAnyPart( partName, FALSE,   \
                                                          FALSE, FALSE ))
#endif
 
#endif  /* _SO_BASE_KIT_ */