OSDLPolygon.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2003-2009 Olivier Boudeville
 *
 * This file is part of the OSDL library.
 *
 * The OSDL library is free software: you can redistribute it and/or modify
 * it under the terms of either the GNU Lesser General Public License or
 * the GNU General Public License, as they are published by the Free Software
 * Foundation, either version 3 of these Licenses, or (at your option) 
 * any later version.
 *
 * The OSDL library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License and the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License and of the GNU General Public License along with the OSDL library.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Olivier Boudeville (olivier.boudeville@esperide.com)
 *
 */


#ifndef OSDL_POLYGON_H_
#define OSDL_POLYGON_H_


#include "OSDLPixel.h"              // for Pixels::put, Pixels::Pixel

#include "Ceylan.h"                 // for TextDisplayable, AngleInDegrees

#include <string>
#include <list>


#if ! defined(OSDL_USES_SDL) || OSDL_USES_SDL 

#include "SDL.h"             // for ColorDefinition

#endif // OSDL_USES_SDL


namespace OSDL
{


    
    namespace Video
    {



        // Polygons are drawn to surfaces.
        class Surface ;
                
        
        
        namespace TwoDimensional
        {
        
        
        
            // Polygons are made from 2D points .
            class Point2D ;
                
                
                
            typedef std::list<Point2D *> listPoint2D ;
                
            
            
            /*
             * Methods could be inlined in a dedicated file for faster
             * processing.
             *
             */
    
    
    
            OSDL_DLL bool drawPie( Surface & targetSurface, 
                Coordinate xCenter, Coordinate yCenter, Length radius, 
                Ceylan::Maths::AngleInDegrees angleStart,
                Ceylan::Maths::AngleInDegrees angleStop,
                Pixels::ColorElement red, Pixels::ColorElement green, 
                Pixels::ColorElement blue, 
                Pixels::ColorElement alpha = Pixels::AlphaOpaque ) ;
    
    
    
            OSDL_DLL bool drawPie( Surface & targetSurface, 
                Coordinate xCenter, Coordinate yCenter, Length radius, 
                Ceylan::Maths::AngleInDegrees angleStart,
                Ceylan::Maths::AngleInDegrees angleStop, 
                Pixels::ColorDefinition colorDef ) ;
    
    

            OSDL_DLL bool drawTriangle( Surface & targetSurface, 
                Coordinate x1, Coordinate y1, 
                Coordinate x2, Coordinate y2, 
                Coordinate x3, Coordinate y3, 
                Pixels::ColorElement red, Pixels::ColorElement green, 
                Pixels::ColorElement blue, 
                Pixels::ColorElement alpha = Pixels::AlphaOpaque,
                bool filled = true ) ;



            OSDL_DLL bool drawTriangle( Surface & targetSurface, 
                Coordinate x1, Coordinate y1, 
                Coordinate x2, Coordinate y2, 
                Coordinate x3, Coordinate y3, 
                Pixels::ColorDefinition colorDef, bool filled = true ) ;
    
    

            OSDL_DLL bool drawTriangle( Surface & targetSurface, 
                const Point2D & p1, const Point2D & p2, const Point2D & p3,
                Pixels::ColorElement red, Pixels::ColorElement green, 
                Pixels::ColorElement blue, 
                Pixels::ColorElement alpha = Pixels::AlphaOpaque,
                bool filled = true ) ;



            OSDL_DLL bool drawTriangle( Surface & targetSurface, 
                const Point2D & p1, const Point2D & p2, const Point2D & p3,
                Pixels::ColorDefinition colorDef, bool filled = true ) ;
    


            OSDL_DLL bool drawPolygon( Surface & targetSurface, 
                const listPoint2D & summits,
                Coordinate x, Coordinate y,
                Pixels::ColorElement red, Pixels::ColorElement green, 
                Pixels::ColorElement blue, 
                Pixels::ColorElement alpha = Pixels::AlphaOpaque,
                bool filled = true ) ;              



            OSDL_DLL bool drawPolygon( Surface & targetSurface, 
                const listPoint2D & summits,
                Coordinate x, Coordinate y,
                Pixels::ColorDefinition colorDef, bool filled = true ) ;
                
                 
                 
            
            class OSDL_DLL Polygon: public Ceylan::Locatable2D
            {
            
            
                public:
                
                
                
                    explicit Polygon( listPoint2D & summits, 
                        bool listOwner = false ) ;
                    
            
            
                    virtual ~Polygon() throw() ;
                    
                    
                    
                    virtual bool draw( Surface & targetSurface,
                        Pixels::ColorDefinition colorDef = Pixels::White, 
                        bool filled = true ) const ;
                        
                    
                    
                    virtual listPoint2D & getPoints() const ;
                        
                        
                        
                    virtual void setPoints( listPoint2D & newList ) ;
                    
                    
                    
                        
                    virtual bool isListOwner() const ;
                
                                        
                        
                    virtual const std::string toString( 
                        Ceylan::VerbosityLevels level = Ceylan::high ) const ;
                    
                    
                    
                    
                    
                    // Static section.
                    
                    
                    
                    static Polygon & CreateFlakeBranch( 
                        Length length = 200,
                        Length thickness = 20, 
                        Ceylan::Maths::AngleInDegrees childAngle = 50, 
                        Ceylan::Maths::Ratio branchingHeightRatio = 0.7, 
                        Ceylan::Maths::Ratio scale = 0.3 ) ;
                    
                    
                    
                    static listPoint2D & Duplicate( 
                        const listPoint2D & source ) ;
    
    
    
                    static void Delete( listPoint2D & listToBeDeleted ) ;
                    
                    
                    
                    static listPoint2D & Append( listPoint2D & toBeAugmented, 
                        const listPoint2D & toAppend ) ;
                        
                        
                        
                    static listPoint2D & Apply( 
                        const Ceylan::Maths::Linear::HomogeneousMatrix3 
                            & transformation,
                        listPoint2D & sourceList ) ;
                        
                    
                    
                    
                private:
            
                
/* 
 * Takes care of the awful issue of Windows DLL with templates.
 *
 * @see Ceylan's developer guide and README-build-for-windows.txt 
 * to understand it, and to be aware of the associated risks. 
 * 
 */
#pragma warning( push )
#pragma warning( disable: 4251 )

                    listPoint2D * _summits ;

#pragma warning( pop ) 
            
                    
                    
                    bool _listOwner ;
                    
                
                
                    explicit Polygon( const Polygon & source ) ;
                    
                    
            
                    Polygon & operator = ( const Polygon & source ) ;

                    
                    
            } ;
            




            class OSDL_DLL PolygonSet: public Ceylan::Locatable2D
            {
            
            
                public:
                
                
                                        
                     explicit PolygonSet( bool listOwner = false ) ;
                     
                     
                     
                    explicit PolygonSet( 
                        std::list<listPoint2D *> & polygonList, 
                        bool listOwner = false ) ;
                    
            
            
                    virtual ~PolygonSet() throw() ;
                    
                    
                    
                    virtual void addPointsOf( Polygon & newPolygon ) ;
                    
                    
                    
                    virtual void addPointList( listPoint2D & listToAdd ) ;
                    
                    
                    
                    virtual bool draw( Surface & targetSurface,
                        Coordinate x, Coordinate y,
                        Pixels::ColorDefinition colorDef = Pixels::White, 
                        bool filled = true ) const ;
    
    
                        
                    virtual const std::string toString( 
                        Ceylan::VerbosityLevels level = Ceylan::high ) const ;
                    
                    
                    
                    
                    // Static section.
                    
                    
                    
                    static PolygonSet & CreateFlake( 
                        Ceylan::Uint8 branchCount = 5, 
                        Length length = 200, Length thickness = 20, 
                        Ceylan::Maths::AngleInDegrees childAngle = 50, 
                        Ceylan::Maths::Ratio branchingHeightRatio = 0.7, 
                        Ceylan::Maths::Ratio scale = 0.3 ) ;
                    
                
                        
                protected:

                
/* 
 * Takes care of the awful issue of Windows DLL with templates.
 *
 * @see Ceylan's developer guide and README-build-for-windows.txt 
 * to understand it, and to be aware of the associated risks. 
 * 
 */
#pragma warning( push )
#pragma warning( disable: 4251 )
                
                    std::list<listPoint2D *> * _polygonList ;
            
#pragma warning( pop ) 

            
            
                    bool _listOwner ;
                    
                    
                    
                    
                private:
                
                
                
                    explicit PolygonSet( const PolygonSet & source ) ;
                    
                    
                    
                    PolygonSet & operator = ( const PolygonSet & source ) ;
                        
                    
            } ; 
                    
                 
        }
        
    }
    
}



#endif // OSDL_POLYGON_H_

---