ImFusion SDK 4.3
HistogramOverlay Class Reference

#include <ImFusion/GUI/HistogramOverlay.h>

ViewOverlay to show an intensity histogram of the first shown image in a SliceView. More...

+ Inheritance diagram for HistogramOverlay:

Detailed Description

ViewOverlay to show an intensity histogram of the first shown image in a SliceView.

Additionally, it shows a the visual representation of the datasets window/level as configured in its DisplayOptions2d. Basic mouse interaction allows for manipulating window/level as well for configuring the overlay itself through a context menu.

See also
GlHistogramOverlay

Public Member Functions

 HistogramOverlay (SliceView *view2d)
 
const GlHistogramOverlay * glOverlay () const
 Get a pointer to the underlying GlHistogramOverlay.
 
GlHistogramOverlay * glOverlay ()
 Get a pointer to the underlying GlHistogramOverlay.
 
void render () override
 Calls GlOverlay::render() on the underlying glOverlay() using the current viewport() shrinked by margin().
 
EventResult handleInputEvent (const InputEvent &event) override
 Handle a user event received from the parent View.
 
- Public Member Functions inherited from ViewOverlay
 ViewOverlay (std::unique_ptr< GlOverlay > glOverlay)
 Instantiate a new ViewOverlay taking ownership of the underlying GlOverlay which must not be null.
 
const GlOverlayglOverlay () const
 Get a pointer to the underlying overlay.
 
GlOverlayglOverlay ()
 Get a pointer to the underlying overlay.
 
const GL::Viewportviewport ()
 Returns the area where this overlay is rendered.
 
bool isVisible () const
 Returns the visibility of this overlay.
 
virtual void setVisible (bool value)
 Sets the visibility of this overlay.
 
const vec2i & margin () const
 Returns the margin in pixels between the border of the drawing area and the border of the overlay content.
 
void setMargin (const vec2i &value)
 Sets the margin in pixels between the border of the drawing area and the border of the overlay content.
 
vec2i minimalSizeHint () const
 Returns the underlying GlOverlay's minimal size hint plus the configured margin().
 
vec2i sizeHint () const
 Returns the underlying GlOverlay's size hint plus the configured margin().
 
void configure (const Properties *p) override
 Configure this object instance by de-serializing the given Properties.
 
void configuration (Properties *p) const override
 Serialize the current object configuration into the given Properties object.
 
- Public Member Functions inherited from Configurable
virtual void configureDefaults ()
 Retrieve the properties of this object, replaces values with their defaults and sets it again.
 
void registerParameter (ParameterBase *param)
 Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
 
void unregisterParameter (const ParameterBase *param)
 Remove the given Parameter or SubProperty from the list of registered parameters.
 
 Configurable (const Configurable &rhs)
 
 Configurable (Configurable &&rhs) noexcept
 
Configurableoperator= (const Configurable &)
 
Configurableoperator= (Configurable &&) noexcept
 
- Public Member Functions inherited from SignalReceiver
 SignalReceiver ()=default
 Default constructor.
 
 SignalReceiver (const SignalReceiver &other)
 Copy constructor, does not copy any existing signal connections from other.
 
SignalReceiveroperator= (SignalReceiver rhs)
 Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs.
 
virtual ~SignalReceiver ()
 Virtual destructor disconnects from all connected signals.
 

Protected Types

enum class  InteractionMode { None , Moving , ResizeLeft , ResizeRight }
 

Protected Member Functions

void onViewDataChanged ()
 
void updateHistogram ()
 
Menu createContextMenu () const
 
- Protected Member Functions inherited from SignalReceiver
void disconnectAll ()
 Disconnects all existing connections.
 

Protected Attributes

GlHistogramOverlay * m_typedOverlay = nullptr
 
SliceViewm_view2D = nullptr
 
const SharedImageSetm_currentSIS = nullptr
 
int m_currentFocus = -1
 
DisplayOptions2dm_currentDisplayOptions = nullptr
 
std::shared_ptr< SignalConnectionm_viewDataChangedConnection
 
enum ImFusion::GUI::HistogramOverlay::InteractionMode m_interactionMode = InteractionMode::None
 
vec2 m_mouseMoveStart = vec2::Zero()
 mouse position where the operation started
 
double m_startLevel = 0
 level when the operations started
 
double m_startWindow = 0
 window when the operations started
 
- Protected Attributes inherited from ViewOverlay
std::unique_ptr< GlOverlaym_glOverlay
 
GL::Viewport m_viewport = {}
 
vec2i m_margin = vec2i::Zero()
 
bool m_isVisible = true
 
- Protected Attributes inherited from Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.
 

Additional Inherited Members

- Public Types inherited from ViewOverlay
enum class  Anchor {
  BottomLeft = 0 , BottomRight = 1 , TopLeft = 2 , TopRight = 3 ,
  Top = 4 , Bottom = 5 , Left = 6 , Right = 7 ,
  Fill = 8
}
 Anchor point of the overlay in the parent View. More...
 
enum class  LayoutDirection { Horizontal = 0 , Vertical = 1 }
 Layout direction when stacking multiple ViewOverlays at the same anchor.
 
- Public Attributes inherited from ViewOverlay
Signal signalUpdateRequested
 Emitted in order to notify the parent Display that it's contents have changed and need to be re-rendered.
 
Signal signalLayoutNeeded
 Emitted whenever the size hints or margin have changed to notify the parent View that it needs to perform overlay layouting.
 
- Public Attributes inherited from Configurable
Signal signalParametersChanged
 Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
 

Member Function Documentation

◆ render()

void render ( )
overridevirtual

Calls GlOverlay::render() on the underlying glOverlay() using the current viewport() shrinked by margin().

Reimplemented from ViewOverlay.

◆ handleInputEvent()

EventResult handleInputEvent ( const InputEvent & event)
overridevirtual

Handle a user event received from the parent View.

The default implementation is empty.

Reimplemented from ViewOverlay.


The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close