FGFS-4.1/OpenSceneGraph
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

2
include/osgViewer/CompositeViewer
View File

@@ -71,7 +71,7 @@ class OSGVIEWER_EXPORT CompositeViewer : public ViewerBase, public virtual osg::
const osgGA::EventQueue* getEventQueue() const { return _eventQueue.get(); }
/** Execute a main frame loop.
* Equivialant to while (!viewer.done()) viewer.frame();
* Equivalent to while (!viewer.done()) viewer.frame();
* Also calls realize() if the viewer is not already realized,
* and installs trackball manipulator if one is not already assigned.
*/

4
include/osgViewer/Export
View File

@@ -45,9 +45,9 @@
\namespace osgViewer
The osgViewer library provides high level viewer functionality designed to make it easier to write a range of differnt types of viewers,
The osgViewer library provides high level viewer functionality designed to make it easier to write a range of different types of viewers,
from viewers embedded in existing windows via SimpleViewer, through to highly scalable and flexible Viewer and Composite classes. A
set of event handlers add functionality to these viewers so that you can rapidly compose the viewer functionality taylored to your needs.
set of event handlers add functionality to these viewers so that you can rapidly compose the viewer functionality tailored to your needs.
Finally the viewer classes can be adapted to work with a range of different window toolkit API's via GraphicsWindow implementations,
with native Win32, X11 and Carbon implementations on Windows, Unices and OSX respectively, and other window toolkits such as WxWidgets, Qt etc.
*/

24
include/osgViewer/GraphicsWindow
View File

@@ -30,10 +30,10 @@ extern "C"
namespace osgViewer {
/** Base class for providing Windowing API agnostic access to creating and managing graphisc window and events.
/** Base class for providing Windowing API agnostic access to creating and managing graphics window and events.
* Note, the GraphicsWindow is subclassed from osg::GraphicsContext, and to provide an implemention you'll need to implement its
* range of pure virtual functions, you'll find these all have naming convention methodNameImplemention(..).
* GraphicsWindow adds the event queue ontop of the GraphicsContext, thereby adding a mechnism for adapting Windowing events
* GraphicsWindow adds the event queue on top of the GraphicsContext, thereby adding a mechanism for adapting Windowing events
* as well as basics graphics context work, you should wire up custom GraphicsWindowImplementation to push their events through
* into the EventQueue. */
class OSGVIEWER_EXPORT GraphicsWindow : public osg::GraphicsContext, public osgGA::GUIActionAdapter
@@ -135,35 +135,35 @@ class OSGVIEWER_EXPORT GraphicsWindow : public osg::GraphicsContext, public osgG
/** Return whether a valid and usable GraphicsContext has been created.*/
virtual bool valid() const { osg::notify(osg::NOTICE)<<"GraphicsWindow::valid() not implemented."<<std::endl; return false; }
/** Realise the GraphicsContext implementation,
* Pure virtual - must be implemented by concrate implementations of GraphicsContext. */
/** Realize the GraphicsContext implementation,
* Pure virtual - must be implemented by concrete implementations of GraphicsContext. */
virtual bool realizeImplementation() { osg::notify(osg::NOTICE)<<"GraphicsWindow::realizeImplementation() not implemented."<<std::endl; return false; }
/** Return true if the graphics context has been realised, and is ready to use, implementation.
* Pure virtual - must be implemented by concrate implementations of GraphicsContext. */
/** Return true if the graphics context has been realized, and is ready to use, implementation.
* Pure virtual - must be implemented by concrete implementations of GraphicsContext. */
virtual bool isRealizedImplementation() const { osg::notify(osg::NOTICE)<<"GraphicsWindow::isRealizedImplementation() not implemented."<<std::endl; return false; }
/** Close the graphics context implementation.
* Pure virtual - must be implemented by concrate implementations of GraphicsContext. */
* Pure virtual - must be implemented by concrete implementations of GraphicsContext. */
virtual void closeImplementation() { osg::notify(osg::NOTICE)<<"GraphicsWindow::closeImplementation() not implemented."<<std::endl; }
/** Make this graphics context current implementation.
* Pure virtual - must be implemented by concrate implementations of GraphicsContext. */
* Pure virtual - must be implemented by concrete implementations of GraphicsContext. */
virtual bool makeCurrentImplementation() { osg::notify(osg::NOTICE)<<"GraphicsWindow::makeCurrentImplementation() not implemented."<<std::endl; return false;}
/** Make this graphics context current with specified read context implementation.
* Pure virtual - must be implemented by concrate implementations of GraphicsContext. */
* Pure virtual - must be implemented by concrete implementations of GraphicsContext. */
virtual bool makeContextCurrentImplementation(GraphicsContext* /*readContext*/) { osg::notify(osg::NOTICE)<<"GraphicsWindow::makeContextCurrentImplementation(..) not implemented."<<std::endl; return false;}
/** Release the graphics context.*/
virtual bool releaseContextImplementation() { osg::notify(osg::NOTICE)<<"GraphicsWindow::releaseContextImplementation(..) not implemented."<<std::endl; return false; }
/** Pure virtual, Bind the graphics context to associated texture implementation.
* Pure virtual - must be implemented by concrate implementations of GraphicsContext. */
* Pure virtual - must be implemented by concrete implementations of GraphicsContext. */
virtual void bindPBufferToTextureImplementation(GLenum /*buffer*/) { osg::notify(osg::NOTICE)<<"GraphicsWindow::bindPBufferToTextureImplementation(..) not implemented."<<std::endl; }
/** Swap the front and back buffers implementation.
* Pure virtual - must be implemented by Concrate implementations of GraphicsContext. */
* Pure virtual - must be implemented by concrete implementations of GraphicsContext. */
virtual void swapBuffersImplementation() { osg::notify(osg::NOTICE)<<"GraphicsWindow:: swapBuffersImplementation() not implemented."<<std::endl; }
public:
@@ -231,7 +231,7 @@ class GraphicsWindowEmbedded : public GraphicsWindow
}
}
// dumy implementations, assume that graphics context is *always* current and valid.
// dummy implementations, assume that graphics context is *always* current and valid.
virtual bool valid() const { return true; }
virtual bool realizeImplementation() { return true; }
virtual bool isRealizedImplementation() const { return true; }

2
include/osgViewer/Scene
View File

@@ -24,7 +24,7 @@
namespace osgViewer{
/** Scene holds the highe level reference to a single scene graph.*/
/** Scene holds the higher level reference to a single scene graph.*/
class OSGVIEWER_EXPORT Scene : public osg::Referenced
{
public:

14
include/osgViewer/View
View File

@@ -41,7 +41,7 @@ class OSGVIEWER_EXPORT View : public osg::View, public osgGA::GUIActionAdapter
META_Object(osgViewer,View);
/** Provide a mechanism for getting the osg::View assocaited from the GUIActionAdapter.
/** Provide a mechanism for getting the osg::View associated from the GUIActionAdapter.
* One would use this to case view to osgViewer::View(er) if supported by the subclass.*/
virtual osg::View* asView() { return this; }
@@ -81,7 +81,7 @@ class OSGVIEWER_EXPORT View : public osg::View, public osgGA::GUIActionAdapter
/** Get the const View's database pager.*/
const osgDB::DatabasePager* getDatabasePager() const;
/* Set the EventQueue that View uses to intregrate external non window related events.*/
/* Set the EventQueue that View uses to integrate external non window related events.*/
void setEventQueue(osgGA::EventQueue* eventQueue) { _eventQueue = eventQueue; }
/* Get the View's EventQueue.*/
@@ -151,20 +151,20 @@ class OSGVIEWER_EXPORT View : public osg::View, public osgGA::GUIActionAdapter
float getFusionDistanceValue() const { return _fusionDistanceValue; }
/** Convinience method for creating slave Cameras and associated GraphicsWindows across all screens.*/
/** Convenience method for creating slave Cameras and associated GraphicsWindows across all screens.*/
void setUpViewAcrossAllScreens();
/** Convinience method for a single Camara on a single window.*/
/** Convenience method for a single camera on a single window.*/
void setUpViewInWindow(int x, int y, int width, int height, unsigned int screenNum=0);
/** Convinience method for a single Camara associated with a single full screen GraphicsWindow.*/
/** Convenience method for a single camera associated with a single full screen GraphicsWindow.*/
void setUpViewOnSingleScreen(unsigned int screenNum=0);
/** Convinience method for spherical display using 6 slave cameras rendering the 6 sides of a cube map, and 7th camera doing distortion correction to present on a spherical display.*/
/** Convenience method for spherical display using 6 slave cameras rendering the 6 sides of a cube map, and 7th camera doing distortion correction to present on a spherical display.*/
void setUpViewFor3DSphericalDisplay(double radius=1.0, double collar=0.45, unsigned int screenNum=0, osg::Image* intensityMap=0);
/** Convinience method for spherical display by rendering main scene to as panoramic 2:1 texture and then doing distortion correction to present onto a spherical display.*/
/** Convenience method for spherical display by rendering main scene to as panoramic 2:1 texture and then doing distortion correction to present onto a spherical display.*/
void setUpViewForPanoramicSphericalDisplay(double radius=1.0, double collar=0.45, unsigned int screenNum=0, osg::Image* intensityMap=0);

2
include/osgViewer/Viewer
View File

@@ -68,7 +68,7 @@ class OSGVIEWER_EXPORT Viewer : public ViewerBase, public osgViewer::View
/** Execute a main frame loop.
* Equivialant to while (!viewer.done()) viewer.frame();
* Equivalent to while (!viewer.done()) viewer.frame();
* Also calls realize() if the viewer is not already realized,
* and installs trackball manipulator if one is not already assigned.
*/

10
include/osgViewer/ViewerBase
View File

@@ -31,7 +31,7 @@ namespace osgViewer {
class View;
/** ViewerBase is the view base class that is inhertied by both Viewer and CompositeViewer.*/
/** ViewerBase is the view base class that is inherited by both Viewer and CompositeViewer.*/
class OSGVIEWER_EXPORT ViewerBase : public virtual osg::Object
{
public:
@@ -99,7 +99,7 @@ class OSGVIEWER_EXPORT ViewerBase : public virtual osg::Object
/** Set the position of the end barrier.
* AfterSwapBuffers will may result is slightly higher framerates, by may
* lead to inconcistent swapping between different windows.
* lead to inconsistent swapping between different windows.
* BeforeSwapBuffers may lead to slightly lower framerate, but improve consistency in timing of swap buffers,
* especially important if you are likely to consistently break frame.*/
void setEndBarrierPosition(BarrierPosition bp);
@@ -109,10 +109,10 @@ class OSGVIEWER_EXPORT ViewerBase : public virtual osg::Object
/** Set the done flag to singnal the viewer's work is done and should exit the frame loop.*/
/** Set the done flag to signal the viewer's work is done and should exit the frame loop.*/
void setDone(bool done) { _done = done; }
/** Reurn true if viewer's work is done and should exit the frame loop.*/
/** Return true if viewer's work is done and should exit the frame loop.*/
bool done() const { return _done; }
/** Set the EventVisitor. */
@@ -180,7 +180,7 @@ class OSGVIEWER_EXPORT ViewerBase : public virtual osg::Object
/** Execute a main frame loop.
* Equivialant to while (!viewer.done()) viewer.frame();
* Equivalent to while (!viewer.done()) viewer.frame();
* Also calls realize() if the viewer is not already realized,
* and installs trackball manipulator if one is not already assigned.
*/

2
include/osgViewer/api/Win32/GraphicsWindowWin32
View File

@@ -46,7 +46,7 @@ class OSGVIEWER_EXPORT GraphicsWindowWin32 : public osgViewer::GraphicsWindow
/** Realize the GraphicsContext.*/
virtual bool realizeImplementation();
/** Return true if the graphics context has been realised and is ready to use.*/
/** Return true if the graphics context has been realized and is ready to use.*/
virtual bool isRealizedImplementation() const { return _realized; }
/** Close the graphics context.*/

4
include/osgViewer/api/Win32/PixelBufferWin32
View File

@@ -11,7 +11,7 @@
* OpenSceneGraph Public License for more details.
*/
/* Note, elements of PixeBufferWin32 have used Prodcer/RenderSurface_Win32.cpp as both
/* Note, elements of PixeBufferWin32 have used Producer/RenderSurface_Win32.cpp as both
* a guide to use of X11/GLX and copiying directly in the case of setBorder().
* These elements are license under OSGPL as above, with Copyright (C) 2001-2004 Don Burns.
*/
@@ -47,7 +47,7 @@ class OSGVIEWER_EXPORT PixelBufferWin32 : public osg::GraphicsContext
/** Realize the GraphicsContext.*/
virtual bool realizeImplementation();
/** Return true if the graphics context has been realised and is ready to use.*/
/** Return true if the graphics context has been realized and is ready to use.*/
virtual bool isRealizedImplementation() const { return _realized; }
/** Close the graphics context.*/