DAFFVizBalloonPlot.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_DIRECTIVITY
#define IW_DAFF_DIRECTIVITY

#include <daffviz/DAFFVizSGNode.h>

#include <vtkSmartPointer.h>

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

class DAFFContent;

namespace DAFFViz
{


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

        enum
        {
            MODE_SURFACE=0,
            MODE_WIREFRAME,
            MODE_POINT
        };

        BalloonPlot( SGNode* pParentNode, const DAFFContent* pContent );
        BalloonPlot( const DAFFContent* pContent );
        virtual ~BalloonPlot();

        // --= Object related methods =--

        int GetSelectedFrequency() const;

        void SetSelectedFrequency( int iFreqIndex );

        int GetScaling() const;

        void SetScaling( int iScaling );

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

        void SetRange( double dMin, double dMax );

        void SetUseCustomRange(bool bChecked);

        void SetScalarVisibility( bool bVisible );

        int GetScalarVisibility();

        void SetDisplayMode( int iMode );

        void SetChannel( int iChannel );

        int GetChannel();

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

        void SetNormalize(bool bChecked);

        void SetNormalizeFrequenciesIndividually(bool bChecked);

        void SetUsePhaseAsColor( bool bUse );
    
        void SetProbeAngles( double dAlpha, double dBeta );

        void SetProbeVisible( bool bVisible );

        void UpdateProbe();
    private:

        const DAFFContent* m_pContent;
        vtkSmartPointer< vtkWarpScalar > m_pWarp;
        vtkSmartPointer< vtkPolyDataMapper > m_pMapper;
        vtkSmartPointer< vtkActor > m_pPlotActor;
        vtkSmartPointer< vtkPolyData > m_pPlotPolydata;
        vtkSmartPointer< vtkDoubleArray > m_pNormals;
        int m_iFrequency;
        int m_iNumFrequencies;
        int m_iScaling;
        float m_dMin, m_dMax, m_dProbeAlpha, m_dProbeBeta; // linear factors!
        int m_iChannel;
        bool m_bWarp, m_bUsePhaseAsColor;
        bool m_bNormalize, m_bNormalizeFreqsIndiv, m_bUseCustomRange;
        vtkSmartPointer< vtkActor > m_pProbe;
        vtkSmartPointer< vtkVectorText > m_pProbeLabel;
        vtkSmartPointer< vtkActor > m_pLabel;

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

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

        // Convert orientation (phi, theta) into cartesian coordiates (x,y,z)
        void sph2cart( double phi, double theta, double& x, double& y, double& z );

        // Convert a linear value into decibel
        float FactorToDecibel( float x ) const;
    
        // Convert decibel to linear value
        float DecibelToFactor( float x ) const;

        float  getMagnitudeMaximum() const;
    };

} // End of namespace "DAFFViz"

#endif //  IW_DAFF_DIRECTIVITY