From 4689db0fd8b20c1c04c9aebf5a9f8482ba7dc015 Mon Sep 17 00:00:00 2001
From: Robert Osfield
Date: Fri, 6 Aug 2004 08:34:54 +0000
Subject: [PATCH] Updated docs
---
doc/doc++/osg/AutoTransform.html | 145 ++++++++++++++++++++-----------
doc/doc++/osg/osg.html | 2 +-
2 files changed, 94 insertions(+), 53 deletions(-)
diff --git a/doc/doc++/osg/AutoTransform.html b/doc/doc++/osg/AutoTransform.html
index b96066e8b..06b6584e7 100644
--- a/doc/doc++/osg/AutoTransform.html
+++ b/doc/doc++/osg/AutoTransform.html
@@ -7,7 +7,7 @@
-AutoTransform - is Transform the automatically scales or rotates to keep its children relative to screen space coordinates.
+AutoTransform - is Transform the automatically scales or rotates to keep its children relative to screen space coordinates
Inheritance:
@@ -21,6 +21,11 @@
+
+Public Classes
-
+enum AutoRotateMode
+
+
Public Methods
-
AutoTransform()
@@ -65,57 +70,63 @@
-
float getAutoUpdateEyeMovementTolerance() const
-
-void setAutoRotateToScreen(bool autoRotateToScreen)
+void setAutoRotateMode(AutoRotateMode mode)
-
-bool getAutoRotateToScreen() const
+AutoRotateMode getAutoRotateMode() const
-
-void setAutoScaleToScreen(bool autoScaleToScreen)
+void setAutoRotateToScreen(bool autoRotateToScreen)
-
-bool getAutoScaleToScreen() const
+void setAutoRotateToCamera(bool autoRotateToCamera)
-
-virtual bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const
+bool getAutoRotateToCamera() const
-
-virtual bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const
+void setAutoScaleToScreen(bool autoScaleToScreen)
+
-
+bool getAutoScaleToScreen() const
+
-
+virtual bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const
+
-
+virtual bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const
Protected Fields
-
-Vec3 _position
+Vec3 _position
-
-Vec3 _pivotPoint
+Vec3 _pivotPoint
-
-float _autoUpdateEyeMovementTolerance
+float _autoUpdateEyeMovementTolerance
-
-bool _autoRotateToScreen
+AutoRotateMode _autoRotateMode
-
-bool _autoScaleToScreen
+bool _autoScaleToScreen
-
-mutable Quat _rotation
+mutable Quat _rotation
-
-mutable Vec3 _scale
+mutable Vec3 _scale
-
-mutable bool _firstTimeToInitEyePoint
+mutable bool _firstTimeToInitEyePoint
-
-mutable osg::Vec3 _previousEyePoint
+mutable osg::Vec3 _previousEyePoint
-
-mutable int _previousWidth
+mutable int _previousWidth
-
-mutable int _previousHeight
+mutable int _previousHeight
-
-mutable osg::Matrix _previousProjection
+mutable osg::Matrix _previousProjection
-
-mutable osg::Vec3 _previousPosition
+mutable osg::Vec3 _previousPosition
-
-mutable bool _matrixDirty
+mutable bool _matrixDirty
-
-mutable osg::Matrix _cachedMatrix
+mutable osg::Matrix _cachedMatrix
Protected Methods
-
-virtual ~AutoTransform()
+virtual ~AutoTransform()
-
-void computeMatrix() const
+void computeMatrix() const
@@ -393,7 +404,7 @@
Documentation
AutoTransform - is Transform the automatically scales or rotates
-to keep its children relative to screen space coordinates.
+to keep its children relative to screen space coordinates
@@ -480,96 +491,126 @@ to keep its children relative to screen space coordinates.
- float getAutoUpdateEyeMovementTolerance() const
-
+
+
- enum AutoRotateMode
+
+
+
+
+- NO_ROTATION
+
+
+
+
- ROTATE_TO_SCREEN
+
+
+
+
- ROTATE_TO_CAMERA
+
+
+
+
+- void setAutoRotateMode(AutoRotateMode mode)
+
+
+
+
- AutoRotateMode getAutoRotateMode() const
+
+
+
- void setAutoRotateToScreen(bool autoRotateToScreen)
-
-
-
- bool getAutoRotateToScreen() const
+
+
+
- void setAutoRotateToCamera(bool autoRotateToCamera)
+
+
+
+
- bool getAutoRotateToCamera() const
-
+
- void setAutoScaleToScreen(bool autoScaleToScreen)
-
+
- bool getAutoScaleToScreen() const
-
+
- virtual bool computeLocalToWorldMatrix(Matrix& matrix, NodeVisitor* nv) const
-
+
- virtual bool computeWorldToLocalMatrix(Matrix& matrix, NodeVisitor* nv) const
-
+
- virtual ~AutoTransform()
-
+
- Vec3 _position
-
+
- Vec3 _pivotPoint
-
+
- float _autoUpdateEyeMovementTolerance
-
-
-
- bool _autoRotateToScreen
+
+
+
- AutoRotateMode _autoRotateMode
-
+
- bool _autoScaleToScreen
-
+
- mutable Quat _rotation
-
+
- mutable Vec3 _scale
-
+
- mutable bool _firstTimeToInitEyePoint
-
+
- mutable osg::Vec3 _previousEyePoint
-
+
- mutable int _previousWidth
-
+
- mutable int _previousHeight
-
+
- mutable osg::Matrix _previousProjection
-
+
- mutable osg::Vec3 _previousPosition
-
+
- void computeMatrix() const
-
+
- mutable bool _matrixDirty
-
+
- mutable osg::Matrix _cachedMatrix
diff --git a/doc/doc++/osg/osg.html b/doc/doc++/osg/osg.html
index 9bb45e7a3..2e94d1641 100644
--- a/doc/doc++/osg/osg.html
+++ b/doc/doc++/osg/osg.html
@@ -96,7 +96,7 @@ class ConstValueVisitor
template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>inline void TemplateIndexArray<T,ARRAYTYPE,DataSize,DataType> ::accept(unsigned int index, ConstValueVisitor& vv) const
class SG_EXPORT AutoTransform: public Transform
-AutoTransform - is Transform the automatically scales or rotates to keep its children relative to screen space coordinates.
+AutoTransform - is Transform the automatically scales or rotates to keep its children relative to screen space coordinates
class SG_EXPORT Billboard: public Geode
Billboard - a Geode which orientates its child osg::Drawable's to face the eye point.