<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: FrameBegin3DDraw Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>FrameBegin3DDraw Class Reference<br>
<small>
[<a class="el" href="group__event__handling.html">Event handling</a>]</small>
</h1><!-- doxytag: class="FrameBegin3DDraw" --><!-- doxytag: inherits="scfImplementation1< FrameBegin3DDraw, iEventHandler >" --><a class="el" href="classFrameBegin3DDraw.html" title="FrameBegin3DDraw handles every csevFrame event in the 3D phase.">FrameBegin3DDraw</a> handles every csevFrame event in the 3D phase.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="common__handlers_8h-source.html">csutil/common_handlers.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for FrameBegin3DDraw:</div>
<div class="dynsection">
<p><center><img src="classFrameBegin3DDraw__inherit__graph.png" border="0" usemap="#FrameBegin3DDraw__inherit__map" alt="Inheritance graph"></center>
<map name="FrameBegin3DDraw__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< FrameBegin3DDraw, iEventHandler \>" alt="" coords="65,161,476,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< FrameBegin3DDraw \>" alt="" coords="5,84,307,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="324,7,380,33"><area shape="rect" href="structiEventHandler.html" title="This interface describes an entity that can receive events." alt="" coords="331,84,443,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="45,7,267,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classFrameBegin3DDraw-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFrameBegin3DDraw.html#e5f8becceec3962f5ea8bc98dec1e3af">HandleEvent</a> (<a class="el" href="structiEvent.html">iEvent</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is the basic event handling function. <a href="#e5f8becceec3962f5ea8bc98dec1e3af"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c8c7a2c63004879fe438815be2b0cb40"></a><!-- doxytag: member="FrameBegin3DDraw::engine" ref="c8c7a2c63004879fe438815be2b0cb40" args="" -->
<a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiEngine.html">iEngine</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classFrameBegin3DDraw.html#c8c7a2c63004879fe438815be2b0cb40">engine</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8e55afd22540ac993ac513cc6cb7978"></a><!-- doxytag: member="FrameBegin3DDraw::g3d" ref="d8e55afd22540ac993ac513cc6cb7978" args="" -->
<a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiGraphics3D.html">iGraphics3D</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classFrameBegin3DDraw.html#d8e55afd22540ac993ac513cc6cb7978">g3d</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e106df3a366de940348497e021724010"></a><!-- doxytag: member="FrameBegin3DDraw::object_reg" ref="e106df3a366de940348497e021724010" args="" -->
<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFrameBegin3DDraw.html#e106df3a366de940348497e021724010">object_reg</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fcc39e21c2203dc0baf6f747ab933853"></a><!-- doxytag: member="FrameBegin3DDraw::view" ref="fcc39e21c2203dc0baf6f747ab933853" args="" -->
<a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiView.html">iView</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classFrameBegin3DDraw.html#fcc39e21c2203dc0baf6f747ab933853">view</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classFrameBegin3DDraw.html" title="FrameBegin3DDraw handles every csevFrame event in the 3D phase.">FrameBegin3DDraw</a> handles every csevFrame event in the 3D phase.
<p>
It calls g3d->BeginDraw(engine->GetBeginDrawFlags () | CSDRAW_3DGRAPHICS) and view->Draw (), where engine and g3d are loaded from the registry by the constructor and view is loaded from the registry each time the event is handled. The handler returns false, so it will not prevent any subsequent csevFrame handlers being called.
<p>Definition at line <a class="el" href="common__handlers_8h-source.html#l00048">48</a> of file <a class="el" href="common__handlers_8h-source.html">common_handlers.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e5f8becceec3962f5ea8bc98dec1e3af"></a><!-- doxytag: member="FrameBegin3DDraw::HandleEvent" ref="e5f8becceec3962f5ea8bc98dec1e3af" args="(iEvent &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool FrameBegin3DDraw::HandleEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiEvent.html">iEvent</a> & </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This is the basic event handling function.
<p>
To receive events, a component must implement <a class="el" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a> and register with an event queue using <a class="el" href="structiEventQueue.html#60116ec12210ce66f7aa65f9c5677321" title="Register a listener with the event scheduling subsystem.">iEventQueue::RegisterListener()</a> and <a class="el" href="structiEventQueue.html#d3e206126333538024bdd9587a7bd221" title="Subscribe an event listener to a given event subtree.">iEventQueue::Subscribe()</a>. The event handler should return true if the event was handled. Returning true prevents the event from being passed along to other event handlers (unless the event's Broadcast flag has been set, in which case it is sent to all subscribers regardless of the return value). If the event was not handled, then false should be returned, in which case other event handlers are given a shot at the event. Do <b>not</b> return true unless you really handled the event and want event dispatch to stop at your handler.
<p>Implements <a class="el" href="structiEventHandler.html#4b3885c2c5dc59fc4ecf32c089f0973a">iEventHandler</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="common__handlers_8h-source.html">common_handlers.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
205
