pFigure.h

Go to the documentation of this file.

#ifndef __pFIGURE__
#define __pFIGURE__

// ----------------------------------------------------------------------------
// WX headers inclusion.
// For compilers that support precompilation, includes <wx/wx.h>.
// ----------------------------------------------------------------------------
#include <wx/wxprec.h>
#ifdef __BORLANDC__
#pragma hdrstop
#endif
#ifndef WX_PRECOMP
#include <wx/wx.h>
#endif

class pFigure :public  wxObject{

public:

        //------------------------------------------------------------------------------------------------------------
        // Constructors & Destructors
        //------------------------------------------------------------------------------------------------------------
        pFigure(int edges_n, int _w, int _h,int _orientation, bool bar_orientation);
        ~pFigure();

        //------------------------------------------------------------------------------------------------------------
        // Methods
        //------------------------------------------------------------------------------------------------------------

        int getNumberEdges();

        void setNumberEdges(int n_edges);
        
        void getVertexPoints(wxPoint thePoints[]);

        void setVertexPoints(wxPoint * n_points);

        /*
        * Sets the heigth of the figure
        * @param _h The heigth to set
        */
        void setHeigth(int _h);

        /*
        * Gets the heigth of the figure
        * @retval heigth The heigth of the figure
        */
        int getHeigth();

        /*
        * Sets the width of the figure
        * @param _w The width to set
        */
        void setWidth(int _w);

        /*
        * Gets the width of the figure
        * @retval width The width of the figure
        */
        int getWidth();

        /*
        * Indicates if a pixel point is inside the figure
        * @param xFig_PixelPoint The known reference point inside the figure
        * @param xPixel The x-pixel coord asking for
        * @retval Returns true if the point is inside
        */
        bool isPointInside(int xFig_PixelPoint, int xPixel);

        /*
        * Sets the bar orientation 
        * @ bar_orientation The orientation to set (true for horizontal, false for vertical)
        */
        void setBarOrientation(bool bar_orientation);

        /*
        * Sets the bar orientation used for triangles
        * @ bar_orientation The orientation to set (LEFT = -4, RIGHT = -6, UP = -8, DOWN = -2)
        */
        void setFigureOrientation(int fig_orientation);
        
        //------------------------------------------------------------------------------------------------------------
        // Constants
        //------------------------------------------------------------------------------------------------------------
        
        enum
        {
                TRIANGLE = 3,
                RECTANGLE = 4,
                LEFT = -4,
                RIGHT = -6,
                UP = -8,
                DOWN = -2,
        };

private:

        //------------------------------------------------------------------------------------------------------------
        // Attributes
        //------------------------------------------------------------------------------------------------------------

        /*
        * Represents the heigth of the figure
        */
        int heigth;

        /*
        * Represents the width of the figure
        */
        int width;

        /*
        * Represents the edges of the figure
        */
        int edges;

        int orientation;

        /*
        * Is the bar orientation (true for HORIZONTAL, false VERTICAL)
        */
        bool barOrientation;

        /*
        * Represents the vertex points distribution of the figure in pixels scale
        */
        wxPoint *v_points;

DECLARE_CLASS(pColorBar)

};
#endif