From Roland Smeenk, "Attached you will find a large set of small typo fixes (mainly in the comments)."

This commit is contained in:
Robert Osfield
2007-12-10 17:30:18 +00:00
parent 1dcb6cc4fd
commit f4afa427a7
216 changed files with 613 additions and 619 deletions

View File

@@ -36,7 +36,7 @@ namespace osgDB {
/** Database paging class which manages the loading of files in a background thread,
* and syncronizing of loaded models with the main scene graph.*/
* and synchronizing of loaded models with the main scene graph.*/
class OSGDB_EXPORT DatabasePager : public osg::NodeVisitor::DatabaseRequestHandler, public OpenThreads::Thread
{
public :
@@ -206,13 +206,13 @@ class OSGDB_EXPORT DatabasePager : public osg::NodeVisitor::DatabaseRequestHandl
addLoadedDataToSceneGraph(currentFrameTime);
}
/** Turn the compilation of rendering objects for specfied graphics context on (true) or off(false). */
/** Turn the compilation of rendering objects for specified graphics context on (true) or off(false). */
void setCompileGLObjectsForContextID(unsigned int contextID, bool on);
/** Get whether the compilation of rendering objects for specfied graphics context on (true) or off(false). */
/** Get whether the compilation of rendering objects for specified graphics context on (true) or off(false). */
bool getCompileGLObjectsForContextID(unsigned int contextID);
/** Rerturn true if an external draw thread should call compileGLObjects(..) or not.*/
/** Return true if an external draw thread should call compileGLObjects(..) or not.*/
bool requiresExternalCompileGLObjects(unsigned int contextID) const;
/** Return true if there are pending compile operations that are required.

View File

@@ -42,7 +42,7 @@
\namespace osgDB
The osgDB library provides support for reading and writing scene graphs, providing a plugin framework and file utility classes.
The plugin framework in centred around the osgDB::Registry, and allows plugins which provide specific file format support to be dynamically loaded on demand.
The plugin framework in centered around the osgDB::Registry, and allows plugins which provide specific file format support to be dynamically loaded on demand.
*/
#endif

View File

@@ -43,7 +43,7 @@ extern OSGDB_EXPORT bool makeDirectory( const std::string &directoryPath );
extern OSGDB_EXPORT bool makeDirectoryForFile( const std::string &filePath );
/** return true if a file exisits. */
/** return true if a file exists. */
extern OSGDB_EXPORT bool fileExists(const std::string& filename);
/** return type of file. */
@@ -55,7 +55,7 @@ extern OSGDB_EXPORT std::string findFileInPath(const std::string& filename, cons
/** return the directory/filename of a file if its is contained within specified directory.
* return "" if directory does not contain file. If caseInsensitive is set to true then
* a case insensitive comparison is used to compare fileName to directory contents.
* This is useful when unix programs attempt read case insentive windows filenames.
* This is useful when unix programs attempt read case insensitive windows filenames.
*/
extern OSGDB_EXPORT std::string findFileInDirectory(const std::string& fileName,const std::string& dirName,CaseSensitivity caseSensitivity=CASE_SENSITIVE);
@@ -92,7 +92,7 @@ inline FilePathList& getLibraryFilePathList() { return osgDB::Registry::instance
extern OSGDB_EXPORT std::string findLibraryFile(const std::string& filename,CaseSensitivity caseSensitivity=CASE_SENSITIVE);
/** convert a string containing a list of paths deliminated either with ';' (Windows) or ':' (All other platforms) into FilePath represetation.*/
/** convert a string containing a list of paths delimited either with ';' (Windows) or ':' (All other platforms) into FilePath representation.*/
extern OSGDB_EXPORT void convertStringPathIntoFilePathList(const std::string& paths,FilePathList& filepath);
extern OSGDB_EXPORT void appendPlatformSpecificLibraryFilePaths(FilePathList& filepath);

View File

@@ -86,7 +86,7 @@ class OSGDB_EXPORT Registry : public osg::Referenced
void addFileExtensionAlias(const std::string mapExt, const std::string toExt);
/** Reads a file that configures extension mappings. File is ASCII text
* and each line contains the parameyters to the addFileExtensionAlias
* and each line contains the parameters to the addFileExtensionAlias
* method. Lines can be commented out with an initial '#' character.*/
bool readPluginAliasConfigurationFile( const std::string& file );
@@ -288,18 +288,18 @@ class OSGDB_EXPORT Registry : public osg::Referenced
const ReaderWriter::Options* getOptions() const { return _options.get(); }
/** initilize both the Data and Library FilePaths, by default called by the
/** initialize both the Data and Library FilePaths, by default called by the
* constructor, so it should only be required if you want to force
* the re-reading of environmental variables.*/
void initFilePathLists() { initDataFilePathList(); initLibraryFilePathList(); }
/** initilize the Data FilePath by reading the OSG_FILE_PATH environmental variable.*/
/** initialize the Data FilePath by reading the OSG_FILE_PATH environmental variable.*/
void initDataFilePathList();
/** Set the data file path using a list of paths stored in a FilePath, which is used when search for data files.*/
void setDataFilePathList(const FilePathList& filepath) { _dataFilePath = filepath; }
/** Set the data file path using a single string deliminated either with ';' (Windows) or ':' (All other platforms), which is used when search for data files.*/
/** Set the data file path using a single string delimited either with ';' (Windows) or ':' (All other platforms), which is used when search for data files.*/
void setDataFilePathList(const std::string& paths);
/** get the data file path which is used when search for data files.*/
@@ -308,14 +308,14 @@ class OSGDB_EXPORT Registry : public osg::Referenced
/** get the const data file path which is used when search for data files.*/
const FilePathList& getDataFilePathList() const { return _dataFilePath; }
/** initilize the Library FilePath by reading the OSG_LIBRARY_PATH
/** initialize the Library FilePath by reading the OSG_LIBRARY_PATH
* and the appropriate system environmental variables*/
void initLibraryFilePathList();
/** Set the library file path using a list of paths stored in a FilePath, which is used when search for data files.*/
void setLibraryFilePathList(const FilePathList& filepath) { _libraryFilePath = filepath; }
/** Set the library file path using a single string deliminated either with ';' (Windows) or ':' (All other platforms), which is used when search for data files.*/
/** Set the library file path using a single string delimited either with ';' (Windows) or ':' (All other platforms), which is used when search for data files.*/
void setLibraryFilePathList(const std::string& paths);
/** get the library file path which is used when search for library (dso/dll's) files.*/
@@ -329,7 +329,7 @@ class OSGDB_EXPORT Registry : public osg::Referenced
* for that object in the cache to specified time.
* This would typically be called once per frame by applications which are doing database paging,
* and need to prune objects that are no longer required.
* Time value is time in sceonds.*/
* Time value is time in seconds.*/
void updateTimeStampOfObjectsInCacheWithExternalReferences(double currentTime);
/** Removed object in the cache which have a time stamp at or before the specified expiry time.
@@ -338,13 +338,13 @@ class OSGDB_EXPORT Registry : public osg::Referenced
* after the call to updateTimeStampOfObjectsInCacheWithExternalReferences(currentTime).
* Note, the currentTime is not the expiryTime, one would typically set the expiry time
* to a fixed amount of time before currentTime, such as expiryTime = currentTime-10.0.
* Time value is time in sceonds.*/
* Time value is time in seconds.*/
void removeExpiredObjectsInCache(double expiryTime);
/** Remove all objects in the cache regardless of having external references or expiry times.*/
void clearObjectCache();
/** Add a filename,object,timestamp tripple to the Registry::ObjectCache.*/
/** Add a filename,object,timestamp triple to the Registry::ObjectCache.*/
void addEntryToObjectCache(const std::string& filename, osg::Object* object, double timestamp = 0.0);
/** Get an object from the object cache*/
@@ -460,7 +460,7 @@ class OSGDB_EXPORT Registry : public osg::Referenced
ReaderWriter::ReadResult readImplementation(const ReadFunctor& readFunctor,bool useObjectCache);
// forward declar helper class
// forward declare helper class
class AvailableReaderWriterIterator;
friend class AvailableReaderWriterIterator;

View File

@@ -68,7 +68,7 @@ namespace osgDB {
typedef std::set< osg::ref_ptr<osg::StateSet> > StateSetSet;
StateSetSet _sharedStateSetList;
// Temporary lists just to avoid unnecesary find calls
// Temporary lists just to avoid unnecessary find calls
typedef std::pair<osg::StateAttribute*, bool> TextureSharePair;
typedef std::map<osg::StateAttribute*, TextureSharePair> TextureTextureSharePairMap;
TextureTextureSharePairMap tmpSharedTextureList;