OSDLPoint3D.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_POINT_3D_H_
#define OSDL_POINT_3D_H_


#include "OSDLPoint.h"        // for inheritance
#include "OSDLVideoTypes.h"   // for Coordinate

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

#include <string>
#include <list>




namespace OSDL
{


    
    namespace Video
    {
    
    
    
        namespace TwoDimensional
        {
        
        
        
        
            class OSDL_DLL Point3D : public Point
            {



                public:
    
        
                    Point3D( Coordinate x, Coordinate y, Coordinate z ) ;



                    Point3D( const Point3D & source ) ;
                    
                    
                    
                    explicit Point3D( 
                        const Ceylan::Maths::Linear::Vector3 & source ) ;
                    
                    
                     
                    Point3D( 
                        FloatingPointCoordinate x, 
                        FloatingPointCoordinate y,
                        FloatingPointCoordinate z ) ;



                    virtual ~Point3D() throw() ;
    
    
    
                    virtual void setFrom( const Point3D & source ) ;
                    
                    
        
                    virtual void setFrom( 
                        const Ceylan::Maths::Linear::Vector3 & source ) ;
                    
                    
                    
                    inline Coordinate getX() const ;
                    
                    
                    inline void setX( Coordinate newX ) ;
    
    
    
                    inline Coordinate getY() const;
                    
                    
                    inline void setY( Coordinate newY ) ;



                    inline Coordinate getZ() const;
                    
                    
                    inline void setZ( Coordinate newY ) ;



                    void translate( Offset x, Offset y, Offset z ) ;
                    
                    
                    
                    virtual void flip() ;
                    
                    
                    
                    void flipX() ;
                    
                    
                    void flipY() ;
                    
                    
                    void flipZ() ;
                    
                    
                    
                    virtual const std::string toString( 
                        Ceylan::VerbosityLevels level = Ceylan::high ) const ;
                        




                    // Static section.
    
    
    
                    static const Point3D Origin ;



                    static void Translate( std::list<Point3D *> & pointList, 
                        Offset x, Offset y, Offset z ) ;
                    
                    
                    
                    static const Ceylan::Maths::Linear::MatrixIndex Dimensions 
                        = 3 ;




                protected:
    
    
    
                    Coordinate _coord[ Dimensions ] ;
                    
                    

            } ;
    
    
    
    
            // Inline section.
            
            
            
            Coordinate Point3D::getX() const
            {
            
                return _coord[0] ;
                
            }
    
    
    
            void Point3D::setX( Coordinate newX )
            {
            
                _coord[0] = newX ;
                
            }
    
    
    
    
            Coordinate Point3D::getY() const
            {
            
                return _coord[1] ;
                
            }
    
    
    
            void Point3D::setY( Coordinate newY )
            {
                _coord[1] = newY ;
            }
            
            
            
            
            Coordinate Point3D::getZ() const
            {
            
                return _coord[2] ;
                
            }
            
            
    
            void Point3D::setZ( Coordinate newZ )
            {
            
                _coord[2] = newZ ;
                
            }
            
            
            
        }

    }
    
}



OSDL_DLL std::ostream & operator << ( std::ostream & os, 
    const OSDL::Video::TwoDimensional::Point3D & p ) ;



#endif // OSDL_POINT_3D_H_

---