SoInteractionKit.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 defines the base class for all interaction nodekits.
 |
 |   Author(s): Paul Isaacs
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_INTERACTION_KIT_
#define  _SO_INTERACTION_KIT_
 
#include <Inventor/nodes/SoSeparator.h>
#include <Inventor/nodekits/SoBaseKit.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/sensors/SoFieldSensor.h>
#include <Inventor/SoNodeKitPath.h>
 
class SoPath;
class SoPathList;
 


 
class INVENTOR_API SoInteractionKit : public SoBaseKit {
 
    SO_KIT_HEADER(SoInteractionKit);
 
    SO_KIT_CATALOG_ENTRY_HEADER(topSeparator);
    SO_KIT_CATALOG_ENTRY_HEADER(geomSeparator);
 
  public:

    virtual bool    setPartAsPath( const SbName &partName, 
                                   SoPath *surrogatePath );

    virtual bool affectsState() const;

    enum CacheEnabled {
        OFF,                    
        ON,                     
        AUTO                    
    };



    SoSFEnum renderCaching;     

    SoSFEnum boundingBoxCaching;

    SoSFEnum renderCulling;     

    SoSFEnum pickCulling;       

 
  SoEXTENDER public:

    virtual bool setPartAsDefault(const SbName &partName, 
                              SoNode *newNode, bool onlyIfAlready = TRUE );
    virtual bool setPartAsDefault(const SbName &partName, 
                    const SbName &newNodeName, bool onlyIfAlready = TRUE);

    bool isPathSurrogateInMySubgraph(const SoPath *pathToCheck);
    bool isPathSurrogateInMySubgraph(const SoPath *pathToCheck, 
                                       SoPath *&pathToOwner,
                                       SbName  &surrogateNameInOwner,
                                       SoPath *&surrogatePathInOwner,
                                       bool    fillArgs = TRUE );
 
    static void setSwitchValue( SoNode *n, int newVal );
 
  SoINTERNAL public:
    static void         initClass();    
 
  protected:
    SoInteractionKit();
    ~SoInteractionKit();

    virtual void        copyContents(const SoFieldContainer *fromFC,
                                     bool copyConnections);

    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 );

    virtual bool    setAnyPartAsPath( const SbName &partName, 
                                      SoPath *surrogatePath,
                                      bool leafCheck = FALSE, 
                                      bool publicCheck = FALSE );

    virtual bool readInstance(SoInput *in, unsigned short flags);
 
    static void readDefaultParts( const char *fileName,        
                                  const char defaultBuffer[],   
                                    int defBufSize );        

    virtual bool setAnyPartAsDefault(const SbName &partName, 
                       SoNode *newNode, bool anyPart = TRUE, 
                       bool onlyIfAlready = TRUE );
    virtual bool setAnyPartAsDefault(const SbName &partName, 
                       const SbName &newNodeName, bool anyPart = TRUE, 
                       bool onlyIfAlready = TRUE );
 
    bool setAnySurrogatePath( const SbName &inName, SoPath *inPath,
                        bool leafCheck = FALSE, bool publicCheck = FALSE );

    virtual bool setUpConnections( bool onOff, bool doItAlways = FALSE );

    virtual void setDefaultOnNonWritingFields();

    SoFieldSensor *fieldSensor;
    static void fieldSensorCB( void *, SoSensor *);
    SoSeparator *oldTopSep;
 
    void connectSeparatorFields( SoSeparator *dest, bool onOff );
 
  private:
  
    SoPathList    *surrogatePartPathList;
    SbPList       *surrogatePartNameList;
 
    void   setMySurrogatePath( const SbName &name, SoPath *newPath );
    int    indexOfSurrogateInMyList(const SoPath *pathToCheck);

    static SoGroup *readFromFile(const char *fileName);
    static SoGroup *readFromBuffer( const char defaultBuffer[], int defBufSize);
};
 
#endif /* _SO_INTERACTION_KIT_ */