Coin Logo http://www.sim.no
http://www.coin3d.org

SoInteractionKit.h
1 #ifndef COIN_SOINTERACTIONKIT_H
2 #define COIN_SOINTERACTIONKIT_H
3 
4 /**************************************************************************\
5  *
6  * This file is part of the Coin 3D visualization library.
7  * Copyright (C) 1998-2007 by Systems in Motion. All rights reserved.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * ("GPL") version 2 as published by the Free Software Foundation.
12  * See the file LICENSE.GPL at the root directory of this source
13  * distribution for additional information about the GNU GPL.
14  *
15  * For using Coin with software that can not be combined with the GNU
16  * GPL, and for taking advantage of the additional benefits of our
17  * support services, please contact Systems in Motion about acquiring
18  * a Coin Professional Edition License.
19  *
20  * See http://www.coin3d.org/ for more information.
21  *
22  * Systems in Motion, Postboks 1283, Pirsenteret, 7462 Trondheim, NORWAY.
23  * http://www.sim.no/ sales@sim.no coin-support@coin3d.org
24  *
25 \**************************************************************************/
26 
27 #include <Inventor/nodekits/SoSubKit.h>
28 #include <Inventor/nodekits/SoBaseKit.h>
29 #include <Inventor/fields/SoSFEnum.h>
30 
31 #ifdef COIN_INTERNAL
32 class SoFieldSensor;
33 #else // !COIN_INTERNAL
34 // Include this header file for better Open Inventor compatibility.
35 #include <Inventor/sensors/SoFieldSensor.h>
36 #endif // !COIN_INTERNAL
37 
38 class SoSensor;
39 class SoSeparator;
40 
41 class COIN_DLL_API SoInteractionKit : public SoBaseKit {
42  typedef SoBaseKit inherited;
43 
44  SO_KIT_HEADER(SoInteractionKit);
45 
46  SO_KIT_CATALOG_ENTRY_HEADER(geomSeparator);
47  SO_KIT_CATALOG_ENTRY_HEADER(topSeparator);
48 
49 public:
54 
55 public:
56  SoInteractionKit(void);
57  static void initClass(void);
58 
59  enum CacheEnabled { OFF, ON, AUTO };
60 
61  virtual SbBool setPartAsPath(const SbName &partname,
62  SoPath *path);
63  virtual SbBool setPartAsDefault(const SbName &partname,
64  SoNode *node,
65  SbBool onlyifdefault = TRUE);
66  virtual SbBool setPartAsDefault(const SbName &partname,
67  const SbName &nodename,
68  SbBool onlyifdefault = TRUE);
69  SbBool isPathSurrogateInMySubgraph(const SoPath *path,
70  SoPath *&pathToOwner,
71  SbName &surrogatename,
72  SoPath *&surrogatepath,
73  SbBool fillargs = TRUE);
74  SbBool isPathSurrogateInMySubgraph(const SoPath *path);
75  static void setSwitchValue(SoNode *node, const int newVal);
76  virtual SbBool setPart(const SbName & partname, SoNode * from);
77 
78 protected:
79  virtual ~SoInteractionKit();
80  virtual void copyContents(const SoFieldContainer *fromFC,
81  SbBool copyConnections);
82 
83  virtual SbBool setPart(const int partNum, SoNode *node);
84  virtual SbBool readInstance(SoInput *in, unsigned short flags);
85  static void readDefaultParts(const char *fileName,
86  const char defaultBuffer[],
87  int defBufSize);
88  virtual SbBool setAnyPartAsDefault(const SbName &partname,
89  SoNode *node,
90  SbBool anypart = TRUE,
91  SbBool onlyifdefault = TRUE);
92  virtual SbBool setAnyPartAsDefault(const SbName &partname,
93  const SbName &nodename,
94  SbBool anypart = TRUE,
95  SbBool onlyifdefault = TRUE);
96  SbBool setAnySurrogatePath(const SbName &name,
97  SoPath *path,
98  SbBool leafcheck = FALSE,
99  SbBool publiccheck = FALSE);
100  virtual SbBool setUpConnections(SbBool onoff, SbBool doitalways = FALSE);
101  virtual void setDefaultOnNonWritingFields();
102 
104  static void fieldSensorCB(void *, SoSensor *);
106 
107  void connectSeparatorFields( SoSeparator *dest, SbBool onOff );
108 
109 private:
110  class SoInteractionKitP * pimpl;
111  friend class SoInteractionKitP;
112 };
113 
114 #endif // !COIN_SOINTERACTIONKIT_H
SbPList::getLength
int getLength(void) const
Definition: SbPList.h:94
SoBaseKit::copyContents
virtual void copyContents(const SoFieldContainer *fromfc, SbBool copyconnections)
Definition: SoBaseKit.cpp:1593
SoNodekitCatalog
The SoNodekitCatalog class is a container for nodekit layouts.
Definition: SoNodekitCatalog.h:36
SoSearchAction::setType
void setType(const SoType type, const SbBool chkderived=1)
Definition: SoSearchAction.cpp:175
SoBase::getNamedBase
static SoBase * getNamedBase(const SbName &name, SoType type)
Definition: SoBase.cpp:1072
SoInput::openFile
virtual SbBool openFile(const char *fileName, SbBool okIfNotFound=0)
Definition: SoInput.cpp:787
SoInteractionKit::copyContents
virtual void copyContents(const SoFieldContainer *fromFC, SbBool copyConnections)
Definition: SoInteractionKit.cpp:370
SbName
The SbName class stores strings by reference.
Definition: SbName.h:31
SoAction::apply
virtual void apply(SoNode *root)
Definition: SoAction.cpp:476
SoSeparator::renderCulling
SoSFEnum renderCulling
Definition: SoSeparator.h:50
SoBaseKit::setDefaultOnNonWritingFields
virtual void setDefaultOnNonWritingFields(void)
Definition: SoBaseKit.cpp:1277
SoSearchAction::setFind
void setFind(const int what)
Definition: SoSearchAction.cpp:230
SoInteractionKit::SoInteractionKit
SoInteractionKit(void)
Definition: SoInteractionKit.cpp:192
SoNodekitCatalog::getName
const SbName & getName(int part) const
Definition: SoNodekitCatalog.cpp:110
SoBaseKit::getAnyPart
virtual SoNode * getAnyPart(const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0)
Definition: SoBaseKit.cpp:1722
SoDebugError::post
static void post(const char *const source, const char *const format,...)
Definition: SoDebugError.cpp:314
SoSensor
The SoSensor class is the abstract base class for all sensors.
Definition: SoSensor.h:34
SoField::isDefault
SbBool isDefault(void) const
Definition: SoField.cpp:669
SoBaseKit::setUpConnections
virtual SbBool setUpConnections(SbBool onoff, SbBool doitalways=0)
Definition: SoBaseKit.cpp:2071
SoBase::getName
virtual SbName getName(void) const
Definition: SoBase.cpp:730
SoNodekitCatalog::getParentPartNumber
int getParentPartNumber(int part) const
Definition: SoNodekitCatalog.cpp:252
SoSearchAction
The SoSearchAction class provides methods for searching through scene graphs.
Definition: SoSearchAction.h:32
SoDebugError::postWarning
static void postWarning(const char *const source, const char *const format,...)
Definition: SoDebugError.cpp:324
SoSwitch
The SoSwitch class is a group node which selects one child subgraph for traversal.
Definition: SoSwitch.h:37
SoText2
The SoText2 class is a node type for visualizing 2D text aligned with the camera plane.
Definition: SoText2.h:33
SoInteractionKit::setSwitchValue
static void setSwitchValue(SoNode *node, const int newVal)
Definition: SoInteractionKit.cpp:358
SoInput::setBuffer
virtual void setBuffer(void *bufpointer, size_t bufsize)
Definition: SoInput.cpp:1025
SoSwitch::whichChild
SoSFInt32 whichChild
Definition: SoSwitch.h:47
SoInteractionKit::getNodekitCatalog
virtual const SoNodekitCatalog * getNodekitCatalog(void) const
Definition: SoInteractionKit.cpp:186
SoPathList
The SoPathList class is a container for pointers to SoPath objects.
Definition: SoPathList.h:31
SbList::append
void append(const Type item)
Definition: SbList.h:98
SbString
The SbString class is a string class with convenience functions for string operations.
Definition: SbString.h:42
SoPath::containsPath
SbBool containsPath(const SoPath *const path) const
Definition: SoPath.cpp:611
SoInteractionKit::readDefaultParts
static void readDefaultParts(const char *fileName, const char defaultBuffer[], int defBufSize)
Definition: SoInteractionKit.cpp:433
SoInteractionKit::setUpConnections
virtual SbBool setUpConnections(SbBool onoff, SbBool doitalways=0)
Definition: SoInteractionKit.cpp:648
SoInteractionKit::~SoInteractionKit
virtual ~SoInteractionKit()
Definition: SoInteractionKit.cpp:229
SoInteractionKit::isPathSurrogateInMySubgraph
SbBool isPathSurrogateInMySubgraph(const SoPath *path, SoPath *&pathToOwner, SbName &surrogatename, SoPath *&surrogatepath, SbBool fillargs=1)
Definition: SoInteractionKit.cpp:300
SoSeparator::renderCaching
SoSFEnum renderCaching
Definition: SoSeparator.h:48
SoBaseKit::readInstance
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition: SoBaseKit.cpp:2078
SoPath
The SoPath class is a container class for traversal path descriptions.
Definition: SoPath.h:43
SoField::setDefault
void setDefault(SbBool def)
Definition: SoField.cpp:650
SoType
The SoType class is the basis for the run-time type system in Coin.
Definition: SoType.h:50
SoSeparator::boundingBoxCaching
SoSFEnum boundingBoxCaching
Definition: SoSeparator.h:49
SbList< SbName >
SbName::getString
const char * getString(void) const
Definition: SbName.cpp:278
SoDebugError::postInfo
static void postInfo(const char *const source, const char *const format,...)
Definition: SoDebugError.cpp:334
SbList::getLength
int getLength(void) const
Definition: SbList.h:145
SoGroup::findChild
virtual int findChild(const SoNode *node) const
Definition: SoGroup.cpp:447
SoSFEnum
The SoSFEnum class is a container for an enum value.
Definition: SoSFEnum.h:31
SoNodekitCatalog::isLeaf
SbBool isLeaf(int part) const
Definition: SoNodekitCatalog.cpp:199
SoInteractionKit::CacheEnabled
CacheEnabled
Definition: SoInteractionKit.h:59
SoInteractionKit::setPartAsPath
virtual SbBool setPartAsPath(const SbName &partname, SoPath *path)
Definition: SoInteractionKit.cpp:253
SoInteractionKit::connectSeparatorFields
void connectSeparatorFields(SoSeparator *dest, SbBool onOff)
Definition: SoInteractionKit.cpp:734
SoBase
The SoBase class is the top-level superclass for a number of class-hierarchies.
Definition: SoBase.h:41
SoFieldContainer
The SoFieldContainer class is a base class for all classes that contain fields.
Definition: SoFieldContainer.h:35
SoBase::ref
void ref(void) const
Definition: SoBase.cpp:574
SoInteractionKit::boundingBoxCaching
SoSFEnum boundingBoxCaching
Definition: SoInteractionKit.h:51
SoNodekitCatalog::isPublic
SbBool isPublic(int part) const
Definition: SoNodekitCatalog.cpp:406
SoBaseKit::getCatalogInstances
const SbList< SoSFNode * > & getCatalogInstances(void) const
Definition: SoBaseKit.cpp:2045
SoInteractionKit::readInstance
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition: SoInteractionKit.cpp:392
SoType::createInstance
void * createInstance(void) const
Definition: SoType.cpp:803
SoNode::getChildren
virtual SoChildList * getChildren(void) const
Definition: SoNode.cpp:1265
SoBaseKit::connectionsSetUp
SbBool connectionsSetUp
Definition: SoBaseKit.h:142
SoSearchAction::getPaths
SoPathList & getPaths(void)
Definition: SoSearchAction.cpp:331
SoField::isConnectionEnabled
SbBool isConnectionEnabled(void) const
Definition: SoField.cpp:721
SoBase::getTypeId
virtual SoType getTypeId(void) const =0
SoInteractionKit::renderCulling
SoSFEnum renderCulling
Definition: SoInteractionKit.h:52
SoInteractionKit::pickCulling
SoSFEnum pickCulling
Definition: SoInteractionKit.h:53
SoInteractionKit::renderCaching
SoSFEnum renderCaching
Definition: SoInteractionKit.h:50
SoFieldSensor
The SoFieldSensor class detects changes to a field.
Definition: SoFieldSensor.h:29
SoInteractionKit
The SoInteractionKit class is a base class for draggers.
Definition: SoInteractionKit.h:41
SoSFNode
The SoSFNode class is a container for a single node.
Definition: SoSFNode.h:38
SoInteractionKit::setDefaultOnNonWritingFields
virtual void setDefaultOnNonWritingFields()
Definition: SoInteractionKit.cpp:687
SoSeparator
The SoSeparator class is a state-preserving group node.
Definition: SoSeparator.h:34
SoBaseKit::getNodekitCatalog
virtual const SoNodekitCatalog * getNodekitCatalog(void) const
Definition: SoBaseKit.cpp:573
SoDB::readAll
static SoSeparator * readAll(SoInput *in)
Definition: SoDB.cpp:1048
SoInput
The SoInput class is an abstraction of file import functionality.
Definition: SoInput.h:55
SoBaseKit
The SoBaseKit class is the toplevel superclass for nodekits.
Definition: SoBaseKit.h:57
SoBase::isOfType
SbBool isOfType(SoType type) const
Definition: SoBase.cpp:710
SoInteractionKit::oldTopSep
SoSeparator * oldTopSep
Definition: SoInteractionKit.h:105
SoNode
The SoNode class is the base class for nodes used in scene graphs.
Definition: SoNode.h:47
SoBaseList::copy
void copy(const SoBaseList &l)
Definition: SoBaseList.cpp:171
SoField::isConnected
SbBool isConnected(void) const
Definition: SoField.cpp:1139
SoInteractionKit::fieldSensorCB
static void fieldSensorCB(void *, SoSensor *)
Definition: SoInteractionKit.cpp:725
SoField::connectFrom
SbBool connectFrom(SoEngineOutput *master, SbBool notnotify=0, SbBool append=0)
Definition: SoField.cpp:870
SoInteractionKit::setAnyPartAsDefault
virtual SbBool setAnyPartAsDefault(const SbName &partname, SoNode *node, SbBool anypart=1, SbBool onlyifdefault=1)
Definition: SoInteractionKit.cpp:496
SbString::getLength
int getLength(void) const
Definition: SbString.h:63
SoInteractionKit::fieldSensor
SoFieldSensor * fieldSensor
Definition: SoInteractionKit.h:103
SbString::getString
const char * getString(void) const
Definition: SbString.h:71
SoInteractionKit::setPart
virtual SbBool setPart(const SbName &partname, SoNode *from)
Definition: SoInteractionKit.cpp:713
SoBaseKit::setPart
virtual SbBool setPart(const SbName &partname, SoNode *from)
Definition: SoBaseKit.cpp:793
SoSeparator::pickCulling
SoSFEnum pickCulling
Definition: SoSeparator.h:51
SoInteractionKit::setPartAsDefault
virtual SbBool setPartAsDefault(const SbName &partname, SoNode *node, SbBool onlyifdefault=1)
Definition: SoInteractionKit.cpp:271
SoSearchAction::setSearchingAll
void setSearchingAll(const SbBool searchall)
Definition: SoSearchAction.cpp:278
SoInteractionKit::setAnySurrogatePath
SbBool setAnySurrogatePath(const SbName &name, SoPath *path, SbBool leafcheck=0, SbBool publiccheck=0)
Definition: SoInteractionKit.cpp:581

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Wed Jul 24 2019 for Coin by Doxygen. 1.8.17