MeVisLab Toolbox Reference
SoPicking Class Reference

#include <SoPicking.h>

Inheritance diagram for SoPicking:
SoInteractionNode SoInteractionProviderNode SoInteractionHandler SoInteractionOwner SoInteractionProvider

Public Member Functions

 SoPicking ()
 Constructor. More...
 
- Public Member Functions inherited from SoInteractionNode
 SoInteractionNode ()
 Constructor. More...
 
 ~SoInteractionNode () override
 
void handleEvent (SoHandleEventAction *action) override
 Handles the mouse and keyboard events. More...
 
- Public Member Functions inherited from SoInteractionProviderNode
 SoInteractionProviderNode ()
 Default constructor. More...
 
 ~SoInteractionProviderNode () override
 Destructor. More...
 
std::string getID () const override
 Returns the id string for identifying the provider (and its actions) - this is usually the name of the scene node. More...
 
void objRef () override
 Memory management by reference counting; must be implemented in derived classes. More...
 
void objUnref () override
 
- Public Member Functions inherited from SoInteractionOwner
 SoInteractionOwner ()
 Default constructor. More...
 
 ~SoInteractionOwner () override
 The destructor will destroy all interactions created with this object as owner. More...
 
std::list< SoInteraction * > getInteractions (SoState *state) override
 Returns the list of all interactions of this provider. More...
 
void pointerPosition (SoState *state, const SoPointerPosition &pos) override
 Same as below, with additional SoState argument. Be defaults simply calls the below version. More...
 
void pointerLeftWindow (SoState *state) override
 Same as below, with additional SoState argument. Be defaults simply calls the below version. More...
 
void addListener (SoInteractionOwnerListenerInterface *listener)
 Add a listener object that is notified of changes in the interaction list. More...
 
void removeListener (SoInteractionOwnerListenerInterface *listener)
 Remove a listener object that was notified of changes in the interaction list. 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)
 
- Public Member Functions inherited from SoInteractionHandler
 SoInteractionHandler (SoInteractionProvider *provider)
 
virtual ~SoInteractionHandler ()
 
virtual void handleEventForInteraction (SoHandleEventAction *action)
 Handles the mouse and keyboard events and send them to interaction nodes. More...
 

Static Public Member Functions

static void initClass ()
 Initializes this class. More...
 
- Static Public Member Functions inherited from SoInteractionNode
static void initClass ()
 Initializes this class. More...
 
static SoInteractionProvidergetInteractionProvider (SoNode *node)
 
- Static Public Member Functions inherited from SoInteractionProviderNode
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 SoInteractionProvidergetInteractionProvider (SoNode *node)
 Get a SoInteractionProvider from a SoNode if registered, else NULL. More...
 

Public Attributes

Output fields for selected point, normal and texture coordinates in world and object coordinates.
SoSFVec3f objectLocal
 
SoSFVec3f objectWorld
 
SoSFVec3f normalLocal
 
SoSFVec3f normalWorld
 
SoSFVec3f textureLocal3
 
SoSFVec3f textureWorld3
 
SoSFVec4f textureLocal4
 
SoSFVec4f textureWorld4
 
SoSFBool pointPicked
 
SoSFBool enableColorPicking
 
SoSFColor diffuseColor
 
SoSFBool enablePathPicking
 
SoSFPath pickedPath
 
SoSFBool highlighted
 
SoSFBool buttonPressed
 
SoSFInt32 clickCount
 
SoSFBool enabled
 
SoSFBool updateWhileDragging
 
SoSFBool performPreClickTest
 
SoSFBool updateContinuously
 
SoSFEnum cursorShape
 
SoSFString actionID
 
SoSFBool highlighted2
 
SoSFBool buttonPressed2
 
SoSFInt32 clickCount2
 
SoSFBool enabled2
 
SoSFBool updateWhileDragging2
 
SoSFBool performPreClickTest2
 
SoSFEnum cursorShape2
 
SoSFString actionID2
 
SoSFBool highlighted3
 
SoSFBool buttonPressed3
 
SoSFInt32 clickCount3
 
SoSFBool enabled3
 
SoSFBool updateWhileDragging3
 
SoSFBool performPreClickTest3
 
SoSFEnum cursorShape3
 
SoSFString actionID3
 
- Public Attributes inherited from SoInteractionProviderNode
SoSFString instanceName
 Defines interface field to store the instance name. More...
 
SoSFString interactionProviderID
 This field overrides the instanceName as providerID if specified. More...
 

Protected Member Functions

void pointerPosition (const SoPointerPosition &pos) override
 this is called for every mouse move More...
 
void pointerLeftWindow () override
 this is called when the mouse leaves the window More...
 
- Protected Member Functions inherited from SoInteractionOwner
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 *)
 
- Protected Member Functions inherited from SoInteractionHandler
bool handleKeyPress (SoState *state, const SoPointerPosition &location, int modifiers, SoKeyboardEvent::Key nKey)
 Handles key press by checking for commands actions with matching key shortcuts and executing (one of) them. More...
 
virtual bool augmentLocation (SoPointerPosition &, bool)
 This method can be overridden to provide further position information to SoPointingActions - e.g. More...
 
void buttonMaskChanged (SoState *state, const SoPointerPosition &location, int buttonMask)
 Called if the button mask changed since the last input event. More...
 
void modifierMaskChanged (SoState *state, const SoPointerPosition &location, int modifierMask)
 Called if the modifier mask changed since the last input event. More...
 
void locationChanged (SoState *state, const SoPointerPosition &location, bool force=false, bool renderRefresh=false)
 Called if the pointer location changed since the last input event. More...
 
bool wheelRotated (SoState *state, const SoPointerPosition &location, int modifierMask, SoMouseWheelEvent::Orientation orientation, short rotation)
 Called when the mouse wheel is rotated. More...
 
void handlePointerLeftWindow (SoState *state)
 Called if the pointer left the scene widget. More...
 
SoInteractionCoordinatorgetCoordinator ()
 Access method, returns the interaction coordinator during event handling. More...
 
SoPointingActiongetLocalCurrentPointingAction ()
 
virtual bool isEnabled (SoPointingAction *action, int currentMask)
 This method returns true if the pointing action should be enabled for the given modifier/button mask. More...
 
virtual bool isValidStartingLocation (const SoPointerPosition &location)
 This method returns whether the current location is valid for starting a pointing action. More...
 
bool canSelectPointingAction ()
 
void selectTargetPointingAction (SoState *state, const SoPointerPosition &location, int mask)
 
bool trySwitchGlobalPointingAction (SoState *state, const SoPointerPosition &location, int buttonMask, int modifierMask)
 Tries to switch from one global pointing action to another during a drag. More...
 
int getCurrentButtonMask ()
 
int getCurrentModifierMask ()
 Returns the currently active button modifier. More...
 
SoPointerPosition getCurrentPointerLocation ()
 Returns the current position of the mouse cursor. More...
 
bool isCurrentPointerLocationValid ()
 Returns whether the current mouse cursor position is valid. More...
 

Friends

class SoPickingPickAction
 

Additional Inherited Members

- Public Types inherited from SoInteractionProvider
typedef SoInteractionProvider *(* GetProviderFunc) (SoNode *)
 

Detailed Description

Definition at line 39 of file SoPicking.h.

Constructor & Destructor Documentation

◆ SoPicking()

SoPicking::SoPicking ( )

Constructor.

Member Function Documentation

◆ initClass()

static void SoPicking::initClass ( )
static

Initializes this class.

◆ pointerLeftWindow()

void SoPicking::pointerLeftWindow ( )
overrideprotectedvirtual

this is called when the mouse leaves the window

Reimplemented from SoInteractionOwner.

◆ pointerPosition()

void SoPicking::pointerPosition ( const SoPointerPosition pos)
overrideprotectedvirtual

this is called for every mouse move

Reimplemented from SoInteractionOwner.

Friends And Related Function Documentation

◆ SoPickingPickAction

friend class SoPickingPickAction
friend

Definition at line 43 of file SoPicking.h.

Member Data Documentation

◆ actionID

SoSFString SoPicking::actionID

Definition at line 80 of file SoPicking.h.

◆ actionID2

SoSFString SoPicking::actionID2

Definition at line 90 of file SoPicking.h.

◆ actionID3

SoSFString SoPicking::actionID3

Definition at line 100 of file SoPicking.h.

◆ buttonPressed

SoSFBool SoPicking::buttonPressed

Definition at line 72 of file SoPicking.h.

◆ buttonPressed2

SoSFBool SoPicking::buttonPressed2

Definition at line 83 of file SoPicking.h.

◆ buttonPressed3

SoSFBool SoPicking::buttonPressed3

Definition at line 93 of file SoPicking.h.

◆ clickCount

SoSFInt32 SoPicking::clickCount

Definition at line 73 of file SoPicking.h.

◆ clickCount2

SoSFInt32 SoPicking::clickCount2

Definition at line 84 of file SoPicking.h.

◆ clickCount3

SoSFInt32 SoPicking::clickCount3

Definition at line 94 of file SoPicking.h.

◆ cursorShape

SoSFEnum SoPicking::cursorShape

Definition at line 79 of file SoPicking.h.

◆ cursorShape2

SoSFEnum SoPicking::cursorShape2

Definition at line 89 of file SoPicking.h.

◆ cursorShape3

SoSFEnum SoPicking::cursorShape3

Definition at line 99 of file SoPicking.h.

◆ diffuseColor

SoSFColor SoPicking::diffuseColor

Definition at line 66 of file SoPicking.h.

◆ enableColorPicking

SoSFBool SoPicking::enableColorPicking

Definition at line 65 of file SoPicking.h.

◆ enabled

SoSFBool SoPicking::enabled

Definition at line 75 of file SoPicking.h.

◆ enabled2

SoSFBool SoPicking::enabled2

Definition at line 86 of file SoPicking.h.

◆ enabled3

SoSFBool SoPicking::enabled3

Definition at line 96 of file SoPicking.h.

◆ enablePathPicking

SoSFBool SoPicking::enablePathPicking

Definition at line 68 of file SoPicking.h.

◆ highlighted

SoSFBool SoPicking::highlighted

Definition at line 71 of file SoPicking.h.

◆ highlighted2

SoSFBool SoPicking::highlighted2

Definition at line 82 of file SoPicking.h.

◆ highlighted3

SoSFBool SoPicking::highlighted3

Definition at line 92 of file SoPicking.h.

◆ normalLocal

SoSFVec3f SoPicking::normalLocal

Definition at line 57 of file SoPicking.h.

◆ normalWorld

SoSFVec3f SoPicking::normalWorld

Definition at line 58 of file SoPicking.h.

◆ objectLocal

SoSFVec3f SoPicking::objectLocal

Definition at line 55 of file SoPicking.h.

◆ objectWorld

SoSFVec3f SoPicking::objectWorld

Definition at line 56 of file SoPicking.h.

◆ performPreClickTest

SoSFBool SoPicking::performPreClickTest

Definition at line 77 of file SoPicking.h.

◆ performPreClickTest2

SoSFBool SoPicking::performPreClickTest2

Definition at line 88 of file SoPicking.h.

◆ performPreClickTest3

SoSFBool SoPicking::performPreClickTest3

Definition at line 98 of file SoPicking.h.

◆ pickedPath

SoSFPath SoPicking::pickedPath

Definition at line 69 of file SoPicking.h.

◆ pointPicked

SoSFBool SoPicking::pointPicked

Definition at line 63 of file SoPicking.h.

◆ textureLocal3

SoSFVec3f SoPicking::textureLocal3

Definition at line 59 of file SoPicking.h.

◆ textureLocal4

SoSFVec4f SoPicking::textureLocal4

Definition at line 61 of file SoPicking.h.

◆ textureWorld3

SoSFVec3f SoPicking::textureWorld3

Definition at line 60 of file SoPicking.h.

◆ textureWorld4

SoSFVec4f SoPicking::textureWorld4

Definition at line 62 of file SoPicking.h.

◆ updateContinuously

SoSFBool SoPicking::updateContinuously

Definition at line 78 of file SoPicking.h.

◆ updateWhileDragging

SoSFBool SoPicking::updateWhileDragging

Definition at line 76 of file SoPicking.h.

◆ updateWhileDragging2

SoSFBool SoPicking::updateWhileDragging2

Definition at line 87 of file SoPicking.h.

◆ updateWhileDragging3

SoSFBool SoPicking::updateWhileDragging3

Definition at line 97 of file SoPicking.h.


The documentation for this class was generated from the following file: