| GL Studio C++ Runtime API

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