gls_advanced_mesh.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::GlsAdvancedMesh 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_GLS_ADVANCED_MESH_H
#define INCLUDED_GLS_ADVANCED_MESH_H
 
#ifdef _WIN32
#    include <windows.h>
#endif
 
#include "gls_geometry_resource.h"
#include "gls_geometry_resource_mesh.h"
#include "gls_render_effect.h"
#include "gls_resource_file_mgr.h"
 
/// Provides support for creating DLLs.
#if( defined( GLSGEN_EXPORT_GLSADVANCEDMESH ) || defined( GLSGEN_IMPORT_GLSADVANCEDMESH ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
    && defined( _MSC_VER )
#    if defined( GLSGEN_EXPORT_GLSADVANCEDMESH ) || defined( GLS_EXPORT_GENERATED )
#        define GLSGEN_GlsAdvancedMesh_EXPORT __declspec( dllexport )
#    else
#        define GLSGEN_GlsAdvancedMesh_EXPORT __declspec( dllimport )
#    endif
#else
#    define GLSGEN_GlsAdvancedMesh_EXPORT
#endif
///////////////////////////////////////////////////////////////////////////////
 
/// Automatically link the runtime library plugin (on Windows).
#define LIB_BASE_NAME "gls_advanced_mesh"
#include "gls_auto_lib.h"
#undef LIB_BASE_NAME
 
namespace disti
{
#ifdef GLES
class GlsGloFileAttribute;
#endif
class GlsResourceFileMgr;
 
/// \details The GlsAdvancedMesh class. Implementation for high performance 3D models.
class GlsAdvancedMesh : public GlsGeometryResourceMesh
{
public:
    DISTI_DEPRECATED( "This identifier is forbidden by the C++ standard. Use BaseClass instead." )
    typedef GlsGeometryResourceMesh _BaseClass; ///< Deprecated typedef for the base class.
    typedef GlsGeometryResourceMesh BaseClass;  ///< Typedef for the base class.
    friend class GlsAdvancedMeshEditor;
 
    /** Create a new GlsAdvancedMesh. */
    GLSGEN_GlsAdvancedMesh_EXPORT GlsAdvancedMesh();
 
    /** Create a new GlsAdvancedMesh. 
        \param type The type of Resource to create.
    */
    GLSGEN_GlsAdvancedMesh_EXPORT GlsAdvancedMesh( const GlsGeometryResource::TypeDesc& type );
 
    /**
        \param resource A pointer to a resource that this Mesh will link to
        \pre resource must be valid
        \post the resource interest count will be incremented.
    */
    GLSGEN_GlsAdvancedMesh_EXPORT GlsAdvancedMesh( GlsGeometryResource* resource );
 
    /**
     * Create from a resource id and reference to a resource manager
     * \param resourceMgr - resource manager
     * \param resourceId - the string identifier of the resource
     */
    GLSGEN_GlsAdvancedMesh_EXPORT GlsAdvancedMesh( GlsResourceFileMgr& resourceMgr, const char* resourceId );
 
    /** Copy constructor for GlsAdvancedMesh
     * \param that          The GlsAdvancedMesh to be copied from
     * \param generateNames Whether or not to generate a new instance name
     */
    GLSGEN_GlsAdvancedMesh_EXPORT GlsAdvancedMesh( const GlsAdvancedMesh& that, const bool generateNames );
 
    /** Destructs a GlsAdvancedMesh object */
    virtual GLSGEN_GlsAdvancedMesh_EXPORT ~GlsAdvancedMesh();
 
    /// \return A pointer to a new GlsAdvancedMesh object.
    static GLSGEN_GlsAdvancedMesh_EXPORT DisplayObject* CreateInstance();
 
    //////////////////////////////////////////////////
    // Overridden base class methods
    //////////////////////////////////////////////////
 
    virtual GLSGEN_GlsAdvancedMesh_EXPORT void SetAvailableAttributes( unsigned int value ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GlsAdvancedMesh_EXPORT DisplayObject* CloneObject( bool generateNames = false ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GlsAdvancedMesh_EXPORT void           CopyProperties( DisplayObject* src ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GlsAdvancedMesh_EXPORT void           CopyGeometry( DisplayObject* src ) DISTI_METHOD_OVERRIDE;
 
#ifndef GLES
    virtual GLSGEN_GlsAdvancedMesh_EXPORT InterfaceListType* GetCppInterfaceDescription( InterfaceListType* addToThisList = NULL ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GlsAdvancedMesh_EXPORT void               GetCppInterfaceDescriptionFree( InterfaceListType* array ) DISTI_METHOD_OVERRIDE;
#endif
 
    virtual GLSGEN_GlsAdvancedMesh_EXPORT void PreDraw( const OpenGLMatrices& parentMatrices, Culler& culler ) DISTI_METHOD_OVERRIDE;
 
    //////////////////////////////////////////////////
    // GlsAdvancedMesh specific operations
    //////////////////////////////////////////////////
 
    /**
        Grab a pointer to the Resource.  We do not copy the resource, we now
        have at least two AdvancedMeshs that have interest in the same Geometry.
        \param value a valid GeometryResource object
        \pre
        \post  Interest in any previous geometry is decremented
               Interest in this new geometry in incremented
    */
    GLSGEN_GlsAdvancedMesh_EXPORT void SetGeometryResource( GlsGeometryResource* value );
 
    /**
        NOTE: THIS METHOD WAS RENAMED FROM GetGlsGeometryResource() BECAUSE THE INTERFACE CHANGED.
        THE METHOD NO LONGER IMPLICITLY CALLS IncrementReference() SO THE CALLER SHOULD NOT
        CALL DecrementReference() ANYMORE.
 
        The the GlsGeometryResource for this mesh.
 
        \return a pointer to the Geometry Resource
        \pre _geometryResource must be allocated
 
        NOTE: SEE COMMENTS ABOVE!!! */
    inline GlsGeometryResource* GetGeometryResource()
    {
        return _geometryResource;
    }
 
protected:
    // GlsGeometryResourceMesh override
    virtual GLSGEN_GlsAdvancedMesh_EXPORT GlsGeometryResource* GetRenderMesh() DISTI_METHOD_OVERRIDE;
 
#ifdef GLES
    /** Set a single attribute from the GLO file.
     * \param data The attribute to set and its associated data.
     */
    virtual GLSGEN_GlsAdvancedMesh_EXPORT void SetFromGloData( GlsGloFileAttribute& data ) DISTI_METHOD_OVERRIDE;
#endif
 
    Vector _lastGeometryBoundingVolumeCenter; ///< Center location stored for culling.
    float  _lastGeometryBoundingVolumeRadius; ///< 3D bounding volume stored for culling.
 
    /**
        Access shall be through the GetGlsGeometryResource method
    */
    GlsGeometryResource* _geometryResource;
};
 
} // namespace disti
 
#endif