renpy/doc/matrix.html
2023-01-18 23:13:55 +01:00

342 lines
21 KiB
HTML

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Matrix &#8212; Ren&#39;Py Documentation</title>
<link rel="stylesheet" href="_static/renpydoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/bootstrap-3.3.6/css/bootstrap.min.css" />
<link rel="stylesheet" type="text/css" href="_static/bootstrap-3.3.6/css/bootstrap-theme.min.css" />
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="_static/js/jquery-fix.js"></script>
<script type="text/javascript" src="_static/bootstrap-3.3.6/js/bootstrap.min.js"></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Model-Based Rendering" href="model.html" />
<link rel="prev" title="Color Class" href="color_class.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
</head><body>
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">
Ren&#39;Py Documentation</a>
<span class="navbar-text navbar-version pull-left"><b>7.5.3</b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li><a href="https://www.renpy.org">Home Page</a></li>
<li><a href="https://www.renpy.org/doc/html/">Online Documentation</a></li>
<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="index.html">Site <b class="caret"></b></a>
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"><ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="gui.html">GUI Customization Guide</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="language_basics.html">Language Basics</a></li>
<li class="toctree-l1"><a class="reference internal" href="label.html">Labels &amp; Control Flow</a></li>
<li class="toctree-l1"><a class="reference internal" href="dialogue.html">Dialogue and Narration</a></li>
<li class="toctree-l1"><a class="reference internal" href="displaying_images.html">Displaying Images</a></li>
<li class="toctree-l1"><a class="reference internal" href="menus.html">In-Game Menus</a></li>
<li class="toctree-l1"><a class="reference internal" href="python.html">Python Statements</a></li>
<li class="toctree-l1"><a class="reference internal" href="conditional.html">Conditional Statements</a></li>
<li class="toctree-l1"><a class="reference internal" href="audio.html">Audio</a></li>
<li class="toctree-l1"><a class="reference internal" href="movie.html">Movie</a></li>
<li class="toctree-l1"><a class="reference internal" href="voice.html">Voice</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="text.html">Text</a></li>
<li class="toctree-l1"><a class="reference internal" href="translation.html">Translation</a></li>
<li class="toctree-l1"><a class="reference internal" href="displayables.html">Displayables</a></li>
<li class="toctree-l1"><a class="reference internal" href="transforms.html">Transforms</a></li>
<li class="toctree-l1"><a class="reference internal" href="transitions.html">Transitions</a></li>
<li class="toctree-l1"><a class="reference internal" href="atl.html">Animation and Transformation Language</a></li>
<li class="toctree-l1"><a class="reference internal" href="matrixcolor.html">Matrixcolor</a></li>
<li class="toctree-l1"><a class="reference internal" href="layeredimage.html">Layered Images</a></li>
<li class="toctree-l1"><a class="reference internal" href="3dstage.html">3D Stage</a></li>
<li class="toctree-l1"><a class="reference internal" href="live2d.html">Live2D Cubism</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="style.html">Styles</a></li>
<li class="toctree-l1"><a class="reference internal" href="style_properties.html">Style Properties</a></li>
<li class="toctree-l1"><a class="reference internal" href="screens.html">Screens and Screen Language</a></li>
<li class="toctree-l1"><a class="reference internal" href="screen_actions.html">Screen Actions, Values, and Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="screen_special.html">Special Screen Names</a></li>
<li class="toctree-l1"><a class="reference internal" href="screen_optimization.html">Screen Language Optimization</a></li>
<li class="toctree-l1"><a class="reference internal" href="config.html">Configuration Variables</a></li>
<li class="toctree-l1"><a class="reference internal" href="preferences.html">Preference Variables</a></li>
<li class="toctree-l1"><a class="reference internal" href="store_variables.html">Store Variables</a></li>
<li class="toctree-l1"><a class="reference internal" href="mouse.html">Custom Mouse Cursors</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="launcher.html">Launcher</a></li>
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="director.html">Interactive Director</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="nvl_mode.html">NVL-Mode Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="input.html">Text Input</a></li>
<li class="toctree-l1"><a class="reference internal" href="side_image.html">Side Images</a></li>
<li class="toctree-l1"><a class="reference internal" href="rooms.html">Image Gallery, Music Room, and Replay Actions</a></li>
<li class="toctree-l1"><a class="reference internal" href="drag_drop.html">Drag and Drop</a></li>
<li class="toctree-l1"><a class="reference internal" href="sprites.html">Sprites</a></li>
<li class="toctree-l1"><a class="reference internal" href="keymap.html">Customizing the Keymap</a></li>
<li class="toctree-l1"><a class="reference internal" href="achievement.html">Achievements</a></li>
<li class="toctree-l1"><a class="reference internal" href="history.html">Dialogue History</a></li>
<li class="toctree-l1"><a class="reference internal" href="multiple.html">Multiple Character Dialogue</a></li>
<li class="toctree-l1"><a class="reference internal" href="splashscreen_presplash.html">Splashscreen and Presplash</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="statement_equivalents.html">Statement Equivalents</a></li>
<li class="toctree-l1"><a class="reference internal" href="save_load_rollback.html">Saving, Loading, and Rollback</a></li>
<li class="toctree-l1"><a class="reference internal" href="persistent.html">Persistent Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="trans_trans_python.html">Transforms and Transitions in Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="gui_advanced.html">Advanced GUI</a></li>
<li class="toctree-l1"><a class="reference internal" href="screen_python.html">Screens and Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="modes.html">Modes</a></li>
<li class="toctree-l1"><a class="reference internal" href="cdd.html">Creator-Defined Displayables</a></li>
<li class="toctree-l1"><a class="reference internal" href="cds.html">Creator-Defined Statements</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_text_tags.html">Custom Text Tags</a></li>
<li class="toctree-l1"><a class="reference internal" href="character_callbacks.html">Character Callbacks</a></li>
<li class="toctree-l1"><a class="reference internal" href="file_python.html">File Access</a></li>
<li class="toctree-l1"><a class="reference internal" href="color_class.html">Color Class</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Matrix</a></li>
<li class="toctree-l1"><a class="reference internal" href="model.html">Model-Based Rendering</a></li>
<li class="toctree-l1"><a class="reference internal" href="other.html">Other Functions and Variables</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="build.html">Building Distributions</a></li>
<li class="toctree-l1"><a class="reference internal" href="updater.html">Web Updater</a></li>
<li class="toctree-l1"><a class="reference internal" href="android.html">Android</a></li>
<li class="toctree-l1"><a class="reference internal" href="chromeos.html">Chrome OS/Chromebook</a></li>
<li class="toctree-l1"><a class="reference internal" href="ios.html">iOS</a></li>
<li class="toctree-l1"><a class="reference internal" href="iap.html">In-App Purchasing</a></li>
<li class="toctree-l1"><a class="reference internal" href="gesture.html">Gestures</a></li>
<li class="toctree-l1"><a class="reference internal" href="raspi.html">Raspberry Pi</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="problems.html">Dealing with Problems</a></li>
<li class="toctree-l1"><a class="reference internal" href="environment_variables.html">Environment Variables</a></li>
<li class="toctree-l1"><a class="reference internal" href="self_voicing.html">Self-Voicing</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="editor.html">Text Editor Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="skins.html">Skins</a></li>
<li class="toctree-l1"><a class="reference internal" href="translating_renpy.html">Translating Ren'Py</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog (Ren'Py 7.x-)</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog6.html">Changelog (Ren'Py 6.11 - 6.99)</a></li>
<li class="toctree-l1"><a class="reference internal" href="incompatible.html">Incompatible Changes</a></li>
<li class="toctree-l1"><a class="reference internal" href="distributor.html">Distributor Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="credits.html">Credits</a></li>
<li class="toctree-l1"><a class="reference internal" href="sponsors.html">Ren'Py Development Sponsors</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="thequestion.html">Script of The Question</a></li>
<li class="toctree-l1"><a class="reference internal" href="thequestion_nvl.html">NVL-mode script for The Question</a></li>
</ul>
</ul>
</li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-md-3">
<div id="sidebar" class="bs-sidenav" role="complementary"><ul>
<li><a class="reference internal" href="#">Matrix</a></li>
</ul>
</div>
</div>
<div class="col-md-9 content">
<div class="section" id="matrix">
<span id="id1"></span><h1>Matrix<a class="headerlink" href="#matrix" title="Permalink to this headline"> link</a></h1>
<dl class="function">
<dt id="Matrix">
<code class="descname">Matrix</code><span class="sig-paren">(</span><em>l</em><span class="sig-paren">)</span><a class="headerlink" href="#Matrix" title="Permalink to this definition"> link</a></dt>
<dd><p>This represents a 4x4 matrix, that is used in various places in Ren'Py.</p>
<p>When used to transform coordinates, the 16 elements of this matrix are:</p>
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="n">xdx</span><span class="p">,</span> <span class="n">xdy</span><span class="p">,</span> <span class="n">xdz</span><span class="p">,</span> <span class="n">xdw</span><span class="p">,</span>
<span class="n">ydx</span><span class="p">,</span> <span class="n">ydy</span><span class="p">,</span> <span class="n">ydz</span><span class="p">,</span> <span class="n">ydw</span><span class="p">,</span>
<span class="n">zdx</span><span class="p">,</span> <span class="n">zdy</span><span class="p">,</span> <span class="n">zdz</span><span class="p">,</span> <span class="n">zdw</span><span class="p">,</span>
<span class="n">wdx</span><span class="p">,</span> <span class="n">wdy</span><span class="p">,</span> <span class="n">wdz</span><span class="p">,</span> <span class="n">wdw</span>
</pre></div>
</div>
<p>where x' = xdx * x + xdy * y + xdz * z + xdw * w, where x is the original
value of x and x' is the transformed value, and similarly for x, y, z, and
w. This is usually applied to a position where w is 1, allowing any combination
of translation, rotation, and scaling to be expressed in a single matrix.</p>
<p>When used to transform colors, the 16 elements of this matrix are:</p>
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="n">rdr</span><span class="p">,</span> <span class="n">rdg</span><span class="p">,</span> <span class="n">rdb</span><span class="p">,</span> <span class="n">rda</span><span class="p">,</span>
<span class="n">gdr</span><span class="p">,</span> <span class="n">gdg</span><span class="p">,</span> <span class="n">gdg</span><span class="p">,</span> <span class="n">gda</span><span class="p">,</span>
<span class="n">bdr</span><span class="p">,</span> <span class="n">bdg</span><span class="p">,</span> <span class="n">bdb</span><span class="p">,</span> <span class="n">bda</span><span class="p">,</span>
<span class="n">adr</span><span class="p">,</span> <span class="n">adg</span><span class="p">,</span> <span class="n">adb</span><span class="p">,</span> <span class="n">ada</span><span class="p">,</span>
</pre></div>
</div>
<p>For the red, green, blue, and alpha channels.</p>
<p>Matrix objects can be multiplied using the Python multiplication operator,
to generate a matrix that performs both operations. The order in which
the matrixes appear can matter. Assuming <cite>v</cite> is a position or color being
transformed:</p>
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">step2</span> <span class="o">*</span> <span class="n">step1</span><span class="p">)</span> <span class="o">*</span> <span class="n">v</span>
</pre></div>
</div>
<p>is equivalent to:</p>
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="n">step2</span> <span class="o">*</span> <span class="p">(</span><span class="n">step1</span> <span class="o">*</span> <span class="n">v</span><span class="p">)</span>
</pre></div>
</div>
<dl class="docutils">
<dt><cite>l</cite></dt>
<dd><p class="first">This can be a list of 4, 9, or 16 numbers that is used to introduce
this matrix. If not the full 16, the top-left corner of the matrix
is initialized, with zdz and wdw set to 1.0 if not given. For example:</p>
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="n">Matrix</span><span class="p">([</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span> <span class="p">])</span>
</pre></div>
</div>
<p>would result in the Matrix:</p>
<div class="last highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span>
<span class="mf">3.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span>
<span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span>
<span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span>
</pre></div>
</div>
</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="Matrix.identity">
<code class="descclassname">Matrix.</code><code class="descname">identity</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Matrix.identity" title="Permalink to this definition"> link</a></dt>
<dd><p>Returns an identity matrix.</p>
</dd></dl>
<dl class="function">
<dt id="Matrix.offset">
<code class="descclassname">Matrix.</code><code class="descname">offset</code><span class="sig-paren">(</span><em>x</em>, <em>y</em>, <em>z</em><span class="sig-paren">)</span><a class="headerlink" href="#Matrix.offset" title="Permalink to this definition"> link</a></dt>
<dd><p>Returns a matrix that offsets the vertex by a fixed amount.</p>
</dd></dl>
<dl class="function">
<dt id="Matrix.perspective">
<code class="descclassname">Matrix.</code><code class="descname">perspective</code><span class="sig-paren">(</span><em>w</em>, <em>h</em>, <em>n</em>, <em>p</em>, <em>f</em><span class="sig-paren">)</span><a class="headerlink" href="#Matrix.perspective" title="Permalink to this definition"> link</a></dt>
<dd><p>Returns a matrix suitable for the perspective projection of an image
in the Ren'Py coordinate system. This is a view into the a coordinate
system where, where when z=0, (0, 0) corresponds to the top-left corner
of the screen, and (w, h) corresponds to the bottom-right corner of
the screen.</p>
<dl class="docutils">
<dt><cite>w</cite>, <cite>h</cite></dt>
<dd>The width and height of the input plane, in pixels.</dd>
<dt><cite>n</cite></dt>
<dd>The distance of the near plane from the camera.</dd>
<dt><cite>p</cite></dt>
<dd>How far the z=0 plane is from the camera. This is also where one
virtual pixel is one coordinate unit in x and y.</dd>
<dt><cite>f</cite></dt>
<dd>The distance of the far plane from the camera.</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="Matrix.rotate">
<code class="descclassname">Matrix.</code><code class="descname">rotate</code><span class="sig-paren">(</span><em>x</em>, <em>y</em>, <em>z</em><span class="sig-paren">)</span><a class="headerlink" href="#Matrix.rotate" title="Permalink to this definition"> link</a></dt>
<dd><p>Returns a matrix that rotates the displayable around the
origin.</p>
<dl class="docutils">
<dt><cite>x</cite>, <cite>y</cite>, <cite>z</cite></dt>
<dd>The amount to rotate around the origin, in degrees.</dd>
</dl>
<p>The rotations are applied in order:</p>
<ul class="simple">
<li>A clockwise rotation by <cite>x</cite> degrees in the Y/Z plane.</li>
<li>A clockwise rotation by <cite>y</cite> degrees in the Z/X plane.</li>
<li>A clockwise rotation by <cite>z</cite> degrees in the X/Y plane.</li>
</ul>
</dd></dl>
<dl class="function">
<dt id="Matrix.scale">
<code class="descclassname">Matrix.</code><code class="descname">scale</code><span class="sig-paren">(</span><em>x</em>, <em>y</em>, <em>z</em><span class="sig-paren">)</span><a class="headerlink" href="#Matrix.scale" title="Permalink to this definition"> link</a></dt>
<dd><p>Returns a matrix that scales the displayable.</p>
<dl class="docutils">
<dt><cite>x</cite>, <cite>y</cite>, <cite>z</cite></dt>
<dd>The factor to scale each axis by.</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<p class="pull-right">
<a href="#">Back to top</a>
</p>
<p>
&copy; Copyright 2012-2022, Tom Rothamel.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.6.<br/>
</p>
</div>
</footer>
</body>
</html>