CLight.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_CLight_H
#define opengl_CLight_H

#include <mrpt/utils/utils_defs.h>
#include <mrpt/utils/TTypeName.h>

namespace mrpt
{
namespace utils
{
class CStream;
}

namespace opengl
{
/** Each of the possible lights of a 3D scene \sa COpenGLViewport
  * *IMPORTANT NOTE*: It's the user responsibility to define unique light IDs
 * for each light.
  *  The OpenGL standard only assures that valid IDs are 0,1,..7
  * Refer to standard OpenGL literature and tutorials for the meaning of each
 * field.
  */
struct CLight
{
        /** Default constructor, sets default values */
        CLight();

        void setPosition(float x, float y, float z, float w);
        void setDirection(float dx, float dy, float dz);

        /** OpenGL ID (typical range: 0-7) */
        uint8_t light_ID;

        float color_ambient[4];
        float color_diffuse[4];
        float color_specular[4];

        /** [x,y,z,w]: w=0 means directional light, w=1 means a light at a real 3D
         * position. */
        float position[4];
        /** [x,y,z] */
        float direction[3];
        float constant_attenuation;
        float linear_attenuation;
        float quadratic_attenuation;
        float spot_exponent;
        float spot_cutoff;

        void writeToStream(mrpt::utils::CStream& out) const;
        void readFromStream(mrpt::utils::CStream& in);

        /** Define the light in the current OpenGL rendering context (users normally
         * don't need to call this explicitly, it's done from within a \sa
         * COpenGLViewport) */
        void sendToOpenGL() const;
};

mrpt::utils::CStream& operator>>(
        mrpt::utils::CStream& in, mrpt::opengl::CLight& o);
mrpt::utils::CStream& operator<<(
        mrpt::utils::CStream& out, const mrpt::opengl::CLight& o);

}  // end namespace

namespace utils
{
template <>
struct TTypeName<mrpt::opengl::CLight>
{
        static std::string get() { return std::string("mrpt::opengl::CLight"); }
};
}

}  // End of namespace

#endif