gls_thumb_wheel.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::GlsThumbWheel 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_THUMBWHEEL_H
#define INCLUDED_GLS_THUMBWHEEL_H

#include "gls_odometer.h" // Needed to autolink the odometer lib
#include "glsutil.h"
#include "group.h"

//////////////////// Provides support for creating DLLs ////////////////////////
#if( defined( GLSGEN_EXPORT_GLSTHUMBWHEEL ) || defined( GLSGEN_IMPORT_GLSTHUMBWHEEL ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
    && defined( _MSC_VER )
#    if defined( GLSGEN_EXPORT_GLSTHUMBWHEEL ) || defined( GLS_EXPORT_GENERATED )
#        define GLSGEN_GLSTHUMBWHEEL_EXPORT __declspec( dllexport )
#    else
#        define GLSGEN_GLSTHUMBWHEEL_EXPORT __declspec( dllimport )
#    endif
#else
#    define GLSGEN_GLSTHUMBWHEEL_EXPORT
#endif
///////////////////////////////////////////////////////////////////////////////

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

namespace disti
{
// SetValue enumerations
// enums for metadata attributes
enum
{
    GLS_GLSTHUMBWHEEL_INITIAL_VAL = GLS_LAST_INITIALIZER + 1,
    GLS_GLSTHUMBWHEEL_EMIT_DETENT_VAL_EVENT,
    GLS_GLSTHUMBWHEEL_EMIT_LIMIT_EVENT,
    GLS_GLSTHUMBWHEEL_EMIT_RELEASE_EVENT,
    GLS_GLSTHUMBWHEEL_NUMBER_OF_DETENTS,
    GLS_GLSTHUMBWHEEL_CONTINUOUS_DRAG,
    GLS_GLSTHUMBWHEEL_DETENT_VAL,
    GLS_GLSTHUMBWHEEL_WHICH_OBJECT_THUMBWHEEL,
    GLS_GLSTHUMBWHEEL_WHICH_OBJECT_ODOMETER,
    GLS_GLSTHUMBWHEEL_SOUND_INDEX
};

/** Runtime implementation of a GlsThumbWheel */
class GlsThumbWheel : public Group
{
    friend class GlsThumbWheelEditor;

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

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

    /** Copy construct a new GlsThumbWheel object
      * \param thumbwheel       The thumbwheel to be cloned
      * \param generateNames    Whether or not to generate a new instance name
      */
    GLSGEN_GLSTHUMBWHEEL_EXPORT GlsThumbWheel( const GlsThumbWheel& thumbwheel, const bool generateNames );

    /** Destructs a GlsThumbWheel object */
    virtual GLSGEN_GLSTHUMBWHEEL_EXPORT ~GlsThumbWheel();

    static GLSGEN_GLSTHUMBWHEEL_EXPORT DisplayObject* CreateInstance();

    virtual GLSGEN_GLSTHUMBWHEEL_EXPORT void SetAvailableAttributes( unsigned int value ) DISTI_METHOD_OVERRIDE;

    virtual GLSGEN_GLSTHUMBWHEEL_EXPORT DisplayObject* CloneObject( bool generateNames = false ) DISTI_METHOD_OVERRIDE;

    virtual GLSGEN_GLSTHUMBWHEEL_EXPORT void CopyProperties( DisplayObject* src ) DISTI_METHOD_OVERRIDE;

#ifndef GLES
    virtual GLSGEN_GLSTHUMBWHEEL_EXPORT InterfaceListType* GetCppInterfaceDescription( InterfaceListType* addToThisList = NULL ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSTHUMBWHEEL_EXPORT void               GetCppInterfaceDescriptionFree( InterfaceListType* array ) DISTI_METHOD_OVERRIDE;
#endif

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

    virtual GLSGEN_GLSTHUMBWHEEL_EXPORT DisplayObject* handle( DisplayEvent* ev ) DISTI_METHOD_OVERRIDE;

    /** Calculates if this switch is horizontal or vertical relative to the y axis */
    InputOrientationEnum InputType( void );

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

    //////////////////////////////////////////////////
    // GlsThumbWheel specific operations
    //////////////////////////////////////////////////

    /** Sets current detent of the thumbwheel
      * \param val New detent of the thumbwheel
      */
    GLSGEN_GLSTHUMBWHEEL_EXPORT void DetentVal( const int& val );

    /** Returns the current detent of the thumbwheel
      * \return Current thumbwheel detent
      */
    GLSGEN_GLSTHUMBWHEEL_EXPORT int DetentVal();

    /** Sets current odometer index
      * \param val New current odometer index
      */
    GLSGEN_GLSTHUMBWHEEL_EXPORT void IndexVal( const int& val );

    /** Returns current odometer index
      * \return Current odometer index
      */
    GLSGEN_GLSTHUMBWHEEL_EXPORT int IndexVal();

    /** Sets group index for the selected odometer
      * \param val New group index for the selected odometer
      */
    GLSGEN_GLSTHUMBWHEEL_EXPORT void WhichObjectOdometer( const int& val );

    /** Returns the group index for the selected odometer
      * \return group index for the selected odometer
      */
    GLSGEN_GLSTHUMBWHEEL_EXPORT int WhichObjectOdometer();

    /** Sets group index for the selected ThumbWheel geometry
      * \param val New group index for the selected ThumbWheel geometry
      */
    GLSGEN_GLSTHUMBWHEEL_EXPORT void WhichObjectThumbWheel( const int& val );

    /** Returns the group index for the selected ThumbWheel geometry
      * \return group index for the selected ThumbWheel geometry
      */
    GLSGEN_GLSTHUMBWHEEL_EXPORT int WhichObjectThumbWheel();

    /* See base class */
    virtual GLSGEN_GLSTHUMBWHEEL_EXPORT DisplayObject* Pick3D( const Vector& winLoc,
        const Vector&                                                        logicalCoords,
        float                                                                scale,
        const Vector&                                                        directionVector,
        Vector&                                                              collisionWinLoc /*Returned*/,
        const OpenGLMatrices&                                                drawnMatrices ) DISTI_METHOD_OVERRIDE;

protected:
    // plugin class attributes
    bool _emitDetentValEvent;
    bool _emitLimitEvent; // whether or not to emit limit events - when start or end is reached
    bool _emitReleaseEvent;
    int  _detentVal; // range: 1 to _numberOfDetents            (the detent of the thumbwheel)
    int  _indexVal;  // range: 0 to _numberOfDetents - 1        (the index of the odometer)
    int  _initialVal;
    int  _numberOfDetents;
    int  _soundIndex;            // index into the list of sounds
    bool _continuousDrag;        // if true, the wheel will wrap around when limit is reached
    int  _whichObjectThumbWheel; // The object index in the group to be the thumbwheel
    int  _whichObjectOdometer;   // The object index in the group to be the odometer (if there is one)

    int _browserIndexThumbWheel; // need to keep track of browser Index for use in ShowProperties()
    int _browserIndexOdometer;   // need to keep track of browser Index for use in ShowProperties()

    bool         _initialized;
    bool         _mouseWasDown;
    unsigned int _currentCursor; // the current cursor used for interaction.  Any other cursors are ignored while interacting.

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

} // namespace disti

#endif