DAFFVizCarpetPlot.h

Go to the documentation of this file.

/*
 * -------------------------------------------------------------------------------------
 *
 *  OpenDAFF - A free, open source software package for directional audio data
 *  Copyright 2016 Institute of Technical Acoustics, RWTH Aachen University
 *  OpenDAFF is distributed under the Apache License Version 2.0.
 *
 *  ------------------------------------------------------------------------------------
 *
 */

#ifndef IW_DAFF_CARPETPLOT
#define IW_DAFF_CARPETPLOT

#include <daffviz/DAFFVizSGNode.h>
#include <vtkSmartPointer.h>

// Forward declarations
class vtkActor;
class vtkPolyData;
class vtkPolyDataMapper;
class vtkWarpScalar;
class vtkVectorText;

class DAFFContentIR;

namespace DAFFViz
{

    class DAFF_API CarpetPlot : public DAFFViz::SGNode
    {
    public:
        enum
        {
            SCALING_LINEAR=0,
            SCALING_DECIBEL
        };

        enum
        {
            BETA_FIXED=0,
            ALPHA_FIXED
        };

        enum
        {
            MODE_SURFACE=0,
            MODE_WIREFRAME,
            MODE_POINT
        };

        CarpetPlot( SGNode* pParent, const DAFFContentIR* pContentIR );
        CarpetPlot( const DAFFContentIR* pContentIR );
        virtual ~CarpetPlot();

        // --= Object related methods =--

        float GetSelectedAngle() const;

        void SetSelectedAngle(float fAngle);

        int GetScaling() const;

        void SetScaling(int iScaling);

        void SetFixedAngle(int iFixedAngle);

        int getFixedAngle();

        void SetScalarVisibility(bool bVisible);

        int getScalarVisibility();

        void SetDisplayMode(int iMode);

        double GetRangeMin() const;
    
        double GetRangeMax() const;

        void SetRange(double dMin, double dMax);

        void SetChannel(int iChannel);

        int GetChannel();

        // \note default: enabled
        void EnableWarp();
        void DisableWarp();

        void SetWarpingEnabled( bool bEnabled );

        void GtWarpingEnabled( bool ) const;
    
        void SetProbeAngles(double dAlpha, double dBeta);

        void SetProbeVisible(bool bVisible);

        void UpdateProbe();

    private:

        const DAFFContentIR* m_pContentIR;
        vtkSmartPointer< vtkWarpScalar > m_pWarp;
        vtkSmartPointer< vtkPolyDataMapper > m_pCarpetMapper;
        vtkSmartPointer< vtkActor > m_pCarpetActor;
        vtkSmartPointer< vtkPolyData > m_pCarpetPolyData;
        float m_fAngle;
        int m_iScaling;
        int m_iFixedAngle;
        float m_dMin, m_dMax; // linear factors!
        int m_iChannel;
        bool m_bWarp;
        vtkSmartPointer< vtkActor > m_pProbe;
        vtkSmartPointer< vtkVectorText > m_pProbeLabel;
        vtkSmartPointer< vtkActor > m_pLabel;
        float m_dProbeX, m_dProbeY;

        void Init();

        // The initializer generates dynamic objects like source, mapper, actor ...
        void InitCarpetMesh();

        // Update scalars (e.g. when selected angle changed)
        void SetScalars();

        // Convert a linear value into decibel
        double factor2decibel(double x) const;
    
        // Convert decibel to linear value
        double decibel2factor(double x) const;

        // moves the whole plot to fit to the coordinate axes
        void updatePlotOffset();
    };

} // End of namespace "DAFFViz"

#endif //  IW_DAFF_CARPETPLOT