OSDLGLUprightRectangle.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_UPRIGHT_RECTANGLE_GL_H_
#define OSDL_UPRIGHT_RECTANGLE_GL_H_



#include "OSDLOpenGL.h"        // for GLLength, GLCoordinate, etc.
#include "OSDLPixel.h"         // for ColorElement

#include "Ceylan.h"            // for Bipoint


#include <iostream>           // for ostream
#include <string>



namespace Ceylan 
{


    namespace Maths 
    {
    
    
        namespace Linear 
        {


            // UprightRectangleGL can be defined thanks to Bipoint instances.
            class Bipoint ;
        
        
        }
    
    }
    
    
}       
        



namespace OSDL 
{


    namespace Video 
    {
        
        
        
        // UprightRectangleGL instances can be drawn into surfaces.
        class Surface ;
        
        
        
        namespace TwoDimensional
        {
        
        
        
            
            class OSDL_DLL  UprightRectangleGL : 
                public Ceylan::TextDisplayable
            {
            
                    
                /*
                 * No equality operator defined, since relying on 
                 * floating point values.
                 *
                 */
                        
                        
                public:


                    UprightRectangleGL( 
                        const Ceylan::Maths::Linear::Bipoint & upperLeftCorner,
                        const Ceylan::Maths::Linear::Bipoint & lowerRightCorner
                    ) ;
                    
                    
                    
                    UprightRectangleGL( 
                        const Ceylan::Maths::Linear::Bipoint & upperLeftCorner, 
                        OpenGL::GLLength width, OpenGL::GLLength height ) ;
                    
                    
                    
                    UprightRectangleGL( 
                        OpenGL::GLCoordinate x, OpenGL::GLCoordinate y,
                        OpenGL::GLLength width, OpenGL::GLLength height ) ;
                     
                    
                     
                    virtual ~UprightRectangleGL() throw() ;
    
    
    
                    virtual Ceylan::Maths::Linear::Bipoint 
                        getUpperLeftCorner() const ; 
                    
                    
                    
                    virtual void setUpperLeftCorner( 
                        Ceylan::Maths::Linear::Bipoint & newUpperLeftCorner ) ; 
                    
                    
                    
                    virtual OpenGL::GLCoordinate getUpperLeftAbscissa() const ;


                    virtual OpenGL::GLCoordinate getUpperLeftOrdinate() const ;
                    
                    
                    
                    
                    virtual OpenGL::GLLength getWidth() const ;
                
                
                    virtual void setWidth( OpenGL::GLLength newWidth ) ;
    
    
    
    
                    virtual OpenGL::GLLength getHeight() const ;
                
                
                    virtual void setHeight( OpenGL::GLLength newHeight ) ;
                        
    
    
                    virtual bool draw() const ;
                    
                    
                    
                    virtual const std::string toString( 
                        Ceylan::VerbosityLevels level = Ceylan::high ) const ;
                
                
    
    
                protected:
                
                
                
                    OpenGL::GLCoordinate _x ;
                
                
                
                    OpenGL::GLCoordinate _y ;
                
                
                
                
                    OpenGL::GLLength _width ;
                
                
                
                    OpenGL::GLLength _height ;          
            
            
            
            
                private:
                
                
                
                    explicit UprightRectangleGL( 
                        const UprightRectangleGL & source ) ;
            
            
                    UprightRectangleGL & operator = ( 
                        const UprightRectangleGL & source ) ;
    
    
            } ; 


        }
        
    }
    
}

    

OSDL_DLL std::ostream & operator << ( std::ostream & os, 
    OSDL::Video::TwoDimensional::UprightRectangleGL & rect ) ;



#endif // OSDL_UPRIGHT_RECTANGLE_GL_H_

---