SLRectangle.h

Go to the documentation of this file.

/**
 * \file      SLRectangle.h
 * \date      July 2014
 * \authors   Marcus Hudritsch
 * \copyright http://opensource.org/licenses/GPL-3.0
 * \remarks   Please use clangformat to format the code. See more code style on
 *            https://github.com/cpvrlab/SLProject4/wiki/SLProject-Coding-Style
*/
 
#ifndef SLRECTANGLE_H
#define SLRECTANGLE_H
 
#include <SLMesh.h>
 
//-----------------------------------------------------------------------------
/**
 * @brief SLRectangle creates a rectangular mesh with a certain resolution
 * @details The SLRectangle node draws a rectangle with a minimal and a maximal 
 * corner in the x-y-plane. The normal is [0,0,1].
 * @remarks It is important that during instantiation NO OpenGL functions (gl*) 
 * get called because this constructor will be most probably called in a parallel 
 * thread from within an SLScene::registerAssetsToLoad or SLScene::assemble 
 * function. All objects that get rendered have to do their OpenGL initialization 
 * when they are used the first time during rendering in the main thread.
 * For this mesh it means that the objects for OpenGL drawing (_vao, _vaoP,
 * _vaoN, _vaoT and _vaoS) remain unused until the first frame is rendered.
 */
class SLRectangle : public SLMesh
{
public:
    //! ctor for rectangle w. min & max corner
    SLRectangle(SLAssetManager* assetMgr,
                const SLVec2f&  min,
                const SLVec2f&  max,
                SLuint          resX,
                SLuint          resY,
                const SLstring& name = "rectangle mesh",
                SLMaterial*     mat  = nullptr);
 
    //! ctor for rectangle w. min & max corner & tex. coord.
    SLRectangle(SLAssetManager* assetMgr,
                const SLVec2f&  min,
                const SLVec2f&  max,
                const SLVec2f&  uv_min,
                const SLVec2f&  uv_max,
                SLuint          resX,
                SLuint          resY,
                const SLstring& name = "rectangle mesh",
                SLMaterial*     mat  = nullptr);
 
    void buildMesh(SLMaterial* mat);
 
protected:
    SLVec3f _min;    //!< min corner
    SLVec3f _max;    //!< max corner
    SLVec2f _uv_min; //!< min corner tex.coord.
    SLVec2f _uv_max; //!< max corner tex.coord.
    SLuint  _resX;   //!< resolution in x direction
    SLuint  _resY;   //!< resolution in y direction
};
//-----------------------------------------------------------------------------
#endif