<!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: iSkeletonAnimationKeyFrame 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>iSkeletonAnimationKeyFrame Struct Reference</h1><!-- doxytag: class="iSkeletonAnimationKeyFrame" --><!-- doxytag: inherits="iBase" -->The script key frame contains all bones that will be transformed in a specific time of a skeleton script.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="skeleton_8h-source.html">imesh/skeleton.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iSkeletonAnimationKeyFrame:</div>
<div class="dynsection">
<p><center><img src="structiSkeletonAnimationKeyFrame__inherit__graph.png" border="0" usemap="#iSkeletonAnimationKeyFrame__inherit__map" alt="Inheritance graph"></center>
<map name="iSkeletonAnimationKeyFrame__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="83,7,139,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiSkeletonAnimationKeyFrame-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="structiSkeletonAnimationKeyFrame.html#d0f82bcd56aca4a5e517f28adeea0da2">AddTransform</a> (<a class="el" href="structiSkeletonBoneFactory.html">iSkeletonBoneFactory</a> *bone, <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> &transform, bool relative=false)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add new bone transform to the key frame. <a href="#d0f82bcd56aca4a5e517f28adeea0da2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSkeletonAnimationKeyFrame.html#a5d1569a342df301b2cd8c90f41b049f">GetDuration</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get key frame duration. <a href="#a5d1569a342df301b2cd8c90f41b049f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSkeletonAnimationKeyFrame.html#b1722e19aa706d0bc2575d06e20ea236">GetKeyFrameData</a> (<a class="el" href="structiSkeletonBoneFactory.html">iSkeletonBoneFactory</a> *bone_fact, <a class="el" href="classcsQuaternion.html">csQuaternion</a> &rot, <a class="el" href="classcsVector3.html">csVector3</a> &pos, <a class="el" href="classcsQuaternion.html">csQuaternion</a> &tangent, bool &relative)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get key frame specific data. <a href="#b1722e19aa706d0bc2575d06e20ea236"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSkeletonAnimationKeyFrame.html#c96742ddcd3e9ff9302b36c3c91a0d21">GetName</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get name of the key frame. <a href="#c96742ddcd3e9ff9302b36c3c91a0d21"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSkeletonAnimationKeyFrame.html#abbf5779ce215073b56962b453c06cb1">GetTransform</a> (<a class="el" href="structiSkeletonBoneFactory.html">iSkeletonBoneFactory</a> *bone, <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> &dst_trans)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the transform of a bone. <a href="#abbf5779ce215073b56962b453c06cb1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSkeletonAnimationKeyFrame.html#2625262209dd3797c3470a79bba038ab">GetTransform</a> (<a class="el" href="structiSkeletonBoneFactory.html">iSkeletonBoneFactory</a> *bone)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the transform of a bone. <a href="#2625262209dd3797c3470a79bba038ab"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSkeletonAnimationKeyFrame.html#334fdee8f74d51fe688260c3b5f3b20e">GetTransformsCount</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get number of key transforms. <a href="#334fdee8f74d51fe688260c3b5f3b20e"></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="structiSkeletonAnimationKeyFrame.html#87b01f834677274c96bb39fda974ce12">SetDuration</a> (<a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> time)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set key frame duration. <a href="#87b01f834677274c96bb39fda974ce12"></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="structiSkeletonAnimationKeyFrame.html#d5c6d712c073435e6fdf96fcfec63f81">SetName</a> (const char *name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set name of the key frame. <a href="#d5c6d712c073435e6fdf96fcfec63f81"></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="structiSkeletonAnimationKeyFrame.html#13471708adadd58027aa89e0f3c1db9b">SetTransform</a> (<a class="el" href="structiSkeletonBoneFactory.html">iSkeletonBoneFactory</a> *bone, <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> &transform)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the transform of a bone. <a href="#13471708adadd58027aa89e0f3c1db9b"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The script key frame contains all bones that will be transformed in a specific time of a skeleton script.
<p>Definition at line <a class="el" href="skeleton_8h-source.html#l00180">180</a> of file <a class="el" href="skeleton_8h-source.html">skeleton.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d0f82bcd56aca4a5e517f28adeea0da2"></a><!-- doxytag: member="iSkeletonAnimationKeyFrame::AddTransform" ref="d0f82bcd56aca4a5e517f28adeea0da2" args="(iSkeletonBoneFactory *bone, csReversibleTransform &transform, bool relative=false)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSkeletonAnimationKeyFrame::AddTransform </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiSkeletonBoneFactory.html">iSkeletonBoneFactory</a> * </td>
<td class="paramname"> <em>bone</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> & </td>
<td class="paramname"> <em>transform</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>relative</em> = <code>false</code></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 new bone transform to the key frame.
<p>
</div>
</div><p>
<a class="anchor" name="a5d1569a342df301b2cd8c90f41b049f"></a><!-- doxytag: member="iSkeletonAnimationKeyFrame::GetDuration" ref="a5d1569a342df301b2cd8c90f41b049f" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> iSkeletonAnimationKeyFrame::GetDuration </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 key frame duration.
<p>
</div>
</div><p>
<a class="anchor" name="b1722e19aa706d0bc2575d06e20ea236"></a><!-- doxytag: member="iSkeletonAnimationKeyFrame::GetKeyFrameData" ref="b1722e19aa706d0bc2575d06e20ea236" args="(iSkeletonBoneFactory *bone_fact, csQuaternion &rot, csVector3 &pos, csQuaternion &tangent, bool &relative)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iSkeletonAnimationKeyFrame::GetKeyFrameData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiSkeletonBoneFactory.html">iSkeletonBoneFactory</a> * </td>
<td class="paramname"> <em>bone_fact</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsQuaternion.html">csQuaternion</a> & </td>
<td class="paramname"> <em>rot</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsVector3.html">csVector3</a> & </td>
<td class="paramname"> <em>pos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsQuaternion.html">csQuaternion</a> & </td>
<td class="paramname"> <em>tangent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool & </td>
<td class="paramname"> <em>relative</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>
Get key frame specific data.
<p>
Returns false when frame don't have data for given bone.
</div>
</div><p>
<a class="anchor" name="c96742ddcd3e9ff9302b36c3c91a0d21"></a><!-- doxytag: member="iSkeletonAnimationKeyFrame::GetName" ref="c96742ddcd3e9ff9302b36c3c91a0d21" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iSkeletonAnimationKeyFrame::GetName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get name of the key frame.
<p>
</div>
</div><p>
<a class="anchor" name="abbf5779ce215073b56962b453c06cb1"></a><!-- doxytag: member="iSkeletonAnimationKeyFrame::GetTransform" ref="abbf5779ce215073b56962b453c06cb1" args="(iSkeletonBoneFactory *bone, csReversibleTransform &dst_trans)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iSkeletonAnimationKeyFrame::GetTransform </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiSkeletonBoneFactory.html">iSkeletonBoneFactory</a> * </td>
<td class="paramname"> <em>bone</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> & </td>
<td class="paramname"> <em>dst_trans</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>
Get the transform of a bone.
<p>
Returns 'false' when there won't be any transform data for given bone.
</div>
</div><p>
<a class="anchor" name="2625262209dd3797c3470a79bba038ab"></a><!-- doxytag: member="iSkeletonAnimationKeyFrame::GetTransform" ref="2625262209dd3797c3470a79bba038ab" args="(iSkeletonBoneFactory *bone)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a>& iSkeletonAnimationKeyFrame::GetTransform </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiSkeletonBoneFactory.html">iSkeletonBoneFactory</a> * </td>
<td class="paramname"> <em>bone</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the transform of a bone.
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000097">Deprecated:</a></b></dt><dd>GetTransform (<a class="el" href="structiSkeletonBoneFactory.html" title="The skeleton bone factory is class that is used to create skeleton bones of a iSkeleton...">iSkeletonBoneFactory</a> *bone) is deprecated, use GetTransform (<a class="el" href="structiSkeletonBoneFactory.html" title="The skeleton bone factory is class that is used to create skeleton bones of a iSkeleton...">iSkeletonBoneFactory</a> *bone, <a class="el" href="classcsReversibleTransform.html" title="A class which defines a reversible transformation from one coordinate system to another...">csReversibleTransform</a> &dst_trans) instead </dd></dl>
</div>
</div><p>
<a class="anchor" name="334fdee8f74d51fe688260c3b5f3b20e"></a><!-- doxytag: member="iSkeletonAnimationKeyFrame::GetTransformsCount" ref="334fdee8f74d51fe688260c3b5f3b20e" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t iSkeletonAnimationKeyFrame::GetTransformsCount </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 number of key transforms.
<p>
</div>
</div><p>
<a class="anchor" name="87b01f834677274c96bb39fda974ce12"></a><!-- doxytag: member="iSkeletonAnimationKeyFrame::SetDuration" ref="87b01f834677274c96bb39fda974ce12" args="(csTicks time)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSkeletonAnimationKeyFrame::SetDuration </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td>
<td class="paramname"> <em>time</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set key frame duration.
<p>
</div>
</div><p>
<a class="anchor" name="d5c6d712c073435e6fdf96fcfec63f81"></a><!-- doxytag: member="iSkeletonAnimationKeyFrame::SetName" ref="d5c6d712c073435e6fdf96fcfec63f81" args="(const char *name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSkeletonAnimationKeyFrame::SetName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set name of the key frame.
<p>
</div>
</div><p>
<a class="anchor" name="13471708adadd58027aa89e0f3c1db9b"></a><!-- doxytag: member="iSkeletonAnimationKeyFrame::SetTransform" ref="13471708adadd58027aa89e0f3c1db9b" args="(iSkeletonBoneFactory *bone, csReversibleTransform &transform)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSkeletonAnimationKeyFrame::SetTransform </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiSkeletonBoneFactory.html">iSkeletonBoneFactory</a> * </td>
<td class="paramname"> <em>bone</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> & </td>
<td class="paramname"> <em>transform</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 the transform of a bone.
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>imesh/<a class="el" href="skeleton_8h-source.html">skeleton.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
>
3683
