rso_interface_3.h

Go to the documentation of this file.

/*! \file
  \brief  Defines the RSO interface v3, which extends v2 to add multitouch support through the HandleMultiTouchInput method

  \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_RSO_INTERFACE_3_H
#define INCLUDED_RSO_INTERFACE_3_H

#include "rso_interface_1.h"
#include "rso_interface_2.h"

namespace disti
{
////////////////////////////////////////////////////////////////////////////////
// In order for the RSO to be discovered in a .DLL or .so file,
// The following "C" funtions need to be defined.
// They are only comments here.
////////////////////////////////////////////////////////////////////////////////
// RSOInterface1* CreateRSOInterface3_ClassNameHere()
// Optionally:
// const char* GlsDefaultClassName()
////////////////////////////////////////////////////////////////////////////////

/** The RSOInterface3 class defines an abstract interface to an RSO instance. 
  */
class RSOInterface3 : public RSOInterface2
{
public:
    /** An event containing mouse input. */
    class MouseMultiTouchEvent : public MouseEvent
    {
    public:
        unsigned int _cursor_id; /** the cursor id */

        MouseMultiTouchEvent()
            : _cursor_id( 0 )
        {
        }

        unsigned int CursorId() { return _cursor_id; }
        void         CursorId( unsigned int value ) { _cursor_id = value; }
    };

    ////////////////////////////////////////////////////////////////////////////////
    // The RSO Interface methods
    ////////////////////////////////////////////////////////////////////////////////
    ////////////////////////////////////////////////////////////////////////////////
    /// Allow the object to handle a multitouch event.
    /// Returns true if the event was handled by the component
    ////////////////////////////////////////////////////////////////////////////////
    virtual bool HandleMultiTouchInput( MouseMultiTouchEvent* ev ) = 0;

protected:
    ////////////////////////////////////////////////////////////////////////////////
    /// Protected destructor so it can't be deleted directly.
    ////////////////////////////////////////////////////////////////////////////////
    virtual ~RSOInterface3() {}
};

} // end namespace disti

#endif