gls_lod_group.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::GlsLodGroup 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 _GlsLodGroup_H
#define _GlsLodGroup_H
 
#include <vector>
 
#include "gls_cpp_lang_support.h"
#include "group.h"
 
/// Provides support for creating DLLs.
#if( defined( GLSGEN_EXPORT_GlsLodGroup ) || defined( GLSGEN_IMPORT_GlsLodGroup ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
    && defined( _MSC_VER )
#    if defined( GLSGEN_EXPORT_GlsLodGroup ) || defined( GLS_EXPORT_GENERATED )
#        define GLSGEN_GlsLodGroup_EXPORT __declspec( dllexport )
#    else
#        define GLSGEN_GlsLodGroup_EXPORT __declspec( dllimport )
#    endif
#else
#    define GLSGEN_GlsLodGroup_EXPORT
#endif
///////////////////////////////////////////////////////////////////////////////
 
/// Automatically link the runtime library plugin (on Windows).
#define LIB_BASE_NAME "gls_lod_group"
#include "gls_auto_lib.h"
#undef LIB_BASE_NAME
 
namespace disti
{
// Forward Declaration
class GlsGloFileAttribute;
 
/// SetValue enumerations
typedef enum
{
    GLS_LOD_GROUP_DISTANCE_RANGE = GLS_LAST_INITIALIZER + 1,
    GLS_LOD_GROUP_LOD_POSITIONS
} GLS_LodGroup_Initializers;
 
/** 
    The GlsLodGroup allows users to set different levels of detail (LOD) for its contents based on how far the group is from the camera.  
    The GlsLodGroup renders a single child, and chooses which child to render based on the distance from the current camera and the values 
    set on each LOD position in the editor.  LODs are only used with perspective cameras.
*/
class GlsLodGroup : public Group
{
public:
    DISTI_DEPRECATED( "This identifier is forbidden by the C++ standard. Use BaseClass instead." )
    typedef Group _BaseClass; ///< Deprecated typedef for the base class.
    typedef Group BaseClass;  ///< Typedef for the base class.
 
    friend class GlsLodGroupEditor;
 
    /** Create a new GlsLodGroup.
      * \param generateInstance  Whether or not to generate an instance name
      * for this inputdevice 
      */
    GLSGEN_GlsLodGroup_EXPORT explicit GlsLodGroup( bool generateInstance = false );
 
    /// Copy constructor
    /// \param that The object to copy from.
    /// \param generateNames Whether or not to generate an instance name.
    GLSGEN_GlsLodGroup_EXPORT GlsLodGroup( const GlsLodGroup& that, const bool generateNames );
 
    /// \return A pointer to a new GlsLodGroup object.
    static GLSGEN_GlsLodGroup_EXPORT DisplayObject* CreateInstance();
 
    /// Unused, kept for backward compatibility.
    /// \param cmd
    /// \param arg
    static GLSGEN_GlsLodGroup_EXPORT void GroupDebugCommand( const char* cmd, const char* arg );
 
    //////////////////////////////////////////////////
    // GlsLodGroup specific operations
    //////////////////////////////////////////////////
 
    /// \return The number of LOD positions defined in this object.
    virtual GLSGEN_GlsLodGroup_EXPORT int NumLods();
 
    /// \return The normalized (0-100) position of the desired LOD index.
    /// \param index The LOD index whose position is to be returned.
    virtual GLSGEN_GlsLodGroup_EXPORT float GetLodPosition( int index );
 
    //////////////////////////////////////////////////
    // Overridden base class methods
    // The base class methods are overridden so that the Group Class methods
    // are not called, generally DisplayObject methods are called, there
    // are a few exceptions.
    //////////////////////////////////////////////////
 
    GLSGEN_GlsLodGroup_EXPORT void Draw() DISTI_METHOD_OVERRIDE;
    GLSGEN_GlsLodGroup_EXPORT void PreDraw( const OpenGLMatrices& parentMatrices, Culler& culler ) DISTI_METHOD_OVERRIDE;
    GLSGEN_GlsLodGroup_EXPORT void SetAvailableAttributes( unsigned int value ) DISTI_METHOD_OVERRIDE;
    GLSGEN_GlsLodGroup_EXPORT void InsertObject( DisplayObject* obj, bool reparent = true, bool recalculateBoundingbox = true, int loc = -1 ) DISTI_METHOD_OVERRIDE;
 
protected:
    GLSGEN_GlsLodGroup_EXPORT void SetValue( int spec, va_list& args ) DISTI_METHOD_OVERRIDE;
 
#ifdef GLES
    /** Set a single attribute from the GLO file.
     * \param data The attribute to set and its associated data.
     */
    GLSGEN_GlsLodGroup_EXPORT void SetFromGloData( GlsGloFileAttribute& data ) DISTI_METHOD_OVERRIDE;
#endif
 
    DynamicArray<float> _lodPositions;  ///< List of LOD distances (0-100) where each state will be shown.
    float               _distanceRange; ///< The distance range to interpolate LOD positions over in logical units.
    int                 _currentState;  ///< The current child index being drawn.
    int                 _previewState;  ///< Editor only: the child index being drawn via object preview.
    float               _previewValue;  ///< Editor only: the preview distance value.
 
private:
    // Disable implicit generated Members
    GlsLodGroup& operator=( const GlsLodGroup& rhs ) DISTI_SPECIAL_MEM_FUN_DELETE;
    GlsLodGroup( const GlsLodGroup& src ) DISTI_SPECIAL_MEM_FUN_DELETE;
};
 
} // namespace disti
 
#endif