gls_map_chart.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::GlsMapChart class.

  \par Copyright Information

  Copyright (c) 2008 The DiSTI Corporation.<br>
  11486 Corporate Blvd; Suite 190<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_GLSMAPCHART_H
#define INCLUDED_GLSMAPCHART_H

#include "display.h"
#include "gls_map_view.h"

#include "gls_map_chart_data_source.h"

//////////////////// Provides support for creating DLLs ////////////////////////
#if( defined( GLSGEN_EXPORT_GLSMAPCHART ) || defined( GLSGEN_IMPORT_GLSMAPCHART ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
    && defined( _MSC_VER )
#    if defined( GLSGEN_EXPORT_GLSMAPCHART ) || defined( GLS_EXPORT_GENERATED )
#        define GLSGEN_GLSMAPCHART_EXPORT __declspec( dllexport )
#    else
#        define GLSGEN_GLSMAPCHART_EXPORT __declspec( dllimport )
#    endif
#else
#    define GLSGEN_GLSMAPCHART_EXPORT
#endif
///////////////////////////////////////////////////////////////////////////////

#define LIB_BASE_NAME "gls_map_toolkit"
#include "gls_auto_lib.h"
#undef LIB_BASE_NAME

namespace disti
{
class MapChartCellMgr;

/** Runtime implementation of a GlsMapChart */
class GlsMapChart : public DisplayObject
{
public:
    DISTI_DEPRECATED( "This identifier is forbidden by the C++ standard. Use BaseClass instead." )
    typedef DisplayObject _BaseClass;
    typedef DisplayObject BaseClass;

    friend class GlsMapChartEditor;

    /** Create a new GlsMapChart.
      * \param generateInstance  Whether or not to generate an instance name
      * for this inputdevice */
    GLSGEN_GLSMAPCHART_EXPORT GlsMapChart( bool generateInstance = false );

    /** Destructs a GlsMapChart object */
    virtual GLSGEN_GLSMAPCHART_EXPORT ~GlsMapChart();

    static GLSGEN_GLSMAPCHART_EXPORT DisplayObject* CreateInstance();

    //////////////////////////////////////////////////
    // Overridden base class methods
    //////////////////////////////////////////////////

    virtual GLSGEN_GLSMAPCHART_EXPORT void SetAvailableAttributes( unsigned int value );
    virtual GLSGEN_GLSMAPCHART_EXPORT DisplayObject* CloneObject( bool generateNames = false );
    virtual GLSGEN_GLSMAPCHART_EXPORT void           CopyProperties( DisplayObject* src );

    virtual GLSGEN_GLSMAPCHART_EXPORT InterfaceListType* GetCppInterfaceDescription( InterfaceListType* addToThisList = NULL );
    virtual GLSGEN_GLSMAPCHART_EXPORT void               GetCppInterfaceDescriptionFree( InterfaceListType* array );

    virtual GLSGEN_GLSMAPCHART_EXPORT void PreDraw( const OpenGLMatrices& parentMatrices, Culler& culler );
    virtual GLSGEN_GLSMAPCHART_EXPORT void Draw( void );

    virtual GLSGEN_GLSMAPCHART_EXPORT DisplayObject* handle( DisplayEvent* ev );

    virtual GLSGEN_GLSMAPCHART_EXPORT void SetValue( int spec, va_list& args );

    //////////////////////////////////////////////////
    // GlsMapChart specific operations
    //////////////////////////////////////////////////

    /** \returns pointer to the GlsMapView that the chart will use for rendering
      * or NULL if not found. */
    inline GlsMapView* GetMapView()
    {
        return GetParentMapView( this );
    }

    /** Set the GlsMapChartDataSource to use for rendering.
      * The creator of the GlsMapChartDataSource instance is responsible for deleting it.
      * \param database Pointer to the GlsMapChartDataSource to use
      */
    virtual void SetDataSource( GlsMapChartDataSource* database );

    /** \returns pointer to the GlsMapChartDataSource this chart is using
      * or NULL if the chart is not using a data source. */
    inline GlsMapChartDataSource* GetDataSource() { return _dataSource; }

    /** If true, the GlsMapChart will display MapChartCells that have not yet loaded
      * using it's own texture settings.
      * Default: false */
    GLSGEN_GLSMAPCHART_EXPORT void ShowLoadingCells( const bool& value );
    /** \return Whether the GlsMapChart will display MapChartCells that have not yet loaded */
    inline bool ShowLoadingCells() { return _showLoadingCells; }

    /** Utility method.
      * Not normally called by user. 
      * May be removed in future releases. */
    bool BindLoadingImage();

protected:
    GlsMapChartDataSource* _dataSource;

    bool _showLoadingCells;

    MapChartCellMgr* _cellMgr;
};

} // namespace disti

#endif