Material.h

Go to the documentation of this file.

/*

Copyright (c) 2017, Dr Franck P. Vidal (franck.p.vidal@fpvidal.net),
http://www.fpvidal.net/
All rights reserved.

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

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

2. 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.

3. Neither the name of the Bangor University 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 HOLDER 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.

*/


#ifndef __Material_h
#define __Material_h


//******************************************************************************
//  Include
//******************************************************************************
#ifndef GVXR_CONFIG_H
#include "gVirtualXRay/gVirtualXRayConfig.h"
#endif


//******************************************************************************
//  namespace
//******************************************************************************
namespace gVirtualXRay {


//==============================================================================
//==============================================================================
class Material
//------------------------------------------------------------------------------
{
//******************************************************************************
public:
    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    Material();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    Material(const Material& aMaterial);


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    ~Material();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    Material& operator=(const Material& aMaterial);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setAmbientColour(float aRedChannel,
            float aGreenChannel,
            float aBlueChannel,
            float aAlphaChannel);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setDiffuseColour(float aRedChannel,
            float aGreenChannel,
            float aBlueChannel,
            float aAlphaChannel);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setSpecularColour(float aRedChannel,
            float aGreenChannel,
            float aBlueChannel,
            float aAlphaChannel);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    void setShininess(float aShininessValue);


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    const float* getAmbientColour() const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    const float* getDiffuseColour() const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    const float* getSpecularColour() const;


    //--------------------------------------------------------------------------

    //--------------------------------------------------------------------------
    float getShininess() const;


//******************************************************************************
protected:
    float m_p_ambient_colour[4];


    float m_p_diffuse_colour[4];


    float m_p_specular_colour[4];


    float m_shininess;
};


} // namespace gVirtualXRay


//******************************************************************************
#include "Material.inl"


#endif // __Material_h