material.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::Material class.
 
  \par Copyright Information
 
  Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>
 
  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.
 
  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
 
  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).
 
  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.
 
*/
 
#ifndef INCLUDED_DISTI_MATERIAL_H
#define INCLUDED_DISTI_MATERIAL_H
 
#include "display_types.h"
#include "gls_color.h"
#include "gls_gl.h"
#include "unhide_globals.h"
#include <iosfwd> //Forward references for the stream operators
#include <string>
 
namespace disti
{
/** The Material class
  */
class Material
{
public:
    static GlsColor _ambientDefault;   ///< The ambient value for the default material.
    static GlsColor _diffuseDefault;   ///< The diffuse value for the default material.
    static GlsColor _specularDefault;  ///< The specular value for the default material.
    static GlsColor _emissionDefault;  ///< The emission value for the default material.
    static float    _shininessDefault; ///< The shininess value for the default material.
 
    GlsColor            _ambient;           ///< Ambient component of the material.
    GlsColor            _diffuse;           ///< Diffuse component of the material.
    GlsColor            _specular;          ///< Specular component of the material.
    GlsColor            _emission;          ///< Emission component of the material.
    float               _shininess;         ///< Shininess component of the material.
    bool                _inUse;             ///< True if the material is in use.
    std::string         _name;              ///< String name of the material.
    ColorMaterialMode_e _colorMaterialMode; ///< Color mode to use for this material.
 
    GLS_EXPORT Material();
 
    /// Constructor
    /// \param ambient The ambient component of the material.
    /// \param diffuse The diffuse component of the material.
    /// \param specular The specular component of the material.
    /// \param emission The emission component of the material.
    /// \param shininess The shininess component of the material.
    GLS_EXPORT Material(
        const GlsColor& ambient,
        const GlsColor& diffuse,
        const GlsColor& specular,
        const GlsColor& emission,
        const float&    shininess );
 
    /// Materials are equivalent if all of their parameters are the same.
    /// \param m1 A material to compare.
    /// \param m2 The other material to compare.
    /// \return True if the materials are the same.
    inline static bool MaterialsAreEquivalent( const Material& m1, const Material& m2 )
    {
        return m1._name == m2._name && m1._ambient == m2._ambient && m1._specular == m2._specular && m1._diffuse == m2._diffuse && m1._emission == m2._emission && m1._shininess == m2._shininess;
    }
 
    /** Applies the ambient component of this material to the OpenGL pipeline 
      * \param face Which faces to apply this to (front, back or front and back faces)
      */
    GLS_EXPORT void ApplyAmbient( GLenum face = GL_FRONT_AND_BACK );
 
    /** Applies the diffuse component of this material to the OpenGL pipeline 
      * \param face Which faces to apply this to (front, back or front and back faces)
      */
    GLS_EXPORT void ApplyDiffuse( GLenum face = GL_FRONT_AND_BACK );
 
    /** Applies the specular component of this material to the OpenGL pipeline 
      * \param face Which faces to apply this to (front, back or front and back faces)
      */
    GLS_EXPORT void ApplySpecular( GLenum face = GL_FRONT_AND_BACK );
 
    /** Applies the emission component of this material to the OpenGL pipeline 
      * \param face Which faces to apply this to (front, back or front and back faces)
      */
    GLS_EXPORT void ApplyEmission( GLenum face = GL_FRONT_AND_BACK );
 
    /** Applies the shininess component of this material to the OpenGL pipeline 
      * \param face Which faces to apply this to (front, back or front and back faces)
      */
    GLS_EXPORT void ApplyShininess( GLenum face = GL_FRONT_AND_BACK );
 
    /** Applies all of the components of this material to the OpenGL pipeline 
      * \param face Which faces to apply this to (front, back or front and back faces)
      */
    GLS_EXPORT void ApplyAll( GLenum face = GL_FRONT_AND_BACK );
 
    /** \return True if this material is in use */
    GLS_EXPORT bool InUse() const;
 
    /** Sets whether this material is in use 
      * \param val  Whether this material is in use 
      */
    GLS_EXPORT void InUse( bool val );
 
    /** \return The material name */
    GLS_EXPORT const std::string& Name() const;
 
    /** Sets the material name
      * \param name  The material name
      */
    GLS_EXPORT void Name( const std::string& name );
};
 
/// Equality operator
/// \param rhs An object to compare.
/// \param lhs Another object to compare.
/// \return Whether or not the objects are equal.
GLS_EXPORT bool operator==( const Material& rhs, const Material& lhs );
 
/// Inequality operator
/// \param rhs An object to compare.
/// \param lhs Another object to compare.
/// \return Whether or not the objects are not equal.
GLS_EXPORT bool operator!=( const Material& rhs, const Material& lhs );
 
/// Stream out operator
/// \param outstr The stream to write to.
/// \param mat The value to write to the stream.
/// \return The stream in its current state.
GLS_EXPORT std::ostream& operator<<( std::ostream& outstr, const Material& mat );
 
/// Stream in operator
/// \param instr The stream to read from.
/// \param mat The returned value read from the stream.
/// \return The stream in its current state.
GLS_EXPORT std::istream& operator>>( std::istream& instr, Material& mat );
 
} // namespace disti
 
#endif