MeVisLab Toolbox Reference
SoView2DRigidRegistrationEditorBase Class Reference

interactive editor to accumulate a transformation matrix More...

#include <SoView2DRigidRegistrationEditorBase.h>

Inheritance diagram for SoView2DRigidRegistrationEditorBase:
SoView2DInteractionExtension SoView2DExtension SoInteractionProviderNode SoInteractionOwner SoInteractionProvider SoView2DRigidRegistrationEditor

Classes

struct  RegistrationState
 

Public Member Functions

 SoView2DRigidRegistrationEditorBase (const std::string &actionID)
 Constructor.
 
void draw (View2DSliceList *list, View2DSlice *slice, int z) override
 Called by the SoView2D for each slice that is rendered.
 
virtual void doReset ()
 
- Public Member Functions inherited from SoView2DInteractionExtension
 SoView2DInteractionExtension (const std::string &actionID, bool positionSensitive=true)
 
 SoView2DInteractionExtension ()
 Constructor.
 
- Public Member Functions inherited from SoView2DExtension
 SoView2DExtension ()
 Constructor.
 
void init ()
 setup internal state
 
virtual void updateValues ()
 Update fields to local variables, may be reimplemented if you want to update additional local vars.
 
virtual bool evalEvent (SoView2D *view2d, View2DSliceList *slicelist, View2DEvent *ec, View2DEventPhase phase)
 Called by the SoView2D for each event that happens on the viewer.
 
virtual void startDrawing (View2DSliceList *)
 
virtual void endDrawing (View2DSliceList *)
 
virtual void overwriteDrawingSettings (SoView2DDrawingSettings &)
 
View2DEventgetEvent ()
 get the current event (when inside of evalEvent)
 
float getSelectDist ()
 Set the distance tolerance on hit checking in pixels.
 
bool isPointInsideDeviceRect (float pointX, float pointY, float centerX, float centerY, float hitRectangleSize=0.0)
 returns whether the given point is inside a rectangle around the given center.
 
void drawMiniRect (float xp, float yp, float ext, float lineWidth=1.f)
 Draws a small rectangle with given half side length and a line width.
 
void drawDashedMiniRect (float xp, float yp, float ext, float lineWidth)
 
void drawFilledMiniRect (float xp, float yp, float ext, float lineWidth=1.f)
 Draws a small filled rectangle with given half side length.
 
void drawMiniTriangle (float xp, float yp, float ext, float lineWidth=1.f)
 Draws a small triangle with given center point, half height and line width.
 
void drawFilledMiniTriangle (float xp, float yp, float ext, float lineWidth=1.f)
 Draws a small filled triangle with given center point and half height.
 
void drawMiniCircle (float xp, float yp, float ext, float lineWidth=1.f)
 Draws a small circle with given center point and radius.
 
void drawFilledMiniCircle (float xp, float yp, float ext, float lineWidth=1.f)
 Draws a small filled circle with given center point and radius.
 
void drawFixedSizeMiniCircleAt (float xp, float yp)
 Draws a fixed size small circle at the given position.
 
void drawVoxelBorder (View2DSlice *slice, float vx, float vy, float vz)
 surround the given voxel with a border
 
int getX ()
 get the x device position of current event, only returns valid result when called inside of evalEvent()
 
int getY ()
 get the y device position of current event, only returns valid result when called inside of evalEvent()
 
virtual bool isDrawingOn ()
 check if drawing is on
 
virtual bool isEditingOn ()
 check if editing is on
 
virtual bool isFixZOn ()
 check if z should stay fixed
 
virtual bool isClipToSlice ()
 check if the image is clipped to slice
 
virtual void fieldChanged (SoSensor *sensor)
 handle if any field has changed
 
bool isCreateNewMode ()
 check if extension is in createNewMode
 
void setCreateNewMode (bool flag)
 set this extension to create new objects
 
bool isCreateNewModeRequest ()
 check if extension has a request for createNewMode
 
void setCreateNewModeRequest (bool flag)
 set that extension want to become createNewMode
 
virtual bool isActive ()
 returns if the extension is active (derive this method in child) (in createNewMode or with a selected object)(called by SoView2D)
 
virtual void deleteSelectedObject ()
 deletes the currently active object (derive this method in child) (called by SoView2D)
 
virtual void getStatusString (SbString &status)
 get the current status of this extension
 
virtual bool evaluateEvent (SoView2D *view2d, View2DEvent *ec)
 
virtual bool ignoreEvent (View2DEvent *ec)
 Return true if ec has been handled before and if ignoreHandledEvents is True.
 
bool wantsMouseOverUpdates () const
 public access to _wantsMouseOverUpdateEvents
 
virtual void consumeEvent (View2DEvent *ec, bool handled=TRUE)
 Set handled-flag of ec to true (= consumed) if handled is True and setEventHandled is True.
 
int getSelectedModifierMask ()
 Get compare and ignore mask for the currently selected button/modifier combination, usable with SoPointingAction.
 
int getSelectedIgnoreMask ()
 
SoPointingAction::Trigger getPointingActionTriggerFromFields ()
 Get the trigger that matches the button/modifier field state.
 
- Public Member Functions inherited from SoInteractionProviderNode
 SoInteractionProviderNode ()
 Default constructor.
 
 ~SoInteractionProviderNode () override
 Destructor.
 
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.
 
void objRef () override
 Memory management by reference counting; must be implemented in derived classes.
 
void objUnref () override
 
- Public Member Functions inherited from SoInteractionOwner
 SoInteractionOwner ()
 Default constructor.
 
 ~SoInteractionOwner () override
 The destructor will destroy all interactions created with this object as owner.
 
std::list< SoInteraction * > getInteractions (SoState *state) override
 Returns the list of all interactions of this provider.
 
void pointerPosition (SoState *state, const SoPointerPosition &pos) override
 Same as below, with additional SoState argument. Be defaults simply calls the below version.
 
void pointerLeftWindow (SoState *state) override
 Same as below, with additional SoState argument. Be defaults simply calls the below version.
 
void addListener (SoInteractionOwnerListenerInterface *listener)
 Add a listener object that is notified of changes in the interaction list.
 
void removeListener (SoInteractionOwnerListenerInterface *listener)
 Remove a listener object that was notified of changes in the interaction list.
 
- Public Member Functions inherited from SoInteractionProvider
 SoInteractionProvider ()
 Default constructor.
 
virtual ~SoInteractionProvider ()
 
template<class T >
std::list< T * > getInteractionsOfType (SoState *state)
 Returns list of interactions of a specific type:
 
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 (called on dll initialization).
 
- Static Public Member Functions inherited from SoView2DInteractionExtension
static void initClass ()
 Initializes this class.
 
- Static Public Member Functions inherited from SoView2DExtension
static void initClass ()
 Initializes this class.
 
static float snapToPixelCenter (float coordinateComponent)
 Snaps the coordinate component to the pixel center.
 
static void fieldChangedCB (void *data, SoSensor *sensor)
 inventor callbacks if any field has changed, calls fieldChanged
 
static bool isImageParallel (SoSFMLImage *image, View2DSliceList *dsl)
 Return true if image is parallel to the image of the slice list up to slice thickness.
 
static void enableLineStippling (const SoSFEnum &lineStyleField)
 Set/reset stippling pattern.
 
static void disableLineStippling (const SoSFEnum &lineStyleField)
 
static void getAxisOrientation (int axis, SbMatrix &matrix, char &negativeResult, char &positiveResult)
 Geometry helpers.
 
static float pointToLineDistance (SbVec3f point, SbVec3f line1, SbVec3f line2)
 calculate 3D point to line distance
 
static float pointToLineDistance (SbVec2f point, SbVec2f line1, SbVec2f line2)
 calculate 2D point to line distance
 
static Sign edgeIntersectWithPlane (const SbVec3f &v1, const SbVec3f &v2, const SbPlane &plane, SbVec3f &intersect)
 intersect given edge from v1 to v2 with given plane, returns sign and intersect point
 
- Static Public Member Functions inherited from SoInteractionProviderNode
static void initClass ()
 Initializes this class.
 
- Static Public Member Functions inherited from SoInteractionProvider
static void registerInteractionProviderNode (SoType type, GetProviderFunc func)
 Register a function to obtain a SoInteractionProvider from a SoNode.
 
static SoInteractionProvidergetInteractionProvider (SoNode *node)
 Get a SoInteractionProvider from a SoNode if registered, else NULL.
 

Public Attributes

SoSFMatrix outputMatrix
 matrix with the current registration matrix
 
SoSFVec3f rotationCenterWorld
 the current rotation center in world coordinates
 
SoSFTrigger reset
 
SoSFTrigger resetRotationWheelCenter
 
SoSFMatrix defaultOutputMatrix
 default values for outputMatrix and rotationCenterWorld, these will propagate directly and reset the undo stack
 
SoSFString resolvedWheelImageFile
 appearance configuration
 
SoSFString resolvedCenterImageFile
 
SoSFFloat rotationRelativeCenterRadius
 
SoSFFloat minRelativeWheelRadius
 
SoSFFloat maxRelativeWheelRadius
 
SoSFColor inactiveColor
 
SoSFColor highlightColor
 
SoSFBool drawShadow
 
SoSFColor shadowColor
 
SoSFFloat alpha
 
SoSFFloat sizeViewerPercentage
 
SoSFFloat minWheelSizeInPixels
 
SoSFFloat maxWheelSizeInPixels
 
- Public Attributes inherited from SoView2DInteractionExtension
SoSFTrigger singleClicked
 this is triggered when the user clicks without moving the mouse (this only is supported when using Managed Interaction)
 
SoSFTrigger doubleClicked
 the same for the second click in a row
 
- Public Attributes inherited from SoView2DExtension
SoSFColor color
 color that should be used for drawing
 
SoSFBool drawingOn
 flag if the extension should draw, needs to be checked inside of the draw() method
 
SoSFBool editingOn
 flag if the extension should edit objects on mouse events, needs to be checked inside of the evalEvent() method
 
SoSFBool maskValid
 flag if the event mask is valid.
 
SoSFFloat selectionTolerance
 the selection tolerance in pixels
 
SoSFBool wantsAllEvents
 flag if ALL events should be passed to evalEvent(), if disabled, events are only passed to evalEvent when the mouse mask gets valid
 
SoSFBool wantsKeyEvents
 flag if keyboard events should be passed to evalEvent()
 
SoSFBool wantsMouseWheelEvents
 flag if MouseWheel events should be passed to evalEvent()
 
SoSFBool setEventHandled
 Set event handled if it is indeed handled by this extension.
 
SoSFBool ignoreHandledEvents
 Ignore events, that have been handled by previous extensions.
 
SoSFEnum button1
 mouse mask for button1
 
SoSFEnum button2
 mouse mask for button2
 
SoSFEnum button3
 mouse mask for button3
 
SoSFEnum shift
 shift modifier for mouse mask
 
SoSFEnum control
 shift control for mouse mask
 
SoSFEnum alt
 shift alt for mouse mask
 
SoSFBool needsValidVoxel
 sets if a valid voxel must be hit to get evalEvent() calls
 
SoSFBool renderOnSlab
 defines if the extension should be rendered on all slab slices
 
SoSFBool createNewMode
 flag if extension is in createNewMode
 
SoSFTrigger createNewModeRequest
 
SoSFBool clipToSlice
 Flag to clip drawing to slice.
 
SoSFEnum cursorShape
 Set cursor shape if the mouse mask fits and mouseEvents are effectively sent to evalEvent for editing.
 
SoSFBool fixZOn
 DEPRECATED flag that indicates that the extension should fix the z value, only used in SoView2DRectangle.
 
- Public Attributes inherited from SoInteractionProviderNode
SoSFString instanceName
 Defines interface field to store the instance name.
 
SoSFString interactionProviderID
 This field overrides the instanceName as providerID if specified.
 

Protected Member Functions

 ~SoView2DRigidRegistrationEditorBase () override
 Protected destructor.
 
bool implementsManagedInteractionAndClassicEventHandling () const override
 this node is a hybrid module providing managed interaction and classic event handling
 
void doResetCallback (SoField *)
 field change callbacks:
 
void doResetRotationWheelCenterCallback (SoField *)
 
virtual void iconImagesChanged (SoField *)
 
void pointerPosition (const SoPointerPosition &pos) override
 interface inherited from SoInteractionProvider
 
void pointerLeftWindow () override
 This is called when the mouse cursor leaves the window.
 
virtual void pushOldState (const RegistrationState &)
 callback for undo system
 
bool getRegistrationState (RegistrationState &state) const
 
void setRegistrationState (const RegistrationState &state)
 
bool isSensitiveAt (const SoPointerPosition &) override
 interface forwarded from SoPointingAction:
 
int getCurrentCursor (SoViewerProxy *viewerProxy) override
 interface forwarded from SoPointingAction:
 
void setHighlightAt (const SoPointerPosition &pos) override
 
void unsetHighlight () override
 
void startPressAt (const SoPointerPosition &pos) override
 
void dragMoveTo (const SoPointerPosition &pos) override
 
SoPointingActionendPress (int clickCount) override
 
- Protected Member Functions inherited from SoView2DInteractionExtension
 ~SoView2DInteractionExtension () override
 destructor
 
bool isValidLocation (const SoPointerPosition &pos)
 return true if the position is inside the image or needsValidVoxel is not set
 
virtual bool shouldPointingActionBeEnabled ()
 
void editingOnChanged (SoField *field) override
 called when editingOn field is touched:
 
void buttonMaskChanged (SoField *field) override
 called when one of the button/modifier fields is touched:
 
virtual int getNumInteractionModes () const
 
virtual void setInteractionMode (int)
 
- Protected Member Functions inherited from SoView2DExtension
virtual void createNewModeRequestTriggered (SoField *)
 called when createNewModeRequest field ist touched:
 
 ~SoView2DExtension () override
 destructor
 
void GLRender (SoGLRenderAction *action) override
 Inventor actions.
 
void callback (SoCallbackAction *action) override
 
void handleEvent (SoHandleEventAction *action) override
 
void getMatrix (SoGetMatrixAction *action) override
 
void getBoundingBox (SoGetBoundingBoxAction *action) override
 
void pick (SoPickAction *action) override
 
void doAction (SoAction *action) override
 
- Protected Member Functions inherited from SoInteractionOwner
bool hasInteractions () const
 Returns whether there are any actions defined by this owner.
 
template<class T >
bool hasInteractionsOfType () const
 Same as above, but asking for a specific type of interaction.
 
void addPointingAction (SoPointingAction *)
 
void addCommandAction (SoCommandAction *)
 
void addOffsetAction (SoOffsetAction *)
 

Additional Inherited Members

- Public Types inherited from SoView2DExtension
enum  Sign { ZERO , NEGATIVE , POSITIVE }
 defines the sign of a number, with zero as an extra value More...
 
- Public Types inherited from SoInteractionProvider
typedef SoInteractionProvider *(* GetProviderFunc) (SoNode *)
 
- Protected Attributes inherited from SoView2DInteractionExtension
SoPointingAction_pointingAction
 
- Protected Attributes inherited from SoView2DExtension
SoNodeSensor_nodeSensor
 node sensor that is used to notice field changes
 
float _rgbColor [4]
 Color of the object, update on each field change by _nodeSensor.
 
bool _wantsMouseOverUpdateEvents
 set this flag to receive mouse over events while the extension is active
 

Detailed Description

interactive editor to accumulate a transformation matrix

Definition at line 41 of file SoView2DRigidRegistrationEditorBase.h.

Constructor & Destructor Documentation

◆ SoView2DRigidRegistrationEditorBase()

SoView2DRigidRegistrationEditorBase::SoView2DRigidRegistrationEditorBase ( const std::string & actionID)

Constructor.

◆ ~SoView2DRigidRegistrationEditorBase()

SoView2DRigidRegistrationEditorBase::~SoView2DRigidRegistrationEditorBase ( )
overrideprotected

Protected destructor.

Member Function Documentation

◆ doReset()

virtual void SoView2DRigidRegistrationEditorBase::doReset ( )
virtual

◆ doResetCallback()

void SoView2DRigidRegistrationEditorBase::doResetCallback ( SoField * )
inlineprotected

field change callbacks:

Definition at line 107 of file SoView2DRigidRegistrationEditorBase.h.

◆ doResetRotationWheelCenterCallback()

void SoView2DRigidRegistrationEditorBase::doResetRotationWheelCenterCallback ( SoField * )
inlineprotected

Definition at line 108 of file SoView2DRigidRegistrationEditorBase.h.

◆ dragMoveTo()

void SoView2DRigidRegistrationEditorBase::dragMoveTo ( const SoPointerPosition & pos)
overrideprotectedvirtual

Reimplemented from SoView2DInteractionExtension.

◆ draw()

void SoView2DRigidRegistrationEditorBase::draw ( View2DSliceList * slicelist,
View2DSlice * slice,
int sliceZ )
overridevirtual

Called by the SoView2D for each slice that is rendered.

Implement this method if you want your SoView2DExtension to point on the slices. The sliceZ is the slice that is rendered onto, the slicelist and slice object are passed to access image geometry and render state

Reimplemented from SoView2DExtension.

◆ endPress()

SoPointingAction * SoView2DRigidRegistrationEditorBase::endPress ( int clickCount)
overrideprotectedvirtual

Reimplemented from SoView2DInteractionExtension.

◆ getCurrentCursor()

int SoView2DRigidRegistrationEditorBase::getCurrentCursor ( SoViewerProxy * viewerProxy)
overrideprotectedvirtual

interface forwarded from SoPointingAction:

Reimplemented from SoView2DInteractionExtension.

◆ getRegistrationState()

bool SoView2DRigidRegistrationEditorBase::getRegistrationState ( RegistrationState & state) const
protected

◆ iconImagesChanged()

virtual void SoView2DRigidRegistrationEditorBase::iconImagesChanged ( SoField * )
inlineprotectedvirtual

Definition at line 109 of file SoView2DRigidRegistrationEditorBase.h.

◆ implementsManagedInteractionAndClassicEventHandling()

bool SoView2DRigidRegistrationEditorBase::implementsManagedInteractionAndClassicEventHandling ( ) const
inlineoverrideprotectedvirtual

this node is a hybrid module providing managed interaction and classic event handling

Reimplemented from SoView2DInteractionExtension.

Definition at line 93 of file SoView2DRigidRegistrationEditorBase.h.

◆ initClass()

static void SoView2DRigidRegistrationEditorBase::initClass ( )
static

Initializes this class (called on dll initialization).

◆ isSensitiveAt()

bool SoView2DRigidRegistrationEditorBase::isSensitiveAt ( const SoPointerPosition & )
overrideprotectedvirtual

interface forwarded from SoPointingAction:

Reimplemented from SoView2DInteractionExtension.

◆ pointerLeftWindow()

void SoView2DRigidRegistrationEditorBase::pointerLeftWindow ( )
overrideprotectedvirtual

This is called when the mouse cursor leaves the window.

Reimplemented from SoInteractionOwner.

◆ pointerPosition()

void SoView2DRigidRegistrationEditorBase::pointerPosition ( const SoPointerPosition & pos)
overrideprotectedvirtual

interface inherited from SoInteractionProvider

Reimplemented from SoInteractionOwner.

◆ pushOldState()

virtual void SoView2DRigidRegistrationEditorBase::pushOldState ( const RegistrationState & )
inlineprotectedvirtual

callback for undo system

Reimplemented in SoView2DRigidRegistrationEditor.

Definition at line 125 of file SoView2DRigidRegistrationEditorBase.h.

◆ setHighlightAt()

void SoView2DRigidRegistrationEditorBase::setHighlightAt ( const SoPointerPosition & pos)
overrideprotectedvirtual

Reimplemented from SoView2DInteractionExtension.

◆ setRegistrationState()

void SoView2DRigidRegistrationEditorBase::setRegistrationState ( const RegistrationState & state)
protected

◆ startPressAt()

void SoView2DRigidRegistrationEditorBase::startPressAt ( const SoPointerPosition & pos)
overrideprotectedvirtual

Reimplemented from SoView2DInteractionExtension.

◆ unsetHighlight()

void SoView2DRigidRegistrationEditorBase::unsetHighlight ( )
overrideprotectedvirtual

Reimplemented from SoView2DInteractionExtension.

Member Data Documentation

◆ alpha

SoSFFloat SoView2DRigidRegistrationEditorBase::alpha

Definition at line 80 of file SoView2DRigidRegistrationEditorBase.h.

◆ defaultOutputMatrix

SoSFMatrix SoView2DRigidRegistrationEditorBase::defaultOutputMatrix

default values for outputMatrix and rotationCenterWorld, these will propagate directly and reset the undo stack

Definition at line 62 of file SoView2DRigidRegistrationEditorBase.h.

◆ drawShadow

SoSFBool SoView2DRigidRegistrationEditorBase::drawShadow

Definition at line 78 of file SoView2DRigidRegistrationEditorBase.h.

◆ highlightColor

SoSFColor SoView2DRigidRegistrationEditorBase::highlightColor

Definition at line 77 of file SoView2DRigidRegistrationEditorBase.h.

◆ inactiveColor

SoSFColor SoView2DRigidRegistrationEditorBase::inactiveColor

Definition at line 76 of file SoView2DRigidRegistrationEditorBase.h.

◆ maxRelativeWheelRadius

SoSFFloat SoView2DRigidRegistrationEditorBase::maxRelativeWheelRadius

Definition at line 74 of file SoView2DRigidRegistrationEditorBase.h.

◆ maxWheelSizeInPixels

SoSFFloat SoView2DRigidRegistrationEditorBase::maxWheelSizeInPixels

Definition at line 84 of file SoView2DRigidRegistrationEditorBase.h.

◆ minRelativeWheelRadius

SoSFFloat SoView2DRigidRegistrationEditorBase::minRelativeWheelRadius

Definition at line 73 of file SoView2DRigidRegistrationEditorBase.h.

◆ minWheelSizeInPixels

SoSFFloat SoView2DRigidRegistrationEditorBase::minWheelSizeInPixels

Definition at line 83 of file SoView2DRigidRegistrationEditorBase.h.

◆ outputMatrix

SoSFMatrix SoView2DRigidRegistrationEditorBase::outputMatrix

matrix with the current registration matrix

Definition at line 56 of file SoView2DRigidRegistrationEditorBase.h.

◆ reset

SoSFTrigger SoView2DRigidRegistrationEditorBase::reset

Definition at line 65 of file SoView2DRigidRegistrationEditorBase.h.

◆ resetRotationWheelCenter

SoSFTrigger SoView2DRigidRegistrationEditorBase::resetRotationWheelCenter

Definition at line 66 of file SoView2DRigidRegistrationEditorBase.h.

◆ resolvedCenterImageFile

SoSFString SoView2DRigidRegistrationEditorBase::resolvedCenterImageFile

Definition at line 70 of file SoView2DRigidRegistrationEditorBase.h.

◆ resolvedWheelImageFile

SoSFString SoView2DRigidRegistrationEditorBase::resolvedWheelImageFile

appearance configuration

Definition at line 69 of file SoView2DRigidRegistrationEditorBase.h.

◆ rotationCenterWorld

SoSFVec3f SoView2DRigidRegistrationEditorBase::rotationCenterWorld

the current rotation center in world coordinates

Definition at line 59 of file SoView2DRigidRegistrationEditorBase.h.

◆ rotationRelativeCenterRadius

SoSFFloat SoView2DRigidRegistrationEditorBase::rotationRelativeCenterRadius

Definition at line 72 of file SoView2DRigidRegistrationEditorBase.h.

◆ shadowColor

SoSFColor SoView2DRigidRegistrationEditorBase::shadowColor

Definition at line 79 of file SoView2DRigidRegistrationEditorBase.h.

◆ sizeViewerPercentage

SoSFFloat SoView2DRigidRegistrationEditorBase::sizeViewerPercentage

Definition at line 82 of file SoView2DRigidRegistrationEditorBase.h.


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