DAFFVizSGNode.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_NODE
#define IW_DAFF_NODE

// Includes
#include <DAFFDefs.h>
#include <vector>

// VTK includes
#include <vtkSmartPointer.h>

// Forward declarations
class vtkActor;
class vtkAssembly;
class vtkCamera;
class QtDAFFVizTestWindow;
class QDAFFVTKWidget;

namespace DAFFViz
{


    class DAFF_API SGNode
    {
    public:

        SGNode( DAFFViz::SGNode* pParentNode = NULL );


        virtual ~SGNode();

        // --= Node functionality =--


        DAFFViz::SGNode* GetRootNode() const;


        DAFFViz::SGNode* GetParentNode() const;


        bool HasParentNode() const;


        bool IsRoot() const;


        bool HasChildNodes() const;


        bool IsLeaf() const;


        const DAFFViz::SGNode* GetChildNode(int iIndex) const;


        DAFFViz::SGNode* GetChildNode(int iIndex);


        void GetChildNodes(std::vector<const DAFFViz::SGNode*>& vpChildren) const;


        void GetChildNodes( std::vector<DAFFViz::SGNode*>& vpChildren );


        bool AddChildNode(DAFFViz::SGNode* pChild);


        bool AddChildNodes(const std::vector<DAFFViz::SGNode*>& vpChildren);


        bool RemoveChildNode(DAFFViz::SGNode* pChild);


        bool RemoveChildNodes(const std::vector<DAFFViz::SGNode*>& vpChildren);


        // --= Modificators =--


        void GetPosition(double& x, double& y, double& z) const;
    

        void SetPosition(double x, double y, double z);


        void GetOrientation(double& dRotXDeg, double& dRotYDeg, double& dRotZDeg) const;


        void SetOrientation(double dRotXDeg, double dRotYDeg, double dRotZDeg);


        void SetOrientationYPR(double dYawDeg, double dPitchDeg, double dRollDeg);


        void GetOrientationYPR( double& dYawDeg, double& dPitchDeg, double& dRollDeg );


        void SetOrientationVU(double vx, double vy, double vz,
                              double ux, double uy, double uz);


        void GetOrientationVU(double& vx, double& vy, double& vz,
                              double& ux, double& uy, double& uz);


        void GetScale(double& sx, double& sy, double& sz) const;
    

        void SetScale(double sx, double sy, double sz);


        virtual void SetVisible( bool bVisible);


        virtual bool IsVisible() const;

    protected:

        // --= Modificators for subclasses =--


        void AddActor( vtkSmartPointer< vtkActor > pActor );
    

        void RemoveActor( vtkSmartPointer< vtkActor > pActor );
    

        void AddAssembly( vtkSmartPointer< vtkAssembly > pAssembly );


        void RemoveAssembly( vtkSmartPointer< vtkAssembly > pAssembly );

        // --= Event handlers =--


        virtual void OnSetFollowerCamera( vtkSmartPointer< vtkCamera > pCamera );

    private:
        DAFFViz::SGNode*                m_pParentNode;      
        std::vector< DAFFViz::SGNode* > m_vpChildNodes;     
        vtkSmartPointer< vtkAssembly >  m_pNodeAssembly;    

        bool _debug; 

        // --= Uncopyable =--

        inline SGNode( const SGNode& ) {};

        inline SGNode& operator=( const SGNode& ) { return *this; };


        vtkSmartPointer< vtkAssembly > GetNodeAssembly();
    
        // The display class needs access to the node assembly
        friend class VTKDAFFVizWindow;
        friend class QDAFFVTKWidget;
        friend class QtDAFFVizTestWindow;
    };

} // End of namespace "DAFFViz"

#endif //  IW_DAFF_NODE