<!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: iView Struct 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>iView Struct Reference</h1><!-- doxytag: class="iView" --><!-- doxytag: inherits="iBase" -->The <a class="el" href="structiView.html" title="The iView class encapsulates the top-level Crystal Space renderer interface.">iView</a> class encapsulates the top-level Crystal Space renderer interface.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="view_8h-source.html">ivaria/view.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iView:</div>
<div class="dynsection">
<p><center><img src="structiView__inherit__graph.png" border="0" usemap="#iView__inherit__map" alt="Inheritance graph"></center>
<map name="iView__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csView, iView \>" alt="" coords="5,161,269,188"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="109,7,165,33"><area shape="rect" href="classcsView.html" title="The csView class encapsulates the top-level Crystal Space renderer interface." alt="" coords="105,239,169,265"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiView-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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiView.html#f06b0e34324e2fe0ee57ba1e418dbfc6">AddViewVertex</a> (int x, int y)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a vertex to clipping polygon (non-rectangular clipping). <a href="#f06b0e34324e2fe0ee57ba1e418dbfc6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiView.html#1c947f5e0306a47b5dc7a48974831d65">ClearView</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear clipper in order to start building a polygon-based clipper. <a href="#1c947f5e0306a47b5dc7a48974831d65"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiView.html#01c040b1dd37d8a0e195b61a53f0d3df">Draw</a> (<a class="el" href="structiMeshWrapper.html">iMeshWrapper</a> *mesh=0)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Draw 3D world as seen from the camera. <a href="#01c040b1dd37d8a0e195b61a53f0d3df"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiCamera.html">iCamera</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiView.html#9d0bccdf359e51077468bcd929627b7a">GetCamera</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get current camera. <a href="#9d0bccdf359e51077468bcd929627b7a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiClipper2D.html">iClipper2D</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiView.html#7bb214e5083edfccefe2f19f115a05d0">GetClipper</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current clipper. This function may call UpdateClipper (). <a href="#7bb214e5083edfccefe2f19f115a05d0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiGraphics3D.html">iGraphics3D</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiView.html#2c826360a161a73ae4418c5eccf2b857">GetContext</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get Context. <a href="#2c826360a161a73ae4418c5eccf2b857"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiEngine.html">iEngine</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiView.html#bc815079d4f0b00cd08b02941671b31e">GetEngine</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get engine handle. <a href="#bc815079d4f0b00cd08b02941671b31e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiView.html#5340f3e10c24d18c3c88d4a512ea479f">RestrictClipperToScreen</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clip the view clipper to the screen boundaries. <a href="#5340f3e10c24d18c3c88d4a512ea479f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiView.html#0614c7de334babdbf08121a480ed808f">SetAutoResize</a> (bool state)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable / Disable automatic resizing. <a href="#0614c7de334babdbf08121a480ed808f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiView.html#3213f8ad4cd0b268566e73f37d542284">SetCamera</a> (<a class="el" href="structiCamera.html">iCamera</a> *c)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set current camera. <a href="#3213f8ad4cd0b268566e73f37d542284"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiView.html#41c3eac39303750637157a0b239a07ff">SetContext</a> (<a class="el" href="structiGraphics3D.html">iGraphics3D</a> *ig3d)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set Context. <a href="#41c3eac39303750637157a0b239a07ff"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiView.html#2da26d335048be1cac26ac7a863b8d7a">SetEngine</a> (<a class="el" href="structiEngine.html">iEngine</a> *e)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set engine handle. <a href="#2da26d335048be1cac26ac7a863b8d7a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiView.html#8197b24651ab35bf48fe82c3e97d2afb">SetRectangle</a> (int x, int y, int w, int h)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set clipping rectangle. <a href="#8197b24651ab35bf48fe82c3e97d2afb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiView.html#cb04858acb838eb8d970bc70c5fefc57">UpdateClipper</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update the Clipper. This is usually called from Draw. <a href="#cb04858acb838eb8d970bc70c5fefc57"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="structiView.html" title="The iView class encapsulates the top-level Crystal Space renderer interface.">iView</a> class encapsulates the top-level Crystal Space renderer interface.
<p>
It is basically a camera and a clipper.<p>
Main creators of instances implementing this interface:<ul>
<li>Applications using <a class="el" href="classcsView.html" title="The csView class encapsulates the top-level Crystal Space renderer interface.">csView</a>.</li></ul>
<p>
Main ways to get pointers to this interface:<ul>
<li>Application stores it.</li></ul>
<p>
Main users of this interface:<ul>
<li>Application uses it. </li></ul>
<p>Definition at line <a class="el" href="view_8h-source.html#l00049">49</a> of file <a class="el" href="view_8h-source.html">view.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f06b0e34324e2fe0ee57ba1e418dbfc6"></a><!-- doxytag: member="iView::AddViewVertex" ref="f06b0e34324e2fe0ee57ba1e418dbfc6" args="(int x, int y)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iView::AddViewVertex </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>y</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a vertex to clipping polygon (non-rectangular clipping).
<p>
<p>Implemented in <a class="el" href="classcsView.html#e8847ca9743570c2b8a57821d97b73b4">csView</a>.</p>
</div>
</div><p>
<a class="anchor" name="1c947f5e0306a47b5dc7a48974831d65"></a><!-- doxytag: member="iView::ClearView" ref="1c947f5e0306a47b5dc7a48974831d65" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iView::ClearView </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear clipper in order to start building a polygon-based clipper.
<p>
<p>Implemented in <a class="el" href="classcsView.html#c71ec710eb13caeb6892ccef5fbfa9e3">csView</a>.</p>
</div>
</div><p>
<a class="anchor" name="01c040b1dd37d8a0e195b61a53f0d3df"></a><!-- doxytag: member="iView::Draw" ref="01c040b1dd37d8a0e195b61a53f0d3df" args="(iMeshWrapper *mesh=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iView::Draw </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiMeshWrapper.html">iMeshWrapper</a> * </td>
<td class="paramname"> <em>mesh</em> = <code>0</code> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Draw 3D world as seen from the camera.
<p>
If a mesh is given then only that single mesh is rendered. Note that in that case the mesh will only be rendered if it is in the same sector as the camera!
<p>Implemented in <a class="el" href="classcsView.html#d4407ebd4f82f3d642e14c949d8a4934">csView</a>.</p>
</div>
</div><p>
<a class="anchor" name="9d0bccdf359e51077468bcd929627b7a"></a><!-- doxytag: member="iView::GetCamera" ref="9d0bccdf359e51077468bcd929627b7a" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiCamera.html">iCamera</a>* iView::GetCamera </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get current camera.
<p>
<p>Implemented in <a class="el" href="classcsView.html#9dbba0334bfb853e158e3379c633424b">csView</a>.</p>
</div>
</div><p>
<a class="anchor" name="7bb214e5083edfccefe2f19f115a05d0"></a><!-- doxytag: member="iView::GetClipper" ref="7bb214e5083edfccefe2f19f115a05d0" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiClipper2D.html">iClipper2D</a>* iView::GetClipper </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the current clipper. This function may call UpdateClipper ().
<p>
<p>Implemented in <a class="el" href="classcsView.html#a40d35665c354cfcbe3fe2bea1b835c7">csView</a>.</p>
</div>
</div><p>
<a class="anchor" name="2c826360a161a73ae4418c5eccf2b857"></a><!-- doxytag: member="iView::GetContext" ref="2c826360a161a73ae4418c5eccf2b857" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiGraphics3D.html">iGraphics3D</a>* iView::GetContext </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get Context.
<p>
<p>Implemented in <a class="el" href="classcsView.html#e3b84e3d9c48b11e6fecd74e0a44ebfc">csView</a>.</p>
</div>
</div><p>
<a class="anchor" name="bc815079d4f0b00cd08b02941671b31e"></a><!-- doxytag: member="iView::GetEngine" ref="bc815079d4f0b00cd08b02941671b31e" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiEngine.html">iEngine</a>* iView::GetEngine </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get engine handle.
<p>
<p>Implemented in <a class="el" href="classcsView.html#e85e857e055ba95a7283e395697f72db">csView</a>.</p>
</div>
</div><p>
<a class="anchor" name="5340f3e10c24d18c3c88d4a512ea479f"></a><!-- doxytag: member="iView::RestrictClipperToScreen" ref="5340f3e10c24d18c3c88d4a512ea479f" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iView::RestrictClipperToScreen </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clip the view clipper to the screen boundaries.
<p>
<p>Implemented in <a class="el" href="classcsView.html#7895b9bc0ba9a2b9d790d2ffa61079cb">csView</a>.</p>
</div>
</div><p>
<a class="anchor" name="0614c7de334babdbf08121a480ed808f"></a><!-- doxytag: member="iView::SetAutoResize" ref="0614c7de334babdbf08121a480ed808f" args="(bool state)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iView::SetAutoResize </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>state</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Enable / Disable automatic resizing.
<p>
When this is true (default) then the view will detect automatically when the window size changes and adapt the view and camera automatically (i.e. it will change the view rectangle and perspective center). If you don't want that then you can disable this.
<p>Implemented in <a class="el" href="classcsView.html#4337049ef2cbdffb7c8c03c8266ef97a">csView</a>.</p>
</div>
</div><p>
<a class="anchor" name="3213f8ad4cd0b268566e73f37d542284"></a><!-- doxytag: member="iView::SetCamera" ref="3213f8ad4cd0b268566e73f37d542284" args="(iCamera *c)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iView::SetCamera </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiCamera.html">iCamera</a> * </td>
<td class="paramname"> <em>c</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set current camera.
<p>
<p>Implemented in <a class="el" href="classcsView.html#aac69b8df74bbeb13d50fc8d19155868">csView</a>.</p>
</div>
</div><p>
<a class="anchor" name="41c3eac39303750637157a0b239a07ff"></a><!-- doxytag: member="iView::SetContext" ref="41c3eac39303750637157a0b239a07ff" args="(iGraphics3D *ig3d)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iView::SetContext </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiGraphics3D.html">iGraphics3D</a> * </td>
<td class="paramname"> <em>ig3d</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set Context.
<p>
<p>Implemented in <a class="el" href="classcsView.html#d3a2b2c08e21c36831e523c817fb7890">csView</a>.</p>
</div>
</div><p>
<a class="anchor" name="2da26d335048be1cac26ac7a863b8d7a"></a><!-- doxytag: member="iView::SetEngine" ref="2da26d335048be1cac26ac7a863b8d7a" args="(iEngine *e)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iView::SetEngine </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiEngine.html">iEngine</a> * </td>
<td class="paramname"> <em>e</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set engine handle.
<p>
<p>Implemented in <a class="el" href="classcsView.html#da142bfff145a279a259bff3a653d02c">csView</a>.</p>
</div>
</div><p>
<a class="anchor" name="8197b24651ab35bf48fe82c3e97d2afb"></a><!-- doxytag: member="iView::SetRectangle" ref="8197b24651ab35bf48fe82c3e97d2afb" args="(int x, int y, int w, int h)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iView::SetRectangle </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>h</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set clipping rectangle.
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>The coordinates are vertically mirrored in comparison to screen space, i.e. y=0 is at the bottom of the viewport, y=GetHeight() at the top. </dd></dl>
<p>Implemented in <a class="el" href="classcsView.html#e6deef0420fc076dc5a4d0e50f568cb5">csView</a>.</p>
</div>
</div><p>
<a class="anchor" name="cb04858acb838eb8d970bc70c5fefc57"></a><!-- doxytag: member="iView::UpdateClipper" ref="cb04858acb838eb8d970bc70c5fefc57" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iView::UpdateClipper </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update the Clipper. This is usually called from Draw.
<p>
<p>Implemented in <a class="el" href="classcsView.html#4522ed71e300b9e1c44f66bc1929036d">csView</a>.</p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivaria/<a class="el" href="view_8h-source.html">view.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
>
3939
