Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
SoGLDeviceSettings.h
1/*=======================================================================
2 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
3 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
4 *** ***
5 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
6 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
7 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
8 *** ***
9 *** RESTRICTED RIGHTS LEGEND ***
10 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
11 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
12 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
13 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
14 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
15 *** ***
16 *** COPYRIGHT (C) 1996-2024 BY FEI S.A.S, ***
17 *** BORDEAUX, FRANCE ***
18 *** ALL RIGHTS RESERVED ***
19**=======================================================================*/
20/*=======================================================================
21** Author : Martial PAPILLON (June 2013)
22**=======================================================================*/
23
24#ifndef SO_DEVICE_SETTINGS
25#define SO_DEVICE_SETTINGS
26
27#include <Inventor/devices/SoDevice.h>
28#include <Inventor/lists/SbStringList.h>
29
98{
99public:
103 static void initClass();
104
108 static void exitClass();
109
113 virtual int getParameterCount() const = 0;
114
122 virtual SbString getParameterIdbyIndex(const unsigned int index) const = 0;
123
128 virtual SbString getParameter(const SbString& pParameterId) const = 0;
129
134 virtual bool setParameter(const SbString& pParameterId, const SbString& pParameterValue) = 0;
135
139 virtual SbString getSettingName() const = 0;
140
146 virtual bool setSettingName(const SbString &pPredefinedSettingName) = 0;
147
152 virtual int getSettingsCount() const = 0;
153
158 virtual SbString getSettingNameByIndex(const unsigned int index) const = 0;
159
163 virtual bool applySettings() const = 0;
164
168 friend std::ostream& operator << ( std::ostream& os, const SoGLDeviceSettings &profile );
169
170 // ----------------------- Protected usage --------------------------------------
171private:
172
177
182
186 virtual SbString printProfile() const { return SbString("No Profile information"); };
187
188 // Refs counter
189 static int s_initRefCount;
190
191 // ----------------------- Private usage --------------------------------------
192private:
193
198 const SoGLDeviceSettings& operator = (const SoGLDeviceSettings& copy);
199
200};
201
202#endif // SO_DEVICE_SETTINGS
Class for smart character strings.
Definition SbString.h:202
<a href="IconLegend.html"><img src="extTGS.gif" alt="VSG extension" border="0"></a> Device settings ...
virtual SbString getSettingName() const =0
Returns the name of the current setting (vendor defined list of parameters).
friend std::ostream & operator<<(std::ostream &os, const SoGLDeviceSettings &profile)
Prints information about the device settings.
static void exitClass()
Cleans SoDeviceSettings.
virtual int getSettingsCount() const =0
Returns the number of vendor defined settings.
static void initClass()
Initializes SoDeviceSettings.
virtual bool applySettings() const =0
Apply changes to the setting and/or parameters.
virtual SbString getParameterIdbyIndex(const unsigned int index) const =0
Returns the name of the parameter with the specified index in the current setting.
virtual bool setParameter(const SbString &pParameterId, const SbString &pParameterValue)=0
Set the value of a parameter in the current setting.
virtual SbString getParameter(const SbString &pParameterId) const =0
Returns current value of specified parameter in current setting.
virtual bool setSettingName(const SbString &pPredefinedSettingName)=0
Set a setting (vendor defined list of parameters) by name.
virtual int getParameterCount() const =0
Returns number of parameters in current setting.
virtual SbString getSettingNameByIndex(const unsigned int index) const =0
Returns the name of the specified setting.