TextureCoords.hpp

Go to the documentation of this file.

/*
 * Author: Sven Gothel <sgothel@jausoft.com>
 * Copyright Gothel Software e.K.
 *
 * SPDX-License-Identifier: MIT
 *
 * This Source Code Form is subject to the terms of the MIT License
 * If a copy of the MIT was not distributed with this file,
 * you can obtain one at https://opensource.org/license/mit/.
 */
#ifndef GAMP_RENDER_GL_TEXTURE_TEXTURECOORDS_HPP_
#define GAMP_RENDER_GL_TEXTURE_TEXTURECOORDS_HPP_
 
#include <jau/math/recti.hpp>
#include <jau/string_util.hpp>
 
#include <gamp/GampTypes.hpp>
 
namespace gamp::render::gl::texture {
    /** \addtogroup Gamp_GL
     *
     *  @{
     */
 
    /** Rectangular texture coordinates.
     
        Note that some textures are inherently flipped vertically
        from OpenGL's standard coordinate system. This class takes care of
        this vertical flip so that the "bottom" and "top" coordinates may
        sometimes be reversed. From the point of view of code rendering
        textured polygons, it can always map the bottom and left texture
        coordinates from the TextureCoords to the lower left point of the
        textured polygon and achieve correct results. */    
    class TextureCoords {
      private:
        jau::math::Point2f m_bl; /// <Bottom Left
        jau::math::Point2f m_tr; /// <Top right
        
      public:    
        TextureCoords() noexcept
        : m_bl(), m_tr()                        
        { }
        TextureCoords(float left, float bottom,
                      float right, float top) noexcept
        : m_bl(left, bottom), m_tr(right, top)                        
        { }
        
        TextureCoords(const jau::math::Point2f& bl, const jau::math::Point2f& tr) noexcept
        : m_bl(bl), m_tr(tr)                        
        { }
        
        TextureCoords(const jau::math::Point2i& bl, const jau::math::Point2i& tr) noexcept
        : m_bl(float(bl.x), float(bl.y)), m_tr(float(tr.x), float(tr.y))                        
        { }
        
        /// Returns the bottom-left texture coordinate
        const jau::math::Point2f& bl() const noexcept { return m_bl; }
        /// Returns the top-right texture coordinate
        const jau::math::Point2f& tr() const noexcept { return m_tr; }
    
        std::string toString() const noexcept { return "TexCoord[bl: "+m_bl.toString()+", tr: "+m_tr.toString()+"]"; }
    };
 
    /**@}*/
 
}  // namespace gamp::render::gl
 
#endif /* GAMP_RENDER_GL_TEXTURE_TEXTURECOORDS_HPP_ */