FGFS-4.1/OpenSceneGraph
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
54d47a13ce
OpenSceneGraph/doc/doc++/osgProducer/EventAdapter.html
Robert Osfield 1a630e97de Updated doc++ documentation.
2003-07-23 11:27:31 +00:00

361 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class OSGPRODUCER_EXPORT osgProducer::EventAdapter</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class OSGPRODUCER_EXPORT <A HREF="#DOC.DOCU">osgProducer::EventAdapter</A></H2></H2><BLOCKQUOTE>Class for adapting Producer events so that they can be used as input to osgGA::CameraManipulators</BLOCKQUOTE>
<HR>
<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=65>
<param name=classes value="MosgGA::GUIEventAdapter,M,CEventAdapter,MEventAdapter.html">
<param name=before value="M,M">
<param name=after value="Md_,M">
<param name=indent value="0,1">
<param name=arrowdir value="down">
</APPLET>
<HR>
<DL>
<P><DL>
<DT><H3>Public Fields</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>static unsigned int <B><A HREF="#DOC.2.1.38">_s_accumulatedButtonMask</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>static int <B><A HREF="#DOC.2.1.39">_s_button</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>static float <B><A HREF="#DOC.2.1.40">_s_Xmin</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>static float <B><A HREF="#DOC.2.1.41">_s_Xmax</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>static float <B><A HREF="#DOC.2.1.42">_s_Ymin</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>static float <B><A HREF="#DOC.2.1.43">_s_Ymax</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>static float <B><A HREF="#DOC.2.1.44">_s_mx</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>static float <B><A HREF="#DOC.2.1.45">_s_my</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>static int <B><A HREF="#DOC.2.1.46">_s_modKeyMask</A></B>
</DL></P>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.1.1">EventAdapter</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual <B><A HREF="#DOC.2.1.2">~EventAdapter</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual EventType <B><A HREF="#DOC.2.1.3">getEventType</A></B>() const
<DD><I>Get the EventType of the GUI event</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual int <B><A HREF="#DOC.2.1.4">getKey</A></B>() const
<DD><I>key pressed, return -1 if inappropriate for this event.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual int <B><A HREF="#DOC.2.1.5">getButton</A></B>() const
<DD><I>button pressed/released, return -1 if inappropriate for this event</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual float <B><A HREF="#DOC.2.1.6">getXmin</A></B>() const
<DD><I>window minimum x.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual float <B><A HREF="#DOC.2.1.7">getXmax</A></B>() const
<DD><I>window maximum x.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual float <B><A HREF="#DOC.2.1.8">getYmin</A></B>() const
<DD><I>window minimum y.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual float <B><A HREF="#DOC.2.1.9">getYmax</A></B>() const
<DD><I>window maximum y.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual float <B><A HREF="#DOC.2.1.10">getX</A></B>() const
<DD><I>current mouse x position</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual float <B><A HREF="#DOC.2.1.11">getY</A></B>() const
<DD><I>current mouse y position</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual unsigned int <B><A HREF="#DOC.2.1.12">getButtonMask</A></B>() const
<DD><I>current mouse button state </I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual double <B><A HREF="#DOC.2.1.13">time</A></B>() const
<DD><I>time in seconds of event.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual unsigned int <B><A HREF="#DOC.2.1.14">getModKeyMask</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>static void <B><A HREF="#DOC.2.1.15">setWindowSize</A></B>(float Xmin, float Ymin, float Xmax, float Ymax)
<DD><I>static method for setting window dimensions</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>static void <B><A HREF="#DOC.2.1.16">setButtonMask</A></B>(unsigned int buttonMask)
<DD><I>static method for setting button state</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.1.17">adaptResize</A></B>(double t, float Xmin, float Ymin, float Xmax, float Ymax)
<DD><I>method for adapting resize events.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.1.18">adaptMouseScroll</A></B>(double t, Producer::KeyboardMouseCallback::ScrollingMotion sm)
<DD><I>method for adapting mouse scroll wheel events.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.1.19">adaptMouseMotion</A></B>(double t, float x, float y)
<DD><I>method for adapting mouse motion events whilst mouse buttons are pressed</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.1.20">adaptButtonPress</A></B>(double t, float x, float y, unsigned int button)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.1.21">adaptButtonRelease</A></B>(double t, float x, float y, unsigned int button)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.1.22">adaptKeyPress</A></B>( double t, Producer::KeySymbol key)
<DD><I>method for adapting keyboard events</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.1.23">adaptKeyRelease</A></B>( double t, Producer::KeySymbol key)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.1.24">adaptFrame</A></B>(double t)
<DD><I>method for adapting frame events, ie.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.1.25">copyStaticVariables</A></B>()
</DL></P>
<P><DL>
<DT><H3>Protected Fields</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>EventType <B><A HREF="#DOC.2.1.26">_eventType</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>int <B><A HREF="#DOC.2.1.27">_key</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>int <B><A HREF="#DOC.2.1.28">_button</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>float <B><A HREF="#DOC.2.1.29">_Xmin</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>float <B><A HREF="#DOC.2.1.30">_Xmax</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>float <B><A HREF="#DOC.2.1.31">_Ymin</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>float <B><A HREF="#DOC.2.1.32">_Ymax</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>float <B><A HREF="#DOC.2.1.33">_mx</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>float <B><A HREF="#DOC.2.1.34">_my</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>unsigned int <B><A HREF="#DOC.2.1.35">_buttonMask</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>unsigned int <B><A HREF="#DOC.2.1.36">_modKeyMask</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>double <B><A HREF="#DOC.2.1.37">_time</A></B>
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>Class for adapting Producer events so that they can be used as input to osgGA::CameraManipulators</BLOCKQUOTE>
<DL>
<A NAME="EventAdapter"></A>
<A NAME="DOC.2.1.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> EventAdapter()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="~EventAdapter"></A>
<A NAME="DOC.2.1.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual ~EventAdapter()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getEventType"></A>
<A NAME="DOC.2.1.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual EventType getEventType() const </B></TT>
<DD>Get the EventType of the GUI event
<DL><DT><DD></DL><P>
<A NAME="getKey"></A>
<A NAME="DOC.2.1.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual int getKey() const </B></TT>
<DD>key pressed, return -1 if inappropriate for this event.
<DL><DT><DD></DL><P>
<A NAME="getButton"></A>
<A NAME="DOC.2.1.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual int getButton() const </B></TT>
<DD>button pressed/released, return -1 if inappropriate for this event
<DL><DT><DD></DL><P>
<A NAME="getXmin"></A>
<A NAME="DOC.2.1.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual float getXmin() const </B></TT>
<DD>window minimum x.
<DL><DT><DD></DL><P>
<A NAME="getXmax"></A>
<A NAME="DOC.2.1.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual float getXmax() const </B></TT>
<DD>window maximum x.
<DL><DT><DD></DL><P>
<A NAME="getYmin"></A>
<A NAME="DOC.2.1.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual float getYmin() const </B></TT>
<DD>window minimum y.
<DL><DT><DD></DL><P>
<A NAME="getYmax"></A>
<A NAME="DOC.2.1.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual float getYmax() const </B></TT>
<DD>window maximum y.
<DL><DT><DD></DL><P>
<A NAME="getX"></A>
<A NAME="DOC.2.1.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual float getX() const </B></TT>
<DD>current mouse x position
<DL><DT><DD></DL><P>
<A NAME="getY"></A>
<A NAME="DOC.2.1.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual float getY() const </B></TT>
<DD>current mouse y position
<DL><DT><DD></DL><P>
<A NAME="getButtonMask"></A>
<A NAME="DOC.2.1.12"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual unsigned int getButtonMask() const </B></TT>
<DD>current mouse button state
<DL><DT><DD></DL><P>
<A NAME="time"></A>
<A NAME="DOC.2.1.13"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual double time() const </B></TT>
<DD>time in seconds of event.
<DL><DT><DD></DL><P>
<A NAME="getModKeyMask"></A>
<A NAME="DOC.2.1.14"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual unsigned int getModKeyMask() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="setWindowSize"></A>
<A NAME="DOC.2.1.15"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>static void setWindowSize(float Xmin, float Ymin, float Xmax, float Ymax)</B></TT>
<DD>static method for setting window dimensions
<DL><DT><DD></DL><P>
<A NAME="setButtonMask"></A>
<A NAME="DOC.2.1.16"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>static void setButtonMask(unsigned int buttonMask)</B></TT>
<DD>static method for setting button state
<DL><DT><DD></DL><P>
<A NAME="adaptResize"></A>
<A NAME="DOC.2.1.17"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void adaptResize(double t, float Xmin, float Ymin, float Xmax, float Ymax)</B></TT>
<DD>method for adapting resize events.
<DL><DT><DD></DL><P>
<A NAME="adaptMouseScroll"></A>
<A NAME="DOC.2.1.18"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void adaptMouseScroll(double t, Producer::KeyboardMouseCallback::ScrollingMotion sm)</B></TT>
<DD>method for adapting mouse scroll wheel events.
<DL><DT><DD></DL><P>
<A NAME="adaptMouseMotion"></A>
<A NAME="DOC.2.1.19"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void adaptMouseMotion(double t, float x, float y)</B></TT>
<DD>method for adapting mouse motion events whilst mouse buttons are pressed
<DL><DT><DD></DL><P>
<A NAME="adaptButtonPress"></A>
<A NAME="DOC.2.1.20"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void adaptButtonPress(double t, float x, float y, unsigned int button)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="adaptButtonRelease"></A>
<A NAME="DOC.2.1.21"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void adaptButtonRelease(double t, float x, float y, unsigned int button)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="adaptKeyPress"></A>
<A NAME="DOC.2.1.22"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void adaptKeyPress( double t, Producer::KeySymbol key)</B></TT>
<DD>method for adapting keyboard events
<DL><DT><DD></DL><P>
<A NAME="adaptKeyRelease"></A>
<A NAME="DOC.2.1.23"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void adaptKeyRelease( double t, Producer::KeySymbol key)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="adaptFrame"></A>
<A NAME="DOC.2.1.24"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void adaptFrame(double t)</B></TT>
<DD>method for adapting frame events, ie. idle/display callback.
<DL><DT><DD></DL><P>
<A NAME="copyStaticVariables"></A>
<A NAME="DOC.2.1.25"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void copyStaticVariables()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_eventType"></A>
<A NAME="DOC.2.1.26"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>EventType _eventType</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_key"></A>
<A NAME="DOC.2.1.27"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>int _key</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_button"></A>
<A NAME="DOC.2.1.28"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>int _button</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_Xmin"></A>
<A NAME="DOC.2.1.29"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>float _Xmin</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_Xmax"></A>
<A NAME="DOC.2.1.30"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>float _Xmax</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_Ymin"></A>
<A NAME="DOC.2.1.31"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>float _Ymin</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_Ymax"></A>
<A NAME="DOC.2.1.32"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>float _Ymax</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_mx"></A>
<A NAME="DOC.2.1.33"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>float _mx</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_my"></A>
<A NAME="DOC.2.1.34"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>float _my</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_buttonMask"></A>
<A NAME="DOC.2.1.35"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>unsigned int _buttonMask</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_modKeyMask"></A>
<A NAME="DOC.2.1.36"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>unsigned int _modKeyMask</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_time"></A>
<A NAME="DOC.2.1.37"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>double _time</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_s_accumulatedButtonMask"></A>
<A NAME="DOC.2.1.38"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>static unsigned int _s_accumulatedButtonMask</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_s_button"></A>
<A NAME="DOC.2.1.39"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>static int _s_button</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_s_Xmin"></A>
<A NAME="DOC.2.1.40"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>static float _s_Xmin</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_s_Xmax"></A>
<A NAME="DOC.2.1.41"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>static float _s_Xmax</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_s_Ymin"></A>
<A NAME="DOC.2.1.42"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>static float _s_Ymin</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_s_Ymax"></A>
<A NAME="DOC.2.1.43"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>static float _s_Ymax</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_s_mx"></A>
<A NAME="DOC.2.1.44"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>static float _s_mx</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_s_my"></A>
<A NAME="DOC.2.1.45"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>static float _s_my</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_s_modKeyMask"></A>
<A NAME="DOC.2.1.46"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>static int _s_modKeyMask</B></TT>
<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>
Reference in New Issue View Git Blame Copy Permalink