MeVisLab Toolbox Reference
SoView2DVectorFieldView Class Reference

SoView2DExtension for displaying a vector field. More...

#include <SoView2DVectorFieldView.h>

Inheritance diagram for SoView2DVectorFieldView:
SoView2DExtension SoInteractionProviderNode SoInteractionOwner SoInteractionProvider

Public Member Functions

 SoView2DVectorFieldView (void)
 Creates a detail viewer for voxels. More...
 
void draw (View2DSliceList *dsl, View2DSlice *dslice, int slice) override
 Virtual method called by the SoView2D node. 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 bool evalEvent (SoView2D *view2d, View2DSliceList *slicelist, View2DEvent *ec, View2DEventPhase phase)
 Called by the SoView2D for each event that happens on the viewer. 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...
 
virtual bool implementsManagedInteractionAndClassicEventHandling () const
 return true if this node is a hybrid module providing managed interaction and classic event handling - in this case SoView2D::useManagedInteraction decides which one to use 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 (void)
 Initialization function of 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

Parameter fields.
SoSFColor vectorColor
 The vector color. More...
 
SoSFColor midpointColor
 The point color;. More...
 
SoSFFloat midpointSize
 Size of the midpoints as a factor of the voxel size. More...
 
SoSFUInt32 midpointSegments
 Number of point segments. More...
 
SoSFBool midpointAbsoluteSize
 Indicate that we want absolute width values instead of relative widths. More...
 
SoSFFloat vectorWidth
 Width of the vectors, as a factor of the voxel size. More...
 
SoSFFloat vectorLength
 Vector length. More...
 
SoSFFloat vectorMinLength
 Threshold on minimum vector length (to speed up rendering) More...
 
SoSFBool vectorAbsoluteSize
 Again, indicate we want absolute widths. More...
 
SoSFUInt32 stepWidth
 Step width between shown vectors. More...
 
SoSFBool drawArrowTips
 Indicate we want to draw some arrow tips. More...
 
SoSFColor arrowTipColor
 The color of the arrow tips. More...
 
SoSFFloat arrowTipWidth
 The width of the arrow tips. More...
 
SoSFFloat arrowTipHeight
 The height of the arrow tips. More...
 
SoSFBool normalizeVectors
 Normalize, that is, scale all vectors to the same length. More...
 
SoSFBool useComps2And3
 If enabled then component 2 and 3 are used as x and y component, default is false. 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...
 

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 Member Functions inherited from SoView2DExtension
virtual void editingOnChanged (SoField *)
 called when editingOn field is touched: More...
 
virtual void buttonMaskChanged (SoField *)
 called when one of the button/modifier fields is touched: More...
 
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
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 *)
 
- 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

SoView2DExtension for displaying a vector field.

The vector field must contain three-dimensional vectors (vec3 or vec3f). Include system dependency stuff of this library. Include base class from which we typically derive our new extension. SoView2DExtension for detailed voxel viewing.

Definition at line 38 of file SoView2DVectorFieldView.h.

Constructor & Destructor Documentation

◆ SoView2DVectorFieldView()

SoView2DVectorFieldView::SoView2DVectorFieldView ( void  )

Creates a detail viewer for voxels.

Member Function Documentation

◆ draw()

void SoView2DVectorFieldView::draw ( View2DSliceList dsl,
View2DSlice dslice,
int  slice 
)
overridevirtual

Virtual method called by the SoView2D node.

It is called for each slices drawn in each viewer. dsl is the View2DSliceList, the list containing all information of all slices handled by the viewer. dslice is the slice currently drawn and slice the the number of the currently drawn slice.

Reimplemented from SoView2DExtension.

◆ initClass()

static void SoView2DVectorFieldView::initClass ( void  )
static

Initialization function of this class.

It implements the registration of this class in the runtime type system of open Inventor and other user stuff e.g. activation of other Inventor classes (events, actions, elements) needed in this class.

Member Data Documentation

◆ arrowTipColor

SoSFColor SoView2DVectorFieldView::arrowTipColor

The color of the arrow tips.

Definition at line 104 of file SoView2DVectorFieldView.h.

◆ arrowTipHeight

SoSFFloat SoView2DVectorFieldView::arrowTipHeight

The height of the arrow tips.

Definition at line 110 of file SoView2DVectorFieldView.h.

◆ arrowTipWidth

SoSFFloat SoView2DVectorFieldView::arrowTipWidth

The width of the arrow tips.

Definition at line 107 of file SoView2DVectorFieldView.h.

◆ drawArrowTips

SoSFBool SoView2DVectorFieldView::drawArrowTips

Indicate we want to draw some arrow tips.

Definition at line 101 of file SoView2DVectorFieldView.h.

◆ midpointAbsoluteSize

SoSFBool SoView2DVectorFieldView::midpointAbsoluteSize

Indicate that we want absolute width values instead of relative widths.

Definition at line 82 of file SoView2DVectorFieldView.h.

◆ midpointColor

SoSFColor SoView2DVectorFieldView::midpointColor

The point color;.

Definition at line 73 of file SoView2DVectorFieldView.h.

◆ midpointSegments

SoSFUInt32 SoView2DVectorFieldView::midpointSegments

Number of point segments.

Definition at line 79 of file SoView2DVectorFieldView.h.

◆ midpointSize

SoSFFloat SoView2DVectorFieldView::midpointSize

Size of the midpoints as a factor of the voxel size.

Definition at line 76 of file SoView2DVectorFieldView.h.

◆ normalizeVectors

SoSFBool SoView2DVectorFieldView::normalizeVectors

Normalize, that is, scale all vectors to the same length.

Definition at line 113 of file SoView2DVectorFieldView.h.

◆ stepWidth

SoSFUInt32 SoView2DVectorFieldView::stepWidth

Step width between shown vectors.

Definition at line 98 of file SoView2DVectorFieldView.h.

◆ useComps2And3

SoSFBool SoView2DVectorFieldView::useComps2And3

If enabled then component 2 and 3 are used as x and y component, default is false.

Definition at line 116 of file SoView2DVectorFieldView.h.

◆ vectorAbsoluteSize

SoSFBool SoView2DVectorFieldView::vectorAbsoluteSize

Again, indicate we want absolute widths.

Definition at line 95 of file SoView2DVectorFieldView.h.

◆ vectorColor

SoSFColor SoView2DVectorFieldView::vectorColor

The vector color.

Definition at line 70 of file SoView2DVectorFieldView.h.

◆ vectorLength

SoSFFloat SoView2DVectorFieldView::vectorLength

Vector length.

Definition at line 89 of file SoView2DVectorFieldView.h.

◆ vectorMinLength

SoSFFloat SoView2DVectorFieldView::vectorMinLength

Threshold on minimum vector length (to speed up rendering)

Definition at line 92 of file SoView2DVectorFieldView.h.

◆ vectorWidth

SoSFFloat SoView2DVectorFieldView::vectorWidth

Width of the vectors, as a factor of the voxel size.

This is NOT the vector length;

Definition at line 86 of file SoView2DVectorFieldView.h.


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