GL Studio C++ Runtime API
rso_interface_3.h
Go to the documentation of this file.
1/// \file rso_interface_3.h
2/// \brief Defines the RSO interface v3, which extends v2 to add multitouch support through the HandleMultiTouchInput method
3///
4/// \par Copyright Information
5///
6/// Copyright (c) 2017 by The DiSTI Corporation.<br>
7/// 12249 Science Drive; Suite 300<br>
8/// Orlando, Florida 32826<br>
9/// USA<br>
10/// <br>
11/// All rights reserved.<br>
12///
13/// This Software contains proprietary trade secrets of DiSTI and may not be
14/// reproduced, in whole or part, in any form, or by any means of electronic,
15/// mechanical, or otherwise, without the written permission of DiSTI. Said
16/// permission may be derived through the purchase of applicable DiSTI product
17/// licenses which detail the distribution rights of this content and any
18/// Derivative Works based on this or other copyrighted DiSTI Software.
19///
20/// NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
21/// AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
22/// PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
23/// AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
24/// IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
25/// PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
26///
27/// LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
28/// IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
29/// INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
30/// DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
31/// INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
32/// INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
33/// OF SUCH DAMAGES. DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
34/// EXCEED FIVE DOLLARS (US$5.00).
35///
36/// The aforementioned terms and restrictions are governed by the laws of the
37/// State of Florida and the United States of America.
38
39#ifndef INCLUDED_RSO_INTERFACE_3_H
40#define INCLUDED_RSO_INTERFACE_3_H
41
42#include "rso_interface_1.h"
43#include "rso_interface_2.h"
44
45namespace disti
46{
47////////////////////////////////////////////////////////////////////////////////
48// In order for the RSO to be discovered in a .DLL or .so file,
49// The following "C" funtions need to be defined.
50// They are only comments here.
51////////////////////////////////////////////////////////////////////////////////
52// RSOInterface1* CreateRSOInterface3_ClassNameHere()
53// Optionally:
54// const char* GlsDefaultClassName()
55////////////////////////////////////////////////////////////////////////////////
56
57/** The RSOInterface3 class defines an abstract interface to an RSO instance.
58 */
60{
61public:
62 /** An event containing mouse input. */
64 {
65 public:
66 unsigned int _cursor_id; ///< The cursor id.
67
69 : _cursor_id( 0 )
70 {
71 }
72
73 /// \return The cursor id associated with this event.
74 unsigned int CursorId() { return _cursor_id; }
75
76 /// Set the cursor id associated with this event.
77 /// \param value The new id to set.
78 void CursorId( unsigned int value ) { _cursor_id = value; }
79 };
80
81 ////////////////////////////////////////////////////////////////////////////////
82 // The RSO Interface methods
83 ////////////////////////////////////////////////////////////////////////////////
84
85 /// Allow the object to handle a multitouch event.
86 /// \param ev The event to handle.
87 /// \return True if the event was handled by the component.
89
90protected:
91 ////////////////////////////////////////////////////////////////////////////////
92 /// Protected destructor so it can't be deleted directly.
93 ////////////////////////////////////////////////////////////////////////////////
94 virtual ~RSOInterface3() {}
95};
96
97} // end namespace disti
98
99#endif
Definition: rso_interface_1.h:416
Definition: rso_interface_2.h:59
Definition: rso_interface_3.h:64
void CursorId(unsigned int value)
Definition: rso_interface_3.h:78
unsigned int CursorId()
Definition: rso_interface_3.h:74
unsigned int _cursor_id
The cursor id.
Definition: rso_interface_3.h:66
Definition: rso_interface_3.h:60
virtual ~RSOInterface3()
Protected destructor so it can't be deleted directly.
Definition: rso_interface_3.h:94
virtual bool HandleMultiTouchInput(MouseMultiTouchEvent *ev)=0
Definition: bmpimage.h:46
Defines the RSO interface, which provides a generic way of accessing RSOs and other content,...
Defines the RSO interface v2, which provides a generic way of accessing RSOs and other content,...