Skip to content

GitLab

Commit 8c61742e authored by Mathias Goldau's avatar Mathias Goldau
Browse files

[CHANGE] Adapted histogramView to new WCustomWidget interface and made use of... 

[CHANGE] Adapted histogramView to new WCustomWidget interface and made use of the new WCustomWidgetEventHandler
parent 30eb22b8
Hide whitespace changes
Inline Side-by-side
Showing with 105 additions and 186 deletions
src/modules/histogramView/WMHistogramView.cpp
View file @ 8c61742e
......@@ -30,6 +30,7 @@
#include <boost/thread/locks.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/bind.hpp>
#include <osg/Drawable>
#include <osg/Geode>
......@@ -41,65 +42,12 @@
#include "core/common/WPathHelper.h"
#include "core/graphicsEngine/WGERequirement.h"
#include "core/gui/WCustomWidget.h"
#include "core/gui/WCustomWidgetEventHandler.h"
#include "core/gui/WGUI.h"
#include "core/kernel/WKernel.h"
#include "WMHistogramView.h"
#include "WMHistogramView.xpm"
/**
* \class CustomWidget
*
* This is a helper class that opens a custom window in the constructor and closes
* it in the destructor. This is used to make the custom widget exception safe in the following sense:
*
* If an exception gets thrown in a function, destructors of all local objects are called before passing the exception
* to the caller. If used to manage the custom widget, this class will guarantee closing of the widget even if exceptions are
* thrown e.g. in the mainloop of a module and - depending on the operation system - may even close the custom widget when the
* OpenWalnut process gets terminated.
*/
class CustomWidget
{
public:
/**
* Constructor. Creates a custom widget.
*
* \param title The title of the custom widget.
* \param mode The projection to use.
* \param shutdown A module's shutdown flag.
*
* \note To open a new widget, the title must be different from that of all current custom widgets.
*/
CustomWidget( std::string title, WGECamera::ProjectionMode mode, WBoolFlag& shutdown ) // NOLINT non-const ref
{
m_widget = WKernel::getRunningKernel()->getGui()->openCustomWidget( title, mode, shutdown.getValueChangeCondition() );
}
/**
* Destructor. Closes the widget.
*/
~CustomWidget()
{
if( m_widget )
{
WKernel::getRunningKernel()->getGui()->closeCustomWidget( m_widget );
}
}
/**
* Returns a pointer to the widget.
*
* \return Shared pointer to the widget.
*/
WCustomWidget::SPtr get()
{
return m_widget;
}
private:
//! The pointer to the widget.
WCustomWidget::SPtr m_widget;
};
//! The number of inputs/datasets/histograms.
#define NUM_INPUTS 3
......@@ -212,16 +160,41 @@ void WMHistogramView::requirements()
m_requirements.push_back( new WGERequirement() );
}
void WMHistogramView::handleMouseMove( WVector2f pos )
{
if( m_infoNode )
{
m_mainNode->remove( m_infoNode );
}
if( m_markerNode )
{
m_mainNode->remove( m_markerNode );
}
createInfo( pos );
}
void WMHistogramView::handleResize( int /* x */, int /* y */, int width, int height )
{
m_windowWidth = width;
m_windowHeight = height;
m_redrawMutex.lock();
m_mainNode->clear();
if( m_windowHeight != 0 && m_windowWidth != 0 )
{
redraw();
}
m_redrawMutex.unlock();
}
void WMHistogramView::moduleMain()
{
m_moduleState.setResetable( true, true );
m_moduleState.add( m_propCondition );
m_sizeChangedCondition = boost::shared_ptr< WCondition >( new WCondition );
m_mouseMovedCondition = boost::shared_ptr< WCondition >( new WCondition );
m_moduleState.add( m_sizeChangedCondition );
m_moduleState.add( m_mouseMovedCondition );
for( std::size_t k = 0; k < m_input.size(); ++k )
{
m_moduleState.add( m_input[ k ]->getDataChangedCondition() );
......@@ -234,24 +207,24 @@ void WMHistogramView::moduleMain()
ready();
CustomWidget widget( std::string( "HistogramView " ) + string_utils::toString( m_instanceID ), WGECamera::TWO_D, m_shutdownFlag );
m_widget = WKernel::getRunningKernel()->getGui()->openCustomWidget( getName() + string_utils::toString( m_instanceID ),
WGECamera::TWO_D, m_shutdownFlag.getValueChangeCondition() );
WCustomWidgetEventHandler eh( m_widget );
eh.subscribeMove( boost::bind( &WMHistogramView::handleMouseMove, this, _1 ) );
eh.subscribeResize( boost::bind( &WMHistogramView::handleResize, this, _1, _2, _3, _4 ) );
m_widget->addEventHandler( &eh );
if( widget.get() )
if( m_widget )
{
// window width and height
m_windowWidth = widget.get()->getViewer()->getCamera()->getViewport()->width();
m_windowHeight = widget.get()->getViewer()->getCamera()->getViewport()->height();
m_windowWidth = m_widget->width();
m_windowHeight = m_widget->height();
m_mainNode = widget.get()->getScene();
m_mainNode = m_widget->getScene();
if( !m_mainNode )
{
errorLog() << "Could not aquire scene node from widget.";
}
else
{
m_windowHandler = new WindowHandler( this );
widget.get()->getViewer()->getView()->addEventHandler( m_windowHandler );
}
}
else
{
......@@ -272,6 +245,8 @@ void WMHistogramView::moduleMain()
// if we do not have a main node, there is no point in doing anything
if( m_mainNode )
{
m_redrawMutex.lock();
bool dataChanged = false;
bool hasData = false;
for( std::size_t k = 0; k < m_data.size(); ++k )
......@@ -291,18 +266,8 @@ void WMHistogramView::moduleMain()
colorChanged = colorChanged | m_colors[ k ]->changed();
}
if( dataChanged || colorChanged || m_histoBins->changed() || m_styleSelection->changed() || m_sizeChanged )
if( dataChanged || colorChanged || m_histoBins->changed() || m_styleSelection->changed() )
{
m_sizeChanged = false;
m_mouseMoved = false;
if( m_windowHeight == 0 || m_windowWidth == 0 )
{
// remove all child nodes from main node
m_mainNode->clear();
continue;
}
infoLog() << "Recalculating histogram.";
// get current data
......@@ -318,44 +283,10 @@ void WMHistogramView::moduleMain()
// remove all child nodes from main node
m_mainNode->clear();
int sel = m_styleSelection->get( true ).getItemIndexOfSelected( 0 );
if( sel >= static_cast< int >( m_geometryFunctions.size() ) )
{
errorLog() << "BUG: There is no geometry generation function for this style!";
}
else
{
// call sel'th geometry generation function
// this adds the osg nodes that draw the histogram
// depending on which style was selected
m_geometryFunctions[ sel ]();
// this creates the frame and labels
createFrame();
}
// show information about the histogram bin pointed to by the mouse cursor
createInfo();
redraw();
}
else if( m_mouseMoved )
{
// if only the mouse was moved, update the info and marker
m_mouseMoved = false;
// we need to remove the old info and marker nodes however,
// as we did not clear the main node this time
if( m_infoNode )
{
m_mainNode->remove( m_infoNode );
}
if( m_markerNode )
{
m_mainNode->remove( m_markerNode );
}
createInfo();
}
m_redrawMutex.unlock();
}
}
......@@ -364,11 +295,30 @@ void WMHistogramView::moduleMain()
// clear main node, just in case
m_mainNode->clear();
// at this point the custom widget will be closed by "widget"'s destructor
WKernel::getRunningKernel()->getGui()->closeCustomWidget( m_widget );
debugLog() << "Finished. Good bye!";
}
void WMHistogramView::redraw()
{
int sel = m_styleSelection->get( true ).getItemIndexOfSelected( 0 );
if( sel >= static_cast< int >( m_geometryFunctions.size() ) )
{
errorLog() << "BUG: There is no geometry generation function for this style!";
}
else
{
// call sel'th geometry generation function
// this adds the osg nodes that draw the histogram
// depending on which style was selected
m_geometryFunctions[ sel ]();
// this creates the frame and labels
createFrame();
}
}
void WMHistogramView::calculateHistograms()
{
m_histograms = std::vector< boost::shared_ptr< WHistogramBasic > >( m_data.size() );
......@@ -1125,10 +1075,11 @@ void WMHistogramView::createFrame()
m_mainNode->insert( m_frameNode );
}
void WMHistogramView::createInfo()
void WMHistogramView::createInfo( WVector2f mousePos )
{
m_createInfoMutex.lock();
// transform mouse position to histogram space
WVector2d m = windowSpaceToHistogramSpace( m_mousePos );
WVector2d m = windowSpaceToHistogramSpace( WVector2d( mousePos ) );
if( m_data.size() == 0 )
{
......@@ -1243,6 +1194,7 @@ void WMHistogramView::createInfo()
m_mainNode->insert( m_markerNode );
}
}
m_createInfoMutex.unlock();
}
void WMHistogramView::createNothing()
......
src/modules/histogramView/WMHistogramView.h
View file @ 8c61742e
......@@ -28,6 +28,7 @@
#include <string>
#include <vector>
#include <boost/thread.hpp>
#include <osg/Geode>
#include "core/common/math/linearAlgebra/WMatrixFixed.h"
......@@ -168,60 +169,38 @@ protected:
private:
/**
* \class WindowHandler
* Called on every mouse move event from the custom widget.
*
* An event handler for a custom widget. Handles resize and mouse movement.
* \note this runs in OSG thread.
* \param pos New mouse position.
*/
class WindowHandler : public osgGA::GUIEventHandler
{
public:
/**
* Constructor.
*
* \param module The WMHistogram to handle events for.
*/
explicit WindowHandler( WMHistogramView* module )
: m_module( module )
{
}
/**
* Deals with the events found by the osg.
*
* \param ea Event class for storing Keyboard, mouse and window events.
*
* \return true if the event was handled.
*/
bool handle( const osgGA::GUIEventAdapter& ea, osgGA::GUIActionAdapter& /* aa */ )
{
switch( ea.getEventType() )
{
case osgGA::GUIEventAdapter::RESIZE:
{
m_module->m_windowWidth = ea.getWindowWidth();
m_module->m_windowHeight = ea.getWindowHeight();
m_module->m_sizeChanged = true;
m_module->m_sizeChangedCondition->notify();
return true;
}
case osgGA::GUIEventAdapter::MOVE:
{
m_module->m_mousePos = WVector2d( ea.getX(), ea.getY() );
m_module->m_mouseMoved = true;
m_module->m_mouseMovedCondition->notify();
}
default:
return false;
}
return false;
}
private:
//! The WMHistogram to handle events for.
WMHistogramView* const m_module;
};
//! The window handler is a friend.
friend class WindowHandler;
void handleMouseMove( WVector2f pos );
/**
* Called on every resize event from the custom widget.
*
* \note this runs in OSG thread.
* \param x X pos
* \param y Y pos
* \param width Widht
* \param height Height
*/
void handleResize( int x, int y, int width, int height );
/**
* Whenever a new info node is made this mutex should be used.
*/
boost::mutex m_createInfoMutex;
/**
* Whenever a redraw is made this mutex should be used.
*/
boost::mutex m_redrawMutex;
/**
* Redraws the histogram and add it to the main geode.
*/
void redraw();
/**
* This updates the maximum value of the histograms.
......@@ -286,7 +265,7 @@ private:
*
* Also adds a quad denoting the currently selected bin that is drawn behind the geometry.
*/
void createInfo();
void createInfo( WVector2f mousePos );
/**
* This finds a suitable spacing of ticks to use for an axis with a certain length and
......@@ -344,29 +323,17 @@ private:
//! The height of the window.
int m_windowHeight;
//! A flag indicating the size of the window was changed.
bool m_sizeChanged;
//! A condition used to force execution of the main loop after a window size change.
boost::shared_ptr< WCondition > m_sizeChangedCondition;
//! The position of the mouse cursor in window coordinates.
WVector2d m_mousePos;
//! A flag indicating the mouse was moved.
bool m_mouseMoved;
//! A condition used to force execution of the main loop after a change to mouse position.
boost::shared_ptr< WCondition > m_mouseMovedCondition;
//! Draws histogram bin info to the top right corner of the window.
osg::ref_ptr< osg::Geode > m_infoNode;
//! Draws a marker showing the currently selected histogram bin.
osg::ref_ptr< osg::Geode > m_markerNode;
//! The event handler for the custom widget.
osg::ref_ptr< WindowHandler > m_windowHandler;
//! Holds the reference to the custom widget used for displaying the histogram
WCustomWidget::SPtr m_widget;
//! Draws the frame and ticks/labels.
osg::ref_ptr< osg::Geode > m_frameNode;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment