SoView2DLabel.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2013, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 

 
#pragma once
 
#include "SoView2DSystem.h"
#include "SoView2DInteractionExtension.h"
 
#include <Inventor/fields/SoSFString.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/fields/SoSFVec3f.h>
#include <Inventor/fields/SoSFVec2f.h>
#include <Inventor/SbBox.h>
#include <DCMTree_Tag.h>
 
 
class SoView2D;
class View2DFont;
 
// Constant name definitions
 
enum VertPositionMode {
    POS_ABOVE,
    POS_VCENTER,
    POS_BELOW
};
 
enum HorizPositionMode {
    POS_LEFT,
    POS_HCENTER,
    POS_RIGHT
};
 
enum TextPositioningMode {
  WORLD_COORDINATES,
  RELATIVE_TO_VIEWER
};
 
class SOVIEW2D_API SoView2DLabel : public SoView2DInteractionExtension
{
  SO_NODE_HEADER(SoView2DLabel);
 
public:

  enum depthVisibilityType
  {
    DEPTH_IN_SLICES,
    DEPTH_IN_MM
  };

  enum FontSizeMode
  {
    FONT_SIZE_IN_PIXELS,
    FONT_SIZE_IN_MM,
    FONT_SIZE_IN_VOXELS
  };

  enum BorderMode
  {
    SHOW_BORDER_OFF,
    SHOW_BORDER_WHEN_HIGHLIGHTED,
    SHOW_BORDER_ALWAYS
  };

 
  SoSFString text;
  SoSFString viewerId;
 
  SoSFEnum textPositioning;
  SoSFVec3f worldPosition;
  SoSFVec2f relativeViewerPosition;
 
  SoSFEnum verticalPosition;
  SoSFFloat verticalOffset;
  SoSFEnum horizontalPosition;
  SoSFFloat horizontalOffset;
 
  SoSFInt32 fontSize;
  SoSFEnum fontSizeMode;
  SoSFFloat alpha;
  SoSFBool textShadow;

  SoSFBool highlighted;

  SoSFTypedEnum<BorderMode> borderMode;
  SoSFColor                 borderColor;

  SoSFFloat depthVisibility;

  SoSFEnum  depthVisibilityMode;

  SoSFBool  useDepthVisibility;
 
  SoSFBool  keepLabelInViewer;
 
  SoSFFloat depthMinimumAlpha;
 
  SoSFInt32 timePoint;
  SoSFBool  showLabelOnAllTimePoints;
 
  // field for definition of background box
  SoSFBool   drawBackground;
  SoSFColor  backgroundColor;
  SoSFFloat  backgroundAlpha;
  SoSFFloat  backgroundMarginTop;
  SoSFFloat  backgroundMarginRight;
  SoSFFloat  backgroundMarginBottom;
  SoSFFloat  backgroundMarginLeft;
 
  SoSFBool isUnderMouse;
  SoSFBool keepCursorPositionInViewerWhenMoving;

  static void   initClass();

  SoView2DLabel();
 
  ~SoView2DLabel() override;

  void   draw(View2DSliceList *dsl, View2DSlice* dslice, int slice) override;
 
  float getDepthVisibilityBlendValue(float distance, float voxelSizeZ);
 
protected:
  bool getTextLocation(View2DSliceList *dsl, View2DSlice* dslice, int slice, float& alphaToUse, float& dx, float& dy, int& textWidth, int& textHeight);
 
  bool implementsManagedInteractionAndClassicEventHandling() const override { return false; }

  bool isSensitiveAt(const SoPointerPosition& pos) override;
  void setHighlightAt(const SoPointerPosition& pos) override;
  void unsetHighlight() override;
  void startPressAt(const SoPointerPosition& pos) override;
  void dragMoveTo(const SoPointerPosition& pos) override;

  void pointerPosition(SoState* state, const SoPointerPosition& pos) override;
  void pointerLeftWindow(SoState* state) override;
 
 
 
private:
  using SoView2DInteractionExtension::pointerPosition;
  using SoView2DInteractionExtension::pointerLeftWindow;
 
  float getFontSizeInPixels(View2DSlice* dslice) const;
  bool labelIsVisibleOnTimePoint(const SoView2D* const view2D) const;
  void getVisibleDeviceArea(View2DSlice *dsl, float& minX, float& maxX, float& minY, float& maxY) const;
 
  SbVec2f _startDragDevicePosition;
  SbVec3f _startWorldPosition;
  SbVec2f _startRelativePosition;
  SbBox2f _labelBounds;
  int _currentInteractionSlice;
};