sointeractionkit(3)
NAME
SoInteractionKit
SYNOPSIS
#include <Inventor/nodekits/SoInteractionKit.h> Inherits SoBaseKit. Inherited by SoDragger.
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.)
- Public Types
- enum CacheEnabled { OFF, ON, AUTO }
- Public Member Functions
- virtual SoType getTypeId (void) const
virtual const SoNodekitCatalog * getNodekitCatalog (void) const SoInteractionKit (void)
virtual SbBool setPartAsPath (const SbName &partname, SoPath *path) virtual SbBool setPartAsDefault (const SbName &partname, SoNode *node,SbBool onlyifdefault=1) - virtual SbBool setPartAsDefault (const SbName &partname, const SbName
&nodename, SbBool onlyifdefault=1)
- SbBool isPathSurrogateInMySubgraph (const SoPath *path, SoPath
*&pathToOwner, SbName &surrogatename, SoPath *&surrogatepath, SbBool fillargs=1)
- SbBool isPathSurrogateInMySubgraph (const SoPath *path) virtual SbBool setPart (const SbName &partname, SoNode *from)
- Static Public Member Functions
- static SoType getClassTypeId (void)
static const SoNodekitCatalog * getClassNodekitCatalog (void)
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 const SoFieldData * getFieldData (void) const
virtual ~SoInteractionKit ()
virtual void copyContents (const SoFieldContainer *fromFC, SbBoolcopyConnections) - 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=1, SbBool onlyifdefault=1)
- virtual SbBool setAnyPartAsDefault (const SbName &partname, const
SbName &nodename, SbBool anypart=1, SbBool onlyifdefault=1)
- SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool
leafcheck=0, SbBool publiccheck=0)
- virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=0) virtual void setDefaultOnNonWritingFields () void connectSeparatorFields (SoSeparator *dest, SbBool onOff)
- Static Protected Member Functions
- static const SoFieldData ** getFieldDataPtr (void)
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
static void readDefaultParts (const char *fileName, const char
defaultBuffer[], int defBufSize)
- static void fieldSensorCB (void *, SoSensor *)
- Protected Attributes
- SoSFNode geomSeparator
SoSFNode topSeparator
SoFieldSensor * fieldSensor SoSeparator * oldTopSep - Friends
- class SoInteractionKitP
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
- SoType SoInteractionKit::getClassTypeId (void) [static]
- This static method returns the SoType object associated with objects of this class.
- 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.
- Referenced by setAnySurrogatePath().
- SoType SoInteractionKit::getTypeId (void) const [virtual]
- Returns the type identification of an object derived from a class
inheriting SoBase. This is used for run-time type checking and 'downward' casting. - Usage example:
void foo(SoNode * node)
{if (node->getTypeId() == SoFile::getClassTypeId()) {SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type}
else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {SoGroup * group = (SoGroup *)node; // safe downward cast, knows the type}} - For application programmers wanting to extend the library with new
nodes, engines, nodekits, draggers or others: this method needs to be
overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually
accomplished by using the pre-defined macros available through for
instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and
SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. - For more information on writing Coin extensions, see the class
documentation of the toplevel superclasses for the various class
groups. - 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.
- const SoFieldData ** SoInteractionKit::getFieldDataPtr (void) [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 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.
- const SoFieldData * SoInteractionKit::getFieldData (void) const [protected,
- virtual]
Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. - 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.
- const SoNodekitCatalog * SoInteractionKit::getClassNodekitCatalog (void)
- [static]
Returns the nodekit catalog which defines the layout of this class'
kit. - 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.
- const SoNodekitCatalog * SoInteractionKit::getNodekitCatalog (void) const
- [virtual]
Returns the nodekit catalog which defines the layout of this class'
kit. - 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.
- const SoNodekitCatalog ** SoInteractionKit::getClassNodekitCatalogPtr
- (void) [static, protected]
Returns the pointer to the pointer of the nodekit catalog for this
class. - 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.
- 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.
- Referenced by SoInteraction::init().
- 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, SbBool onlyifdefault = 1) [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. - References setAnyPartAsDefault().
- Referenced by SoCenterballDragger::setUpConnections(), and
SoTranslate2Dragger::SoTranslate2Dragger(). - SbBool SoInteractionKit::setPartAsDefault (const SbName & partname, const
- SbName & nodename, SbBool onlyifdefault = 1) [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,
SbBool fillargs = 1)
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 int newVal)
- [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. - Referenced by SoDragPointDragger::dragStart(),
SoHandleBoxDragger::setAllPartsActive(), and
SoTranslate2Dragger::SoTranslate2Dragger(). - SbBool SoInteractionKit::setPart (const SbName & partname, SoNode * from)
- [virtual]
Sets the catalog part given by partname to the from node pointer. - Reimplemented from SoBaseKit.
- Referenced by SoSpotLightManip::fieldSensorCB(),
SoPointLightManip::fieldSensorCB(), and
SoDirectionalLightManip::fieldSensorCB(). - void SoInteractionKit::copyContents (const SoFieldContainer * from, SbBool
- copyconnections) [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.
- Referenced by SoRotateSphericalDragger::getProjector(), and
SoRotateCylindricalDragger::getProjector(). - SbBool SoInteractionKit::setPart (const int partnum, 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 short flags)
- [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.
- References SoBaseKit::getAnyPart(), SoNode::getChildren(),
SoSeparator::getClassTypeId(), SoGroup::getClassTypeId(),
SbPList::getLength(), and SoBase::getTypeId(). - void SoInteractionKit::readDefaultParts (const char * fileName, const char
- defaultBuffer[], int defBufSize) [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. - Referenced by SoTranslate2Dragger::SoTranslate2Dragger().
- SbBool SoInteractionKit::setAnyPartAsDefault (const SbName & partname,
- SoNode * node, SbBool anypart = 1, SbBool onlyifdefault = 1)
[protected, virtual]
Protected version of setPartAsDefault(), to make it possible to set non-leaf and private parts (if anypart is TRUE). - See also:
setPartAsDefault()
- References SoBaseKit::getCatalogInstances(), SoField::isDefault(),
SoDebugError::postInfo(), SoField::setDefault(), and
SoBaseKit::setPart(). - Referenced by setAnyPartAsDefault(), and setPartAsDefault().
- SbBool SoInteractionKit::setAnyPartAsDefault (const SbName & partname,
- const SbName & nodename, SbBool anypart = 1, SbBool onlyifdefault = 1)
[protected, virtual]
Protected version of setPartAsDefault(), to make it possible to set non-leaf and private parts (if anypart is TRUE). - See also:
setPartAsDefault()
- References setAnyPartAsDefault().
- SbBool SoInteractionKit::setAnySurrogatePath (const SbName & partname,
- SoPath * path, SbBool leafcheck = 0, SbBool publiccheck = 0)
[protected]
Protected version of setPartAsPath(), to make it possible to set nonleaf and private parts. - ('The nice thing about C++ is that only your friends can handle your
private parts.') - See also:
setPartAsPath()
- References SoType::createInstance(), SoGroup::findChild(),
SoBaseKit::getCatalogInstances(), SoSeparator::getClassTypeId(),
SoGroup::getClassTypeId(), SoSwitch::getClassTypeId(),
getClassTypeId(), SoBase::getName(), SoBaseKit::getNodekitCatalog(),
SbName::getString(), SoBase::getTypeId(), SoSFInt32::getValue(),
SoBase::isOfType(), SoDebugError::postInfo(), SoBaseKit::setPart(),
SoSFInt32::setValue(), and SoSwitch::whichChild. - SbBool SoInteractionKit::setUpConnections (SbBool onoff, SbBool doitalways
- = 0) [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.
- Referenced by SoTranslate2Dragger::setUpConnections(),
SoTranslate1Dragger::setUpConnections(),
SoScaleUniformDragger::setUpConnections(),
SoScale2UniformDragger::setUpConnections(),
SoScale2Dragger::setUpConnections(),
SoScale1Dragger::setUpConnections(),
SoRotateSphericalDragger::setUpConnections(),
SoRotateDiscDragger::setUpConnections(),
SoRotateCylindricalDragger::setUpConnections(),
SoCenterballDragger::setUpConnections(),
SoDirectionalLightDragger::~SoDirectionalLightDragger(),
SoDragPointDragger::~SoDragPointDragger(),
SoJackDragger::~SoJackDragger(), and
SoPointLightDragger::~SoPointLightDragger(). - 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, SbBool
onOff) [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.