gls_button.h

Go to the documentation of this file.

/*! \file
  \brief  The GlsPushButton runtime 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_BUTTON_H
#define INCLUDED_GLS_BUTTON_H

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

//////////////////// Provides support for creating DLLs ////////////////////////
#if( defined( GLSGEN_EXPORT_GlsPushButton ) || defined( GLSGEN_IMPORT_GlsPushButton ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
    && defined( _MSC_VER )
#    if defined( GLSGEN_EXPORT_GlsPushButton ) || defined( GLS_EXPORT_GENERATED )
#        define GLSGEN_GlsPushButton_EXPORT __declspec( dllexport )
#    else
#        define GLSGEN_GlsPushButton_EXPORT __declspec( dllimport )
#    endif
#else
#    define GLSGEN_GlsPushButton_EXPORT
#endif
///////////////////////////////////////////////////////////////////////////////

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

namespace disti
{
enum
{
    GLS_GLSBUTTON_CHANGE_CALLBACK = GLS_LAST_INITIALIZER + 1,
    GLS_GLSBUTTON_TOGGLE,
    GLS_GLSBUTTON_WHICH_OBJ_POS_UP,
    GLS_GLSBUTTON_WHICH_OBJ_POS_DOWN,
    GLS_GLSBUTTON_STATE,
    GLS_GLSBUTTON_EMIT_STATE_CHANGE_EVENT
};

/** Runtime implementation of a push button */
class GlsPushButton : public Group
{
private:
    GlsPushButton& operator=( const GlsPushButton& ) DISTI_SPECIAL_MEM_FUN_DELETE;
    GlsPushButton( const GlsPushButton& ) DISTI_SPECIAL_MEM_FUN_DELETE;

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

    /* See base class */
    GLSGEN_GlsPushButton_EXPORT void SetValue( int spec, va_list& args ) DISTI_METHOD_OVERRIDE;

    bool _toggle;             // The push button behavior (true=toggle, false=momentary)
    int  _whichObjectPosUp;   // The object index to be the button up position
    int  _whichObjectPosDown; // The object index to be the button down position
    int  _state;              // The button state: 0=up, 1=down
    bool _emitStateChangeEvent;

    bool         _mouseIsDown;   // True when the mouse has been pushed down on this button
    unsigned int _currentCursor; // the current cursor used for interaction.  Any other cursors are ignored while interacting.

    friend class GlsPushButtonEditor;

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

    GLSGEN_GlsPushButton_EXPORT GlsPushButton( const GlsPushButton& that, const bool generateNames );

    /** Destroy a GlsPushButton object */
    virtual GLSGEN_GlsPushButton_EXPORT ~GlsPushButton();

    static GLSGEN_GlsPushButton_EXPORT DisplayObject* CreateInstance();

    virtual GLSGEN_GlsPushButton_EXPORT void SetAvailableAttributes( unsigned int value ) DISTI_METHOD_OVERRIDE;

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

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

    virtual GLSGEN_GlsPushButton_EXPORT void Draw( void ) DISTI_METHOD_OVERRIDE;

    virtual GLSGEN_GlsPushButton_EXPORT void CopyProperties( DisplayObject* src ) DISTI_METHOD_OVERRIDE;

    /** Sets the child index that represents the up state of the button
          * \param which New child index for the up state
          */
    virtual GLSGEN_GlsPushButton_EXPORT void WhichObjectPosUp( int which );

    /** Returns the child index that represents the up state of the button
          * \return Current child index for the up state
          */
    virtual GLSGEN_GlsPushButton_EXPORT int WhichObjectPosUp( void ) const;

    /** Sets the child index that represents the down state of the button
          * \param state New child index for the down state
          */
    virtual GLSGEN_GlsPushButton_EXPORT void WhichObjectPosDown( int which );

    /** Returns the index that represents the down state of the button
          * \return Current child index for the down state
          */
    virtual GLSGEN_GlsPushButton_EXPORT int WhichObjectPosDown( void ) const;

    /** Sets if the object should hold its state(true) or return to the up state(false)
          * \param state New bevahiour of if the object should hold its state(true) or return to the up state(false)
          */
    virtual GLSGEN_GlsPushButton_EXPORT void Toggle( bool toggle );

    /** Returns if the object should hold its state(true) or return to the up state(false)
          * \return Current bevahiour of if the object should hold its state(true) or return to the up state(false)
          */
    virtual GLSGEN_GlsPushButton_EXPORT bool Toggle( void ) const;

    /* See base class */
    virtual GLSGEN_GlsPushButton_EXPORT DisplayObject* Pick3D( const Vector& winLoc,
        const Vector&                                                        logicalCoords,
        float                                                                scale,
        const Vector&                                                        directionVector,
        Vector&                                                              collisionWinLoc /*Returned*/,
        const OpenGLMatrices&                                                drawnMatrices ) DISTI_METHOD_OVERRIDE;
#ifndef GLES
    /* See base class */
    virtual GLSGEN_GlsPushButton_EXPORT InterfaceListType* GetCppInterfaceDescription( InterfaceListType* addToThisList = NULL ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GlsPushButton_EXPORT void               GetCppInterfaceDescriptionFree( InterfaceListType* array ) DISTI_METHOD_OVERRIDE;
#endif

    /** Traverses upward in the hierarchy to determine if this object is visible in the scene.
      */
    GLSGEN_GlsPushButton_EXPORT bool IsVisibleInScene( const DisplayObject* obj = NULL ) const DISTI_METHOD_OVERRIDE;

    //////////////////////////////////////////////////
    // Push Button specific operations
    //////////////////////////////////////////////////
    GLSGEN_GlsPushButton_EXPORT DisplayObject* handle( DisplayEvent* ev ) DISTI_METHOD_OVERRIDE;

    /** Sets the push button state (0=up, 1=down)
          * \param state New button state (0=up, 1=down)
          */
    virtual GLSGEN_GlsPushButton_EXPORT void State( const int& state );

    /** Returns the current push button state (0=up, 1=down)
          * \return Current push button state (0=up, 1=down)
          */
    virtual GLSGEN_GlsPushButton_EXPORT int State() const;

    /** Returns the current push button state (0=up, 1=down)
     * \deprecated this method is not const correct, use const version instead
     * \return Current push button state (0=up, 1=down)
     */
    DISTI_DEPRECATED( "Use the const version instead." )
    virtual int State() DISTI_FINAL
    {
        return const_cast<const GlsPushButton*>( this )->State();
    }

private:
    DisplayObject* GetPickedObject( bool firstPick,
        const Vector&                    winLoc,
        const Vector&                    logicalCoords,
        float scale, const Vector& directionVector,
        Vector&               collisionWinLoc /*Returned*/,
        const OpenGLMatrices& drawnMatrices );

protected:
#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 ) DISTI_METHOD_OVERRIDE;
#endif
};

} // namespace disti

#endif