GL Studio C++ Runtime API
rso_interface_4.h
Go to the documentation of this file.
1/// \file rso_interface_4.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) 2018 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_4_H
40#define INCLUDED_RSO_INTERFACE_4_H
41
42#include "rso_interface_3.h"
43
44namespace disti
45{
46////////////////////////////////////////////////////////////////////////////////
47// In order for the RSO to be discovered in a .DLL or .so file,
48// The following "C" funtions need to be defined.
49// They are only comments here.
50////////////////////////////////////////////////////////////////////////////////
51// RSOInterface1* CreateRSOInterface4_ClassNameHere()
52// Optionally:
53// const char* GlsDefaultClassName()
54////////////////////////////////////////////////////////////////////////////////
55
56/** The RSOInterface4 class defines an abstract interface to an RSO instance.
57 */
59{
60public:
61 /** Class used to call a callback method that takes a DistiAttributeBase */
63 {
64 public:
65 /** Called when the resource value has changed
66 * \param handle the handle to the resource that changed
67 */
68 virtual void Call( ResourceHandle handle ) = 0;
69
70 /** deletes the observer */
71 virtual void Destroy() = 0;
72
73 protected:
74 virtual ~ResourceObserver() {}
75 };
76
77 /// Type for unique identifiers
78 typedef unsigned int CallbackID;
79
80 /** Register a resource observer to be notified when a resource changes *
81 * \param resourceHandle the resource handle
82 * \param observer the observer to be notified. The RSO takes ownership of the observer and will call Destroy to delete it when needed.
83 * \return the id used to unregister the observer in combination with the original resourceHandle
84 */
85 virtual CallbackID RegisterResourceObserver( ResourceHandle resourceHandle, ResourceObserver* observer ) = 0;
86
87 /** Unregister a resource observer
88 * \param resourceHandle the resource handle used to register the observer
89 * \param id the id used to register the resource observer
90 */
91 virtual void UnregisterResourceObserver( ResourceHandle resourceHandle, CallbackID id ) = 0;
92
93protected:
94 ////////////////////////////////////////////////////////////////////////////////
95 /// Protected destructor so it can't be deleted directly.
96 ////////////////////////////////////////////////////////////////////////////////
97 virtual ~RSOInterface4() {}
98};
99
100} // end namespace disti
101
102#endif
unsigned int ResourceHandle
Typedef for a unique resource identifier.
Definition: rso_interface_2.h:64
Definition: rso_interface_3.h:60
Definition: rso_interface_4.h:63
virtual void Call(ResourceHandle handle)=0
Definition: rso_interface_4.h:59
virtual ~RSOInterface4()
Protected destructor so it can't be deleted directly.
Definition: rso_interface_4.h:97
virtual CallbackID RegisterResourceObserver(ResourceHandle resourceHandle, ResourceObserver *observer)=0
virtual void UnregisterResourceObserver(ResourceHandle resourceHandle, CallbackID id)=0
unsigned int CallbackID
Type for unique identifiers.
Definition: rso_interface_4.h:78
Definition: bmpimage.h:46
Defines the RSO interface v3, which extends v2 to add multitouch support through the HandleMultiTouch...