SoInteractionProviderNode is the base class for (almost) all interaction nodes in OpenInventor. More...
#include <SoInteractionProviderNode.h>
Public Member Functions | |
| SoInteractionProviderNode () | |
| Default constructor. More... | |
| virtual | ~SoInteractionProviderNode () |
| Destructor. More... | |
| virtual std::string | getID () const |
| Returns the id string for identifying the provider (and its actions) - this is usually the name of the scene node. More... | |
Memory management by reference counting. | |
| virtual void | objRef () |
| Memory management by reference counting; must be implemented in derived classes. More... | |
| virtual void | objUnref () |
 Public Member Functions inherited from SoInteractionOwner | |
| SoInteractionOwner () | |
| Default constructor. More... | |
| virtual | ~SoInteractionOwner () |
| The destructor will destroy all interactions created with this object as owner. More... | |
| virtual std::list< SoInteraction * > | getInteractions (SoState *state) |
| Returns the list of all interactions of this provider. More... | |
| virtual void | pointerPosition (SoState *state, const SoPointerPosition &pos) |
| Same as below, with additional SoState argument. Be defaults simply calls the below version. More... | |
| virtual void | pointerLeftWindow (SoState *state) |
| Same as below, with additional SoState argument. Be defaults simply calls the below version. More... | |
| Public Member Functions inherited from SoInteractionProvider | |
| SoInteractionProvider () | |
| Default constructor. More... | |
| virtual | ~SoInteractionProvider () |
| template<class T > | |
| std::list< T * > | getInteractionsOfType (SoState *state) |
| Returns list of interactions of a specific type: More... | |
| virtual std::list< SoCommandAction * > | getCommandActions (SoState *state) |
| virtual std::list< SoPointingAction * > | getPointingActions (SoState *state) |
| virtual std::list< SoOffsetAction * > | getOffsetActions (SoState *state) |
Static Public Member Functions | |
| static void | initClass () |
| Initializes this class. More... | |
| Static Public Member Functions inherited from SoInteractionProvider | |
| static void | registerInteractionProviderNode (SoType type, GetProviderFunc func) |
| Register a function to obtain a SoInteractionProvider from a SoNode. More... | |
| static SoInteractionProvider * | getInteractionProvider (SoNode *node) |
| Get a SoInteractionProvider from a SoNode if registered, else NULL. More... | |
Public Attributes | |
| SoSFString | instanceName |
| Defines interface field to store the instance name. More... | |
| SoSFString | interactionProviderID |
| This field overrides the instanceName as providerID if specified. More... | |
Additional Inherited Members | |
| Public Types inherited from SoInteractionProvider | |
| typedef SoInteractionProvider *(* | GetProviderFunc) (SoNode *) |
| Callback function type. More... | |
| Protected Member Functions inherited from SoInteractionOwner | |
| virtual void | pointerPosition (const SoPointerPosition &) |
| Override this if you always need to be informed of the current mouse cursor position. More... | |
| virtual void | pointerLeftWindow () |
| This is called when the mouse cursor leaves the window. More... | |
| bool | hasInteractions () const |
| Returns whether there are any actions defined by this owner. More... | |
| template<class T > | |
| bool | hasInteractionsOfType () const |
| Same as above, but asking for a specific type of interaction. More... | |
| void | addPointingAction (SoPointingAction *) |
| void | addCommandAction (SoCommandAction *) |
| void | addOffsetAction (SoOffsetAction *) |
Detailed Description
SoInteractionProviderNode is the base class for (almost) all interaction nodes in OpenInventor.
Definition at line 30 of file SoInteractionProviderNode.h.
Constructor & Destructor Documentation
| SoInteractionProviderNode::SoInteractionProviderNode | ( | ) |
Default constructor.
Adds an instanceName field, which is used for getting the provider ID. If this is not what you want, you should override getID() to retrieve the provider ID from another source.
|
virtual |
Destructor.
Member Function Documentation
|
virtual |
Returns the id string for identifying the provider (and its actions) - this is usually the name of the scene node.
Reimplemented from SoInteractionOwner.
|
static |
Initializes this class.
|
virtual |
Memory management by reference counting; must be implemented in derived classes.
(Name changed from Inventor methods to avoid confusion, though ref and unref will normally be called for SoInteractionOwners based on OpenInventor.)
Implements SoInteractionOwner.
|
virtual |
Implements SoInteractionOwner.
Member Data Documentation
| SoSFString SoInteractionProviderNode::instanceName |
Defines interface field to store the instance name.
Definition at line 58 of file SoInteractionProviderNode.h.
| SoSFString SoInteractionProviderNode::interactionProviderID |
This field overrides the instanceName as providerID if specified.
Definition at line 61 of file SoInteractionProviderNode.h.
The documentation for this class was generated from the following file:
- MeVis/Foundation/Sources/SoManagedInteraction/SoInteractionProviderNode.h
