openscenegraph
Options
Go to the documentation of this file.
1/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
2 *
3 * This library is open source and may be redistributed and/or modified under
4 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
5 * (at your option) any later version. The full license is in LICENSE file
6 * included with this distribution, and on the openscenegraph.org website.
7 *
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * OpenSceneGraph Public License for more details.
12*/
13
14#ifndef OSGDB_OPTIONS
15#define OSGDB_OPTIONS 1
16
17#include <osgDB/Callbacks>
18#include <osgDB/ObjectCache>
19#include <osg/ObserverNodePath>
20
21#include <deque>
22#include <list>
23#include <iosfwd>
24
25namespace osgDB {
26
27
30{
31 public:
32
35 {
36 CACHE_NONE = 0,
37
39 CACHE_NODES = 1<<0,
40
42 CACHE_IMAGES = 1<<1,
43
45 CACHE_HEIGHTFIELDS = 1<<2,
46
48 CACHE_ARCHIVES = 1<<3,
49
51 CACHE_OBJECTS = 1<<4,
52
54 CACHE_SHADERS = 1<<5,
55
57 CACHE_ALL = CACHE_NODES |
58 CACHE_IMAGES |
59 CACHE_HEIGHTFIELDS |
60 CACHE_ARCHIVES |
61 CACHE_OBJECTS |
62 CACHE_SHADERS
63 };
64
69 {
70 FLOAT_PRECISION_ALL = 0,
71
72 DOUBLE_PRECISION_VERTEX = 1<<0,
73 DOUBLE_PRECISION_NORMAL = 1<<1,
74 DOUBLE_PRECISION_COLOR = 1<<2,
75 DOUBLE_PRECISION_SECONDARY_COLOR = 1<<3,
76 DOUBLE_PRECISION_FOG_COORD = 1<<4,
77 DOUBLE_PRECISION_TEX_COORD = 1<<5,
78 DOUBLE_PRECISION_VERTEX_ATTRIB = 1<<6,
79
80 DOUBLE_PRECISION_ALL = DOUBLE_PRECISION_VERTEX |
81 DOUBLE_PRECISION_NORMAL |
82 DOUBLE_PRECISION_COLOR |
83 DOUBLE_PRECISION_SECONDARY_COLOR |
84 DOUBLE_PRECISION_FOG_COORD |
85 DOUBLE_PRECISION_TEX_COORD |
86 DOUBLE_PRECISION_VERTEX_ATTRIB
87 };
88
96
97
99
100 Options(const std::string& str);
101
103
105
106 Options* cloneOptions(const osg::CopyOp& copyop=osg::CopyOp::SHALLOW_COPY) const { return static_cast<Options*>(clone(copyop)); }
107
109 void setOptionString(const std::string& str) { _str = str; parsePluginStringData(str); }
110
112 const std::string& getOptionString() const { return _str; }
113
115 void setDatabasePath(const std::string& str) { _databasePaths.clear(); _databasePaths.push_back(str); }
116
118 FilePathList& getDatabasePathList() { return _databasePaths; }
119
121 const FilePathList& getDatabasePathList() const { return _databasePaths; }
122
123
125 void setObjectCacheHint(CacheHintOptions useObjectCache) { _objectCacheHint = useObjectCache; }
126
128 CacheHintOptions getObjectCacheHint() const { return _objectCacheHint; }
129
131 void setObjectCache(ObjectCache* objectCache) { _objectCache = objectCache; }
132
134 ObjectCache* getObjectCache() const { return _objectCache.get(); }
135
136
138 void setPrecisionHint(PrecisionHint hint) { _precisionHint = hint; }
139
141 PrecisionHint getPrecisionHint() const { return _precisionHint; }
142
144 void setBuildKdTreesHint(BuildKdTreesHint hint) { _buildKdTreesHint = hint; }
145
147 BuildKdTreesHint getBuildKdTreesHint() const { return _buildKdTreesHint; }
148
149
151 void setAuthenticationMap(AuthenticationMap* authenticationMap) { _authenticationMap = authenticationMap; }
152
154 const AuthenticationMap* getAuthenticationMap() const { return _authenticationMap.get(); }
155
156
158 void setPluginData(const std::string& s, void* v) const { _pluginData[s] = v; }
159
161 void* getPluginData(const std::string& s) { return _pluginData[s]; }
162
164 const void* getPluginData(const std::string& s) const
165 {
166 PluginDataMap::const_iterator itr = _pluginData.find(s);
167 return (itr == _pluginData.end()) ? 0 : itr->second;
168 }
169
171 void removePluginData(const std::string& s) const { _pluginData.erase(s); }
172
174 unsigned int getNumPluginData() const { return static_cast<unsigned int>(_pluginData.size()); }
175
176
178 void setPluginStringData(const std::string& s, const std::string& v) const { _pluginStringData[s] = v; }
179
181 std::string& getPluginStringData(const std::string& s) { return _pluginStringData[s]; }
182
184 const std::string getPluginStringData(const std::string& s) const
185 {
186 PluginStringDataMap::const_iterator itr = _pluginStringData.find(s);
187 return (itr == _pluginStringData.end()) ? std::string("") : itr->second;
188 }
189
191 void removePluginStringData(const std::string& s) const { _pluginStringData.erase(s); }
192
194 unsigned int getNumPluginStringData() const { return static_cast<unsigned int>(_pluginStringData.size()); }
195
197 void parsePluginStringData(const std::string& str, char separator1=' ', char separator2='=');
198
199
201 void setFindFileCallback( FindFileCallback* cb) { _findFileCallback = cb; }
202
204 FindFileCallback* getFindFileCallback() const { return _findFileCallback.get(); }
205
206
208 void setReadFileCallback( ReadFileCallback* cb) { _readFileCallback = cb; }
209
211 ReadFileCallback* getReadFileCallback() const { return _readFileCallback.get(); }
212
213
215 void setWriteFileCallback( WriteFileCallback* cb) { _writeFileCallback = cb; }
216
218 WriteFileCallback* getWriteFileCallback() const { return _writeFileCallback.get(); }
219
220
222 void setFileLocationCallback( FileLocationCallback* cb) { _fileLocationCallback = cb; }
223
225 FileLocationCallback* getFileLocationCallback() const { return _fileLocationCallback.get(); }
226
228 void setFileCache(FileCache* fileCache) { _fileCache = fileCache; }
229
231 FileCache* getFileCache() const { return _fileCache.get(); }
232
233
235 void setTerrain(osg::observer_ptr<osg::Node>& terrain) { _terrain = terrain; }
236
238 const osg::observer_ptr<osg::Node>& getTerrain() const { return _terrain; }
239
241 void setParentGroup(osg::observer_ptr<osg::Group>& parentGroup) { _parentGroup= parentGroup; }
242
244 const osg::observer_ptr<osg::Group>& getParentGroup() const { return _parentGroup; }
245
246 bool operator < (const Options &rhs) const;
247 bool operator == (const Options &rhs) const;
248
249 protected:
250
251 virtual ~Options();
252
253 std::string _str;
255
258
262
263 typedef std::map<std::string,void*> PluginDataMap;
265 typedef std::map<std::string,std::string> PluginStringDataMap;
267
272
274
276 osg::observer_ptr<osg::Group> _parentGroup; // Set by the DatabasePager to the node where the requested file will be inserted. NOTE: observer since prent can be dettached whilst DB thread is loading the object
277};
278
279}
280
281#endif // OSGDB_OPTIONS
Definition AuthenticationMap:62
Definition FileCache:27
Definition osgDB/Callbacks:95
Definition osgDB/Callbacks:40
Definition ObjectCache:27
Definition Options:30
void setDatabasePath(const std::string &str)
Definition Options:115
osg::ref_ptr< WriteFileCallback > _writeFileCallback
Definition Options:270
void removePluginData(const std::string &s) const
Definition Options:171
osg::ref_ptr< ObjectCache > _objectCache
Definition Options:257
const AuthenticationMap * getAuthenticationMap() const
Definition Options:154
CacheHintOptions
bit mask for setting up which object types get cached by readObject/Image/HeightField/Node(filename) ...
Definition Options:35
void setWriteFileCallback(WriteFileCallback *cb)
Definition Options:215
void setObjectCacheHint(CacheHintOptions useObjectCache)
Definition Options:125
BuildKdTreesHint
range of options of whether to build kdtrees automatically on loading
Definition Options:91
@ NO_PREFERENCE
Definition Options:92
@ DO_NOT_BUILD_KDTREES
Definition Options:93
void setParentGroup(osg::observer_ptr< osg::Group > &parentGroup)
Definition Options:241
std::string & getPluginStringData(const std::string &s)
Definition Options:181
void setReadFileCallback(ReadFileCallback *cb)
Definition Options:208
const FilePathList & getDatabasePathList() const
Definition Options:121
FilePathList _databasePaths
Definition Options:254
const void * getPluginData(const std::string &s) const
Definition Options:164
virtual ~Options()
FilePathList & getDatabasePathList()
Definition Options:118
PrecisionHint getPrecisionHint() const
Definition Options:141
const osg::observer_ptr< osg::Node > & getTerrain() const
Definition Options:238
void setBuildKdTreesHint(BuildKdTreesHint hint)
Definition Options:144
CacheHintOptions getObjectCacheHint() const
Definition Options:128
PrecisionHint _precisionHint
Definition Options:259
const std::string getPluginStringData(const std::string &s) const
Definition Options:184
void setOptionString(const std::string &str)
Definition Options:109
void * getPluginData(const std::string &s)
Definition Options:161
unsigned int getNumPluginData() const
Definition Options:174
const osg::observer_ptr< osg::Group > & getParentGroup() const
Definition Options:244
Options(const std::string &str)
FileCache * getFileCache() const
Definition Options:231
void removePluginStringData(const std::string &s) const
Definition Options:191
osg::observer_ptr< osg::Group > _parentGroup
Definition Options:276
void setAuthenticationMap(AuthenticationMap *authenticationMap)
Definition Options:151
ReadFileCallback * getReadFileCallback() const
Definition Options:211
ObjectCache * getObjectCache() const
Definition Options:134
osg::ref_ptr< FindFileCallback > _findFileCallback
Definition Options:268
Options(const Options &options, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
void setPluginData(const std::string &s, void *v) const
Definition Options:158
osg::ref_ptr< FileCache > _fileCache
Definition Options:273
CacheHintOptions _objectCacheHint
Definition Options:256
std::map< std::string, std::string > PluginStringDataMap
Definition Options:265
void parsePluginStringData(const std::string &str, char separator1=' ', char separator2='=')
void setFindFileCallback(FindFileCallback *cb)
Definition Options:201
osg::ref_ptr< AuthenticationMap > _authenticationMap
Definition Options:261
PluginDataMap _pluginData
Definition Options:264
void setTerrain(osg::observer_ptr< osg::Node > &terrain)
Definition Options:235
FileLocationCallback * getFileLocationCallback() const
Definition Options:225
void setFileCache(FileCache *fileCache)
Definition Options:228
std::map< std::string, void * > PluginDataMap
Definition Options:263
BuildKdTreesHint _buildKdTreesHint
Definition Options:260
BuildKdTreesHint getBuildKdTreesHint() const
Definition Options:147
void setPluginStringData(const std::string &s, const std::string &v) const
Definition Options:178
osg::observer_ptr< osg::Node > _terrain
Definition Options:275
const std::string & getOptionString() const
Definition Options:112
FindFileCallback * getFindFileCallback() const
Definition Options:204
PluginStringDataMap _pluginStringData
Definition Options:266
WriteFileCallback * getWriteFileCallback() const
Definition Options:218
PrecisionHint
Definition Options:69
void setObjectCache(ObjectCache *objectCache)
Definition Options:131
META_Object(osgDB, Options)
unsigned int getNumPluginStringData() const
Definition Options:194
osg::ref_ptr< ReadFileCallback > _readFileCallback
Definition Options:269
void setFileLocationCallback(FileLocationCallback *cb)
Definition Options:222
Options * cloneOptions(const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY) const
Definition Options:106
std::string _str
Definition Options:253
void setPrecisionHint(PrecisionHint hint)
Definition Options:138
osg::ref_ptr< FileLocationCallback > _fileLocationCallback
Definition Options:271
Definition osgDB/Callbacks:53
Definition osgDB/Callbacks:75
Definition CopyOp:41
@ SHALLOW_COPY
Definition CopyOp:47
Definition Object:61
Definition observer_ptr:39
Definition ref_ptr:32
Definition Archive:24
std::deque< std::string > FilePathList
Definition osgDB/Callbacks:28
#define OSGDB_EXPORT
Definition osgDB/Export:39