Updates for Doxygen and osgGA headers from Neil.
This commit is contained in:
@@ -30,10 +30,11 @@
|
||||
|
||||
\namespace osgGA
|
||||
|
||||
The 'GA' in osgGA stands for 'GUI Abstraction'.
|
||||
The 'GA' in osgGA stands for 'GUI Abstraction'; the osgGA namespace provides facilities to
|
||||
help developers write the glue to allow the osg to work with varying window systems.
|
||||
|
||||
As the OpenSceneGraph is a cross-platform, window system-agnostic class library,
|
||||
it has no direct ties to any given windowing environment. Viewers, however, must at
|
||||
As a cross-platform, window system-agnostic class library, the OpenSceneGraph
|
||||
has no direct ties to any given windowing environment. Viewers, however, must at
|
||||
some level interact with a window system - where Window system may refer to a windowing
|
||||
API, e.g. GLUT, Qt, FLTK, MFC, ...
|
||||
|
||||
@@ -42,12 +43,13 @@ environments. E.g. most Viewers will update a Camera position in response to a m
|
||||
event, and may request that a timer be started as a result of a model being 'spun'.
|
||||
|
||||
The purpose of the osgGA namespace is to centralise the common areas of this
|
||||
functionality. With this centralised, the viewer writer needs only write a
|
||||
GUIEventAdapter, a GUIActionAdapter, and assemble a collection of GUIEventHandlers
|
||||
functionality. The viewer writer needs then only write a GUIEventAdapter, a
|
||||
GUIActionAdapter, and assemble a collection of GUIEventHandlers
|
||||
as appropriate for the viewer.
|
||||
|
||||
Events from the windowing environment are adpated, and then fed into the GUIEventHandlers.
|
||||
The GUIEventHandlers analyse and take action, and make requests of the windowing
|
||||
environemnt via the GUIActionAdapter. The viewer writer should honour these requests.
|
||||
environemnt via the GUIActionAdapter. The viewer writer should then honour these
|
||||
requests, translating them into calls to the windowing API.
|
||||
|
||||
*/
|
||||
|
||||
@@ -5,13 +5,13 @@
|
||||
#ifndef OSGGA_GEOSTATE_MANIPULATOR
|
||||
#define OSGGA_GEOSTATE_MANIPULATOR 1
|
||||
|
||||
#include <osg/StateSet>
|
||||
|
||||
#include <osgGA/Export>
|
||||
#include <osgGA/GUIEventAdapter>
|
||||
#include <osgGA/GUIActionAdapter>
|
||||
#include <osgGA/GUIEventHandler>
|
||||
|
||||
#include <osg/StateSet>
|
||||
|
||||
namespace osgGA{
|
||||
|
||||
class OSGGA_EXPORT StateSetManipulator : public GUIEventHandler
|
||||
|
||||
Reference in New Issue
Block a user