~ubuntu-branches/ubuntu/utopic/castle-game-engine/utopic

<h2>Castle Game Engine</h2><p><a href="introduction.html" class="navigation">Introduction</a></p><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">

<a name="TCastlePrecalculatedAnimationCore"></a><h1 class="cio">Class TCastlePrecalculatedAnimationCore</h1>

<tr>

<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></td><td>Fields</td><td><a class="section" href="#PasDoc-Methods">Methods</a></td><td>Properties</td></tr></table>

<a href="CastlePrecalculatedAnimationCore.html">CastlePrecalculatedAnimationCore</a></p>

<h2 class="declaration">Declaration</h2>

<code>type TCastlePrecalculatedAnimationCore = class(<a class="normal" href="Castle3D.T3D.html">T3D</a>)</code></p>

<h2 class="description">Description</h2>

<p>

An abstract (cannot be rendered) precalculated animation. You usually want to use a descendant of this class that can be rendered in OpenGL, see <a class="normal" href="CastlePrecalculatedAnimation.TCastlePrecalculatedAnimation.html">TCastlePrecalculatedAnimation</a>.</p>

<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>

<ul class="hierarchy"><li class="ancestor">TComponent</li>

<li class="thisitem">TCastlePrecalculatedAnimationCore</li></ul><h2 class="overview">Overview</h2>

<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>

<td class="itemcode"><code>class procedure <b><a href="CastlePrecalculatedAnimationCore.TCastlePrecalculatedAnimationCore.html#LoadFromFileToVars">LoadFromFileToVars</a></b>(const FileName: string; ModelFileNames: TStringList; Times: <a href="CastleUtils.TSingleList.html">TSingleList</a>; out ScenesPerTime: Cardinal; out EqualityEpsilon: Single; out ATimeLoop, ATimeBackwards: boolean);</code></td>

</tr>

<td class="itemcode"><code>class procedure <b><a href="CastlePrecalculatedAnimationCore.TCastlePrecalculatedAnimationCore.html#LoadFromDOMElementToVars">LoadFromDOMElementToVars</a></b>(Element: TDOMElement; const BasePath: string; ModelFileNames: TStringList; Times: <a href="CastleUtils.TSingleList.html">TSingleList</a>; out ScenesPerTime: Cardinal; out EqualityEpsilon: Single; out ATimeLoop, ATimeBackwards: boolean);</code></td>

</tr>

</table>

<h2 class="description">Description</h2>

<h3 class="detail">Methods</h3>

<td class="itemcode"><a name="LoadFromFileToVars"></a><code>class procedure <b>LoadFromFileToVars</b>(const FileName: string; ModelFileNames: TStringList; Times: <a href="CastleUtils.TSingleList.html">TSingleList</a>; out ScenesPerTime: Cardinal; out EqualityEpsilon: Single; out ATimeLoop, ATimeBackwards: boolean);</code></td>

</tr>

<p>

Load animation data from a given FileName to a set of variables.

<p>See [<a href="http://castle-engine.sourceforge.net/kanim_format.php">http://castle-engine.sourceforge.net/kanim_format.php</a>] for specification of the file format.

<p>This is a <i>class procedure</i> — it doesn't load the animation data to the given <a class="normal" href="CastlePrecalculatedAnimationCore.TCastlePrecalculatedAnimationCore.html">TCastlePrecalculatedAnimationCore</a> instance. Instead it loads the data to your variables (passed as "out" params). In case of RootNodes and Times, you should pass here references to <i>already created and currently empty</i> lists.

<p>ModelFileNames returned will always contain only absolute paths. We will expand every path (like FileName parameter) if necessary for this.

<p>If you seek for most comfortable way to load <a class="normal" href="CastlePrecalculatedAnimation.TCastlePrecalculatedAnimation.html">TCastlePrecalculatedAnimation</a> from a file, you probably want to use <a class="normal" href="CastlePrecalculatedAnimation.TCastlePrecalculatedAnimation.html#LoadFromFile">TCastlePrecalculatedAnimation.LoadFromFile</a>. This procedure is more flexible — it allows you to e.g. modify parameters before creating <a class="normal" href="CastlePrecalculatedAnimation.TCastlePrecalculatedAnimation.html">TCastlePrecalculatedAnimation</a> instance, and it's usefull to implement a class like TCastlePrecalculatedAnimationInfo that also wants to read animation data, but doesn't have an <a class="normal" href="CastlePrecalculatedAnimation.TCastlePrecalculatedAnimation.html">TCastlePrecalculatedAnimation</a> instance available.</p>

</td></tr>

</table>

<td class="itemcode"><a name="LoadFromDOMElementToVars"></a><code>class procedure <b>LoadFromDOMElementToVars</b>(Element: TDOMElement; const BasePath: string; ModelFileNames: TStringList; Times: <a href="CastleUtils.TSingleList.html">TSingleList</a>; out ScenesPerTime: Cardinal; out EqualityEpsilon: Single; out ATimeLoop, ATimeBackwards: boolean);</code></td>

</tr>

<p>

Load animation data from a given XML element to a set of variables.

<p>This is just like <a class="normal" href="CastlePrecalculatedAnimationCore.TCastlePrecalculatedAnimationCore.html#LoadFromFileToVars">LoadFromFileToVars</a>, but it works using an Element. This way you can use it to load <animation> element that is a part of some larger XML file.

<p></p>

<h6 class="description_section">Parameters</h6>

<dt>BasePath</dt>

<dd>The path from which relative filenames inside Element will be resolved. It doesn't have to be an absolute path, we will expand it to make it absolute if necessary.</dd>

</dl>

</td></tr>

</table>

<hr noshade size="1"><span class="appinfo"><em>Generated by <a href="http://pasdoc.sourceforge.net/">PasDoc 0.12.1</a> on 2013-02-04 20:26:51</em>

</span>

</td></tr></table></body></html>

Older »