OpenSceneGraph/doc/doc++/osgGA/GUIEventHandler.html
Robert Osfield ed10594139 Updated docs
2004-08-06 06:53:36 +00:00

111 lines
5.3 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class OSGGA_EXPORT osgGA::GUIEventHandler</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.6">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class OSGGA_EXPORT <A HREF="#DOC.DOCU">osgGA::GUIEventHandler</A></H2></H2><HR>
<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=155>
<param name=classes value="Mosg::Object,M,CGUIEventHandler,MGUIEventHandler.html,CStateSetManipulator,MStateSetManipulator.html,CMatrixManipulator,MMatrixManipulator.html,CCompositeGUIEventHandler,MCompositeGUIEventHandler.html">
<param name=before value="M,M,M|_,MR_,Mr_">
<param name=after value="Md_,M,M,M,M">
<param name=indent value="0,1,1,1,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.6.1">GUIEventHandler</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.6.2">GUIEventHandler</A></B>(const <!1><A HREF="GUIEventHandler.html#DOC.2.6.2">GUIEventHandler</A>&amp;, const osg::CopyOp&amp;)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>META_Object <B><A HREF="#DOC.2.6.3">(osgGA, GUIEventHandler) const </A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual <!1><A HREF="CompositeGUIEventHandler.html">CompositeGUIEventHandler</A>* <B><A HREF="#DOC.2.6.4">getComposite</A></B>()
<DD><I>Returns 0 if this GUIEventHandler is not a CompositeGUIEventHandler.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual bool <B><A HREF="#DOC.2.6.5">handle</A></B>(const <!1><A HREF="GUIEventAdapter.html">GUIEventAdapter</A>&amp;, <!1><A HREF="GUIActionAdapter.html">GUIActionAdapter</A>&amp;)
<DD><I>Handle events, return true if handled, false otherwise.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.6.6">accept</A></B>(<!1><A HREF="GUIEventHandlerVisitor.html">GUIEventHandlerVisitor</A>&amp;)
<DD><I>Accept visits from GUIEventHandler visitors </I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.6.7">getUsage</A></B>(osg::ApplicationUsage&amp;) const
<DD><I>Get the keyboard and mouse usage of this manipulator</I>
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>
<P>GUIEventHandler provides a basic interface for any class which wants to handle
a GUI Events.
<P>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.
<P>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.
</BLOCKQUOTE>
<DL>
<A NAME="GUIEventHandler"></A>
<A NAME="DOC.2.6.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> GUIEventHandler()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="GUIEventHandler"></A>
<A NAME="DOC.2.6.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> GUIEventHandler(const <!1><A HREF="GUIEventHandler.html#DOC.2.6.2">GUIEventHandler</A>&amp;, const osg::CopyOp&amp;)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="(osgGA, GUIEventHandler) const "></A>
<A NAME="DOC.2.6.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>META_Object (osgGA, GUIEventHandler) const () const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="getComposite"></A>
<A NAME="DOC.2.6.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual <!1><A HREF="CompositeGUIEventHandler.html">CompositeGUIEventHandler</A>* getComposite()</B></TT>
<DD>Returns 0 if this GUIEventHandler is not a CompositeGUIEventHandler.
<DL><DT><DD></DL><P>
<A NAME="handle"></A>
<A NAME="DOC.2.6.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual bool handle(const <!1><A HREF="GUIEventAdapter.html">GUIEventAdapter</A>&amp;, <!1><A HREF="GUIActionAdapter.html">GUIActionAdapter</A>&amp;)</B></TT>
<DD>Handle events, return true if handled, false otherwise.
<DL><DT><DD></DL><P>
<A NAME="accept"></A>
<A NAME="DOC.2.6.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void accept(<!1><A HREF="GUIEventHandlerVisitor.html">GUIEventHandlerVisitor</A>&amp;)</B></TT>
<DD>Accept visits from GUIEventHandler visitors
<DL><DT><DD></DL><P>
<A NAME="getUsage"></A>
<A NAME="DOC.2.6.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void getUsage(osg::ApplicationUsage&amp;) const </B></TT>
<DD>Get the keyboard and mouse usage of this manipulator
<DL><DT><DD></DL><P></DL>
<HR>
<DL><DT><B>Direct child classes:
</B><DD><A HREF="StateSetManipulator.html">StateSetManipulator</A><BR>
<A HREF="MatrixManipulator.html">MatrixManipulator</A><BR>
<A HREF="CompositeGUIEventHandler.html">CompositeGUIEventHandler</A><BR>
</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://www.linuxsupportline.com/~doc++">DOC++</A>.
</BODY>
</HTML>