<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>VisionEgg.Core.Viewport</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="VisionEgg-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.visionegg.org">Vision Egg</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="VisionEgg-module.html">Package VisionEgg</a> ::
<a href="VisionEgg.Core-module.html">Module Core</a> ::
Class Viewport
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="VisionEgg.Core.Viewport-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Viewport</h1><span class="codelink"><a href="VisionEgg.Core-pysrc.html#Viewport">source code</a></span><br /><br />
<pre class="base-tree">
object --+
|
<a href="VisionEgg.ClassWithParameters-class.html">ClassWithParameters</a> --+
|
<strong class="uidshort">Viewport</strong>
</pre>
<hr />
<pre class="literalblock">
Connects stimuli to a screen.
A viewport defines a (possibly clipped region) of the screen on
which stimuli are drawn.
A screen may have multiple viewports. The viewports may be
overlapping.
A viewport may have multiple stimuli.
A single stimulus may be drawn simultaneously by several
viewports, although this is typically useful only for 3D stimuli
to represent different views of the same object.
The coordinates of the stimulus are converted to screen
coordinates via several steps, the most important of which is the
projection, which is defined by an instance of the Projection
class.
By default, a viewport has a projection which maps eye coordinates
to viewport coordinates in 1:1 manner. In other words, eye
coordinates specify pixel location in the viewport.
For cases where pixel units are not natural to describe
coordinates of a stimulus, the application should specify the a
projection other than the default. This is usually the case for
3D stimuli.
For details of the projection and clipping process, see the
section 'Coordinate Transformations' in the book/online document
'The OpenGL Graphics System: A Specification'
Parameters
==========
anchor -- How position parameter is interpreted (String)
Default: lowerleft
camera_matrix -- extrinsic camera parameter matrix (position and orientation) (Instance of <class 'VisionEgg.Core.ModelView'>)
Default: (determined at runtime)
depth_range -- depth range (in object units) for rendering (Sequence2 of Real)
Default: (0, 1)
position -- Position (in pixel units) within the screen (Sequence2 of Real)
Default: (0, 0)
projection -- intrinsic camera parameter matrix (field of view, focal length, aspect ratio) (Instance of <class 'VisionEgg.Core.Projection'>)
Default: (determined at runtime)
screen -- The screen in which this viewport is drawn (Instance of <class 'VisionEgg.Core.Screen'>)
Default: (determined at runtime)
size -- Size (in pixel units) (Sequence2 of Real)
Default: (determined at runtime)
stimuli -- sequence of stimuli to draw in screen (Sequence of Instance of <class 'VisionEgg.Core.Stimulus'>)
Default: (determined at runtime)
</pre><br /><br />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="VisionEgg.Core.Viewport-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**kw</span>)</span><br />
Create a new instance.</td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Core-pysrc.html#Viewport.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="make_new_pixel_coord_projection"></a><span class="summary-sig-name">make_new_pixel_coord_projection</span>(<span class="summary-sig-arg">self</span>)</span><br />
Create instance of Projection mapping eye coordinates 1:1 with pixel coordinates.</td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Core-pysrc.html#Viewport.make_new_pixel_coord_projection">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="make_current"></a><span class="summary-sig-name">make_current</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Core-pysrc.html#Viewport.make_current">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="draw"></a><span class="summary-sig-name">draw</span>(<span class="summary-sig-arg">self</span>)</span><br />
Set the viewport and draw stimuli.</td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Core-pysrc.html#Viewport.draw">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="norm_device_2_window"></a><span class="summary-sig-name">norm_device_2_window</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">norm_device_vertex</span>)</span><br />
Transform normalized device coordinates to window coordinates</td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Core-pysrc.html#Viewport.norm_device_2_window">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="clip_2_window"></a><span class="summary-sig-name">clip_2_window</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">eye_coords_vertex</span>)</span><br />
Transform clip coordinates to window coordinates</td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Core-pysrc.html#Viewport.clip_2_window">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="eye_2_window"></a><span class="summary-sig-name">eye_2_window</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">eye_coords_vertex</span>)</span><br />
Transform eye coordinates to window coordinates</td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Core-pysrc.html#Viewport.eye_2_window">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="VisionEgg.ClassWithParameters-class.html">ClassWithParameters</a></code></b>:
<code><a href="VisionEgg.ClassWithParameters-class.html#__getstate__">__getstate__</a></code>,
<code><a href="VisionEgg.ClassWithParameters-class.html#__setstate__">__setstate__</a></code>,
<code><a href="VisionEgg.ClassWithParameters-class.html#get_specified_type">get_specified_type</a></code>,
<code><a href="VisionEgg.ClassWithParameters-class.html#is_constant_parameter">is_constant_parameter</a></code>,
<code><a href="VisionEgg.ClassWithParameters-class.html#set">set</a></code>,
<code><a href="VisionEgg.ClassWithParameters-class.html#verify_parameters">verify_parameters</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__str__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Class Variables</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="VisionEgg.Core.Viewport-class.html#parameters_and_defaults" class="summary-name">parameters_and_defaults</a> = <code title="VisionEgg.ParameterDefinition({'screen':(None, ve_types.Instance(Scree\
n), 'The screen in which this viewport is drawn'), 'position':((0, 0),\
ve_types.Sequence2(ve_types.Real), 'Position (in pixel units) within \
the screen'), 'anchor':('lowerleft', ve_types.String, 'How position pa\
rameter is interpreted'), 'depth_range':((0, 1), ve_types.Sequence2(ve\
_types.Real), 'depth range (in object units) for rendering'), 'size':(\
None, ve_types.Sequence2(ve_types.Real), 'Size (in pixel units)'), 'pr\
ojection':(None, ve_types.Instance(Projection), 'intrinsic camera para\
...">VisionEgg.ParameterDefinition({'scre<code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="VisionEgg.ClassWithParameters-class.html">ClassWithParameters</a></code></b>:
<code><a href="VisionEgg.ClassWithParameters-class.html#__safe_for_unpickling__">__safe_for_unpickling__</a></code>,
<code><a href="VisionEgg.ClassWithParameters-class.html#constant_parameters_and_defaults">constant_parameters_and_defaults</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Properties</span></td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**kw</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="VisionEgg.Core-pysrc.html#Viewport.__init__">source code</a></span>
</td>
</table>
<pre class="literalblock">
Create a new instance.
Required arguments:
screen
Optional arguments (specify parameter value other than default):
position -- defaults to (0,0), position relative to screen by anchor (see below)
anchor -- defaults to 'lowerleft'
size -- defaults to screen.size
projection -- defaults to self.make_new_pixel_coord_projection()
stimuli -- defaults to empty list
</pre>
<dl class="fields">
<dt>Overrides:
<a href="VisionEgg.ClassWithParameters-class.html#__init__">ClassWithParameters.__init__</a>
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
<a name="section-ClassVariableDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Class Variable Details</span></td>
</tr>
</table>
<a name="parameters_and_defaults"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">parameters_and_defaults</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
VisionEgg.ParameterDefinition({'screen':(None, ve_types.Instance(Scree<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
n), 'The screen in which this viewport is drawn'), 'position':((0, 0),<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
ve_types.Sequence2(ve_types.Real), 'Position (in pixel units) within <span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
the screen'), 'anchor':('lowerleft', ve_types.String, 'How position pa<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
rameter is interpreted'), 'depth_range':((0, 1), ve_types.Sequence2(ve<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
_types.Real), 'depth range (in object units) for rendering'), 'size':(<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
None, ve_types.Sequence2(ve_types.Real), 'Size (in pixel units)'), 'pr<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
ojection':(None, ve_types.Instance(Projection), 'intrinsic camera para<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="VisionEgg-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.visionegg.org">Vision Egg</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0beta1 on Sat Jun 7 15:40:10 2008
</td>
<td align="right" class="footer">
<a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie()
// -->
</script>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
b4347e6708d280a7ffb2b5b2ea3cdb9d
>
files
>
232
