GL Studio C++ Runtime API
rso_interface_3.h
Go to the documentation of this file.
1 /*! \file
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  11301 Corporate Blvd; Suite 100<br>
8  Orlando, Florida 32817<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 */
40 #ifndef INCLUDED_RSO_INTERFACE_3_H
41 #define INCLUDED_RSO_INTERFACE_3_H
42 
43 #include "rso_interface_1.h"
44 #include "rso_interface_2.h"
45 
46 namespace disti
47 {
48 ////////////////////////////////////////////////////////////////////////////////
49 // In order for the RSO to be discovered in a .DLL or .so file,
50 // The following "C" funtions need to be defined.
51 // They are only comments here.
52 ////////////////////////////////////////////////////////////////////////////////
53 // RSOInterface1* CreateRSOInterface3_ClassNameHere()
54 // Optionally:
55 // const char* GlsDefaultClassName()
56 ////////////////////////////////////////////////////////////////////////////////
57 
58 /** The RSOInterface3 class defines an abstract interface to an RSO instance.
59  */
61 {
62 public:
63  /** An event containing mouse input. */
65  {
66  public:
67  unsigned int _cursor_id; /** the cursor id */
68 
70  : _cursor_id( 0 )
71  {
72  }
73 
74  unsigned int CursorId() { return _cursor_id; }
75  void CursorId( unsigned int value ) { _cursor_id = value; }
76  };
77 
78  ////////////////////////////////////////////////////////////////////////////////
79  // The RSO Interface methods
80  ////////////////////////////////////////////////////////////////////////////////
81  ////////////////////////////////////////////////////////////////////////////////
82  /// Allow the object to handle a multitouch event.
83  /// Returns true if the event was handled by the component
84  ////////////////////////////////////////////////////////////////////////////////
85  virtual bool HandleMultiTouchInput( MouseMultiTouchEvent* ev ) = 0;
86 
87 protected:
88  ////////////////////////////////////////////////////////////////////////////////
89  /// Protected destructor so it can't be deleted directly.
90  ////////////////////////////////////////////////////////////////////////////////
91  virtual ~RSOInterface3() {}
92 };
93 
94 } // end namespace disti
95 
96 #endif
virtual ~RSOInterface3()
Protected destructor so it can't be deleted directly.
Definition: rso_interface_3.h:91
Defines the RSO interface, which provides a generic way of accessing RSOs and other content...
virtual bool HandleMultiTouchInput(MouseMultiTouchEvent *ev)=0
Definition: rso_interface_3.h:60
Definition: rso_interface_3.h:64
Defines the RSO interface v2, which provides a generic way of accessing RSOs and other content...
Definition: rso_interface_2.h:59
MouseMultiTouchEvent()
Definition: rso_interface_3.h:69
Definition: bmpimage.h:46
Definition: rso_interface_1.h:385