FGFS-4.1/OpenSceneGraph
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
f0e7e8e48b
OpenSceneGraph/doc/doc++/osgUtil/GUIEventAdapter.html
Robert Osfield a0cb66ed78 A second try at commit these updates to docs.
2002-04-21 21:53:03 +00:00

216 lines
8.2 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class osgUtil::GUIEventAdapter</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.8">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class <A HREF="#DOC.DOCU">osgUtil::GUIEventAdapter</A></H2></H2><BLOCKQUOTE>Pure virtual base class for adapting platform specific events into generic keyboard and mouse events.</BLOCKQUOTE>
<HR>
<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=65>
<param name=classes value="Mosg::Referenced,M,CGUIEventAdapter,MGUIEventAdapter.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 Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.11.1">GUIEventAdapter</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual <!1><A HREF="GUIEventAdapter.html#DOC.2.11.3">EventType</A> <B><A HREF="#DOC.2.11.4">getEventType</A></B>() const = 0
<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.11.5">getKey</A></B>() const = 0
<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.11.6">getButton</A></B>() const = 0
<DD><I>button pressed/released, return -1 if inappropriate for this event</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual int <B><A HREF="#DOC.2.11.7">getXmin</A></B>() const = 0
<DD><I>window minimum x.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual int <B><A HREF="#DOC.2.11.8">getXmax</A></B>() const = 0
<DD><I>window maximum x.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual int <B><A HREF="#DOC.2.11.9">getYmin</A></B>() const = 0
<DD><I>window minimum y.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual int <B><A HREF="#DOC.2.11.10">getYmax</A></B>() const = 0
<DD><I>window maximum y.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual int <B><A HREF="#DOC.2.11.11">getX</A></B>() const = 0
<DD><I>current mouse x position</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual int <B><A HREF="#DOC.2.11.12">getY</A></B>() const = 0
<DD><I>current mouse y position</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual unsigned int <B><A HREF="#DOC.2.11.13">getButtonMask</A></B>() const = 0
<DD><I>current mouse button state </I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual double <B><A HREF="#DOC.2.11.14">time</A></B>() const = 0
<DD><I>time in seconds of event.</I>
</DL></P>
<P><DL>
<DT><H3>Public Members</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>enum <B><A HREF="#DOC.2.11.2">MouseButtonMask</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>enum <B><A HREF="#DOC.2.11.3">EventType</A></B>
</DL></P>
<P><DL>
<DT><H3>Protected Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual <B><A HREF="#DOC.2.11.15">~GUIEventAdapter</A></B>()
<DD><I>Force users to create on heap, so that multiple referencing is safe</I>
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>Pure virtual base class for adapting platform specific events into
generic keyboard and mouse events.
<P>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.</BLOCKQUOTE>
<DL>
<A NAME="GUIEventAdapter"></A>
<A NAME="DOC.2.11.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> GUIEventAdapter()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="MouseButtonMask"></A>
<A NAME="DOC.2.11.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>enum MouseButtonMask</B></TT>
<DL><DT><DD></DL><P><DL>
<A NAME="LEFT_MOUSE_BUTTON"></A>
<A NAME="DOC.2.11.2.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> LEFT_MOUSE_BUTTON</B></TT>
<DL><DT><DD></DL><P>
<A NAME="MIDDLE_MOUSE_BUTTON"></A>
<A NAME="DOC.2.11.2.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> MIDDLE_MOUSE_BUTTON</B></TT>
<DL><DT><DD></DL><P>
<A NAME="RIGHT_MOUSE_BUTTON"></A>
<A NAME="DOC.2.11.2.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> RIGHT_MOUSE_BUTTON</B></TT>
<DL><DT><DD></DL><P></DL>
<A NAME="EventType"></A>
<A NAME="DOC.2.11.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>enum EventType</B></TT>
<DL><DT><DD></DL><P><DL>
<A NAME="PUSH"></A>
<A NAME="DOC.2.11.3.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> PUSH</B></TT>
<DL><DT><DD></DL><P>
<A NAME="RELEASE"></A>
<A NAME="DOC.2.11.3.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> RELEASE</B></TT>
<DL><DT><DD></DL><P>
<A NAME="DRAG"></A>
<A NAME="DOC.2.11.3.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> DRAG</B></TT>
<DL><DT><DD></DL><P>
<A NAME="MOVE"></A>
<A NAME="DOC.2.11.3.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> MOVE</B></TT>
<DL><DT><DD></DL><P>
<A NAME="KEYBOARD"></A>
<A NAME="DOC.2.11.3.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> KEYBOARD</B></TT>
<DL><DT><DD></DL><P>
<A NAME="FRAME"></A>
<A NAME="DOC.2.11.3.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> FRAME</B></TT>
<DL><DT><DD></DL><P>
<A NAME="RESIZE"></A>
<A NAME="DOC.2.11.3.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> RESIZE</B></TT>
<DL><DT><DD></DL><P>
<A NAME="NONE"></A>
<A NAME="DOC.2.11.3.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> NONE</B></TT>
<DL><DT><DD></DL><P></DL>
<A NAME="getEventType"></A>
<A NAME="DOC.2.11.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual <!1><A HREF="GUIEventAdapter.html#DOC.2.11.3">EventType</A> getEventType() const = 0</B></TT>
<DD>Get the EventType of the GUI event
<DL><DT><DD></DL><P>
<A NAME="getKey"></A>
<A NAME="DOC.2.11.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual int getKey() const = 0</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.11.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual int getButton() const = 0</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.11.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual int getXmin() const = 0</B></TT>
<DD>window minimum x.
<DL><DT><DD></DL><P>
<A NAME="getXmax"></A>
<A NAME="DOC.2.11.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual int getXmax() const = 0</B></TT>
<DD>window maximum x.
<DL><DT><DD></DL><P>
<A NAME="getYmin"></A>
<A NAME="DOC.2.11.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual int getYmin() const = 0</B></TT>
<DD>window minimum y.
<DL><DT><DD></DL><P>
<A NAME="getYmax"></A>
<A NAME="DOC.2.11.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual int getYmax() const = 0</B></TT>
<DD>window maximum y.
<DL><DT><DD></DL><P>
<A NAME="getX"></A>
<A NAME="DOC.2.11.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual int getX() const = 0</B></TT>
<DD>current mouse x position
<DL><DT><DD></DL><P>
<A NAME="getY"></A>
<A NAME="DOC.2.11.12"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual int getY() const = 0</B></TT>
<DD>current mouse y position
<DL><DT><DD></DL><P>
<A NAME="getButtonMask"></A>
<A NAME="DOC.2.11.13"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual unsigned int getButtonMask() const = 0</B></TT>
<DD>current mouse button state
<DL><DT><DD></DL><P>
<A NAME="time"></A>
<A NAME="DOC.2.11.14"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual double time() const = 0</B></TT>
<DD>time in seconds of event.
<DL><DT><DD></DL><P>
<A NAME="~GUIEventAdapter"></A>
<A NAME="DOC.2.11.15"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual ~GUIEventAdapter()</B></TT>
<DD>Force users to create on heap, so that multiple referencing is safe
<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