CSetOfTriangles.h

Go to the documentation of this file.

/* +---------------------------------------------------------------------------+
   |          The Mobile Robot Programming Toolkit (MRPT) C++ library          |
   |                                                                           |
   |                   http://mrpt.sourceforge.net/                            |
   |                                                                           |
   |   Copyright (C) 2005-2010  University of Malaga                           |
   |                                                                           |
   |    This software was written by the Machine Perception and Intelligent    |
   |      Robotics Lab, University of Malaga (Spain).                          |
   |    Contact: Jose-Luis Blanco  <jlblanco@ctima.uma.es>                     |
   |                                                                           |
   |  This file is part of the MRPT project.                                   |
   |                                                                           |
   |     MRPT is free software: you can redistribute it and/or modify          |
   |     it under the terms of the GNU General Public License as published by  |
   |     the Free Software Foundation, either version 3 of the License, or     |
   |     (at your option) any later version.                                   |
   |                                                                           |
   |   MRPT 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 General Public License for more details.                          |
   |                                                                           |
   |     You should have received a copy of the GNU General Public License     |
   |     along with MRPT.  If not, see <http://www.gnu.org/licenses/>.         |
   |                                                                           |
   +---------------------------------------------------------------------------+ */
#ifndef opengl_CSetOfTriangles_H
#define opengl_CSetOfTriangles_H

#include <mrpt/opengl/CRenderizable.h>
#include <mrpt/math/geometry.h>

namespace mrpt
{
        namespace opengl
        {
                class MRPTDLLIMPEXP CSetOfTriangles;

                // This must be added to any CSerializable derived class:
                DEFINE_SERIALIZABLE_PRE_CUSTOM_BASE( CSetOfTriangles, CRenderizable )

                /** A set of colored triangles.
                  *  This class can be used to draw any solid, arbitrarily complex object (without textures).
                  *  \sa opengl::COpenGLScene, CSetOfTexturedTriangles
                  */
                class MRPTDLLIMPEXP CSetOfTriangles : public CRenderizable
                {
                        DEFINE_SERIALIZABLE( CSetOfTriangles )
                public:
                        /**
                          * Triangle definition. Each vertex has three spatial coordinates and four color values.
                          */
                        struct MRPTDLLIMPEXP TTriangle
                        {
                                float   x[3],y[3],z[3];
                                float   r[3],g[3],b[3],a[3];
                        };
                        /**
                          * Const iterator type.
                          */
                        typedef std::vector<TTriangle>::const_iterator const_iterator;
                        /**
                          * Const reverse iterator type.
                          */
                        typedef std::vector<TTriangle>::const_reverse_iterator const_reverse_iterator;
                protected:
                        /**
                          * List of triangles.
                          * \sa TTriangle
                          */
                        std::vector<TTriangle>          m_triangles;
                        /**
                          * Transparency enabling.
                          */
                        bool                                            m_enableTransparency;
                        /**
                          * Mutable variable used to check whether polygons need to be recalculated.
                          */
                        mutable bool polygonsUpToDate;
                        /**
                          * Polygon cache.
                          */
                        mutable std::vector<mrpt::math::TPolygonWithPlane> tmpPolygons;
                public:
                        /**
                          * Polygon cache updating.
                          */
                        void updatePolygons() const;
                        /**
                          * Clear this object.
                          */
                        inline void clearTriangles() { m_triangles.clear();polygonsUpToDate=false; }
                        /**
                          * Get triangle count.
                          */
                        inline size_t getTrianglesCount() const { return m_triangles.size(); }
                        /**
                          * Gets the triangle in a given position.
                          */
                        inline void getTriangle(size_t idx, TTriangle &t) const { ASSERT_(idx<m_triangles.size()); t=m_triangles[idx]; }
                        /**
                          * Inserts a triangle into the set.
                          */
                        inline void insertTriangle( const TTriangle &t ) { m_triangles.push_back(t);polygonsUpToDate=false; }
                        /**
                          * Inserts a set of triangles, bounded by iterators, into this set.
                          * \sa insertTriangle
                          */
                        template<class InputIterator> inline void insertTriangles(const InputIterator &begin,const InputIterator &end)  {
                                m_triangles.insert(m_triangles.end(),begin,end);
                                polygonsUpToDate=false;
                        }
                        /**
                          * Inserts an existing CSetOfTriangles into this one.
                          */
                        inline void insertTriangles(const CSetOfTrianglesPtr &p)        {
                                reserve(m_triangles.size()+p->m_triangles.size());
                                m_triangles.insert(m_triangles.end(),p->m_triangles.begin(),p->m_triangles.end());
                                polygonsUpToDate=false;
                        }
                        /**
                          * Reserves memory for certain number of triangles, avoiding multiple memory allocation calls.
                          */
                        inline void reserve(size_t t)   {
                                m_triangles.reserve(t);
                        }

                        /**
                          * Enables or disables transparency.
                          */
                        inline void enableTransparency( bool v )        { m_enableTransparency = v; }
                        /**
                          * Changes the color to all the vertices in each triangle of the set.
                          */
                        virtual void setColor(double R,double G,double B,double A);
                        /**
                          * Changes the color to all the vertices in each triangle of the set.
                          */
                        virtual void setColor(const mrpt::utils::TColorf &c);
                        /**
                          * Changes the red color component to all the vertices in each triangle of the set.
                          */
                        virtual void setColorR(const double r);
                        /**
                          * Changes the green color component to all the vertices in each triangle of the set.
                          */
                        virtual void setColorG(const double g);
                        /**
                          * Changes the blue color component to all the vertices in each triangle of the set.
                          */
                        virtual void setColorB(const double b);
                        /**
                          * Changes the alpha color component to all the vertices in each triangle of the set.
                          */
                        virtual void setColorA(const double a);

                        /** Render
                          */
                        void  render() const;
                        /** Ray tracing
                          */
                        virtual bool traceRay(const mrpt::poses::CPose3D &o,double &dist) const;

                        /**
                          * Gets the polygon cache.
                          */
                        void getPolygons(std::vector<mrpt::math::TPolygon3D> &polys) const;
                        /**
                          * Gets the beginning iterator to this object.
                          */
                        inline const_iterator begin() const     {
                                return m_triangles.begin();
                        }
                        /**
                          * Gets the ending iterator to this object.
                          */
                        inline const_iterator end() const       {
                                return m_triangles.end();
                        }
                        /**
                          * Gets the reverse beginning iterator to this object, which points to the last triangle.
                          */
                        inline const_reverse_iterator rbegin() const    {
                                return m_triangles.rbegin();
                        }
                        /**
                          * Gets the reverse ending iterator to this object, which points to the beginning of the actual set.
                          */
                        inline const_reverse_iterator rend() const      {
                                return m_triangles.rend();
                        }
                private:
                        /** Constructor
                          */
                        CSetOfTriangles( bool enableTransparency = false ) :
                                m_triangles(),
                                m_enableTransparency(enableTransparency),
                                polygonsUpToDate(false)
                        {
                        }

                        /** Private, virtual destructor: only can be deleted from smart pointers */
                        virtual ~CSetOfTriangles() { }
                };
                /** Inserts a set of triangles into the list; note that this method allows to pass another CSetOfTriangles as argument. Allows call chaining.
                  * \sa mrpt::opengl::CSetOfTriangles::insertTriangle
                  */
                template<class T> inline CSetOfTrianglesPtr &operator<<(CSetOfTrianglesPtr &s,const T &t)       {
                        s->insertTriangles(t.begin(),t.end());
                        return s;
                }
                /** Inserts a triangle into the list. Allows call chaining.
                  * \sa mrpt::opengl::CSetOfTriangles::insertTriangle
                  */
                template<> inline CSetOfTrianglesPtr &operator<<(CSetOfTrianglesPtr &s,const CSetOfTriangles::TTriangle &t)     {
                        s->insertTriangle(t);
                        return s;
                }

        } // end namespace

} // End of namespace


#endif