| 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 */
60 class RSOInterface3 : public RSOInterface2
61{
62 public:
63 /** An event containing mouse input. */
64 class MouseMultiTouchEvent : public MouseEvent
65 {
66 public:
67 unsigned int _cursor_id; ///< The cursor id.
68
69 MouseMultiTouchEvent()
70 : _cursor_id( 0 )
71 {
72 }
73
74 /// \return The cursor id associated with this event.
75 unsigned int CursorId() { return _cursor_id; }
76
77 /// Set the cursor id associated with this event.
78 /// \param value The new id to set.
79 void CursorId( unsigned int value ) { _cursor_id = value; }
80 };
81
82 ////////////////////////////////////////////////////////////////////////////////
83 // The RSO Interface methods
84 ////////////////////////////////////////////////////////////////////////////////
85
86 /// Allow the object to handle a multitouch event.
87 /// \param ev The event to handle.
88 /// \return True if the event was handled by the component.
89 virtual bool HandleMultiTouchInput( MouseMultiTouchEvent* ev ) = 0;
90
91 protected:
92 ////////////////////////////////////////////////////////////////////////////////
93 /// Protected destructor so it can't be deleted directly.
94 ////////////////////////////////////////////////////////////////////////////////
95 virtual ~RSOInterface3() {}
96};
97
98} // end namespace disti
99
100#endif
disti::RSOInterface1::MouseEvent
Definition: rso_interface_1.h:417
disti::RSOInterface2
Definition: rso_interface_2.h:60
disti::RSOInterface3::MouseMultiTouchEvent
Definition: rso_interface_3.h:65
disti::RSOInterface3::MouseMultiTouchEvent::CursorId
void CursorId(unsigned int value)
Definition: rso_interface_3.h:79
disti::RSOInterface3::MouseMultiTouchEvent::CursorId
unsigned int CursorId()
Definition: rso_interface_3.h:75
disti::RSOInterface3::MouseMultiTouchEvent::_cursor_id
unsigned int _cursor_id
The cursor id.
Definition: rso_interface_3.h:67
disti::RSOInterface3
Definition: rso_interface_3.h:61
disti::RSOInterface3::~RSOInterface3
virtual ~RSOInterface3()
Protected destructor so it can't be deleted directly.
Definition: rso_interface_3.h:95
disti::RSOInterface3::HandleMultiTouchInput
virtual bool HandleMultiTouchInput(MouseMultiTouchEvent *ev)=0
disti
Definition: bmpimage.h:47
rso_interface_1.h
Defines the RSO interface, which provides a generic way of accessing RSOs and other content,...
rso_interface_2.h
Defines the RSO interface v2, which provides a generic way of accessing RSOs and other content,...