CTexture1d.h

Go to the documentation of this file.

//==============================================================================
/*
    Software License Agreement (BSD License)
    Copyright (c) 2003-2016, CHAI3D.
    (www.chai3d.org)

    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:

    * Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above
    copyright notice, this list of conditions and the following
    disclaimer in the documentation and/or other materials provided
    with the distribution.

    * Neither the name of CHAI3D nor the names of its contributors may
    be used to endorse or promote products derived from this software
    without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE. 

    \author    <http://www.chai3d.org>
    \author    Francois Conti
    \version   3.2.0 $Rev: 2159 $
*/
//==============================================================================

//------------------------------------------------------------------------------
#ifndef CTexture1dH
#define CTexture1dH
//------------------------------------------------------------------------------
#include "graphics/CColor.h"
#include "graphics/CImage.h"
#include "materials/CGenericTexture.h"
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
namespace chai3d {
//------------------------------------------------------------------------------

//==============================================================================
//==============================================================================

//------------------------------------------------------------------------------
class cTexture1d;
typedef std::shared_ptr<cTexture1d> cTexture1dPtr;
//------------------------------------------------------------------------------

//==============================================================================
//==============================================================================
class cTexture1d : public cGenericTexture
{
    //--------------------------------------------------------------------------
    // CONSTRUCTOR & DESTRUCTOR:
    //--------------------------------------------------------------------------

public:

    cTexture1d();

    virtual ~cTexture1d();

    static cTexture1dPtr create() { return (std::make_shared<cTexture1d>()); }


    //--------------------------------------------------------------------------
    // PUBLIC METHODS:
    //--------------------------------------------------------------------------

public:

    inline void setTextureUnit(const GLenum a_textureUnit) { m_textureUnit = a_textureUnit; }

    inline GLenum getTextureUnit() const { return (m_textureUnit); }

    void setTextureId(const GLuint a_textureId) { m_textureID = a_textureId; }

    GLuint getTextureId() { return(m_textureID); }

    cTexture1dPtr copy();

    virtual bool loadFromFile(const std::string& a_fileName);

    virtual bool saveToFile(const std::string& a_fileName);

    virtual void renderInitialize(cRenderOptions& a_options);

    virtual void renderFinalize(cRenderOptions& a_options);

    virtual void markForUpdate();

    virtual void markForDeleteAndUpdate();

    void setEnvironmentMode(const GLint& a_environmentMode) { m_environmentMode = a_environmentMode; }

    GLint getEnvironmentMode() { return (m_environmentMode); }

    virtual void setWrapModeS(const GLint& a_wrapModeS);

    GLint getWrapModeS() const { return (m_wrapModeS); }

    void setMagFunction(const GLint a_magFunction);

    GLint getMagFunction() const { return (m_magFunction); }

    void setMinFunction(const GLint a_minFunction);

    GLint getMinFunction() const { return (m_minFunction); }

    void setSphericalMappingEnabled(const bool a_enabled) { m_useSphericalMapping = a_enabled; }

    bool getSphericalMappingEnabled() const { return (m_useSphericalMapping); }

    void setUseMipmaps(bool a_useMipmaps);

    bool getUseMipmaps() { return (m_useMipmaps); }

    bool setImage (cImagePtr a_image);


    //--------------------------------------------------------------------------
    // PUBLIC METHODS:
    //--------------------------------------------------------------------------

public:

    cImagePtr m_image;

    cColorf m_color;


    //--------------------------------------------------------------------------
    // PROTECTED METHODS:
    //--------------------------------------------------------------------------

protected:

    virtual void reset();

    virtual void update(cRenderOptions& a_options);


    //--------------------------------------------------------------------------
    // PROTECTED MEMBERS:
    //--------------------------------------------------------------------------

protected:

    bool m_deleteTextureFlag;

    bool m_updateTextureFlag;

    GLuint m_textureID;

    GLint m_wrapModeS;

    GLint m_magFunction;

    GLint m_minFunction;

    bool m_useMipmaps;

    bool m_useSphericalMapping;

    GLint m_environmentMode;

    GLenum m_textureUnit;

    GLint m_magFunctionMipmapsOFF;

    GLint m_minFunctionMipmapsOFF;

    GLint m_magFunctionMipmapsON;

    GLint m_minFunctionMipmapsON;
};

//------------------------------------------------------------------------------
} // namespace chai3d
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
#endif
//------------------------------------------------------------------------------