component_light_mgr.h

Go to the documentation of this file.

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

#include "dynamic_array.h"
#include "gls_include.h"

namespace disti
{
class GlsLightSource;
class GlsEyePoint;
class DisplayObject;

/** This class is responsible for keeping track of the lights in a component
  * and setting up lighting for the objects of the component.
  */
class ComponentLightMgr
{
protected:
    DynamicArray<GlsLightSource*> _registeredLights; /** List of active lights in the component
                                                        This list is reset and populated during the PreDraw() traversal */

    bool _useParentsLighting; /** If UseParentsLighting is true, the component will add 
                                                        its lights to those already set by it's parent.
                                                        If false, the component will only use it's own lights.*/

    GLS_EXPORT ComponentLightMgr( void );

public:
    static GLS_EXPORT ComponentLightMgr* CreateInstance( void );

    virtual GLS_EXPORT ~ComponentLightMgr( void );

    /** Accessor method to set whether or not to inherit lighting from the component's parent
      * \param useParentsLighting  Whether or not to inherit lighting from the component's parent
      */
    void GLS_EXPORT UseParentsLighting( bool useParentsLighting );

    /** Accessor method to get whether or not to inherit lighting from the component's parent
      * \return  Whether or not to inherit lighting from the component's parent
      */
    bool GLS_EXPORT UseParentsLighting( void );

    /** Sets whether GL_NORMALIZE is enabled.  Default value is true.
     * \param enableNormalize Set GL_NORMALIZE to true or false
     */
    void GLS_EXPORT EnableNormalize( bool enableNormalize );

    /* Accessor method to get whether or not GL_NORMALIZE is enabled
     * \return Whether or not GL_NORMALIZE is enabled
     */
    bool GLS_EXPORT EnableNormalize();

    /** Any light source in the component that wants to be enabled 
      * must call this during PreDraw().
      * \param light  The light to be enabled
      */
    void GLS_EXPORT RegisterLight( GlsLightSource* light );

    /** Called before PreDraw() to clear the light list
      */
    void GLS_EXPORT ClearRegisteredLights( void );

    /** Called by the the parent of the component to initialize lighting prior to drawing the component
      */
    void GLS_EXPORT TopFrameInitialize( void );

    /** Called by the the parent of the component to restore lighting after drawing the component
      */
    void GLS_EXPORT TopFrameRestore( void );

    /** Detemine the OpenGL lighting state for this component and push it
      * onto the global lighting stack (called from DisplayFrame::Draw())
      */
    void GLS_EXPORT SetupComponentLighting( void );

    /** Called at the end of DisplayFrame::Draw() to restore the original lighting state
      */
    void GLS_EXPORT CleanupComponentLighting( void );

    /** Called by lit objects to setup lights
      * \param object The object to setup lighting for
      */
    void GLS_EXPORT SetupLighting( DisplayObject* object );

    /** Called to force all lights to be reapplied based on
      * the modelview specified by the eyePoint.
      * A value of NULL, reapplys the lights with their original
      * modelview.
      */
    void GLS_EXPORT ReapplyLightsForEyePoint( GlsEyePoint* eyePoint );

    /** Sets a flag to cause the lights to be reapplied when the next lit object
      * draws.  This may be necessary for special cases where the OpenGL matrices
      * have changed during a traversel.  This can
      * happen when drawing multiple views of the same
      * geometry.
      */
    void GLS_EXPORT ReapplyLights();

    /** Get a boolean mask of the active lights
      * \return A boolean array with a bitmask of the currently active lights
      */
    GLS_EXPORT bool* GetActiveLightsMask( void );

    /** Get a bitmask of the active lights
      * \return An unsigned integer with each bit representing a light turned on/off
      */
    GLS_EXPORT unsigned int GetActiveLightsBitMask( void );

    /** Get the number of active lights for this component.  Will include parent lights.
      * Really is the max index(+1) of lights that you need to cycle through to have
      * taken all of them into account (in case of holes in the list created by an
      * outside party).
      * \return An integer representing the number of currently active lights
      */
    GLS_EXPORT unsigned int GetNumActiveLights( void );
};

} // namespace disti

#endif