OpenSceneGraph/doc/doc++/osgGA/KeySwitchCameraManipulator.html
2003-04-17 16:22:51 +00:00

193 lines
9.9 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class OSGGA_EXPORT osgGA::KeySwitchCameraManipulator</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class OSGGA_EXPORT <A HREF="#DOC.DOCU">osgGA::KeySwitchCameraManipulator</A></H2></H2><BLOCKQUOTE> KeySwitchCameraManipulator is a decorator which allows the type of camera manipulator being used to be switched by pressing a key.</BLOCKQUOTE>
<HR>
<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=125>
<param name=classes value="Mosg::Object,M,CGUIEventHandler,MGUIEventHandler.html,CCameraManipulator,MCameraManipulator.html,CKeySwitchCameraManipulator,MKeySwitchCameraManipulator.html">
<param name=before value="M,M,M,M">
<param name=after value="Md_SPSP,Md_SP,Md_,M">
<param name=indent value="0,1,2,3">
<param name=arrowdir value="down">
</APPLET>
<HR>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual const char* <B><A HREF="#DOC.2.10.1">className</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.10.2">addCameraManipulator</A></B>(int key, std::string name, <!1><A HREF="CameraManipulator.html">CameraManipulator</A>* cm)
<DD><I> Add a camera manipulator with an associated name, and a key to trigger the switch,</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.10.3">addNumberedCameraManipulator</A></B>(<!1><A HREF="CameraManipulator.html">CameraManipulator</A>* cm)
<DD><I> Add a camera manipulator with an autogenerated keybinding which is '1' + previous number of camera's registerd</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>unsigned int <B><A HREF="#DOC.2.10.4">getNumCameraManipualtors</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.10.5">selectCameraManipulator</A></B>(unsigned int num)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="CameraManipulator.html">CameraManipulator</A>* <B><A HREF="#DOC.2.10.6">getCurrentCameraManipulator</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>const <!1><A HREF="CameraManipulator.html">CameraManipulator</A>* <B><A HREF="#DOC.2.10.7">getCurrentCameraManipulator</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="CameraManipulator.html">CameraManipulator</A>* <B><A HREF="#DOC.2.10.8">getCameraManipulator</A></B>(unsigned int num)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>const <!1><A HREF="CameraManipulator.html">CameraManipulator</A>* <B><A HREF="#DOC.2.10.9">getCameraManipulator</A></B>(unsigned int num) const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.10.10">setCamera</A></B>(osg::Camera* c)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual const osg::Camera* <B><A HREF="#DOC.2.10.11">getCamera</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual osg::Camera* <B><A HREF="#DOC.2.10.12">getCamera</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.10.13">setNode</A></B>(osg::Node* n)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual const osg::Node* <B><A HREF="#DOC.2.10.14">getNode</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual osg::Node* <B><A HREF="#DOC.2.10.15">getNode</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.10.16">home</A></B>(const <!1><A HREF="GUIEventAdapter.html">GUIEventAdapter</A>&amp; ee, <!1><A HREF="GUIActionAdapter.html">GUIActionAdapter</A>&amp; aa)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.10.17">init</A></B>(const <!1><A HREF="GUIEventAdapter.html">GUIEventAdapter</A>&amp; ee, <!1><A HREF="GUIActionAdapter.html">GUIActionAdapter</A>&amp; aa)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual bool <B><A HREF="#DOC.2.10.18">handle</A></B>(const <!1><A HREF="GUIEventAdapter.html">GUIEventAdapter</A>&amp; ea, <!1><A HREF="GUIActionAdapter.html">GUIActionAdapter</A>&amp; us)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.10.19">getUsage</A></B>(osg::ApplicationUsage&amp; usage) const
<DD><I>Get the keyboard and mouse usage of this manipulator</I>
</DL></P>
</DL>
<HR><H3>Inherited from <A HREF="CameraManipulator.html">CameraManipulator</A>:</H3>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>virtual void <B>accept</B>(<!1><A HREF="GUIEventHandlerVisitor.html">GUIEventHandlerVisitor</A>&amp; v)
</DL></P>
<P><DL>
<DT><H3>Protected Fields</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>osg::ref_ptr&lt;osg::Camera&gt; <B>_camera</B>
</DL></P>
</DL>
<HR><H3>Inherited from <A HREF="GUIEventHandler.html">GUIEventHandler</A>:</H3>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>META_Object <B>(osgGA, GUIEventHandler) const </B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>virtual <!1><A HREF="CompositeGUIEventHandler.html">CompositeGUIEventHandler</A>* <B>getComposite</B>()
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>
KeySwitchCameraManipulator is a decorator which allows the type of camera manipulator
being used to be switched by pressing a key. E.g. '1' for a TrackballManipultor,
'2' for a DriveManipulator, '3' for a FlightManipulator. The manipulators available,
and the associated switch keys, can be configured.</BLOCKQUOTE>
<DL>
<A NAME="className"></A>
<A NAME="DOC.2.10.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual const char* className()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="addCameraManipulator"></A>
<A NAME="DOC.2.10.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void addCameraManipulator(int key, std::string name, <!1><A HREF="CameraManipulator.html">CameraManipulator</A>* cm)</B></TT>
<DD>
Add a camera manipulator with an associated name, and a key to
trigger the switch,
<DL><DT><DD></DL><P>
<A NAME="addNumberedCameraManipulator"></A>
<A NAME="DOC.2.10.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void addNumberedCameraManipulator(<!1><A HREF="CameraManipulator.html">CameraManipulator</A>* cm)</B></TT>
<DD>
Add a camera manipulator with an autogenerated keybinding which is '1' + previous number of camera's registerd
<DL><DT><DD></DL><P>
<A NAME="getNumCameraManipualtors"></A>
<A NAME="DOC.2.10.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>unsigned int getNumCameraManipualtors() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="selectCameraManipulator"></A>
<A NAME="DOC.2.10.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void selectCameraManipulator(unsigned int num)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getCurrentCameraManipulator"></A>
<A NAME="DOC.2.10.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="CameraManipulator.html">CameraManipulator</A>* getCurrentCameraManipulator()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getCurrentCameraManipulator"></A>
<A NAME="DOC.2.10.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>const <!1><A HREF="CameraManipulator.html">CameraManipulator</A>* getCurrentCameraManipulator() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="getCameraManipulator"></A>
<A NAME="DOC.2.10.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="CameraManipulator.html">CameraManipulator</A>* getCameraManipulator(unsigned int num)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getCameraManipulator"></A>
<A NAME="DOC.2.10.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>const <!1><A HREF="CameraManipulator.html">CameraManipulator</A>* getCameraManipulator(unsigned int num) const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="setCamera"></A>
<A NAME="DOC.2.10.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void setCamera(osg::Camera* c)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getCamera"></A>
<A NAME="DOC.2.10.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual const osg::Camera* getCamera() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="getCamera"></A>
<A NAME="DOC.2.10.12"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual osg::Camera* getCamera()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="setNode"></A>
<A NAME="DOC.2.10.13"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void setNode(osg::Node* n)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getNode"></A>
<A NAME="DOC.2.10.14"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual const osg::Node* getNode() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="getNode"></A>
<A NAME="DOC.2.10.15"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual osg::Node* getNode()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="home"></A>
<A NAME="DOC.2.10.16"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void home(const <!1><A HREF="GUIEventAdapter.html">GUIEventAdapter</A>&amp; ee, <!1><A HREF="GUIActionAdapter.html">GUIActionAdapter</A>&amp; aa)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="init"></A>
<A NAME="DOC.2.10.17"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void init(const <!1><A HREF="GUIEventAdapter.html">GUIEventAdapter</A>&amp; ee, <!1><A HREF="GUIActionAdapter.html">GUIActionAdapter</A>&amp; aa)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="handle"></A>
<A NAME="DOC.2.10.18"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual bool handle(const <!1><A HREF="GUIEventAdapter.html">GUIEventAdapter</A>&amp; ea, <!1><A HREF="GUIActionAdapter.html">GUIActionAdapter</A>&amp; us)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getUsage"></A>
<A NAME="DOC.2.10.19"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void getUsage(osg::ApplicationUsage&amp; usage) const </B></TT>
<DD>Get the keyboard and mouse usage of this manipulator
<DL><DT><DD></DL><P></DL>
<HR><DL><DT><B>This class has no child classes.</B></DL>
<DL><DT><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I> <I><A HREF="HIER.html">HTML hierarchy of classes</A> or <A HREF="HIERjava.html">Java</A></I></P><HR>
<BR>
This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
</BODY>
</HTML>