SoInteractionKit.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Paul Isaacs (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2022 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#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: SoInteractionKit
//
// NOTE TO DEVELOPERS:
//     For info about the structure of SoInteractionKit:
//     [1] compile: /usr/share/src/Inventor/samples/ivNodeKitStructure
//     [2] type:    ivNodeKitStructure SoInteractionKit.
//     [3] The program prints a diagram of the scene graph and a table with 
//         information about each part.
//
//  Base class for all draggers.
//

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

  virtual SbBool  setPartAsPath( const SbName &partName, 
                                 SoPath *surrogatePath );
 
  // Override the default behavior of SoNode
  virtual SbBool affectsState() const;

  enum CacheEnabled {
    OFF,
    ON,
    AUTO
  };
 
  // Fields
#if 1             SoDEPRECATED
  SoSFEnum renderCaching;
#endif 

  SoSFEnum boundingBoxCaching;
  SoSFEnum renderCulling;
  SoSFEnum pickCulling;
 
 private:
 
  // Sets the part, then sets the field for that part to default.
  // using partField.setDefault(TRUE).
  // Hence 'newNode' becomes the new default value, and the part 
  // only writes if [a] the part is set to a different node. 
  // [b] values are changes in the fields of newNode.
  // [c] any child below newNode changes.
  //
  // If the flag 'onlyIfAlready' is TRUE, then this will only change values
  // of parts that are already in a default state.
  // 
  // Returns FALSE on failure, TRUE otherwise. 
  // First version sets the part to the given node.
  // Second version looks up resourceName in the global dictionary and sets 
  // the part with the node found.
  virtual SbBool setPartAsDefault(const SbName &partName, 
                                  SoNode *newNode, SbBool onlyIfAlready = TRUE );
  virtual SbBool setPartAsDefault(const SbName &partName, 
                                  const SbName &newNodeName, SbBool onlyIfAlready = TRUE);
 
  // Is the 'inPath' valid as a surrogate path anywhere in this node's
  // subgraph? 
  // Examines the surrogate paths of all InteractionKits from this node down.
  // The first time a surrogate path is found that is contained within 
  // 'inPath', then TRUE is returned.
  // The second version also returns information about the surrogate,
  // only if (fillArgs == TRUE).
  SbBool isPathSurrogateInMySubgraph(const SoPath *pathToCheck);
  SbBool isPathSurrogateInMySubgraph(const SoPath *pathToCheck, 
                                     SoPath *&pathToOwner,
                                     SbName  &surrogateNameInOwner,
                                     SoPath *&surrogatePathInOwner,
                                     SbBool  fillArgs = TRUE );
 
  static void setSwitchValue( SoNode *n, int newVal );
 
 private:
  static void         initClass();    // initialize the class
  static void         exitClass();
 
 private:
  SoInteractionKit();
  ~SoInteractionKit();
 
  // Copies the contents of the given instance into this instance
  // This copies the surrogatePartPathList and the surrogatePartNameList
  virtual void        copyContents(const SoFieldContainer *fromFC,
                                   SbBool copyConnections);
 
  // These are overloaded to set the surrogate path to NULL after completing
  // their work.
  virtual SoNode *getAnyPart( const SbName &partName, SbBool makeIfNeeded,
                              SbBool leafCheck = FALSE, SbBool publicCheck = FALSE );
  virtual SoNodeKitPath *createPathToAnyPart(const SbName &partName,
                                             SbBool makeIfNeeded,
                                             SbBool leafCheck = FALSE, SbBool publicCheck = FALSE,
                                             const SoPath *pathToExtend = NULL );
  virtual SbBool setAnyPart( const SbName &partName, SoNode *from,
                             SbBool anyPart = TRUE );
 
  // This allows you to set any part in the nodekit as a surrogate path.
  // Note: The node corresponding to 'partName' will become empty.
  //       If 'partName' is not a leaf, the subgraph below it will disappear.
  virtual SbBool  setAnyPartAsPath( const SbName &partName, 
                                    SoPath *surrogatePath,
                                    SbBool leafCheck = FALSE, 
                                    SbBool publicCheck = FALSE );
 
  // Reads in from file. Takes care of checking values in 
  // the topSeparator fields and the field of this node.
  virtual SbBool readInstance(SoInput *in, unsigned short flags);
 
  static void readDefaultParts(const SbString& fileName,        // file to read
                               const char defaultBuffer[],   // if no file,
                               int defBufSize);        // read from buffer
 
  // Protected versions of these methods that allow you to set non-leaf
  // and/or private parts.
  virtual SbBool setAnyPartAsDefault(const SbName &partName, 
                                     SoNode *newNode, SbBool anyPart = TRUE, 
                                     SbBool onlyIfAlready = TRUE );
  virtual SbBool setAnyPartAsDefault(const SbName &partName, 
                                     const SbName &newNodeName, SbBool anyPart = TRUE, 
                                     SbBool onlyIfAlready = TRUE );
 
  SbBool setAnySurrogatePath( const SbName &inName, SoPath *inPath,
                              SbBool leafCheck = FALSE, SbBool publicCheck = FALSE );
 
  // detach/attach any sensors, callbacks, and/or field connections.
  // Called by:            start/end of SoBaseKit::readInstance
  // and on new copy by:   start/end of SoBaseKit::copy.
  // Classes that redefine must call setUpConnections(TRUE,TRUE) 
  // at end of constructor.
  // Returns the state of the node when this was called.
  virtual SbBool setUpConnections( SbBool onOff, SbBool doItAlways = FALSE );
 
  // Called by the SoBaseKit::write() method. 
  //
  // InteractionKits don't want to write fields if they have default vals.
  //
  // Calls setDefault(TRUE) on caching fields if default and not 
  // connected.
  //
  // Calls setDefault(TRUE) on the topSeparator. 
  // Calls setDefault(TRUE) on the geomSeparator. 
  // 
  // Calls setDefault(TRUE) on any non-leaf part of type exactly == SoSwitch.
  // Subclasses can override this if they like, since the function is virtual.
  // But interactionKits use non-leaf switches to turn parts on and off, and 
  // this does not need to be written to file.
  //
  // Lastly, calls same method on SoBaseKit.
  //
  // NOTE: Parts which are set to default may still wind up writing to file 
  //       if, for example, they lie on a path.
  virtual void setDefaultOnNonWritingFields();
 
  // This sensor will watch the topSeparator part.  If the part changes to a 
  // new node,  then the fields of the old part will be disconnected and
  // the fields of the new part will be connected.
  // Connections are made from/to the boundingBoxCaching,
  // renderCulling and pickCulling fields. This way, the SoInteractionKit
  // can be treated from the outside just like a regular SoSeparator node.
  // Setting the fields will affect caching and culling, even though the
  // topSeparator takes care of it.
  // oldTopSep keeps track of the part for comparison.
  SoFieldSensor *fieldSensor;
  static void fieldSensorCB( void *, SoSensor *);
  SoSeparator *oldTopSep;
 
  void connectSeparatorFields( SoSeparator *dest, SbBool onOff );
 
 private:
  
  // This list stores all paths that represent surrogate parts.
  // These special parts do not have geometry in the dragger subgraph.
  // Rather, picking one of these paths is regarded as tantamount to 
  // picking a particular part.
  SoPathList    *surrogatePartPathList;
  SbPList       *surrogatePartNameList;
 
  void   setMySurrogatePath( const SbName &name, SoPath *newPath );
  int    indexOfSurrogateInMyList(const SoPath *pathToCheck);
 
  // used to read information by 'readDefaultParts'
  static SoGroup *readFromFile(const SbString& fileName);
  static SoGroup *readFromBuffer(const char defaultBuffer[], int defBufSize);
 
  static SbPList* m_buffStuffList;
  static SbPList* m_fileStuffList;
};
 
#endif /* _SO_INTERACTION_KIT_ */