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

4
include/osgGA/AnimationPathManipulator
View File

@@ -27,8 +27,8 @@ namespace osgGA{
// per line. The succession of values are:
// time px py pz ax ay az aw
// where:
// time = elapsed time in seconds from the begining of the animation
// px py pz = World position in catesian coordinates
// time = elapsed time in seconds from the beginning of the animation
// px py pz = World position in cartesian coordinates
// ax ay az aw = Orientation (attitude) defined as a quaternion
class OSGGA_EXPORT AnimationPathManipulator : public MatrixManipulator

2
include/osgGA/EventQueue
View File

@@ -174,7 +174,7 @@ class OSGGA_EXPORT EventQueue : public osg::Referenced
double getTime() const { return osg::Timer::instance()->delta_s(_startTick, osg::Timer::instance()->tick()); }
/** convinience method for create an event ready to fill in. Clones the getCurrentEventState() to produce a up to date event state. */
/** convenience method for create an event ready to fill in. Clones the getCurrentEventState() to produce a up to date event state. */
GUIEventAdapter* createEvent();

4
include/osgGA/GUIActionAdapter
View File

@@ -21,7 +21,7 @@ namespace osgGA{
/**
Abstract base class defining the interface by which GUIEventHandlers may request
actions of the GUI system in use. These requests for actions should then be honoured
actions of the GUI system in use. These requests for actions should then be honored
by the GUI toolkit of the user's application.
To provide more detail, when a GUIEventHandler (e.g. a TrackballManipulator)
@@ -57,7 +57,7 @@ class GUIActionAdapter
public:
virtual ~GUIActionAdapter() {}
/** Provide a mechanism for getting the osg::View assocaited with this GUIActionAdapter.
/** Provide a mechanism for getting the osg::View associated with this GUIActionAdapter.
* One would use this to case view to osgViewer::View(er) if supported by the subclass.*/
virtual osg::View* asView() { return 0; }

8
include/osgGA/GUIEventAdapter
View File

@@ -142,7 +142,7 @@ public:
KEY_KP_9 = 0xFFB9,
/*
* Auxilliary Functions; note the duplicate definitions for left and right
* Auxiliary Functions; note the duplicate definitions for left and right
* function keys; Sun keyboards and a few other manufactures have such
* function key groups on the left and/or right sides of the keyboard.
* We've not found a keyboard with more than 35 function keys total.
@@ -322,7 +322,7 @@ public:
/** get mouse maximum x. */
float getXmax() const { return _Xmax; }
/** get mmouse minimum y. */
/** get mouse minimum y. */
float getYmin() const { return _Ymin; }
/** get mouse maYimum y. */
@@ -377,13 +377,13 @@ public:
ScrollingMotion getScrollingMotion() const { return _scrollingMotion; }
/** return the getX() value normalised to the range of -1 to 1.
/** return the getX() value normalized to the range of -1 to 1.
* -1 would be the left hand side of the window.
* 0.0 would be the middle of the window.
* +1 would be the right hand side of the window.*/
inline float getXnormalized() const { return 2.0f*(getX()-getXmin())/(getXmax()-getXmin())-1.0f; }
/** return the getY() value normalised to the range of -1 to 1.
/** return the getY() value normalized to the range of -1 to 1.
* -1 would be the bottom of the window.
* 0.0 would be the middle of the window.
* +1 would be the top of the window.*/

4
include/osgGA/GUIEventHandler
View File

@@ -66,7 +66,7 @@ public:
/** Handle events, return true if handled, false otherwise. */
virtual bool handle(const GUIEventAdapter& ea,GUIActionAdapter& aa, osg::Object*, osg::NodeVisitor*) { return handle(ea,aa); }
/** Convnience method that only passes on to the handle(,,,) method events that either haven't been
/** Convenience method that only passes on to the handle(,,,) method events that either haven't been
* handled yet, or have been handled but haven't be set to be ignored by the IgnoreHandledEventsMask.
* Note, this method is an inline method, and not appropriate for users to override, override the handle(,,,)
* method instead.*/
@@ -88,7 +88,7 @@ public:
/** Deprecated, Handle events, return true if handled, false otherwise. */
virtual bool handle(const GUIEventAdapter&,GUIActionAdapter&) { return false; }
/** Convnience method that only passes on to the handle(,) method events that either haven't been
/** Convenience method that only passes on to the handle(,) method events that either haven't been
* handled yet, or have been handled but haven't be set to be ignored by the IgnoreHandledEventsMask.
* Note, this method is an inline method, and not appropriate for users to override, override the handle(,)
* method instead.*/

4
include/osgGA/KeySwitchMatrixManipulator
View File

@@ -100,10 +100,10 @@ public:
/** get the position of the manipulator as a inverse matrix of the manipulator, typically used as a model view matrix.*/
virtual osg::Matrixd getInverseMatrix() const { return _current->getInverseMatrix(); }
/** Get the FusionDistanceMode. Used by SceneView for setting up setereo convergence.*/
/** Get the FusionDistanceMode. Used by SceneView for setting up stereo convergence.*/
virtual osgUtil::SceneView::FusionDistanceMode getFusionDistanceMode() const { return _current->getFusionDistanceMode(); }
/** Get the FusionDistanceValue. Used by SceneView for setting up setereo convergence.*/
/** Get the FusionDistanceValue. Used by SceneView for setting up stereo convergence.*/
virtual float getFusionDistanceValue() const { return _current->getFusionDistanceValue(); }

8
include/osgGA/MatrixManipulator
View File

@@ -43,7 +43,7 @@ public:
virtual const char* className() const { return "MatrixManipulator"; }
/** callback class to use to allow matrix manipulators to querry the application for the local coordinate frame.*/
/** callback class to use to allow matrix manipulators to query the application for the local coordinate frame.*/
class CoordinateFrameCallback : public osg::Referenced
{
public:
@@ -94,10 +94,10 @@ public:
/** get the position of the manipulator as a inverse matrix of the manipulator, typically used as a model view matrix.*/
virtual osg::Matrixd getInverseMatrix() const = 0;
/** Get the FusionDistanceMode. Used by SceneView for setting up setereo convergence.*/
/** Get the FusionDistanceMode. Used by SceneView for setting up stereo convergence.*/
virtual osgUtil::SceneView::FusionDistanceMode getFusionDistanceMode() const { return osgUtil::SceneView::PROPORTIONAL_TO_SCREEN_DISTANCE; }
/** Get the FusionDistanceValue. Used by SceneView for setting up setereo convergence.*/
/** Get the FusionDistanceValue. Used by SceneView for setting up stereo convergence.*/
virtual float getFusionDistanceValue() const { return 1.0f; }
/** Set the mask to use when set up intersection traversal such as used in manipulators that follow terrain or have collision detection.
@@ -129,7 +129,7 @@ public:
_homeUp = up;
}
/** Get the mnaully set home position. */
/** Get the manually set home position. */
virtual void getHomePosition(osg::Vec3d& eye, osg::Vec3d& center, osg::Vec3d& up) const
{
eye = _homeEye;

8
include/osgGA/NodeTrackerManipulator
View File

@@ -48,11 +48,11 @@ class OSGGA_EXPORT NodeTrackerManipulator : public MatrixManipulator
enum TrackerMode
{
/** Track the center of the node's bounding sphere, but not rotations of the node.
* For datatbases which have a CoordinateSystemNode, the orientation is kept relative the coordinate frame if the center of the node.
* For databases which have a CoordinateSystemNode, the orientation is kept relative the coordinate frame if the center of the node.
*/
NODE_CENTER,
/** Track the center of the node's bounding sphere, and the azimuth rotation (about the z axis of the current coordinate frame).
* For datatbases which have a CoordinateSystemNode, the orientation is kept relative the coordinate frame if the center of the node.
* For databases which have a CoordinateSystemNode, the orientation is kept relative the coordinate frame if the center of the node.
*/
NODE_CENTER_AND_AZIM,
/** Tack the center of the node's bounding sphere, and the all rotations of the node.
@@ -90,10 +90,10 @@ class OSGGA_EXPORT NodeTrackerManipulator : public MatrixManipulator
/** get the position of the manipulator as a inverse matrix of the manipulator, typically used as a model view matrix.*/
virtual osg::Matrixd getInverseMatrix() const;
/** Get the FusionDistanceMode. Used by SceneView for setting up setereo convergence.*/
/** Get the FusionDistanceMode. Used by SceneView for setting up stereo convergence.*/
virtual osgUtil::SceneView::FusionDistanceMode getFusionDistanceMode() const { return osgUtil::SceneView::USE_FUSION_DISTANCE_VALUE; }
/** Get the FusionDistanceValue. Used by SceneView for setting up setereo convergence.*/
/** Get the FusionDistanceValue. Used by SceneView for setting up stereo convergence.*/
virtual float getFusionDistanceValue() const { return _distance; }
/** Attach a node to the manipulator.

4
include/osgGA/TerrainManipulator
View File

@@ -50,10 +50,10 @@ class OSGGA_EXPORT TerrainManipulator : public MatrixManipulator
/** get the position of the manipulator as a inverse matrix of the manipulator, typically used as a model view matrix.*/
virtual osg::Matrixd getInverseMatrix() const;
/** Get the FusionDistanceMode. Used by SceneView for setting up setereo convergence.*/
/** Get the FusionDistanceMode. Used by SceneView for setting up stereo convergence.*/
virtual osgUtil::SceneView::FusionDistanceMode getFusionDistanceMode() const { return osgUtil::SceneView::USE_FUSION_DISTANCE_VALUE; }
/** Get the FusionDistanceValue. Used by SceneView for setting up setereo convergence.*/
/** Get the FusionDistanceValue. Used by SceneView for setting up stereo convergence.*/
virtual float getFusionDistanceValue() const { return _distance; }
/** Attach a node to the manipulator.

4
include/osgGA/TrackballManipulator
View File

@@ -38,10 +38,10 @@ class OSGGA_EXPORT TrackballManipulator : public MatrixManipulator
/** get the position of the manipulator as a inverse matrix of the manipulator, typically used as a model view matrix.*/
virtual osg::Matrixd getInverseMatrix() const;
/** Get the FusionDistanceMode. Used by SceneView for setting up setereo convergence.*/
/** Get the FusionDistanceMode. Used by SceneView for setting up stereo convergence.*/
virtual osgUtil::SceneView::FusionDistanceMode getFusionDistanceMode() const { return osgUtil::SceneView::USE_FUSION_DISTANCE_VALUE; }
/** Get the FusionDistanceValue. Used by SceneView for setting up setereo convergence.*/
/** Get the FusionDistanceValue. Used by SceneView for setting up stereo convergence.*/
virtual float getFusionDistanceValue() const { return _distance; }
/** Attach a node to the manipulator.

2
include/osgGA/UFOManipulator
View File

@@ -70,7 +70,7 @@ class OSGGA_EXPORT UFOManipulator : public osgGA::MatrixManipulator
*/
virtual void setByMatrix( const osg::Matrixd &matrix ) ;
/** Set the current position with the invers matrix
/** Set the current position with the inverse matrix
\param invmat The inverse of a viewpoint matrix
*/
virtual void setByInverseMatrix( const osg::Matrixd &invmat);