gls_knob.h

Go to the documentation of this file.

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

#include "gls_cpp_lang_support.h"
#include "group.h"

//////////////////// Provides support for creating DLLs ////////////////////////
#if( defined( GLSGEN_EXPORT_GlsKnob ) || defined( GLSGEN_IMPORT_GlsKnob ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
    && defined( _MSC_VER )
#    if defined( GLSGEN_EXPORT_GlsKnob ) || defined( GLS_EXPORT_GENERATED )
#        define GLSGEN_GlsKnob_EXPORT __declspec( dllexport )
#    else
#        define GLSGEN_GlsKnob_EXPORT __declspec( dllimport )
#    endif
#else
#    define GLSGEN_GlsKnob_EXPORT
#endif
///////////////////////////////////////////////////////////////////////////////

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

namespace disti
{
enum
{
    GLS_GLSKNOB_CHANGE_CALLBACK = GLS_LAST_INITIALIZER + 1,
    GLS_GLSKNOB_ANGLERANGE,
    GLS_GLSKNOB_CONTINUOUS,
    GLS_GLSKNOB_POSITIONVAL,
    GLS_GLSKNOB_DETENTPOSITIONS,
    GLS_GLSKNOB_WHICHOBJECT,
    GLS_GLSKNOB_STARTANGLE,
    GLS_GLSKNOB_EMITDETENTVALEVENT,
    GLS_GLSKNOB_EMITPOSITIONVALEVENT,
    GLS_GLSKNOB_EMITLIMITEVENT,
    GLS_GLSKNOB_EMITRELEASEEVENT,
    GLS_GLSKNOB_SHOWDETENTSONLY,
    GLS_GLSKNOB_CLICKSELECTSDETENT
};

/** Runtime implementation of a knob */
class GlsKnob : public Group
{
public:
    friend class GlsKnobEditor;
    typedef Group _BaseClass;

    float               _angleRange; // In degrees
    int                 _numDetents;
    DynamicArray<float> _detentPositions; // Range 0-100
    float               _positionVal;     // Current knob position
    bool                _continuous;
    int                 _whichObject; // The object index in the group to be the knob
    float               _startAngle;  // An angle offset from the begining position
    bool                _emitDetentValEvent;
    bool                _emitPositionValEvent;

    /** Set if object should emit the DeventVal event */
    inline void EmitDetentValEvent( const bool& value );
    /** Get if object should emit the DeventVal event */
    inline bool EmitDetentValEvent() { return _emitDetentValEvent; }

    /** Set if object should emit the PositionVal event */
    inline void EmitPositionValEvent( const bool& value );
    /** Get if object should emit the PositionVal event */
    inline bool EmitPositionValEvent() { return _emitPositionValEvent; }

    /** Set if object should emit the Limit event */
    inline void EmitLimitEvent( const bool& value );
    /** Get if object should emit the Limit event */
    inline bool EmitLimitEvent() { return _emitLimitEvent; }

    /** Set if object should emit the Release event */
    inline void EmitReleaseEvent( const bool& value );
    /** Get if object should emit the Release event */
    inline bool EmitReleaseEvent() { return _emitReleaseEvent; }

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

    GLSGEN_GlsKnob_EXPORT GlsKnob( const GlsKnob& that, const bool generateNames );

    /** Destroy a GlsKnob object */
    virtual GLSGEN_GlsKnob_EXPORT ~GlsKnob();

    static GLSGEN_GlsKnob_EXPORT DisplayObject* CreateInstance();

    virtual GLSGEN_GlsKnob_EXPORT void SetAvailableAttributes( unsigned int value );

    virtual GLSGEN_GlsKnob_EXPORT DisplayObject* CloneObject( bool generateNames = false );

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

    virtual GLSGEN_GlsKnob_EXPORT void Draw( void );

    virtual GLSGEN_GlsKnob_EXPORT void CopyProperties( DisplayObject* src );

#ifndef GLES
    /* See base class */
    virtual GLSGEN_GlsKnob_EXPORT InterfaceListType* GetCppInterfaceDescription( InterfaceListType* addToThisList = NULL );
    /* See base class */
    virtual GLSGEN_GlsKnob_EXPORT void GetCppInterfaceDescriptionFree( InterfaceListType* array );
#endif
    /* See base class */
    virtual GLSGEN_GlsKnob_EXPORT void SetValue( int spec, va_list& args );

    //////////////////////////////////////////////////
    // Knob specific operations
    //////////////////////////////////////////////////
    GLSGEN_GlsKnob_EXPORT DisplayObject* handle( DisplayEvent* ev );

    /** Sets the value of the ShowDetentsOnly property. 
      */
    inline void ShowDetentsOnly( const bool& value ) { _showDetentsOnly = value; }

    /** Returns the value of the ShowDetentsOnly property. 
      */
    inline bool ShowDetentsOnly() { return _showDetentsOnly; }

    /** Sets the value of the ClickSelectsDetent property. 
      */
    inline void ClickSelectsDetent( const bool& value ) { _clickSelectsDetent = value; }

    /** Returns the value of the ClickSelectsDetent property. 
      */
    inline bool ClickSelectsDetent() { return _clickSelectsDetent; }

    /** Moves the knob to the specified detent
      * Sets the detent value 
      * \param value Desired detent, first detent == 1
      */
    virtual GLSGEN_GlsKnob_EXPORT void DetentVal( const int& value );

    /** Returns the nearest detent for the knob's current poistion.
      * \return Nearest detent, first detent == 1
      */
    virtual GLSGEN_GlsKnob_EXPORT int DetentVal();

    /** Sets current position of the knob (0.0 - 100.0)
      * \param value New position of the knob (0.0 - 100.0)
      */
    virtual GLSGEN_GlsKnob_EXPORT void PositionVal( const float& value );

    /** Returns the current position of the knob (0.0 - 100.0)
      * \return Current knob position (0.0 - 100.0)
      */
    virtual GLSGEN_GlsKnob_EXPORT float PositionVal();

    /** Sets the current knob geometry index value
      * \param value Knob geometry index value
      */
    virtual GLSGEN_GlsKnob_EXPORT void WhichObject( const int& value );

    /** Returns the current knob geometry index value
      * \return Knob geometry index value
      */
    virtual GLSGEN_GlsKnob_EXPORT int WhichObject();

protected:
    bool _showDetentsOnly;
    bool _clickSelectsDetent;

    bool _emitLimitEvent;
    bool _emitReleaseEvent;

    // Some private data for internal calculations
    int    _initialDetentVal;
    float  _mouseDownoX, _mouseDownoY, _mouseDownoZ;
    Vector _mouseDownDirectionVector;
    float  _mouseDownAngle;
    float  _mouseLastAngle;
    bool   _atCwStop;
    bool   _atCcwStop;

    bool                        _sideMode;
    GLSGEN_GlsKnob_EXPORT float CalcRotationAngle();

    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 GLS_EXPORT void SetFromGloData( GlsGloFileAttribute& data );
#endif

private:
    // disallow implicit assignments and copy constructor
    GlsKnob& operator=( const GlsKnob& ) DISTI_SPECIAL_MEM_FUN_DELETE;
    GlsKnob( const GlsKnob& ) DISTI_SPECIAL_MEM_FUN_DELETE;
};

} // namespace disti

#endif