Provided by: libcoin60-doc_3.1.3-2_all bug

NAME

       SoInteractionKit -

       The SoInteractionKit class is a base class for draggers.

       This nodekit class makes it possible to set surrogate paths for parts. Instead of creating
       new geometry for the dragger, it is possible to specify an existing path in your scene to
       be used for interaction. All picks on this path will be handled by the dragger.

SYNOPSIS

       #include <Inventor/nodekits/SoInteractionKit.h>

       Inherits SoBaseKit.

       Inherited by SoDragger.

   Public Types
       enum CacheEnabled { OFF, ON, AUTO }

   Public Member Functions
       SoInteractionKit (void)
       virtual SbBool setPartAsPath (const SbName &partname, SoPath *path)
       virtual SbBool setPartAsDefault (const SbName &partname, SoNode *node, SbBool
           onlyifdefault=TRUE)
       virtual SbBool setPartAsDefault (const SbName &partname, const SbName &nodename, SbBool
           onlyifdefault=TRUE)
       SbBool isPathSurrogateInMySubgraph (const SoPath *path, SoPath *&pathToOwner, SbName
           &surrogatename, SoPath *&surrogatepath, SbBool fillargs=TRUE)
       SbBool isPathSurrogateInMySubgraph (const SoPath *path)
       virtual SbBool setPart (const SbName &partname, SoNode *from)

   Static Public Member Functions
       static void initClass (void)
       static void setSwitchValue (SoNode *node, const int newVal)

   Public Attributes
       SoSFEnum renderCaching
       SoSFEnum boundingBoxCaching
       SoSFEnum renderCulling
       SoSFEnum pickCulling

   Protected Member Functions
       virtual ~SoInteractionKit ()
       virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections)
       virtual SbBool setPart (const int partNum, SoNode *node)
       virtual SbBool readInstance (SoInput *in, unsigned short flags)
       virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool
           anypart=TRUE, SbBool onlyifdefault=TRUE)
       virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool
           anypart=TRUE, SbBool onlyifdefault=TRUE)
       SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE,
           SbBool publiccheck=FALSE)
       virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
       virtual void setDefaultOnNonWritingFields ()
       void connectSeparatorFields (SoSeparator *dest, SbBool onOff)

   Static Protected Member Functions
       static void readDefaultParts (const char *fileName, const char defaultBuffer[], int
           defBufSize)
       static void fieldSensorCB (void *, SoSensor *)

   Protected Attributes
       SoFieldSensor * fieldSensor
       SoSeparator * oldTopSep

Detailed Description

       The SoInteractionKit class is a base class for draggers.

       This nodekit class makes it possible to set surrogate paths for parts. Instead of creating
       new geometry for the dragger, it is possible to specify an existing path in your scene to
       be used for interaction. All picks on this path will be handled by the dragger.

       The SoInteractionKit is primarily an internal class used as a superclass for the dragger
       classes, and it is unlikely that it should be of interest to application programmers,
       unless you have very special needs in your application.

       Node kit structure (new entries versus parent class marked with arrow prefix):

         CLASS SoInteractionKit
         -->"this"
               "callbackList"
         -->   "topSeparator"
         -->      "geomSeparator"
         .fi

       (See SoBaseKit::printDiagram() for information about the output formatting.)

       Detailed information on catalog parts:

         CLASS SoInteractionKit
         PVT   "this",  SoInteractionKit  ---
               "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
         PVT   "topSeparator",  SoSeparator  ---
         PVT   "geomSeparator",  SoSeparator  ---
         .fi

       (See SoBaseKit::printTable() for information about the output formatting.)

Member Enumeration Documentation

   enum SoInteractionKit::CacheEnabled Enumeration of valid values for the cache control fields
       SoInteractionKit::renderCaching, SoInteractionKit::boundingBoxCaching,
       SoInteractionKit::renderCulling and SoInteractionKit::pickCulling.
       The same values with the same semantics are present in this enum as for
       SoSeparator::CacheEnabled, so see that documentation.

Constructor & Destructor Documentation

   SoInteractionKit::SoInteractionKit (void) Constructor.
   SoInteractionKit::~SoInteractionKit () [protected, virtual] Destructor.

Member Function Documentation

   void SoInteractionKit::initClass (void) [static] Sets up initialization for data common to all
       instances of this class, like submitting necessary information to the Coin type system.
       Reimplemented from SoBaseKit.

       Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger,
       SoDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger,
       SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger,
       SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger,
       SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger,
       SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, and SoTranslate2Dragger.

   SbBool SoInteractionKit::setPartAsPath (const SbName &partname, SoPath *path) [virtual] Sets a
       part in the kit as a surrogate path. The partname part is set to NULL, and the surrogate
       path is remembered. Following picks on the surrogate path will be regarded as a pick on
       partname.
   SbBool SoInteractionKit::setPartAsDefault (const SbName &partname, SoNode *node,
       SbBoolonlyifdefault = TRUE) [virtual] Sets the value of partname to node, and sets the
       part's field to default (i.e. node will not be written on scene graph export).
       If onlyifdefault is TRUE, partname is only set if it is already in the default state.

       The reason for this method is to make it possible for dragger subclasses to avoid having
       their default parts written out on export.

   SbBool SoInteractionKit::setPartAsDefault (const SbName &partname, const SbName &nodename,
       SbBoolonlyifdefault = TRUE) [virtual] Find node in the global dictionary, and set as
       default.
       See also:
           setPartAsDefault()

   SbBool SoInteractionKit::isPathSurrogateInMySubgraph (const SoPath *path, SoPath
       *&pathToOwner, SbName &surrogatename, SoPath *&surrogatepath, SbBoolfillargs = TRUE)
       Checks if path is contained within any of the surrogate paths in any interaction kits from
       this node down. Returns information about the owner and the surrogate path if found, and
       fillargs is TRUE. The returned path (pathToOwner) is not ref'ed, It's the callers
       responsibility to ref and unref this path.
   SbBool SoInteractionKit::isPathSurrogateInMySubgraph (const SoPath *path) This is an
       overloaded member function, provided for convenience. It differs from the above function
       only in what argument(s) it accepts.
   void SoInteractionKit::setSwitchValue (SoNode *node, const intnewVal) [static] Convenience
       method that sets the switch value for a switch node. Checks if node != 0, and only sets
       the switch value if value has changed.
   SbBool SoInteractionKit::setPart (const SbName &partname, SoNode *from) [virtual] Sets the
       catalog part given by partname to the from node pointer.
       Reimplemented from SoBaseKit.

   void SoInteractionKit::copyContents (const SoFieldContainer *from, SbBoolcopyconnections)
       [protected, virtual] Makes a deep copy of all data of from into this instance, except
       external scenegraph references if copyconnections is FALSE.
       This is the protected method that should be overridden by extension node / engine /
       dragger / whatever subclasses which needs to account for internal data that are not
       handled automatically.

       For copying nodes from application code, you should not invoke this function directly, but
       rather call the SoNode::copy() function:

         SoNode * mynewnode = templatenode->copy();

       The same also goes for engines.

       Make sure that when you override the copyContents() method in your extension class that
       you also make it call upwards to it's parent superclass in the inheritance hierarchy, as
       copyContents() in for instance SoNode and SoFieldContainer does important work. It should
       go something like this:

         void
         MyCoinExtensionNode::copyContents(const SoFieldContainer * from,
                                           SbBool copyconnections)
         {
           // let parent superclasses do their thing (copy fields, copy
           // instance name, etc etc)
           SoNode::copyContents(from, copyconnections);

           // [..then copy internal data..]
         }

       Reimplemented from SoBaseKit.

       Reimplemented in SoRotateCylindricalDragger, and SoRotateSphericalDragger.

   SbBool SoInteractionKit::setPart (const intpartnum, SoNode *node) [protected, virtual] Sets
       parts, updates nodekit scene graph, and makes sure graph is valid with respect to right
       siblings and parent. This method is virtual to enable subclasses to detect when a part
       changes value.
       This method is not part of the original SGI Open Inventor API, but is an extension
       specific to Coin.

       Reimplemented from SoBaseKit.

   SbBool SoInteractionKit::readInstance (SoInput *in, unsigned shortflags) [protected, virtual]
       This method is mainly intended for internal use during file import operations.
       It reads a definition of an instance from the input stream in. The input stream state
       points to the start of a serialized / persistant representation of an instance of this
       class type.

       TRUE or FALSE is returned, depending on if the instantiation and configuration of the new
       object of this class type went ok or not. The import process should be robust and handle
       corrupted input streams by returning FALSE.

       flags is used internally during binary import when reading user extension nodes, group
       nodes or engines.

       Reimplemented from SoBaseKit.

   void SoInteractionKit::readDefaultParts (const char *fileName, const chardefaultBuffer[],
       intdefBufSize) [static, protected] Reads default parts for a dragger.
       This method is called from dragger constructors to set up a dragger's nodekit catalog of
       interaction and feedback geometry.

       fileName is the user-changeable resource file in the Inventor file format, while
       defaultBuffer and defBufSize can point to the statically compiled default parts.

       The environment variable SO_DRAGGER_DIR must be set to a valid directory prefix for
       fileName, or no resource file will be loaded (and defaultBuffer will be used instead).

       If both a fileName and a defaultBuffer is provided, the file will be attempted found and
       loaded first, if that fails, the geometry will be attempted read from the buffer.

   SbBool SoInteractionKit::setAnyPartAsDefault (const SbName &partname, SoNode *node,
       SbBoolanypart = TRUE, SbBoolonlyifdefault = TRUE) [protected, virtual] Protected version
       of setPartAsDefault(), to make it possible to set non-leaf and private parts (if anypart
       is TRUE).
       See also:
           setPartAsDefault()

   SbBool SoInteractionKit::setAnyPartAsDefault (const SbName &partname, const SbName &nodename,
       SbBoolanypart = TRUE, SbBoolonlyifdefault = TRUE) [protected, virtual] Protected version
       of setPartAsDefault(), to make it possible to set non-leaf and private parts (if anypart
       is TRUE).
       See also:
           setPartAsDefault()

   SbBool SoInteractionKit::setAnySurrogatePath (const SbName &partname, SoPath *path,
       SbBoolleafcheck = FALSE, SbBoolpubliccheck = FALSE) [protected] Protected version of
       setPartAsPath(), to make it possible to set non-leaf and private parts.
       ('The nice thing about C++ is that only your friends can handle your
         private parts.')

       See also:
           setPartAsPath()

   SbBool SoInteractionKit::setUpConnections (SbBoolonoff, SbBooldoitalways = FALSE) [protected,
       virtual] Sets up all internal connections for instances of this class.
       (This method will usually not be of interest to the application programmer, unless you
       want to extend the library with new custom nodekits or dragger classes. If so, see the
       SoBaseKit class documentation.)

       Reimplemented from SoBaseKit.

       Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger,
       SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger,
       SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger,
       SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger,
       SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger,
       SoTranslate1Dragger, and SoTranslate2Dragger.

   void SoInteractionKit::setDefaultOnNonWritingFields (void) [protected, virtual] (Be aware that
       this method is unlikely to be of interest to the application programmer who does not want
       to extend the library with new custom nodekits or draggers. If you indeed are writing
       extensions, see the information in the SoBaseKit class documentation.)
       This is a virtual method, and the code in it should call SoField::setDefault() with
       argument TRUE on part fields that should not be written upon scenegraph export operations.

       This is typically done when:

       1.  field value is NULL and part is NULL by default
       2.  it is a leaf SoGroup or SoSeparator node with no children
       3.  it is a leaf listpart with no children and an SoGroup or SoSeparator container
       4.  it is a non-leaf part and it's of SoGroup type and all fields are at their default
           values
       Subclasses should usually override this to do additional settings for new member fields.
       From the subclass, do remember to call 'upwards' to your superclass'
       setDefaultOnNonWritingFields() method.
       Reimplemented from SoBaseKit.
       Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger,
       SoDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoSpotLightDragger,
       SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, and
       SoTransformerDragger.
   void SoInteractionKit::fieldSensorCB (void *d, SoSensor *s) [static, protected] This API
       member is considered internal to the library, as it is not likely to be of interest to the
       application programmer.
       Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger,
       SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger,
       SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger,
       SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger,
       SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, and
       SoTranslate2Dragger.
   void SoInteractionKit::connectSeparatorFields (SoSeparator *dest, SbBoolonOff) [protected]
       Obsoleted in Coin.

Member Data Documentation

   SoSFEnum SoInteractionKit::renderCaching Controls the value of the SoSeparator::renderCaching
       field in the SoInteractionKit catalog's topSeparator instance.
       See documentation of SoSeparator::renderCaching.
   SoSFEnum SoInteractionKit::boundingBoxCaching Controls the value of the
       SoSeparator::boundingBoxCaching field in the SoInteractionKit catalog's topSeparator
       instance.
       See documentation of SoSeparator::boundingBoxCaching.
   SoSFEnum SoInteractionKit::renderCulling Controls the value of the SoSeparator::renderCulling
       field in the SoInteractionKit catalog's topSeparator instance.
       See documentation of SoSeparator::renderCulling.
   SoSFEnum SoInteractionKit::pickCulling Controls the value of the SoSeparator::pickCulling
       field in the SoInteractionKit catalog's topSeparator instance.
       See documentation of SoSeparator::pickCulling.
   SoFieldSensor * SoInteractionKit::fieldSensor [protected] Obsoleted in Coin.
       Reimplemented in SoDragPointDragger, SoPointLightDragger, SoRotateCylindricalDragger,
       SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger,
       SoScale2UniformDragger, SoScaleUniformDragger, SoTranslate1Dragger, and
       SoTranslate2Dragger.
   SoFieldSensor * SoInteractionKit::oldTopSep [protected] Obsoleted in Coin.

Author

       Generated automatically by Doxygen for Coin from the source code.