MeVisLab Toolbox Reference
SoView2DVoxelValue Class Reference

Reads the voxel value at the mouse position on a SoView2D. More...

#include <SoView2DVoxelValue.h>

Inheritance diagram for SoView2DVoxelValue:
SoView2DInteractionExtension SoView2DExtension SoInteractionProviderNode SoInteractionOwner SoInteractionProvider

Public Member Functions

 SoView2DVoxelValue ()
 Constructor. More...
 
bool evalEvent (SoView2D *view2d, View2DSliceList *slicelist, View2DEvent *ec, View2DEventPhase phase) override
 reimplemented from SoView2DExtension More...
 
- Public Member Functions inherited from SoView2DInteractionExtension
 SoView2DInteractionExtension (const std::string &actionID, bool positionSensitive=true)
 
 SoView2DInteractionExtension ()
 Constructor. More...
 
bool implementsManagedInteractionAndClassicEventHandling () const override
 this node is a hybrid module providing managed interaction and classic event handling More...
 
- Public Member Functions inherited from SoView2DExtension
 SoView2DExtension ()
 Constructor. More...
 
void init ()
 setup internal state More...
 
virtual void updateValues ()
 Update fields to local variables, may be reimplemented if you want to update additional local vars. More...
 
virtual void draw (View2DSliceList *slicelist, View2DSlice *slice, int sliceZ)
 Called by the SoView2D for each slice that is rendered. More...
 
virtual void startDrawing (View2DSliceList *)
 
virtual void endDrawing (View2DSliceList *)
 
virtual void overwriteDrawingSettings (SoView2DDrawingSettings &)
 
View2DEventgetEvent ()
 get the current event (when inside of evalEvent) More...
 
float getSelectDist ()
 Set the distance tolerance on hit checking in pixels. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
void drawFilledMiniTriangle (float xp, float yp, float ext, float lineWidth=1.f)
 Draws a small filled triangle with given center point and half height. More...
 
void drawMiniCircle (float xp, float yp, float ext, float lineWidth=1.f)
 Draws a small circle with given center point and radius. More...
 
void drawFilledMiniCircle (float xp, float yp, float ext, float lineWidth=1.f)
 Draws a small filled circle with given center point and radius. More...
 
void drawFixedSizeMiniCircleAt (float xp, float yp)
 Draws a fixed size small circle at the given position. More...
 
void drawVoxelBorder (View2DSlice *slice, float vx, float vy, float vz)
 surround the given voxel with a border More...
 
int getX ()
 get the x device position of current event, only returns valid result when called inside of evalEvent() More...
 
int getY ()
 get the y device position of current event, only returns valid result when called inside of evalEvent() More...
 
virtual bool isDrawingOn ()
 check if drawing is on More...
 
virtual bool isEditingOn ()
 check if editing is on More...
 
virtual bool isFixZOn ()
 check if z should stay fixed More...
 
virtual bool isClipToSlice ()
 check if the image is clipped to slice More...
 
virtual void fieldChanged (SoSensor *sensor)
 handle if any field has changed More...
 
bool isCreateNewMode ()
 check if extension is in createNewMode More...
 
void setCreateNewMode (bool flag)
 set this extension to create new objects More...
 
bool isCreateNewModeRequest ()
 check if extension has a request for createNewMode More...
 
void setCreateNewModeRequest (bool flag)
 set that extension want to become createNewMode More...
 
virtual bool isActive ()
 returns if the extension is active (derive this method in child) (in createNewMode or with a selected object)(called by SoView2D) More...
 
virtual void deleteSelectedObject ()
 deletes the currently active object (derive this method in child) (called by SoView2D) More...
 
virtual void getStatusString (SbString &status)
 get the current status of this extension More...
 
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. More...
 
bool wantsMouseOverUpdates () const
 public access to _wantsMouseOverUpdateEvents More...
 
virtual void consumeEvent (View2DEvent *ec, bool handled=TRUE)
 Set handled-flag of ec to true (= consumed) if handled is True and setEventHandled is True. More...
 
int getSelectedModifierMask ()
 Get compare and ignore mask for the currently selected button/modifier combination, usable with SoPointingAction. More...
 
int getSelectedIgnoreMask ()
 
SoPointingAction::Trigger getPointingActionTriggerFromFields ()
 Get the trigger that matches the button/modifier field state. 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)
 

Static Public Member Functions

static void initClass ()
 inventor runtime type system More...
 
- Static Public Member Functions inherited from SoView2DInteractionExtension
static void initClass ()
 Initializes this class. More...
 
- Static Public Member Functions inherited from SoView2DExtension
static void initClass ()
 Initializes this class. More...
 
static float snapToPixelCenter (float coordinateComponent)
 Snaps the coordinate component to the pixel center. More...
 
static void fieldChangedCB (void *data, SoSensor *sensor)
 inventor callbacks if any field has changed, calls fieldChanged More...
 
static bool isImageParallel (SoSFMLImage *image, View2DSliceList *dsl)
 Return true if image is parallel to the image of the slice list up to slice thickness. More...
 
static void enableLineStippling (const SoSFEnum &lineStyleField)
 Set/reset stippling pattern. More...
 
static void disableLineStippling (const SoSFEnum &lineStyleField)
 
static void getAxisOrientation (int axis, SbMatrix &matrix, char &negativeResult, char &positiveResult)
 Geometry helpers. More...
 
static float pointToLineDistance (SbVec3f point, SbVec3f line1, SbVec3f line2)
 calculate 3D point to line distance More...
 
static float pointToLineDistance (SbVec2f point, SbVec2f line1, SbVec2f line2)
 calculate 2D point to line distance More...
 
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 More...
 
- 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

SoSFBool valuesValid
 this is set to false if the mouse position is not on the image More...
 
SoSFVec3f voxelPosition
 the current voxel position More...
 
SoSFVec3f worldPosition
 the current world position More...
 
SoSFVec3f integerPosition
 the current voxel position rounded to integer More...
 
SoSFString viewerId
 viewerId of the viewer where the mouse was on More...
 
SoSFFloat storedValue
 the real value that is stored in the image More...
 
SoSFFloat outputValue
 the medical adjusted image value More...
 
SoSFString modality
 modality of the image (so that the correct units can be displayed) More...
 
SoSFBool showColorChannelValues
 If true then color channel values are displayed, separated by channelSep, otherwise only the value of color channel 0 is shown. More...
 
SoSFBool invalidateUndefinedOutputValues
 If set, output fields are set to empty string/NaN if valuesUpToDate is False. More...
 
SoSFString colorChannelSeparator
 String value placed as separator between color channel values in storedValueString. More...
 
SoSFInt32 maxPrecision
 Pixel value as string to support registered/composed ML data types and their precision. More...
 
SoSFString storedValueString
 
SoSFString outputValueString
 
- 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) More...
 
SoSFTrigger doubleClicked
 the same for the second click in a row More...
 
- Public Attributes inherited from SoView2DExtension
SoSFColor color
 color that should be used for drawing More...
 
SoSFBool drawingOn
 flag if the extension should draw, needs to be checked inside of the draw() method More...
 
SoSFBool editingOn
 flag if the extension should edit objects on mouse events, needs to be checked inside of the evalEvent() method More...
 
SoSFBool maskValid
 flag if the event mask is valid. More...
 
SoSFFloat selectionTolerance
 the selection tolerance in pixels More...
 
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 More...
 
SoSFBool wantsKeyEvents
 flag if keyboard events should be passed to evalEvent() More...
 
SoSFBool wantsMouseWheelEvents
 flag if MouseWheel events should be passed to evalEvent() More...
 
SoSFBool setEventHandled
 Set event handled if it is indeed handled by this extension. More...
 
SoSFBool ignoreHandledEvents
 Ignore events, that have been handled by previous extensions. More...
 
SoSFEnum button1
 mouse mask for button1 More...
 
SoSFEnum button2
 mouse mask for button2 More...
 
SoSFEnum button3
 mouse mask for button3 More...
 
SoSFEnum shift
 shift modifier for mouse mask More...
 
SoSFEnum control
 shift control for mouse mask More...
 
SoSFEnum alt
 shift alt for mouse mask More...
 
SoSFBool needsValidVoxel
 sets if a valid voxel must be hit to get evalEvent() calls More...
 
SoSFBool renderOnSlab
 defines if the extension should be rendered on all slab slices More...
 
SoSFBool createNewMode
 flag if extension is in createNewMode More...
 
SoSFTrigger createNewModeRequest
 
SoSFBool clipToSlice
 Flag to clip drawing to slice. More...
 
SoSFEnum cursorShape
 Set cursor shape if the mouse mask fits and mouseEvents are effectively sent to evalEvent for editing. More...
 
SoSFBool fixZOn
 DEPRECATED flag that indicates that the extension should fix the z value, only used in SoView2DRectangle. More...
 
- 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 updateVoxelPosition (const SbVec3f &voxelPos, SoView2D *view2d, View2DSliceList *slicelist)
 update voxelPosition More...
 
void setValuesValid (bool valid)
 
void invalidateValues ()
 
void invalidateUndefinedOutputValuesChanged (SoField *f)
 
void editingOnChanged (SoField *field) override
 called when editingOn field is touched: More...
 
void pointerPosition (const SoPointerPosition &pos) override
 interface inherited from SoInteractionProvider More...
 
void pointerLeftWindow () override
 This is called when the mouse cursor leaves the window. More...
 
void startPressAt (const SoPointerPosition &pos) override
 interface forwarded from SoPointingAction: More...
 
void dragMoveTo (const SoPointerPosition &pos) override
 
- Protected Member Functions inherited from SoView2DInteractionExtension
 ~SoView2DInteractionExtension () override
 destructor More...
 
bool isValidLocation (const SoPointerPosition &pos)
 return true if the position is inside the image or needsValidVoxel is not set More...
 
virtual bool shouldPointingActionBeEnabled ()
 
void editingOnChanged (SoField *field) override
 called when editingOn field is touched: More...
 
void buttonMaskChanged (SoField *field) override
 called when one of the button/modifier fields is touched: More...
 
virtual int getCurrentCursor (SoViewerProxy *viewerProxy)
 interface forwarded from SoPointingAction: More...
 
virtual bool isSensitiveAt (const SoPointerPosition &)
 
virtual void setHighlightAt (const SoPointerPosition &)
 
virtual void unsetHighlight ()
 
virtual SoPointingActionendPress (int)
 
virtual int getNumInteractionModes () const
 
virtual void setInteractionMode (int)
 
- Protected Member Functions inherited from SoView2DExtension
virtual void createNewModeRequestTriggered (SoField *)
 called when createNewModeRequest field ist touched: More...
 
 ~SoView2DExtension () override
 destructor More...
 
void GLRender (SoGLRenderAction *action) override
 Inventor actions. More...
 
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. 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 *)
 

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 More...
 
float _rgbColor [4]
 Color of the object, update on each field change by _nodeSensor. More...
 
bool _wantsMouseOverUpdateEvents
 set this flag to receive mouse over events while the extension is active More...
 

Detailed Description

Reads the voxel value at the mouse position on a SoView2D.

reads the voxel value at the mouse position on a SoView2D

Definition at line 25 of file SoView2DVoxelValue.h.

Constructor & Destructor Documentation

◆ SoView2DVoxelValue()

SoView2DVoxelValue::SoView2DVoxelValue ( )

Constructor.

Member Function Documentation

◆ dragMoveTo()

void SoView2DVoxelValue::dragMoveTo ( const SoPointerPosition pos)
overrideprotectedvirtual

Reimplemented from SoView2DInteractionExtension.

◆ editingOnChanged()

void SoView2DVoxelValue::editingOnChanged ( SoField *  field)
overrideprotectedvirtual

called when editingOn field is touched:

Reimplemented from SoView2DExtension.

◆ evalEvent()

bool SoView2DVoxelValue::evalEvent ( SoView2D view2d,
View2DSliceList slicelist,
View2DEvent ec,
View2DEventPhase  phase 
)
overridevirtual

reimplemented from SoView2DExtension

Reimplemented from SoView2DExtension.

◆ initClass()

static void SoView2DVoxelValue::initClass ( )
static

inventor runtime type system

◆ invalidateUndefinedOutputValuesChanged()

void SoView2DVoxelValue::invalidateUndefinedOutputValuesChanged ( SoField *  f)
protected

◆ invalidateValues()

void SoView2DVoxelValue::invalidateValues ( )
protected

◆ pointerLeftWindow()

void SoView2DVoxelValue::pointerLeftWindow ( )
overrideprotectedvirtual

This is called when the mouse cursor leaves the window.

Reimplemented from SoInteractionOwner.

◆ pointerPosition()

void SoView2DVoxelValue::pointerPosition ( const SoPointerPosition pos)
overrideprotectedvirtual

interface inherited from SoInteractionProvider

Reimplemented from SoInteractionOwner.

◆ setValuesValid()

void SoView2DVoxelValue::setValuesValid ( bool  valid)
protected

◆ startPressAt()

void SoView2DVoxelValue::startPressAt ( const SoPointerPosition pos)
overrideprotectedvirtual

interface forwarded from SoPointingAction:

Reimplemented from SoView2DInteractionExtension.

◆ updateVoxelPosition()

void SoView2DVoxelValue::updateVoxelPosition ( const SbVec3f &  voxelPos,
SoView2D view2d,
View2DSliceList slicelist 
)
protected

update voxelPosition

Member Data Documentation

◆ colorChannelSeparator

SoSFString SoView2DVoxelValue::colorChannelSeparator

String value placed as separator between color channel values in storedValueString.

Definition at line 57 of file SoView2DVoxelValue.h.

◆ integerPosition

SoSFVec3f SoView2DVoxelValue::integerPosition

the current voxel position rounded to integer

Definition at line 38 of file SoView2DVoxelValue.h.

◆ invalidateUndefinedOutputValues

SoSFBool SoView2DVoxelValue::invalidateUndefinedOutputValues

If set, output fields are set to empty string/NaN if valuesUpToDate is False.

Definition at line 54 of file SoView2DVoxelValue.h.

◆ maxPrecision

SoSFInt32 SoView2DVoxelValue::maxPrecision

Pixel value as string to support registered/composed ML data types and their precision.

Definition at line 60 of file SoView2DVoxelValue.h.

◆ modality

SoSFString SoView2DVoxelValue::modality

modality of the image (so that the correct units can be displayed)

Definition at line 47 of file SoView2DVoxelValue.h.

◆ outputValue

SoSFFloat SoView2DVoxelValue::outputValue

the medical adjusted image value

Definition at line 45 of file SoView2DVoxelValue.h.

◆ outputValueString

SoSFString SoView2DVoxelValue::outputValueString

Definition at line 62 of file SoView2DVoxelValue.h.

◆ showColorChannelValues

SoSFBool SoView2DVoxelValue::showColorChannelValues

If true then color channel values are displayed, separated by channelSep, otherwise only the value of color channel 0 is shown.

Definition at line 51 of file SoView2DVoxelValue.h.

◆ storedValue

SoSFFloat SoView2DVoxelValue::storedValue

the real value that is stored in the image

Definition at line 43 of file SoView2DVoxelValue.h.

◆ storedValueString

SoSFString SoView2DVoxelValue::storedValueString

Definition at line 61 of file SoView2DVoxelValue.h.

◆ valuesValid

SoSFBool SoView2DVoxelValue::valuesValid

this is set to false if the mouse position is not on the image

Definition at line 31 of file SoView2DVoxelValue.h.

◆ viewerId

SoSFString SoView2DVoxelValue::viewerId

viewerId of the viewer where the mouse was on

Definition at line 40 of file SoView2DVoxelValue.h.

◆ voxelPosition

SoSFVec3f SoView2DVoxelValue::voxelPosition

the current voxel position

Definition at line 34 of file SoView2DVoxelValue.h.

◆ worldPosition

SoSFVec3f SoView2DVoxelValue::worldPosition

the current world position

Definition at line 36 of file SoView2DVoxelValue.h.


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