gls_light_source.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::GlsLightSource 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 _GLS_LIGHT_SOURCE_H
#define _GLS_LIGHT_SOURCE_H

#include "display.h"
#include "gls_color.h"
#include "gls_cpp_lang_support.h"
#include "gls_include.h"

namespace disti
{
/**
    LightType_e
*/
typedef enum
{
    LIGHT_LOCAL,
    LIGHT_INFINITE
} LightType_e;

/**
    Light Source Initializers
*/
typedef enum
{
    GLS_LIGHT_SOURCE_AMBIENT = GLS_LAST_INITIALIZER + 1,
    GLS_LIGHT_SOURCE_DIFFUSE,
    GLS_LIGHT_SOURCE_SPECULAR,
    GLS_LIGHT_SOURCE_SPOT_CUTOFF,
    GLS_LIGHT_SOURCE_SPOT_EXPONENT,
    GLS_LIGHT_SOURCE_CONSTANT_ATTENUATION,
    GLS_LIGHT_SOURCE_LINEAR_ATTENUATION,
    GLS_LIGHT_SOURCE_QUADRATIC_ATTENUATION,
    GLS_LIGHT_SOURCE_LIGHT_TYPE
} GLS_LightSource_Initializers;

#ifdef GLES
// Forward Declaration
class GlsGloFileAttribute;
#endif

/**
  The GlsLightSource class.  Implements Lights as objects
*/
class GlsLightSource : public DisplayObject
{
private:
    /** Disabling the default implicit assignment and copy constructors */
    GlsLightSource& operator=( const GlsLightSource& ) DISTI_SPECIAL_MEM_FUN_DELETE; // = delete
    GlsLightSource( const GlsLightSource& ) DISTI_SPECIAL_MEM_FUN_DELETE;

public:
    DISTI_DEPRECATED( "This identifier is forbidden by the C++ standard. Use BaseClass instead." )
    typedef DisplayObject _BaseClass;
    typedef DisplayObject BaseClass;
    friend class GlsLightSourceEditor;

protected:
    /** NOTE:  _visible determines if the light is on */

    GlsColor    _ambient;              /**< Value for the ambient light component */
    GlsColor    _diffuse;              /**< Value for the diffuse light component */
    GlsColor    _specular;             /**< Value for the ambient light component */
    LightType_e _lightType;            /**< Value for the light type */
    float       _spotCutoff;           /**< Value for the GL_SPOT_CUTOFF glLight() parameter       */
    float       _spotExponent;         /**< Value for the GL_SPOT_EXPONENT glLight() parameter     */
    float       _constantAttenuation;  /**< Value for GL_CONSTANT_ATTENUATION glLight() parameter  */
    float       _linearAttenuation;    /**< Value for GL_LINEAR_ATTENUATION glLight() parameter    */
    float       _quadraticAttenuation; /**< Value for GL_QUADRATIC_ATTENUATION glLight() parameter */

public:
    /* See base class */
    virtual GLS_EXPORT DisplayObject* CloneObject( bool generateNames = false ) DISTI_METHOD_OVERRIDE;

    /** Allocate a (blank) LightSource object */
    GLS_EXPORT GlsLightSource( bool newGlLight = true );

    GLS_EXPORT GlsLightSource( const GlsLightSource& that, const bool generateNames );

    /** Destroy a LightSource object */
    virtual GLS_EXPORT ~GlsLightSource( void );

    virtual GLS_EXPORT void SetAvailableAttributes( unsigned int value ) DISTI_METHOD_OVERRIDE;

    /** Setup the given OpenGL light number with this light's properties */
    virtual GLS_EXPORT void SetupLight( unsigned int light_number, GlsMatrixType* alternateModelMatrix = NULL );

    /* See base class */
    virtual GLS_EXPORT void Draw( void ) DISTI_METHOD_OVERRIDE;

    /* See base class */
    virtual GLS_EXPORT void PreDraw( const OpenGLMatrices& current, Culler& culler ) DISTI_METHOD_OVERRIDE;

    /* See base class */
    virtual GLS_EXPORT void CopyProperties( DisplayObject* src ) DISTI_METHOD_OVERRIDE;

    /** Set the ambient color for this light
      * \param color  The new ambient color
      */
    GLS_EXPORT void SetAmbient( const GlsColor& color );

    /** Set the diffuse color for this light
      * \param color  The new diffuse color
      */
    GLS_EXPORT void SetDiffuse( const GlsColor& color );

    /** Set the specular color for this light
      * \param color  The new specular color
      */
    GLS_EXPORT void SetSpecular( const GlsColor& color );

    /** Get the ambient color for this light
      * \return  The ambient color
      */
    GLS_EXPORT GlsColor GetAmbient();

    /** Get the diffuse color for this light
      * \return  The diffuse color
      */
    GLS_EXPORT GlsColor GetDiffuse();

    /** Get the specular color for this light
      * \return  The specular color
      */
    GLS_EXPORT GlsColor GetSpecular();

    /** Get what type of light this is
      * \return Tye type of light (\sa LightType_e)
      */
    GLS_EXPORT int LightType( void );

    /** Set what type of light this is
      * \param type  The type of light (\sa LightType_e)
      */
    GLS_EXPORT void LightType( int type );

    /** Set the spot cutoff factor
      * \param s New spot cutoff factor
      */
    GLS_EXPORT void SpotCutoff( float s );

    /** Get the spot cutoff factor
      * \return Spot cutoff factor
      */
    GLS_EXPORT float SpotCutoff();

    /** Set the spot exponent
      * \param s New spot exponent
      */
    GLS_EXPORT void SpotExponent( float s );

    /** Get the spot exponent
      * \return Spot exponent
      */
    GLS_EXPORT float SpotExponent();

    /** Set the constant attenuation coefficient
      * \param c New coefficient
      */
    GLS_EXPORT void ConstantAttenuation( float c );

    /** Get the constant attenuation coefficient
      * \return The coefficient
      */
    GLS_EXPORT float ConstantAttenuation();

    /** Set the linear attenuation coefficient
      * \param c New coefficient
      */
    GLS_EXPORT void LinearAttenuation( float c );

    /** Get the linear attenuation coefficient
      * \return The coefficient
      */
    GLS_EXPORT float LinearAttenuation();

    /** Set the quadratic attenuation coefficient
      * \param c New coefficient
      */
    GLS_EXPORT void QuadraticAttenuation( float c );

    /** Get the quadratic attenuation coefficient
      * \return The coefficient
      */
    GLS_EXPORT float QuadraticAttenuation();

#ifdef GLES
    /** Set a single attribute from the GLO file.
     * \param data The attribute to set and its associated data.
     */
    virtual GLS_EXPORT void SetFromGloData( GlsGloFileAttribute& data ) DISTI_METHOD_OVERRIDE;
#endif

    /* See base class */
    virtual GLS_EXPORT bool Hit( float x, float y, float z, float scale, const Vector& directionVector, Vector* collisionPoint ) DISTI_METHOD_OVERRIDE;

    /* See base class */
    virtual GLS_EXPORT void SetValue( int spec, va_list& args ) DISTI_METHOD_OVERRIDE;

#ifndef GLES
    /* See base class */
    virtual GLS_EXPORT InterfaceListType* GetCppInterfaceDescription( InterfaceListType* addToThisList = NULL ) DISTI_METHOD_OVERRIDE;

    /* See base class */
    virtual GLS_EXPORT void GetCppInterfaceDescriptionFree( InterfaceListType* array ) DISTI_METHOD_OVERRIDE;
#endif
};

#define DEF_LIGHT_TYPE LIGHT_INFINITE
/** The DistiAttributeLightTypeEnum class
  */
//template class GLS_EXPORT DistiAttributeEnum<LightType_e>;
class DistiAttributeLightTypeEnum : public DistiAttributeEnum<GlsLightSource, int, int>
{
public:
    GLS_EXPORT DistiAttributeLightTypeEnum( GlsLightSource* frame, SetMethodType setMethod, GetMethodType getMethod, const AttributeName& name );
    virtual GLS_EXPORT ~DistiAttributeLightTypeEnum();
};

} // namespace disti

#endif