VR-Forces 5.0.3 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
DtVirtualRealitySettingsManager.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright (c) 2021 MAK Technologies, Inc.
3  * All rights reserved.
4  ******************************************************************************/
5 
9 
10 #pragma once
11 
14 
15 #include <vrvCore/vrvCore.h>
17 
18 namespace makVrv
19 {
20  class DtDe;
21 
25  class DT_DLL_VRVVR DtVirtualRealitySettingsManager : public DtBaseSettingsManager<makArchives::DtVirtualRealitySettingsRecord>
26  {
27  private:
30 
33 
36 
37  public:
38 
40  static DtVirtualRealitySettingsManager& instance( DtDe& de );
41 
44 
47 
49  virtual void setEnabled(bool enabled);
50 
52  virtual bool enabled() const;
53 
56  virtual void setMirroring(makArchives::DtVirtualRealitySettingsRecord::DtMirroring enabled);
57 
60 
63  virtual void setMirrorChannel(const std::string& channelName);
64 
66  virtual const std::string& mirrorChannel() const;
67 
69  virtual void setAttachedObserver(const std::string& obsName);
70 
72  virtual const std::string& attachedObserver();
73 
77  virtual void setFlipOverlays(bool flip);
78 
80  virtual bool flipOverlays() const;
81 
83  virtual void setOverlayWidth(float width);
84 
86  virtual float overlayWidth() const;
87 
89  virtual void setOverlayAspect(float aspect);
90 
92  virtual float overlayAspect() const;
93 
95  virtual void setOverlayDistance(float distance);
96 
98  virtual float overlayDistance() const;
99 
102 
105 
108  virtual void setPreferOpenVR(bool prefer);
109 
112  virtual bool preferOpenVR() const;
113 
115  virtual void setPreferedProvider(std::string provider);
116 
118  virtual std::string preferedProvider() const;
119 
121  virtual void setDisableDepthCopy(bool use);
122 
124  virtual bool disableDepthCopy() const;
125 
127  virtual void setEnableVRS(bool enable);
128 
130  virtual bool enableVRS() const;
131 
133  virtual void setResolutionScale(int scale);
134 
136  virtual int resolutionScale() const;
137 
139  virtual void setEnableMixedRealityMask(bool enable);
140 
142  virtual bool enableMixedRealityMask() const;
143 
145  virtual void setMixedRealityDefinitionFilePath(const std::string& filePath, bool autoLoad = true);
146 
148  virtual const std::string& mixedRealityDefinitionFilePath() const;
149 
151  void setEnableRealWorldDepthTesting(bool enable);
152 
154  bool enableRealWorldDepthTesting() const;
155 
157 
161  boost::signalslib::signal<void (bool)> signal_enabledChanged;
162 
164  boost::signalslib::signal<void(makArchives::DtVirtualRealitySettingsRecord::DtMirroring)> signal_mirroringChanged;
165 
167  boost::signalslib::signal<void (std::string)> signal_mirrorChannelChanged;
168 
170  boost::signalslib::signal<void (std::string)> signal_attachedObserverChanged;
171 
173  boost::signalslib::signal<void(std::string)> signal_preferedProviderChanged;
174 
176  boost::signalslib::signal<void(bool)> signal_flipOverlaysChanged;
177 
179  boost::signalslib::signal<void(float)> signal_overlayWidthChanged;
180 
182  boost::signalslib::signal<void(float)> signal_overlayAspectChanged;
183 
185  boost::signalslib::signal<void(float)> signal_overlayDistanceChanged;
186 
188  boost::signalslib::signal<void(makArchives::DtVirtualRealitySettingsRecord::DtOverlayOutput)> signal_overlayOutputChanged;
189 
191  boost::signalslib::signal<void(bool)> signal_disableDepthCopyChanged;
192 
194  boost::signalslib::signal<void(bool)> signal_enableVRSChanged;
195 
197  boost::signalslib::signal<void(int)> signal_resolutionScaleChanged;
198 
200  boost::signalslib::signal<void(bool)> signal_enableMixedRealityMaskChanged;
201 
203  boost::signalslib::signal<void(bool)> signal_enableRealWorldDepthTestingChanged;
204 
206 
210  virtual void setFromRecord( const makArchives::DtVirtualRealitySettingsRecord& rec );
211 
213  virtual void getRecord( makArchives::DtVirtualRealitySettingsRecord& rec ) const;
215 
216  protected:
217 
220  template <typename ManagerClass>
221  friend ManagerClass& defaultManagerInstanceFunction( DtDe&, bool );
222 
225  template <typename ManagerClass>
226  friend void defaultManagerRegisterInstanceFunction(DtDe&, ManagerClass*);
227 
228  protected:
231  };
232 }
Base class for (non-shared) settings managers. Extends the functionality provided by the DtCommonBase...
Definition: DtBaseSettingsManager.h:271
boost::signalslib::signal< void(bool)> signal_enableMixedRealityMaskChanged
signaled when enable mixed reality mask changes
Definition: DtVirtualRealitySettingsManager.h:200
Contains DLL export macros.
boost::signalslib::signal< void(bool)> signal_enableVRSChanged
signaled when use vrs changes
Definition: DtVirtualRealitySettingsManager.h:194
boost::signalslib::signal< void(std::string)> signal_mirrorChannelChanged
signaled when the channel that the user wants to display the HMD mirror on changes ...
Definition: DtVirtualRealitySettingsManager.h:167
DtVirtualRealitySettingsRecord is the serializable record used to read and write a VirtualReality Set...
Definition: DtVirtualRealitySettingsRecord.h:25
DtDe & myDe
Definition: DtVirtualRealitySettingsManager.h:230
boost::signalslib::signal< void(std::string)> signal_attachedObserverChanged
signaled when the attached observer changes
Definition: DtVirtualRealitySettingsManager.h:170
boost::signalslib::signal< void(std::string)> signal_preferedProviderChanged
signaled when prefered provider changes
Definition: DtVirtualRealitySettingsManager.h:173
DtOverlayOutput
Definition: DtVirtualRealitySettingsRecord.h:29
Contains makArchives::DtVirtualRealitySettingsRecord class.
boost::signalslib::signal< void(makArchives::DtVirtualRealitySettingsRecord::DtMirroring)> signal_mirroringChanged
signals when the HMD mirror state changes
Definition: DtVirtualRealitySettingsManager.h:164
#define DT_DLL_VRVVR
Definition: vrvVirtualReality.h:19
DtMirroring
Definition: DtVirtualRealitySettingsRecord.h:28
Contains the DtVirtualRealitySettingsManager class declaration. This class can be used to programatic...
Definition: DtVirtualRealitySettingsManager.h:25
boost::signalslib::signal< void(int)> signal_resolutionScaleChanged
signaled when resolution scale changes
Definition: DtVirtualRealitySettingsManager.h:197
boost::signalslib::signal< void(bool)> signal_flipOverlaysChanged
signaled when the flip overlay changes
Definition: DtVirtualRealitySettingsManager.h:176
boost::signalslib::signal< void(float)> signal_overlayAspectChanged
signaled when the overlay aspect changes
Definition: DtVirtualRealitySettingsManager.h:182
DT_DLL_VRVCORE double distance(const makVrv::DtCoordinateSystem &, const DtVector &from, const DtVector &to)
Returns the distance from the two points. Coordinates are in local database coordinates The coordinat...
boost::signalslib::signal< void(float)> signal_overlayWidthChanged
signaled when the overlay width changes
Definition: DtVirtualRealitySettingsManager.h:179
void defaultManagerRegisterInstanceFunction(DtDe &de, ManagerClass *mgr)
Default implementation of how to register a manager, especially necessary when overriding the manager...
Definition: DtDe.h:866
boost::signalslib::signal< void(bool)> signal_enabledChanged
signals when the HMD mirror state changes
Definition: DtVirtualRealitySettingsManager.h:161
boost::signalslib::signal< void(bool)> signal_disableDepthCopyChanged
signaled when use multiview changes
Definition: DtVirtualRealitySettingsManager.h:191
boost::signalslib::signal< void(bool)> signal_enableRealWorldDepthTestingChanged
signaled when enable mixed reality mask changes
Definition: DtVirtualRealitySettingsManager.h:203
ManagerClass & defaultManagerInstanceFunction(DtDe &de, bool allowedInSlave)
default Manager instance function. Manager requirements: 1) Static instance function 2) Protected DtS...
Definition: DtDe.h:828
const char int mode
Definition: ioapi.h:38
makArchives::DtVirtualRealitySettingsRecord mySettingsRecord
Definition: DtVirtualRealitySettingsManager.h:229
boost::signalslib::signal< void(makArchives::DtVirtualRealitySettingsRecord::DtOverlayOutput)> signal_overlayOutputChanged
signaled when the overlay output mode changes
Definition: DtVirtualRealitySettingsManager.h:188
The DtDe is the core component of any VR-Vantage application. It owns a DtRenderer, DtDeCommunicator, as well as a DtDisplay and other things.
Definition: DtDe.h:70
boost::signalslib::signal< void(float)> signal_overlayDistanceChanged
signaled when the overlay distance changes
Definition: DtVirtualRealitySettingsManager.h:185
Contains the DtBaseSettingsManager class declaration.
Contains DLL export macros.

Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)