You are on page 1of 4

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.

org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>sge.View &mdash; The Pygame SGE 0.8.0 documentation</title> <link rel="stylesheet" href="_static/default.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '', VERSION: '0.8.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <link rel="top" title="The Pygame SGE 0.8.0 documentation" href="index.html" /> <link rel="up" title="Classes" href="classes.html" /> <link rel="next" title="Functions" href="functions.html" /> <link rel="prev" title="sge.Room" href="Room.html" /> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="functions.html" title="Functions" accesskey="N">next</a> |</li> <li class="right" > <a href="Room.html" title="sge.Room" accesskey="P">previous</a> |</li> <li><a href="index.html">The Pygame SGE 0.8.0 documentation</a> &raquo;< /li> <li><a href="classes.html" accesskey="U">Classes</a> &raquo;</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="sge-view"> <h1>sge.View<a class="headerlink" href="#sge-view" title="Permalink to this head line"></a></h1>

<dl class="class"> <dt id="sge.View"> <em class="property">class </em><tt class="descclassname">sge.</tt><tt class="de scname">View</tt><big>(</big><em>x</em>, <em>y</em>, <em>xport=0</em>, <em>yport =0</em>, <em>width=None</em>, <em>height=None</em><big>)</big><a class="headerli nk" href="#sge.View" title="Permalink to this definition"></a></dt> <dd><p>Class for room views.</p> <p>This class controls what the player sees in a room at any given time. Multiple views can exist in a room, and this can be used to create a split-screen effect.</p> <dl class="attribute"> <dt id="View.x"> <tt class="descname">x</tt><a class="headerlink" href="#View.x" title="Permalink to this definition"></a></dt> <dd><p>The horizontal position of the view in the room. When set, if it brings the view outside of the room it is in, it will be re-adjusted so that the view is completely inside the room.</p> </dd></dl> <dl class="attribute"> <dt id="View.y"> <tt class="descname">y</tt><a class="headerlink" href="#View.y" title="Permalink to this definition"></a></dt> <dd><p>The vertical position of the view in the room. When set, if it brings the view outside of the room it is in, it will be re-adjusted so that the view is completely inside the room.</p> </dd></dl> <dl class="attribute"> <dt id="View.xport"> <tt class="descname">xport</tt><a class="headerlink" href="#View.xport" title="P ermalink to this definition"></a></dt> <dd><p>The horizontal position of the view port on the screen.</p> </dd></dl> <dl class="attribute"> <dt id="View.yport"> <tt class="descname">yport</tt><a class="headerlink" href="#View.yport" title="P ermalink to this definition"></a></dt> <dd><p>The vertical position of the view port on the screen.</p> </dd></dl> <dl class="attribute"> <dt id="View.width"> <tt class="descname">width</tt><a class="headerlink" href="#View.width" title="P ermalink to this definition"></a></dt> <dd><p>The width of the view. When set, if it results in the view being outside of the room it is in, <a class="reference internal" href="#View.x" title ="View.x"><tt class="xref py py-attr docutils literal"><span class="pre">x</span ></tt></a> will be adjusted so that the view is completely inside the room.</p> </dd></dl> <dl class="attribute"> <dt id="View.height"> <tt class="descname">height</tt><a class="headerlink" href="#View.height" title= "Permalink to this definition"></a></dt> <dd><p>The height of the view. When set, if it results in the view being outside the room it is in, <a class="reference internal" href="#View.y" ti tle="View.y"><tt class="xref py py-attr docutils literal"><span class="pre">y</s

pan></tt></a> will be adjusted so that the view is completely inside the room.</p> </dd></dl> </dd></dl> <div class="section" id="sge-view-methods"> <h2>sge.View Methods<a class="headerlink" href="#sge-view-methods" title="Permal ink to this headline"></a></h2> <dl class="method"> <dt id="sge.View.__init__"> <tt class="descclassname">View.</tt><tt class="descname">__init__</tt><big>(</bi g><em>x</em>, <em>y</em>, <em>xport=0</em>, <em>yport=0</em>, <em>width=None</em >, <em>height=None</em><big>)</big><a class="headerlink" href="#sge.View.__init_ _" title="Permalink to this definition"></a></dt> <dd><p>Constructor method.</p> <p>Arguments:</p> <ul class="simple"> <li><tt class="docutils literal"><span class="pre">width</span></tt> &#8211; The width of the view. If set to <tt class="xref py py-const docutils literal"><sp an class="pre">None</span></tt>, it will be set such that the view port takes up all of the space that it can horizontally (i.e. <tt class="docutils literal"><span class="pre">sge.game.width</span> <span class ="pre">-</span> <span class="pre">xport</span></tt>).</li> <li><tt class="docutils literal"><span class="pre">height</span></tt> &#8211; Th e height of the view. If set to <tt class="xref py py-const docutils literal"><span class="pre">None</span></tt> , it will be set such that the view port takes up all of the space that it can vertically (i.e. <tt class="docutils literal"><span class="pre">sge.game.height</span> <span clas s="pre">-</span> <span class="pre">yport</span></tt>).</li> </ul> <p>All other arugments set the respective initial attributes of the view. See the documentation for <a class="reference internal" href="#sge.View" title="sge.View"><tt class="xref py py-class docutils literal"><span class="pre" >sge.View</span></tt></a> for more information.</p> </dd></dl> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <p class="logo"><a href="index.html"> <img class="logo" src="_static/sge_logo_alpha_black.png" alt="Logo "/> </a></p> <h3><a href="index.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">sge.View</a><ul> <li><a class="reference internal" href="#sge-view-methods">sge.View Methods</a>< /li> </ul> </li>

</ul> <h4>Previous topic</h4> <p class="topless"><a href="Room.html" title="previous chapter">sge.Room</a></p> <h4>Next topic</h4> <p class="topless"><a href="functions.html" title="next chapter">Functions</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="_sources/View.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="functions.html" title="Functions" >next</a> |</li> <li class="right" > <a href="Room.html" title="sge.Room" >previous</a> |</li> <li><a href="index.html">The Pygame SGE 0.8.0 documentation</a> &raquo;< /li> <li><a href="classes.html" >Classes</a> &raquo;</li> </ul> </div> <div class="footer"> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>

You might also like