Public Methods
-
-
virtual ~ReaderWriter()
+
virtual ~ReaderWriter()
-
-
virtual const char* className() = 0
+
virtual const char* className() = 0
-
-
virtual bool acceptsExtension(const std::string&xtension*/)
+
virtual bool acceptsExtension(const std::string&xtension*/)
-
-
virtual ReadResult readObject(const std::string& , const Options* =NULL)
+
virtual ReadResult readObject(const std::string& , const Options* =NULL)
-
-
virtual ReadResult readImage(const std::string& , const Options* =NULL)
+
virtual ReadResult readImage(const std::string& , const Options* =NULL)
-
-
virtual ReadResult readNode(const std::string& , const Options* =NULL)
+
virtual ReadResult readNode(const std::string& , const Options* =NULL)
-
-
virtual WriteResult writeObject(const osg::Object& , const std::string& , const Options* =NULL)
+
virtual WriteResult writeObject(const osg::Object& , const std::string& , const Options* =NULL)
-
-
virtual WriteResult writeImage(const osg::Image& , const std::string& , const Options* =NULL)
+
virtual WriteResult writeImage(const osg::Image& , const std::string& , const Options* =NULL)
-
-
virtual WriteResult writeNode(const osg::Node& , const std::string& , const Options* =NULL)
+
virtual WriteResult writeNode(const osg::Node& , const std::string& , const Options* =NULL)
@@ -60,39 +60,39 @@ class WriteResult
-
+
virtual ~ReaderWriter()
-
+
virtual const char* className() = 0
-
+
virtual bool acceptsExtension(const std::string&xtension*/)
-
+
virtual ReadResult readObject(const std::string& , const Options* =NULL)
-
+
virtual ReadResult readImage(const std::string& , const Options* =NULL)
-
+
virtual ReadResult readNode(const std::string& , const Options* =NULL)
-
+
virtual WriteResult writeObject(const osg::Object& , const std::string& , const Options* =NULL)
-
+
virtual WriteResult writeImage(const osg::Image& , const std::string& , const Options* =NULL)
-
+
virtual WriteResult writeNode(const osg::Node& , const std::string& , const Options* =NULL)
diff --git a/doc/doc++/osgDB/RegisterDotOsgWrapperProxy.html b/doc/doc++/osgDB/RegisterDotOsgWrapperProxy.html
index f55baf75d..a152ea21c 100644
--- a/doc/doc++/osgDB/RegisterDotOsgWrapperProxy.html
+++ b/doc/doc++/osgDB/RegisterDotOsgWrapperProxy.html
@@ -13,14 +13,14 @@
Public Methods
-
-
RegisterDotOsgWrapperProxy(osg::Object* proto, const std::string& name, const std::string& associates, DotOsgWrapper::ReadFunc readFunc, DotOsgWrapper::WriteFunc writeFunc, DotOsgWrapper::ReadWriteMode readWriteMode=DotOsgWrapper::READ_AND_WRITE)
+
RegisterDotOsgWrapperProxy(osg::Object* proto, const std::string& name, const std::string& associates, DotOsgWrapper::ReadFunc readFunc, DotOsgWrapper::WriteFunc writeFunc, DotOsgWrapper::ReadWriteMode readWriteMode=DotOsgWrapper::READ_AND_WRITE)
-
-
~RegisterDotOsgWrapperProxy()
+
~RegisterDotOsgWrapperProxy()
Protected Fields
-
-
osg::ref_ptr<DotOsgWrapper> _wrapper
+
osg::ref_ptr<DotOsgWrapper> _wrapper
@@ -32,15 +32,15 @@
-
+
RegisterDotOsgWrapperProxy(osg::Object* proto, const std::string& name, const std::string& associates, DotOsgWrapper::ReadFunc readFunc, DotOsgWrapper::WriteFunc writeFunc, DotOsgWrapper::ReadWriteMode readWriteMode=DotOsgWrapper::READ_AND_WRITE)
-
+
~RegisterDotOsgWrapperProxy()
-
+
osg::ref_ptr<DotOsgWrapper> _wrapper
diff --git a/doc/doc++/osgDB/RegisterReaderWriterProxy.html b/doc/doc++/osgDB/RegisterReaderWriterProxy.html
index ef160110b..4e1557f7a 100644
--- a/doc/doc++/osgDB/RegisterReaderWriterProxy.html
+++ b/doc/doc++/osgDB/RegisterReaderWriterProxy.html
@@ -13,14 +13,14 @@
Public Methods
-
-
RegisterReaderWriterProxy()
+
RegisterReaderWriterProxy()
-
-
~RegisterReaderWriterProxy()
+
~RegisterReaderWriterProxy()
Protected Fields
-
-
osg::ref_ptr<T> _rw
+
osg::ref_ptr<T> _rw
@@ -32,15 +32,15 @@
-
+
RegisterReaderWriterProxy()
-
+
~RegisterReaderWriterProxy()
-
+
osg::ref_ptr<T> _rw
diff --git a/doc/doc++/osgDB/Registry.html b/doc/doc++/osgDB/Registry.html
index b835105c6..b0be08048 100644
--- a/doc/doc++/osgDB/Registry.html
+++ b/doc/doc++/osgDB/Registry.html
@@ -13,71 +13,110 @@
Public Methods
-
-
static Registry* instance()
+
static Registry* instance()
-
-
~Registry()
+
~Registry()
-
-
void readCommandLine(std::vector<std::string>& commandLine)
+
void readCommandLine(std::vector<std::string>& commandLine)
- read the command line string list, removing any matched control sequences
-
-
void addFileExtensionAlias(const std::string mapExt, const std::string toExt)
+
void addFileExtensionAlias(const std::string mapExt, const std::string toExt)
- register an fileextension alias to mapExt toExt, the later should the the extension name of the readerwriter plugin library.
-
-
void addDotOsgWrapper(DotOsgWrapper* wrapper)
+
void addDotOsgWrapper(DotOsgWrapper* wrapper)
-
-
void removeDotOsgWrapper(DotOsgWrapper* wrapper)
+
void removeDotOsgWrapper(DotOsgWrapper* wrapper)
-
-
void addReaderWriter(ReaderWriter* rw)
+
void addReaderWriter(ReaderWriter* rw)
-
-
void removeReaderWriter(ReaderWriter* rw)
+
void removeReaderWriter(ReaderWriter* rw)
-
-
std::string createLibraryNameForFile(const std::string& fileName)
+
std::string createLibraryNameForFile(const std::string& fileName)
- create the platform specific library name associated with file
-
-
std::string createLibraryNameForExt(const std::string& ext)
+
std::string createLibraryNameForExt(const std::string& ext)
- create the platform specific library name associated with file extension
-
-
bool loadLibrary(const std::string& fileName)
+
std::string createLibraryNameForNodeKit(const std::string& name)
+ - create the platform specific library name associated with nodekit library name
+
-
+
bool loadLibrary(const std::string& fileName)
- find the library in the SG_LIBRARY_PATH and load it
-
-
bool closeLibrary(const std::string& fileName)
+
bool closeLibrary(const std::string& fileName)
- close the attached library with specified name
-
-
osg::Object* readObjectOfType(const osg::Object& compObj, Input& fr)
+
osg::Object* readObjectOfType(const osg::Object& compObj, Input& fr)
-
-
osg::Object* readObject(Input& fr)
+
osg::Object* readObject(Input& fr)
-
-
osg::Image* readImage(Input& fr)
+
osg::Image* readImage(Input& fr)
-
-
osg::Drawable* readDrawable(Input& fr)
+
osg::Drawable* readDrawable(Input& fr)
-
-
osg::StateAttribute* readStateAttribute(Input& fr)
+
osg::StateAttribute* readStateAttribute(Input& fr)
-
-
osg::Node* readNode(Input& fr)
+
osg::Node* readNode(Input& fr)
-
-
bool writeObject(const osg::Object& obj, Output& fw)
+
bool writeObject(const osg::Object& obj, Output& fw)
-
-
ReaderWriter::ReadResult readObject(const std::string& fileName)
+
ReaderWriter::ReadResult readObject(const std::string& fileName)
-
-
ReaderWriter::WriteResult writeObject(const osg::Object& obj, const std::string& fileName)
+
ReaderWriter::WriteResult writeObject(const osg::Object& obj, const std::string& fileName)
-
-
ReaderWriter::ReadResult readImage(const std::string& fileName)
+
ReaderWriter::ReadResult readImage(const std::string& fileName)
-
-
ReaderWriter::WriteResult writeImage(const osg::Image& obj, const std::string& fileName)
+
ReaderWriter::WriteResult writeImage(const osg::Image& obj, const std::string& fileName)
-
-
ReaderWriter::ReadResult readNode(const std::string& fileName)
+
ReaderWriter::ReadResult readNode(const std::string& fileName)
-
-
ReaderWriter::WriteResult writeNode(const osg::Node& node, const std::string& fileName)
+
ReaderWriter::WriteResult writeNode(const osg::Node& node, const std::string& fileName)
-
-
void setCreateNodeFromImage(bool flag)
+
void setCreateNodeFromImage(bool flag)
-
-
bool getCreateNodeFromImage() const
+
bool getCreateNodeFromImage() const
-
-
void setOptions(ReaderWriter::Options* opt)
+
void setOptions(ReaderWriter::Options* opt)
-
-
ReaderWriter::Options* getOptions()
+
ReaderWriter::Options* getOptions()
-
-
const ReaderWriter::Options* getOptions() const
+
const ReaderWriter::Options* getOptions() const
+-
+
void initFilePathLists()
+ - initilize both the Data and Library FilePaths, by default called by the constructor, so it should only be required if you want to force the re-reading of environmental variables
+
-
+
void initDataFilePathList()
+ - initilize the Data FilePath by reading the OSG_FILE_PATH environmental variable
+
-
+
void setDataFilePathList(const FilePathList& filepath)
+ - Set the data file path using a list of paths stored in a FilePath, which is used when search for data files
+
-
+
void setDataFilePathList(const std::string& paths)
+ - Set the data file path using a single string deliminated either with ';' (Windows) or ':' (All other platforms), which is used when search for data files
+
-
+
FilePathList& getDataFilePathList()
+ - get the data file path which is used when search for data files
+
-
+
const FilePathList& getDataFilePathList() const
+ - get the const data file path which is used when search for data files
+
-
+
void initLibraryFilePathList()
+ - initilize the Library FilePath by reading the OSG_LIBRARY_PATH and the appropriate system environmental variables
+
-
+
void setLibraryFilePathList(const FilePathList& filepath)
+ - Set the library file path using a list of paths stored in a FilePath, which is used when search for data files
+
-
+
void setLibraryFilePathList(const std::string& paths)
+ - Set the library file path using a single string deliminated either with ';' (Windows) or ':' (All other platforms), which is used when search for data files
+
-
+
FilePathList& getLibraryFilePathList()
+ - get the library file path which is used when search for library (dso/dll's) files
+
-
+
const FilePathList& getLibraryFilePathList() const
+ - get the const library file path which is used when search for library (dso/dll's) files
+
-
+
static void convertStringPathIntoFilePathList(const std::string& paths, FilePathList& filepath)
+ - convert a string containing a list of paths deliminated either with ';' (Windows) or ':' (All other platforms) into FilePath represetation
@@ -99,20 +138,20 @@ register at runtime a reader/writer with the Registry.
-
+
static Registry* instance()
-
+
~Registry()
-
+
void readCommandLine(std::vector<std::string>& commandLine)
- read the command line string list, removing any matched control sequences
-
+
void addFileExtensionAlias(const std::string mapExt, const std::string toExt)
- register an fileextension alias to mapExt toExt, the later
should the the extension name of the readerwriter plugin library.
@@ -121,112 +160,180 @@ addExtAlias("tif","tiff") which will enable .tif to be read
by the libdb_tiff readerwriter plugin.
-
+
void addDotOsgWrapper(DotOsgWrapper* wrapper)
-
+
void removeDotOsgWrapper(DotOsgWrapper* wrapper)
-
+
void addReaderWriter(ReaderWriter* rw)
-
+
void removeReaderWriter(ReaderWriter* rw)
-
+
std::string createLibraryNameForFile(const std::string& fileName)
- create the platform specific library name associated with file
-
+
std::string createLibraryNameForExt(const std::string& ext)
- create the platform specific library name associated with file extension
+
+
+
std::string createLibraryNameForNodeKit(const std::string& name)
+- create the platform specific library name associated with nodekit library name
+
-
+
bool loadLibrary(const std::string& fileName)
- find the library in the SG_LIBRARY_PATH and load it
-
+
bool closeLibrary(const std::string& fileName)
- close the attached library with specified name
-
+
osg::Object* readObjectOfType(const osg::Object& compObj, Input& fr)
-
+
osg::Object* readObject(Input& fr)
-
+
osg::Image* readImage(Input& fr)
-
+
osg::Drawable* readDrawable(Input& fr)
-
+
osg::StateAttribute* readStateAttribute(Input& fr)
-
+
osg::Node* readNode(Input& fr)
-
+
bool writeObject(const osg::Object& obj, Output& fw)
-
+
ReaderWriter::ReadResult readObject(const std::string& fileName)
-
+
ReaderWriter::WriteResult writeObject(const osg::Object& obj, const std::string& fileName)
-
+
ReaderWriter::ReadResult readImage(const std::string& fileName)
-
+
ReaderWriter::WriteResult writeImage(const osg::Image& obj, const std::string& fileName)
-
+
ReaderWriter::ReadResult readNode(const std::string& fileName)
-
+
ReaderWriter::WriteResult writeNode(const osg::Node& node, const std::string& fileName)
-
+
void setCreateNodeFromImage(bool flag)
-
+
bool getCreateNodeFromImage() const
-
+
void setOptions(ReaderWriter::Options* opt)
-
+
ReaderWriter::Options* getOptions()
-
+
const ReaderWriter::Options* getOptions() const
+
+
+
+
void initFilePathLists()
+- initilize both the Data and Library FilePaths, by default called by the
+constructor, so it should only be required if you want to force
+the re-reading of environmental variables
+
+
+
+
void initDataFilePathList()
+- initilize the Data FilePath by reading the OSG_FILE_PATH environmental variable
+
+
+
+
void setDataFilePathList(const FilePathList& filepath)
+- Set the data file path using a list of paths stored in a FilePath, which is used when search for data files
+
+
+
+
void setDataFilePathList(const std::string& paths)
+- Set the data file path using a single string deliminated either with ';' (Windows) or ':' (All other platforms), which is used when search for data files
+
+
+
+
FilePathList& getDataFilePathList()
+- get the data file path which is used when search for data files
+
+
+
+
const FilePathList& getDataFilePathList() const
+- get the const data file path which is used when search for data files
+
+
+
+
void initLibraryFilePathList()
+- initilize the Library FilePath by reading the OSG_LIBRARY_PATH
+and the appropriate system environmental variables
+
+
+
+
void setLibraryFilePathList(const FilePathList& filepath)
+- Set the library file path using a list of paths stored in a FilePath, which is used when search for data files
+
+
+
+
void setLibraryFilePathList(const std::string& paths)
+- Set the library file path using a single string deliminated either with ';' (Windows) or ':' (All other platforms), which is used when search for data files
+
+
+
+
FilePathList& getLibraryFilePathList()
+- get the library file path which is used when search for library (dso/dll's) files
+
+
+
+
const FilePathList& getLibraryFilePathList() const
+- get the const library file path which is used when search for library (dso/dll's) files
+
+
+
+
static void convertStringPathIntoFilePathList(const std::string& paths, FilePathList& filepath)
+- convert a string containing a list of paths deliminated either with ';' (Windows) or ':' (All other platforms) into FilePath represetation
- This class has no child classes.
diff --git a/doc/doc++/osgDB/WriteResult.html b/doc/doc++/osgDB/WriteResult.html
index 173132162..4006a5be8 100644
--- a/doc/doc++/osgDB/WriteResult.html
+++ b/doc/doc++/osgDB/WriteResult.html
@@ -12,35 +12,35 @@
Public Methods
-
-
WriteResult(WriteStatus status=FILE_NOT_HANDLED)
+
WriteResult(WriteStatus status=FILE_NOT_HANDLED)
-
-
WriteResult(const std::string& m)
+
WriteResult(const std::string& m)
-
-
WriteResult(const WriteResult& rr)
+
WriteResult(const WriteResult& rr)
-
-
WriteResult& operator = (const WriteResult& rr)
+
WriteResult& operator = (const WriteResult& rr)
-
-
const std::string& message() const
+
const std::string& message() const
-
-
const WriteStatus status() const
+
const WriteStatus status() const
-
-
const bool success() const
+
const bool success() const
-
-
const bool error() const
+
const bool error() const
-
-
const bool notHandled() const
+
const bool notHandled() const
Public Members
-
-
enum WriteStatus
+
enum WriteStatus
Protected Fields
-
-
WriteStatus _status
+
WriteStatus _status
-
-
std::string _message
+
std::string _message
@@ -51,65 +51,65 @@
-
+
enum WriteStatus
-
+
FILE_NOT_HANDLED
-
+
FILE_SAVED
-
+
ERROR_IN_WRITING_FILE
-
-
WriteResult(WriteStatus status=FILE_NOT_HANDLED)
+
+
WriteResult(WriteStatus status=FILE_NOT_HANDLED)
-
+
WriteResult(const std::string& m)
-
-
WriteResult(const WriteResult& rr)
+
+
WriteResult(const WriteResult& rr)
-
+
WriteResult& operator = (const WriteResult& rr)
-
+
const std::string& message() const
-
-
const WriteStatus status() const
+
+
const WriteStatus status() const
-
+
const bool success() const
-
+
const bool error() const
-
+
const bool notHandled() const
-
-
WriteStatus _status
+
+
WriteStatus _status
-
+
std::string _message
diff --git a/doc/doc++/osgDB/findFileInPath.html b/doc/doc++/osgDB/findFileInPath.html
index 584353bf8..5fe3c5e9d 100644
--- a/doc/doc++/osgDB/findFileInPath.html
+++ b/doc/doc++/osgDB/findFileInPath.html
@@ -2,17 +2,17 @@
- OSGDB_EXPORT extern char* osgDB::findFileInPath
+ OSGDB_EXPORT extern std::string osgDB::findFileInPath
-( const char* _file,
const char* filePath )
find specified file if specified file path
+(const std::string& filename,
const FilePathList& filePath)
find specified file in specified file path
Documentation
-find specified file if specified file path
+find specified file in specified file path
Alphabetic index HTML hierarchy of classes or Java
This page was generated with the help of DOC++.
diff --git a/doc/doc++/osgDB/osgDB.html b/doc/doc++/osgDB/osgDB.html
index 3f943ea4d..2350069b0 100644
--- a/doc/doc++/osgDB/osgDB.html
+++ b/doc/doc++/osgDB/osgDB.html
@@ -37,40 +37,47 @@ class OSGDB_EXPORT FieldReaderIterator
OSGDB_EXPORT extern bool equalCaseInsensitive(const std::string& lhs, const char* rhs)
-
-OSGDB_EXPORT extern void initFilePath( void )
-
- initialize the data file path, uses OSGFILEPATH environmental variable to defined
+OSGDB_EXPORT extern bool fileExists(const std::string& filename)
+
- return true if a file exisits.
-
-OSGDB_EXPORT extern void setFilePath( const char* _path )
-
- set the data file path
-
-
-OSGDB_EXPORT extern const char* getFilePath()
-
- set the data file path
-
-
-OSGDB_EXPORT extern char* findFileInPath( const char* _file, const char* filePath )
-
- find specified file if specified file path
-
-
-OSGDB_EXPORT extern char* findFile( const char* file )
-
- find specified file on the set data file path
-
-
-OSGDB_EXPORT extern char* findDSO( const char* name )
-
- find specified dso/dll
-
-
-typedef std::vector<std::string> DirectoryContents
-
- simple list of names to represent a directory's contents.
+OSGDB_EXPORT extern std::string findFileInPath(const std::string& filename, const FilePathList& filePath)
+
- find specified file in specified file path
-
OSGDB_EXPORT extern std::string findFileInDirectory(const std::string& fileName, const std::string& dirName, bool caseInsensitive=false)
- return the directory/filename of a file if its is contained within specified directory.
-
+typedef std::vector<std::string> DirectoryContents
+
- simple list of names to represent a directory's contents.
+
-
OSGDB_EXPORT extern DirectoryContents getDirectoryContents(const std::string& dirName)
- return the contents of a directory.
-
+
inline void setDataFilePathList(const FilePathList& filepath)
+-
+
inline void setDataFilePathList(const std::string& paths)
+-
+
inline FilePathList& getDataFilePathList()
+-
+
OSGDB_EXPORT extern std::string findDataFile(const std::string& filename)
+-
+class PushAndPopDataPath
+
- Convinience class for pushing a path on construction, and popping the path and destruction.
+
-
+
inline void setLibraryFilePathList(const FilePathList& filepaths)
+-
+
inline void setLibraryFilePathList(const std::string& paths)
+-
+
inline FilePathList& getLibraryFilePathList()
+-
+
OSGDB_EXPORT extern std::string findLibraryFile(const std::string& filename)
+-
class OSGDB_EXPORT Input: public FieldReaderIterator
- Class for managing the reading of ASCII osg files
-
class OSGDB_EXPORT Output: public std::ofstream
- ofstream wrapper class for adding support for indenting.
-
-
template<class T> bool writeArrayBlock(Output& fw, T* start, T* finish)
+
template<class T> bool writeArrayBlock(Output& fw, T* start, T* finish)
-
class OSGDB_EXPORT ReaderWriter: public osg::Referenced
- pure virtual base class for reading and writing of non native formats.
@@ -87,6 +94,9 @@ OSGDB_EXPORT extern osg::Node* readNodeFile
OSGDB_EXPORT extern osg::Node* readNodeFiles(std::vector<std::string>& commandLine)
- Read an osg::Node subgraph from files, creating a osg::Group to contain the nodes if more than one subgraph has been loaded
-
+typedef std::deque<std::string> FilePathList
+
- list of directories to search through which searching for files.
+
-
class OSGDB_EXPORT Registry
- Registry is a singleton factory which stores the reader/writers which are linked in at runtime for reading non-native file formats.
-
@@ -143,8 +153,40 @@ OSGDB_EXPORT extern bool writeNodeFile(c
OSGDB_EXPORT extern bool equalCaseInsensitive(const std::string& lhs, const char* rhs)
-
+
+
+
inline void setDataFilePathList(const FilePathList& filepath)
+
+
+
+
inline void setDataFilePathList(const std::string& paths)
+
+
+
+
inline FilePathList& getDataFilePathList()
+
+
+
+
OSGDB_EXPORT extern std::string findDataFile(const std::string& filename)
+
+
+
+
inline void setLibraryFilePathList(const FilePathList& filepaths)
+
+
+
inline void setLibraryFilePathList(const std::string& paths)
+
+
+
+
inline FilePathList& getLibraryFilePathList()
+
+
+
+
OSGDB_EXPORT extern std::string findLibraryFile(const std::string& filename)
+
+
+
template<class T> bool writeArrayBlock(Output& fw, T* start, T* finish)
Alphabetic index HTML hierarchy of classes or Java
diff --git a/doc/doc++/osgGA/CameraManipulator.html b/doc/doc++/osgGA/CameraManipulator.html
new file mode 100644
index 000000000..98b20ef16
--- /dev/null
+++ b/doc/doc++/osgGA/CameraManipulator.html
@@ -0,0 +1,160 @@
+
+
+
+
+ class OSGGA_EXPORT osgGA::CameraManipulator
+
+
+
+
+
+
+Inheritance:
+
+
+
+
+
+Public Methods
-
+
CameraManipulator()
+-
+
virtual ~CameraManipulator()
+-
+
virtual void setCamera(osg::Camera*)
+ - attach a camera to the manipulator to be used for specifying view
+
-
+
virtual const osg::Camera* getCamera() const
+ - get the attached camera
+
-
+
virtual osg::Camera* getCamera()
+ - get the attached camera
+
-
+
virtual void setNode(osg::Node*)
+ - Attach a node to the manipulator.
+
-
+
virtual const osg::Node* getNode() const
+ - Return node if attached
+
-
+
virtual osg::Node* getNode()
+ - Return node if attached
+
-
+
virtual void home(const GUIEventAdapter&, GUIActionAdapter&)
+ - Move the camera to the default position.
+
-
+
virtual void init(const GUIEventAdapter&, GUIActionAdapter&)
+ - Start/restart the manipulator
+
-
+
virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us)
+ - Handle events, return true if handled, false otherwise
+
-
+
virtual void accept(GUIEventHandlerVisitor& v)
+ - Handle visitations
+
+
+
+Protected Fields
-
+
osg::ref_ptr<osg::Camera> _camera
+
+
+
+
+
+
+Public Methods
-
+
virtual const CompositeGUIEventHandler* getComposite() const
+-
+
virtual CompositeGUIEventHandler* getComposite()
+
+
+
+
+
+
+Documentation
+
+
+
+
+
CameraManipulator()
+
+
+
+
virtual ~CameraManipulator()
+
+
+
+
virtual void setCamera(osg::Camera*)
+- attach a camera to the manipulator to be used for specifying view
+
+
+
+
virtual const osg::Camera* getCamera() const
+- get the attached camera
+
+
+
+
virtual osg::Camera* getCamera()
+- get the attached camera
+
+
+
+
virtual void setNode(osg::Node*)
+- Attach a node to the manipulator.
+Automatically detaches previously attached node.
+setNode(NULL) detaches previously nodes.
+Is ignored by manipulators which do not require a reference model.
+
+
+
+
virtual const osg::Node* getNode() const
+- Return node if attached
+
+
+
+
virtual osg::Node* getNode()
+- Return node if attached
+
+
+
+
virtual void home(const GUIEventAdapter&, GUIActionAdapter&)
+- Move the camera to the default position.
+May be ignored by manipulators if home functionality is not appropriate.
+
+
+
+
virtual void init(const GUIEventAdapter&, GUIActionAdapter&)
+- Start/restart the manipulator
+
+
+
+
virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us)
+- Handle events, return true if handled, false otherwise
+
+
+
+
virtual void accept(GUIEventHandlerVisitor& v)
+- Handle visitations
+
+
+
+
osg::ref_ptr<osg::Camera> _camera
+
+
+- Direct child classes:
+
- TrackballManipulator
+KeySwitchCameraManipulator
+FlightManipulator
+DriveManipulator
+
+
+
Alphabetic index HTML hierarchy of classes or Java
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/ClassGraph.class b/doc/doc++/osgGA/ClassGraph.class
new file mode 100644
index 000000000..4f41a1fb2
Binary files /dev/null and b/doc/doc++/osgGA/ClassGraph.class differ
diff --git a/doc/doc++/osgGA/ClassGraphPanel.class b/doc/doc++/osgGA/ClassGraphPanel.class
new file mode 100644
index 000000000..4f3ea86bb
Binary files /dev/null and b/doc/doc++/osgGA/ClassGraphPanel.class differ
diff --git a/doc/doc++/osgGA/ClassLayout.class b/doc/doc++/osgGA/ClassLayout.class
new file mode 100644
index 000000000..69a6f494e
Binary files /dev/null and b/doc/doc++/osgGA/ClassLayout.class differ
diff --git a/doc/doc++/osgGA/CompositeGUIEventHandler.html b/doc/doc++/osgGA/CompositeGUIEventHandler.html
new file mode 100644
index 000000000..28e5c5b00
--- /dev/null
+++ b/doc/doc++/osgGA/CompositeGUIEventHandler.html
@@ -0,0 +1,112 @@
+
+
+
+
+ class OSGGA_EXPORT osgGA::CompositeGUIEventHandler
+
+
+
+
+ CompositeGUIEventHandler allows GUIEventHandlers to be composed into hierarchies
+
+
+Inheritance:
+
+
+
+
+
+Public Methods
-
+
typedef std::vector< osg::ref_ptr<GUIEventHandler> >virtual ChildList bool handle(const GUIEventAdapter& ea, GUIActionAdapter& aa)
+-
+
virtual const CompositeGUIEventHandler* getComposite() const
+-
+
virtual CompositeGUIEventHandler* getComposite()
+-
+
virtual void accept(GUIEventHandlerVisitor& v)
+-
+
virtual bool addChild(GUIEventHandler* geh)
+-
+
virtual bool removeChild(GUIEventHandler* geh)
+-
+
const int getNumChildren() const
+-
+
GUIEventHandler* getChild( int i)
+-
+
const GUIEventHandler* getChild( int i ) const
+-
+
bool containsNode( const GUIEventHandler* node ) const
+-
+
ChildList::iterator findChild( const GUIEventHandler* node )
+
+
+
+
+
+
+
+
+
+Documentation
+
+CompositeGUIEventHandler allows GUIEventHandlers to be composed into hierarchies
+
+
+
+
+
typedef std::vector< osg::ref_ptr<GUIEventHandler> >virtual ChildList bool handle(const GUIEventAdapter& ea, GUIActionAdapter& aa)
+
+
+
+
virtual const CompositeGUIEventHandler* getComposite() const
+
+
+
+
virtual CompositeGUIEventHandler* getComposite()
+
+
+
+
virtual void accept(GUIEventHandlerVisitor& v)
+
+
+
+
virtual bool addChild(GUIEventHandler* geh)
+
+
+
+
virtual bool removeChild(GUIEventHandler* geh)
+
+
+
+
const int getNumChildren() const
+
+
+
+
GUIEventHandler* getChild( int i)
+
+
+
+
const GUIEventHandler* getChild( int i ) const
+
+
+
+
bool containsNode( const GUIEventHandler* node ) const
+
+
+
+
ChildList::iterator findChild( const GUIEventHandler* node )
+
+
+
- This class has no child classes.
+
+
Alphabetic index HTML hierarchy of classes or Java
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/DriveManipulator.html b/doc/doc++/osgGA/DriveManipulator.html
new file mode 100644
index 000000000..77db2f095
--- /dev/null
+++ b/doc/doc++/osgGA/DriveManipulator.html
@@ -0,0 +1,143 @@
+
+
+
+
+ class OSGGA_EXPORT osgGA::DriveManipulator
+
+
+
+
+
+
+Inheritance:
+
+
+
+
+
+Public Methods
-
+
DriveManipulator()
+-
+
virtual ~DriveManipulator()
+-
+
virtual void setNode(osg::Node*)
+ - Attach a node to the manipulator.
+
-
+
virtual const osg::Node* getNode() const
+ - Return node if attached
+
-
+
virtual osg::Node* getNode()
+ - Return node if attached
+
-
+
virtual void home(const GUIEventAdapter& ea, GUIActionAdapter& us)
+ - Move the camera to the default position.
+
-
+
virtual void init(const GUIEventAdapter& ea, GUIActionAdapter& us)
+ - Start/restart the manipulator
+
-
+
virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us)
+ - handle events, return true if handled, false otherwise
+
+
+
+
+
+
+Public Methods
-
+
virtual void setCamera(osg::Camera*)
+-
+
virtual const osg::Camera* getCamera() const
+-
+
virtual osg::Camera* getCamera()
+-
+
virtual void accept(GUIEventHandlerVisitor& v)
+
+
+
+Protected Fields
-
+
osg::ref_ptr<osg::Camera> _camera
+
+
+
+
+
+
+Public Methods
-
+
virtual const CompositeGUIEventHandler* getComposite() const
+-
+
virtual CompositeGUIEventHandler* getComposite()
+
+
+
+
+
+
+Documentation
+
+
+
+
+
DriveManipulator()
+
+
+
+
virtual ~DriveManipulator()
+
+
+
+
virtual void setNode(osg::Node*)
+- Attach a node to the manipulator.
+Automatically detaches previously attached node.
+setNode(NULL) detaches previously nodes.
+Is ignored by manipulators which do not require a reference model.
+
+
+
+
virtual const osg::Node* getNode() const
+- Return node if attached
+
+
+
+
virtual osg::Node* getNode()
+- Return node if attached
+
+
+
+
virtual void home(const GUIEventAdapter& ea, GUIActionAdapter& us)
+- Move the camera to the default position.
+May be ignored by manipulators if home functionality is not appropriate.
+
+
+
+
virtual void init(const GUIEventAdapter& ea, GUIActionAdapter& us)
+- Start/restart the manipulator
+
+
+
+
virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us)
+- handle events, return true if handled, false otherwise
+
+
+
+
+
USE_MOUSE_Y_FOR_SPEED
+
+
+
+
USE_MOUSE_BUTTONS_FOR_SPEED
+
+
+
+
- This class has no child classes.
+
+
Alphabetic index HTML hierarchy of classes or Java
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/FlightManipulator.html b/doc/doc++/osgGA/FlightManipulator.html
new file mode 100644
index 000000000..0199db767
--- /dev/null
+++ b/doc/doc++/osgGA/FlightManipulator.html
@@ -0,0 +1,160 @@
+
+
+
+
+ class OSGGA_EXPORT osgGA::FlightManipulator
+
+
+
+
+
+
+Inheritance:
+
+
+
+
+
+Public Methods
-
+
FlightManipulator()
+-
+
virtual ~FlightManipulator()
+-
+
virtual void setNode(osg::Node*)
+ - Attach a node to the manipulator.
+
-
+
virtual const osg::Node* getNode() const
+ - Return node if attached
+
-
+
virtual osg::Node* getNode()
+ - Return node if attached
+
-
+
virtual void home(const GUIEventAdapter& ea, GUIActionAdapter& us)
+ - Move the camera to the default position.
+
-
+
virtual void init(const GUIEventAdapter& ea, GUIActionAdapter& us)
+ - Start/restart the manipulator
+
-
+
virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us)
+ - handle events, return true if handled, false otherwise
+
-
+
void setYawControlMode(YawControlMode ycm)
+ - Set the yaw control between no yaw and yawing when banked
+
+
+
+Public Members
-
+
enum YawControlMode
+
+
+
+
+
+
+Public Methods
-
+
virtual void setCamera(osg::Camera*)
+-
+
virtual const osg::Camera* getCamera() const
+-
+
virtual osg::Camera* getCamera()
+-
+
virtual void accept(GUIEventHandlerVisitor& v)
+
+
+
+Protected Fields
-
+
osg::ref_ptr<osg::Camera> _camera
+
+
+
+
+
+
+Public Methods
-
+
virtual const CompositeGUIEventHandler* getComposite() const
+-
+
virtual CompositeGUIEventHandler* getComposite()
+
+
+
+
+
+
+Documentation
+
+
+
+
+
FlightManipulator()
+
+
+
+
virtual ~FlightManipulator()
+
+
+
+
virtual void setNode(osg::Node*)
+- Attach a node to the manipulator.
+Automatically detaches previously attached node.
+setNode(NULL) detaches previously nodes.
+Is ignored by manipulators which do not require a reference model.
+
+
+
+
virtual const osg::Node* getNode() const
+- Return node if attached
+
+
+
+
virtual osg::Node* getNode()
+- Return node if attached
+
+
+
+
virtual void home(const GUIEventAdapter& ea, GUIActionAdapter& us)
+- Move the camera to the default position.
+May be ignored by manipulators if home functionality is not appropriate.
+
+
+
+
virtual void init(const GUIEventAdapter& ea, GUIActionAdapter& us)
+- Start/restart the manipulator
+
+
+
+
virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us)
+- handle events, return true if handled, false otherwise
+
+
+
+
enum YawControlMode
+
+
+
+
+
YAW_AUTOMATICALLY_WHEN_BANKED
+
+
+
+
NO_AUTOMATIC_YAW
+
+
+
+
+
void setYawControlMode(YawControlMode ycm)
+- Set the yaw control between no yaw and yawing when banked
+
+
+
- This class has no child classes.
+
+
Alphabetic index HTML hierarchy of classes or Java
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/GUIActionAdapter.html b/doc/doc++/osgGA/GUIActionAdapter.html
new file mode 100644
index 000000000..43d3afa12
--- /dev/null
+++ b/doc/doc++/osgGA/GUIActionAdapter.html
@@ -0,0 +1,77 @@
+
+
+
+
+ class osgGA::GUIActionAdapter
+
+
+
+
+Pure virtual base class for adapting the GUI actions requested by CameraManipulators into actions which are handled by the GUI toolkit of the users application.
+
+
+
+
+Public Methods
-
+
virtual void requestRedraw() = 0
+-
+
virtual void requestContinuousUpdate(bool needed=true) = 0
+-
+
virtual void requestWarpPointer(int x, int y) = 0
+
+
+
+
+
+
+Documentation
+Pure virtual base class for adapting the GUI actions requested by CameraManipulators
+into actions which are handled by the GUI toolkit of the users application.
+
+There are several was of using the ActionAdapter either inheriting it as
+done with osgGLUT::Viewer class or passing a simple struct to the camera
+manipulator then unpacking the results and working out what to do to respond
+to the requests.
+
+
Also there are several ways to run your app and handle the updating of
+the window. osgGLUT::Viewer always has a idle callback registered which does a
+redraw all the time. osgGLUT::Viewer can safely ignore both requestRedraw() and
+requestContinousUpdate() as these are happening all the time anyway.
+
+
Other apps will probably want to respond to the requestRedraw() and
+requestContinousUpdate(bool) and again there is more than one way to handle it.
+You can override requestRedraw() and implement to call your own window
+redraw straight away. Or you can implement so that a flag is set and
+then you then respond the flag being set in your own leisure.
+
+
requestContinousUpdate(bool) is for enabling a throw or idle
+callback to be requested by the camera manipulator. Again you can respond
+to this immediately by registering a idle callback or a timed callback, or
+you can delay setting the callback and do at you own leisure.
+
+
requestWarpPointer(int,int) is requesting a respositioning of a mouse pointer
+to a specified x,y location on the window. Used by some camera manipulators
+to initialize the mouse pointer when mouse position relative to a controls
+neutral mouse position is required, i.e when mimicking a aircrafts joystick.
+
+
+
+
+
virtual void requestRedraw() = 0
+
+
+
+
virtual void requestContinuousUpdate(bool needed=true) = 0
+
+
+
+
virtual void requestWarpPointer(int x, int y) = 0
+
+
+
- This class has no child classes.
+
+
Alphabetic index HTML hierarchy of classes or Java
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/GUIEventAdapter.html b/doc/doc++/osgGA/GUIEventAdapter.html
new file mode 100644
index 000000000..9003fa00a
--- /dev/null
+++ b/doc/doc++/osgGA/GUIEventAdapter.html
@@ -0,0 +1,215 @@
+
+
+
+
+ class osgGA::GUIEventAdapter
+
+
+
+
+Pure virtual base class for adapting platform specific events into generic keyboard and mouse events.
+
+
+Inheritance:
+
+
+
+
+
+Public Methods
-
+
GUIEventAdapter()
+-
+
virtual EventType getEventType() const = 0
+ - Get the EventType of the GUI event
+
-
+
virtual int getKey() const = 0
+ - key pressed, return -1 if inappropriate for this event.
+
-
+
virtual int getButton() const = 0
+ - button pressed/released, return -1 if inappropriate for this event
+
-
+
virtual int getXmin() const = 0
+ - window minimum x.
+
-
+
virtual int getXmax() const = 0
+ - window maximum x.
+
-
+
virtual int getYmin() const = 0
+ - window minimum y.
+
-
+
virtual int getYmax() const = 0
+ - window maximum y.
+
-
+
virtual int getX() const = 0
+ - current mouse x position
+
-
+
virtual int getY() const = 0
+ - current mouse y position
+
-
+
virtual unsigned int getButtonMask() const = 0
+ - current mouse button state
+
-
+
virtual double time() const = 0
+ - time in seconds of event.
+
+
+
+Public Members
-
+
enum MouseButtonMask
+-
+
enum EventType
+
+
+
+Protected Methods
-
+
virtual ~GUIEventAdapter()
+ - Force users to create on heap, so that multiple referencing is safe
+
+
+
+
+
+
+Documentation
+Pure virtual base class for adapting platform specific events into
+generic keyboard and mouse events.
+
+Used as GUI toolkit independent input into the osgUtil::CameraManipualor's.
+For an example of how GUIEventAdapter is specialised for a particular GUI
+Toolkit see osgGLUT::GLUTEventAdapter.
+
+
+
+
+
GUIEventAdapter()
+
+
+
+
enum MouseButtonMask
+
+
+
+
+
LEFT_MOUSE_BUTTON
+
+
+
+
MIDDLE_MOUSE_BUTTON
+
+
+
+
RIGHT_MOUSE_BUTTON
+
+
+
+
+
enum EventType
+
+
+
+
+
PUSH
+
+
+
+
RELEASE
+
+
+
+
DRAG
+
+
+
+
MOVE
+
+
+
+
KEYBOARD
+
+
+
+
FRAME
+
+
+
+
RESIZE
+
+
+
+
NONE
+
+
+
+
+
virtual EventType getEventType() const = 0
+- Get the EventType of the GUI event
+
+
+
+
virtual int getKey() const = 0
+- key pressed, return -1 if inappropriate for this event.
+
+
+
+
virtual int getButton() const = 0
+- button pressed/released, return -1 if inappropriate for this event
+
+
+
+
virtual int getXmin() const = 0
+- window minimum x.
+
+
+
+
virtual int getXmax() const = 0
+- window maximum x.
+
+
+
+
virtual int getYmin() const = 0
+- window minimum y.
+
+
+
+
virtual int getYmax() const = 0
+- window maximum y.
+
+
+
+
virtual int getX() const = 0
+- current mouse x position
+
+
+
+
virtual int getY() const = 0
+- current mouse y position
+
+
+
+
virtual unsigned int getButtonMask() const = 0
+- current mouse button state
+
+
+
+
virtual double time() const = 0
+- time in seconds of event.
+
+
+
+
virtual ~GUIEventAdapter()
+- Force users to create on heap, so that multiple referencing is safe
+
+
+
- This class has no child classes.
+
+
Alphabetic index HTML hierarchy of classes or Java
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/GUIEventHandler.html b/doc/doc++/osgGA/GUIEventHandler.html
new file mode 100644
index 000000000..2c5b616d4
--- /dev/null
+++ b/doc/doc++/osgGA/GUIEventHandler.html
@@ -0,0 +1,92 @@
+
+
+
+
+ class OSGGA_EXPORT osgGA::GUIEventHandler
+
+
+
+
+
+
+Inheritance:
+
+
+
+
+
+Public Methods
-
+
virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us) = 0
+ - Handle events, return true if handled, false otherwise
+
-
+
virtual const CompositeGUIEventHandler* getComposite() const
+ - Is this const GUIEventHandler a composite?
+
-
+
virtual CompositeGUIEventHandler* getComposite()
+ - Is this non-const GUIEventHandler a composite?
+
-
+
virtual void accept(GUIEventHandlerVisitor&) = 0
+ - Accept visits from GUIEventHandler visitors
+
+
+
+
+
+
+Documentation
+
+
+GUIEventHandler provides a basic interface for any class which wants to handle
+a GUI Events.
+
+
The GUIEvent is supplied by a GUIEventAdapter. Feedback resulting from the
+handle method is supplied by a GUIActionAdapter, which allows the GUIEventHandler
+to ask the GUI to take some action in response to an incoming event.
+
+
For example, consider a Trackball Viewer class which takes mouse events and
+manipulates a scene camera in response. The Trackball Viewer is a GUIEventHandler,
+and receives the events via the handle method. If the user 'throws' the model,
+the Trackball Viewer class can detect this via the incoming events, and
+request that the GUI set up a timer callback to continually redraw the view.
+This request is made via the GUIActionAdapter class.
+
+
+
+
+
+
virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us) = 0
+- Handle events, return true if handled, false otherwise
+
+
+
+
virtual const CompositeGUIEventHandler* getComposite() const
+- Is this const GUIEventHandler a composite?
+
+
+
+
virtual CompositeGUIEventHandler* getComposite()
+- Is this non-const GUIEventHandler a composite?
+
+
+
+
virtual void accept(GUIEventHandlerVisitor&) = 0
+- Accept visits from GUIEventHandler visitors
+
+
+- Direct child classes:
+
- StateSetManipulator
+CompositeGUIEventHandler
+CameraManipulator
+
+
+
Alphabetic index HTML hierarchy of classes or Java
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/GUIEventHandlerVisitor.html b/doc/doc++/osgGA/GUIEventHandlerVisitor.html
new file mode 100644
index 000000000..121d37f3c
--- /dev/null
+++ b/doc/doc++/osgGA/GUIEventHandlerVisitor.html
@@ -0,0 +1,98 @@
+
+
+
+
+ class OSGGA_EXPORT osgGA::GUIEventHandlerVisitor
+
+
+
+
+Base class primarily for visiting GUIEventHandlers.
+
+
+Inheritance:
+
+
+
+
+
+Public Methods
-
+
virtual void visit(CompositeGUIEventHandler&)
+-
+
virtual void visit(CameraManipulator&)
+-
+
virtual void visit(StateSetManipulator&)
+-
+
const GUIEventAdapter* getGUIEventAdapter()
+ - Get the GUI EventAdapter associated with this GUIEventHandlerVisitor
+
-
+
GUIActionAdapter* getGUIActionAdapter()
+ - Get the GUI Action Adapter associated with this GEH Visitor
+
+
+
+Protected Methods
-
+
GUIEventHandlerVisitor(GUIEventAdapter* in, GUIActionAdapter* out)
+-
+
virtual ~GUIEventHandlerVisitor()
+
+
+
+
+
+
+Documentation
+Base class primarily for visiting GUIEventHandlers.
+
+A Default Visitor, (Might want to make it an Extrinsic Visitor at some point).
+By default, it does nothing to the things it visits. Sub classes of this Visitor
+need only override visit operations for the types of object they're interested in.
+
+
+
+
+
+
virtual void visit(CompositeGUIEventHandler&)
+
+
+
+
virtual void visit(CameraManipulator&)
+
+
+
+
virtual void visit(StateSetManipulator&)
+
+
+
+
const GUIEventAdapter* getGUIEventAdapter()
+- Get the GUI EventAdapter associated with this GUIEventHandlerVisitor
+
+
+
+
GUIActionAdapter* getGUIActionAdapter()
+- Get the GUI Action Adapter associated with this GEH Visitor
+
+
+
+
GUIEventHandlerVisitor(GUIEventAdapter* in, GUIActionAdapter* out)
+
+
+
+
virtual ~GUIEventHandlerVisitor()
+
+
+- Direct child classes:
+
- SetSceneViewVisitor
+
+
+
Alphabetic index HTML hierarchy of classes or Java
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/General.html b/doc/doc++/osgGA/General.html
new file mode 100644
index 000000000..f78d60139
--- /dev/null
+++ b/doc/doc++/osgGA/General.html
@@ -0,0 +1,61 @@
+
+
+
+
+ General Bits
+
+
+
+
+
+-
+
+
#define
+OSGGA_CAMERAMANIPULATOR-
+
+
#define
+OSGGA_DRIVEMANIPULATOR-
+
+
#define
+OSGGA_EXPORT_-
+
+
#define
+OSGGA_EXPORT(dllexport)-
+
+
#define
+OSGGA_EXPORT(dllimport)-
+
+
#define
+OSGGA_EXPORT-
+
+
#define
+OSGGA_GUIACTIONADAPTER-
+
+
#define
+OSGGA_GUIEVENTADAPTER-
+
+
#define
+OSGGA_GUIEVENTHANDLER-
+
+
#define
+OSGGA_GUIEVENTHANDLERVISITOR-
+
+
#define
+OSGUTIL_KEYSWITCHCAMERAMANIPULATORER-
+
+
#define
+OSGGA_SETSCENEVIEWGEHVISITOR-
+
+
#define
+OSGGA_GEOSTATE_MANIPULATOR-
+
+
#define
+OSGGA_TRACKBALLMANIPULATOR-
+
+
#define
+OSGGA_VERSION
+Alphabetic index Hierarchy of classes
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/HIER.html b/doc/doc++/osgGA/HIER.html
new file mode 100644
index 000000000..41b0c2102
--- /dev/null
+++ b/doc/doc++/osgGA/HIER.html
@@ -0,0 +1,34 @@
+
+
+
+
+ Hierarchy of Classes
+
+
+
+Hierarchy of Classes
+
+Alphabetic index
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/HIERjava.html b/doc/doc++/osgGA/HIERjava.html
new file mode 100644
index 000000000..9ba20c8c1
--- /dev/null
+++ b/doc/doc++/osgGA/HIERjava.html
@@ -0,0 +1,44 @@
+
+
+
+
+ Hierarchy of Classes
+
+
+
+Hierarchy of classes
+
+
+
+
+
+
+ alphabetic index
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/KeySwitchCameraManipulator.html b/doc/doc++/osgGA/KeySwitchCameraManipulator.html
new file mode 100644
index 000000000..c46e25fa3
--- /dev/null
+++ b/doc/doc++/osgGA/KeySwitchCameraManipulator.html
@@ -0,0 +1,123 @@
+
+
+
+
+ class OSGGA_EXPORT osgGA::KeySwitchCameraManipulator
+
+
+
+
+
+
+Inheritance:
+
+
+
+
+
+Public Methods
-
+
void addCameraManipulator(int key, std::string name, CameraManipulator* cm)
+-
+
virtual void setCamera(osg::Camera* c)
+-
+
virtual const osg::Camera* getCamera() const
+-
+
virtual osg::Camera* getCamera()
+-
+
virtual void setNode(osg::Node* n)
+-
+
virtual const osg::Node* getNode() const
+-
+
virtual osg::Node* getNode()
+-
+
virtual void home(const GUIEventAdapter& ee, GUIActionAdapter& aa)
+-
+
virtual void init(const GUIEventAdapter& ee, GUIActionAdapter& aa)
+-
+
virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us)
+
+
+
+
+
+
+Public Methods
-
+
virtual void accept(GUIEventHandlerVisitor& v)
+
+
+
+Protected Fields
-
+
osg::ref_ptr<osg::Camera> _camera
+
+
+
+
+
+
+Public Methods
-
+
virtual const CompositeGUIEventHandler* getComposite() const
+-
+
virtual CompositeGUIEventHandler* getComposite()
+
+
+
+
+
+
+Documentation
+
+
+
+
+
void addCameraManipulator(int key, std::string name, CameraManipulator* cm)
+
+
+
+
virtual void setCamera(osg::Camera* c)
+
+
+
+
virtual const osg::Camera* getCamera() const
+
+
+
+
virtual osg::Camera* getCamera()
+
+
+
+
virtual void setNode(osg::Node* n)
+
+
+
+
virtual const osg::Node* getNode() const
+
+
+
+
virtual osg::Node* getNode()
+
+
+
+
virtual void home(const GUIEventAdapter& ee, GUIActionAdapter& aa)
+
+
+
+
virtual void init(const GUIEventAdapter& ee, GUIActionAdapter& aa)
+
+
+
+
virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us)
+
+
+
- This class has no child classes.
+
+
Alphabetic index HTML hierarchy of classes or Java
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/NavigatorButton.class b/doc/doc++/osgGA/NavigatorButton.class
new file mode 100644
index 000000000..fad9c3f2d
Binary files /dev/null and b/doc/doc++/osgGA/NavigatorButton.class differ
diff --git a/doc/doc++/osgGA/SetSceneViewVisitor.html b/doc/doc++/osgGA/SetSceneViewVisitor.html
new file mode 100644
index 000000000..474e5e5ce
--- /dev/null
+++ b/doc/doc++/osgGA/SetSceneViewVisitor.html
@@ -0,0 +1,78 @@
+
+
+
+
+ class OSGGA_EXPORT osgGA::SetSceneViewVisitor
+
+
+
+
+SetSceneViewGUIEventHandlerVisitor which visits various types of GUIEventHandler and sets them up appropriately, given a new scene view.
+
+
+Inheritance:
+
+
+
+
+
+Public Methods
-
+
SetSceneViewVisitor(GUIEventAdapter* in, GUIActionAdapter* out, osgUtil::SceneView* sv)
+-
+
virtual ~SetSceneViewVisitor()
+-
+
virtual void visit(CameraManipulator& cm)
+-
+
virtual void visit(StateSetManipulator& cm)
+
+
+
+
+
+
+Public Methods
-
+
const GUIEventAdapter* getGUIEventAdapter()
+-
+
GUIActionAdapter* getGUIActionAdapter()
+
+
+
+
+
+
+Documentation
+SetSceneViewGUIEventHandlerVisitor which visits various types of GUIEventHandler and
+sets them up appropriately, given a new scene view.
+.
+
+
+
+
+
SetSceneViewVisitor(GUIEventAdapter* in, GUIActionAdapter* out, osgUtil::SceneView* sv)
+
+
+
+
virtual ~SetSceneViewVisitor()
+
+
+
+
virtual void visit(CameraManipulator& cm)
+
+
+
+
virtual void visit(StateSetManipulator& cm)
+
+
+
- This class has no child classes.
+
+
Alphabetic index HTML hierarchy of classes or Java
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/StateSetManipulator.html b/doc/doc++/osgGA/StateSetManipulator.html
new file mode 100644
index 000000000..279d237f2
--- /dev/null
+++ b/doc/doc++/osgGA/StateSetManipulator.html
@@ -0,0 +1,129 @@
+
+
+
+
+ class OSGGA_EXPORT osgGA::StateSetManipulator
+
+
+
+
+
+
+Inheritance:
+
+
+
+
+
+Public Methods
-
+
StateSetManipulator()
+-
+
virtual ~StateSetManipulator()
+-
+
virtual void setStateSet(osg::StateSet*)
+ - attach a stateset to the manipulator to be used for specifying view
+
-
+
virtual osg::StateSet* getStateSet()
+ - get the attached a stateset
+
-
+
virtual const osg::StateSet* getStateSet() const
+ - get the attached a stateset
+
-
+
virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us)
+ - Handle events, return true if handled, false otherwise
+
-
+
virtual void accept(GUIEventHandlerVisitor&)
+ - Handle visitations
+
+
+
+Protected Fields
-
+
osg::ref_ptr<osg::StateSet> _drawState
+-
+
bool _backface
+-
+
bool _lighting
+-
+
bool _texture
+
+
+
+
+
+
+Public Methods
-
+
virtual const CompositeGUIEventHandler* getComposite() const
+-
+
virtual CompositeGUIEventHandler* getComposite()
+
+
+
+
+
+
+Documentation
+
+
+
+
+
StateSetManipulator()
+
+
+
+
virtual ~StateSetManipulator()
+
+
+
+
virtual void setStateSet(osg::StateSet*)
+- attach a stateset to the manipulator to be used for specifying view
+
+
+
+
virtual osg::StateSet* getStateSet()
+- get the attached a stateset
+
+
+
+
virtual const osg::StateSet* getStateSet() const
+- get the attached a stateset
+
+
+
+
virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us)
+- Handle events, return true if handled, false otherwise
+
+
+
+
virtual void accept(GUIEventHandlerVisitor&)
+- Handle visitations
+
+
+
+
osg::ref_ptr<osg::StateSet> _drawState
+
+
+
+
bool _backface
+
+
+
+
bool _lighting
+
+
+
+
bool _texture
+
+
+
- This class has no child classes.
+
+
Alphabetic index HTML hierarchy of classes or Java
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/TrackballManipulator.html b/doc/doc++/osgGA/TrackballManipulator.html
new file mode 100644
index 000000000..9e2a8fc80
--- /dev/null
+++ b/doc/doc++/osgGA/TrackballManipulator.html
@@ -0,0 +1,133 @@
+
+
+
+
+ class OSGGA_EXPORT osgGA::TrackballManipulator
+
+
+
+
+
+
+Inheritance:
+
+
+
+
+
+Public Methods
-
+
TrackballManipulator()
+-
+
virtual ~TrackballManipulator()
+-
+
virtual void setNode(osg::Node*)
+ - Attach a node to the manipulator.
+
-
+
virtual const osg::Node* getNode() const
+ - Return node if attached
+
-
+
virtual osg::Node* getNode()
+ - Return node if attached
+
-
+
virtual void home(const GUIEventAdapter& ea, GUIActionAdapter& us)
+ - Move the camera to the default position.
+
-
+
virtual void init(const GUIEventAdapter& ea, GUIActionAdapter& us)
+ - Start/restart the manipulator
+
-
+
virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us)
+ - handle events, return true if handled, false otherwise
+
+
+
+
+
+
+Public Methods
-
+
virtual void setCamera(osg::Camera*)
+-
+
virtual const osg::Camera* getCamera() const
+-
+
virtual osg::Camera* getCamera()
+-
+
virtual void accept(GUIEventHandlerVisitor& v)
+
+
+
+Protected Fields
-
+
osg::ref_ptr<osg::Camera> _camera
+
+
+
+
+
+
+Public Methods
-
+
virtual const CompositeGUIEventHandler* getComposite() const
+-
+
virtual CompositeGUIEventHandler* getComposite()
+
+
+
+
+
+
+Documentation
+
+
+
+
+
TrackballManipulator()
+
+
+
+
virtual ~TrackballManipulator()
+
+
+
+
virtual void setNode(osg::Node*)
+- Attach a node to the manipulator.
+Automatically detaches previously attached node.
+setNode(NULL) detaches previously nodes.
+Is ignored by manipulators which do not require a reference model.
+
+
+
+
virtual const osg::Node* getNode() const
+- Return node if attached
+
+
+
+
virtual osg::Node* getNode()
+- Return node if attached
+
+
+
+
virtual void home(const GUIEventAdapter& ea, GUIActionAdapter& us)
+- Move the camera to the default position.
+May be ignored by manipulators if home functionality is not appropriate.
+
+
+
+
virtual void init(const GUIEventAdapter& ea, GUIActionAdapter& us)
+- Start/restart the manipulator
+
+
+
+
virtual bool handle(const GUIEventAdapter& ea, GUIActionAdapter& us)
+- handle events, return true if handled, false otherwise
+
+
+
- This class has no child classes.
+
+
Alphabetic index HTML hierarchy of classes or Java
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/icon1.gif b/doc/doc++/osgGA/icon1.gif
new file mode 100644
index 000000000..f78f30eb9
Binary files /dev/null and b/doc/doc++/osgGA/icon1.gif differ
diff --git a/doc/doc++/osgGA/icon2.gif b/doc/doc++/osgGA/icon2.gif
new file mode 100644
index 000000000..6cbe01a83
Binary files /dev/null and b/doc/doc++/osgGA/icon2.gif differ
diff --git a/doc/doc++/osgGA/index.html b/doc/doc++/osgGA/index.html
new file mode 100644
index 000000000..cc919a3ff
--- /dev/null
+++ b/doc/doc++/osgGA/index.html
@@ -0,0 +1,49 @@
+
+
+
+
+ Table of Contents
+
+
+
+
+Table of Contents
+General stuff
+
+Namespaces
+
+Functions
+
+Macros
+
+Hierarchy of classes
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/osgGA.html b/doc/doc++/osgGA/osgGA.html
new file mode 100644
index 000000000..dafb43949
--- /dev/null
+++ b/doc/doc++/osgGA/osgGA.html
@@ -0,0 +1,54 @@
+
+
+
+
+ namespace osgGA
+
+
+
+
+
+
+
+ -
+class OSGGA_EXPORT CameraManipulator: public GUIEventHandler
+
-
+class OSGGA_EXPORT DriveManipulator: public CameraManipulator
+
-
+class OSGGA_EXPORT FlightManipulator: public CameraManipulator
+
-
+class GUIActionAdapter
+
- Pure virtual base class for adapting the GUI actions requested by CameraManipulators into actions which are handled by the GUI toolkit of the users application.
+
-
+class GUIEventAdapter: public osg::Referenced
+
- Pure virtual base class for adapting platform specific events into generic keyboard and mouse events.
+
-
+class OSGGA_EXPORT GUIEventHandler: public osg::Referenced
+
-
+class OSGGA_EXPORT CompositeGUIEventHandler: public GUIEventHandler
+
- CompositeGUIEventHandler allows GUIEventHandlers to be composed into hierarchies
+
-
+class OSGGA_EXPORT GUIEventHandlerVisitor
+
- Base class primarily for visiting GUIEventHandlers.
+
-
+class OSGGA_EXPORT KeySwitchCameraManipulator: public CameraManipulator
+
-
+class OSGGA_EXPORT SetSceneViewVisitor: public GUIEventHandlerVisitor
+
- SetSceneViewGUIEventHandlerVisitor which visits various types of GUIEventHandler and sets them up appropriately, given a new scene view.
+
-
+class OSGGA_EXPORT StateSetManipulator: public GUIEventHandler
+
-
+class OSGGA_EXPORT TrackballManipulator: public CameraManipulator
+
+
+
+
+
+Documentation
+
+
+
Alphabetic index HTML hierarchy of classes or Java
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/osgGAGetLibraryName.html b/doc/doc++/osgGA/osgGAGetLibraryName.html
new file mode 100644
index 000000000..9a6355376
--- /dev/null
+++ b/doc/doc++/osgGA/osgGAGetLibraryName.html
@@ -0,0 +1,21 @@
+
+
+
+
+ extern OSGGA_EXPORT const char* osgGAGetLibraryName
+
+
+
+
+()
getLibraryName_osgGA() returns the library name in human friendly form
+
+
+
+Documentation
+
+getLibraryName_osgGA() returns the library name in human friendly form
+
Alphabetic index HTML hierarchy of classes or Java
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/osgGAGetVersion.html b/doc/doc++/osgGA/osgGAGetVersion.html
new file mode 100644
index 000000000..e89e6693c
--- /dev/null
+++ b/doc/doc++/osgGA/osgGAGetVersion.html
@@ -0,0 +1,34 @@
+
+
+
+
+ extern OSGGA_EXPORT const char* osgGAGetVersion
+
+
+
+
+extern OSGGA_EXPORT const char* osgGAGetVersion
()
getVersion_osgGA() returns the library version number.
+
+
+
+Documentation
+
+getVersion_osgGA() returns the library version number.
+Numbering convention : osg_src-0.8-31 will return 0.8.31 from getVersion_osgGA.
+
+This C function can be also used to check for the existence of the OpenSceneGraph
+library using autoconf and its m4 macro AC_CHECK_LIB.
+
+
Here is the code to add to your configure.in:
+\verbatim
+#
+# Check for the OpenSceneGraph (OSG) utility library
+#
+AC_CHECK_LIB(osg, osgGAGetVersion, ,
+[AC_MSG_ERROR(OpenSceneGraph utility library not found. See http://www.openscenegraph.org)],)
+\endverbatim
+
Alphabetic index HTML hierarchy of classes or Java
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGA/spaceosgGA.html b/doc/doc++/osgGA/spaceosgGA.html
new file mode 100644
index 000000000..2aa27989e
--- /dev/null
+++ b/doc/doc++/osgGA/spaceosgGA.html
@@ -0,0 +1,40 @@
+
+
+
+
+ #define space osgGA
+
+
+
+
+
+
+
+
+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.
+
+
Alphabetic index Hierarchy of classes
+
+This page was generated with the help of DOC++.
+
+
diff --git a/doc/doc++/osgGLUT/GLUTEventAdapter.html b/doc/doc++/osgGLUT/GLUTEventAdapter.html
index 469a0fb05..ba858de20 100644
--- a/doc/doc++/osgGLUT/GLUTEventAdapter.html
+++ b/doc/doc++/osgGLUT/GLUTEventAdapter.html
@@ -7,12 +7,12 @@
-Class for adapting GLUT events so that they can be used as input to osgUtil::CameraManipulators
+Class for adapting GLUT events so that they can be used as input to osgGA::CameraManipulators
Inheritance: