C3DSScene.h

Go to the documentation of this file.

/* +------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)            |
   |                          http://www.mrpt.org/                          |
   |                                                                        |
   | Copyright (c) 2005-2017, Individual contributors, see AUTHORS file     |
   | See: http://www.mrpt.org/Authors - All rights reserved.                |
   | Released under BSD License. See details in http://www.mrpt.org/License |
   +------------------------------------------------------------------------+ */
#ifndef opengl_C3DSScene_H
#define opengl_C3DSScene_H

#include <mrpt/opengl/CRenderizableDisplayList.h>
#include <mrpt/opengl/COpenGLScene.h>
#include <mrpt/utils/CMemoryChunk.h>

namespace mrpt
{
namespace opengl
{
/** This element keeps a set of objects imported from a 3DStudio file (.3ds).
  *  This class uses the opensource library <a
 * href="http://lib3ds.sourceforge.net/" >lib3ds</a> internally.
  *  \sa opengl::COpenGLScene
  * \ingroup mrpt_opengl_grp
  */
class C3DSScene : public CRenderizableDisplayList
{
        DEFINE_SERIALIZABLE(C3DSScene)

   public:
        /** Render child objects.
          */
        void render_dl() const override;

        /** Evaluates the bounding box of this object (including possible children)
         * in the coordinate frame of the object parent. */
        void getBoundingBox(
                mrpt::math::TPoint3D& bb_min,
                mrpt::math::TPoint3D& bb_max) const override;

        /**  Loads a scene from a 3DS file (3D Studio format) into this object, from
         * either plain .3ds format, or in gzip compressed .3ds.gz format.
          *    Previous contents are lost.
          *    If the file ends in ".gz", it'll be automatically decompressed using
         * gzip (see mrpt::compress::zip).
          */
        void loadFrom3DSFile(const std::string& file_name);

        /** Initializes all textures in the scene (See
         * opengl::CTexturedPlane::loadTextureInOpenGL)
          */
        void initializeAllTextures();

        /** Empty the object */
        void clear();

        /** Evaluates the scene at a given animation time
          */
        void evaluateAnimation(double time_anim);

        /** Enables an extra ambient light */
        void enableExtraAmbientLight(bool enable = true)
        {
                m_enable_extra_lighting = enable;
                CRenderizableDisplayList::notifyChange();
        }

        /* Simulation of ray-trace. */
        bool traceRay(const mrpt::poses::CPose3D& o, double& dist) const override;

        /** Default constructor
          */
        C3DSScene();

        /** Private, virtual destructor: only can be deleted from smart pointers */
        virtual ~C3DSScene();

   private:
        /** A container for automatic deletion of lib3ds's scene when the last
         * reference of the smart_ptr's is destroyed.
          */
        struct TImpl3DS
        {
                TImpl3DS();
                ~TImpl3DS();
                /** Lib3dsFile* */
                void* file;
        };

        /** An internal pointer to the lib3ds library's object of type "Lib3dsFile"
          */
        std::shared_ptr<TImpl3DS> m_3dsfile;

        /** Scale of the object */
        // double       m_scale_x,m_scale_y,m_scale_z;
        /** Bounding box */
        mrpt::math::TPoint3D m_bbox_min, m_bbox_max;

        bool m_enable_extra_lighting;

        // float        m_light_cons_attenuation;               //!< OpenGL Light attenuation
        // factor
        // (default=1.0)
        // float        m_light_lin_attenuation;                //!< OpenGL Light attenuation
        // factor
        // (default=0.0)
        // float        m_light_quad_attenuation;               //!< OpenGL Light attenuation
        // factor
        // (default=0.0)
};

}  // end namespace

}  // End of namespace

#endif