osgGA Namespace Reference

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. More...

Classes
class	AnimationPathManipulator
class	CameraManipulator
	CameraManipulator is an abstract base class defining the interface, and a certain amount of default functionality, for classes which wish to control OSG cameras in response to GUI events. More...
class	CameraViewSwitchManipulator
class	Device
	Device base class from abstracting away from devices/windows that can generate events. More...
class	DriveManipulator
	DriveManipulator is a camera manipulator which provides drive-like functionality. More...
class	Event
	Base Event class. More...
class	EventHandler
	EventHandler is base class for adding handling of events, either as node event callback, drawable event callback or an event handler attached directly to the view(er) More...
class	EventQueue
	EventQueue implementation for collecting and adapting windowing events. More...
class	EventVisitor
	Basic EventVisitor implementation for animating a scene. More...
class	FirstPersonManipulator
	FirstPersonManipulator is base class for camera control based on position and orientation of camera, like walk, drive, and flight manipulators. More...
class	FlightManipulator
	FlightManipulator is a CameraManipulator which provides flight simulator-like updating of the camera position & orientation. More...
class	GUIActionAdapter
class	GUIEventAdapter
	Event class for storing Keyboard, mouse and window events. More...
class	GUIEventHandler
	GUIEventHandler provides a basic interface for any class which wants to handle a GUI Events. More...
class	KeySwitchMatrixManipulator
	KeySwitchMatrixManipulator is a decorator which allows the type of camera manipulator being used to be switched by pressing a key. More...
class	MultiTouchTrackballManipulator
class	NodeTrackerManipulator
class	OrbitManipulator
	OrbitManipulator is base class for camera control based on focal center, distance from the center, and orientation of distance vector to the eye. More...
struct	PointerData
class	SphericalManipulator
class	StandardManipulator
	StandardManipulator class provides basic functionality for user controlled manipulation. More...
class	StateSetManipulator
	Experimental class, not been looked at for a while, but which will be returned to at some point :- More...
class	TerrainManipulator
class	TrackballManipulator
class	UFOManipulator
	A UFO manipulator driven with keybindings. More...
class	Widget

Detailed Description

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 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, ...

There is much commonality in the implementation of Viewers for varying windowing environments. E.g. most Viewers will update a Camera position in response to a mouse 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. 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 then honour these requests, translating them into calls to the windowing API.