diff options
Diffstat (limited to 'docs/doxygen/nel/classNL3D_1_1UPlayList.html')
| -rw-r--r-- | docs/doxygen/nel/classNL3D_1_1UPlayList.html | 1445 |
1 files changed, 1445 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNL3D_1_1UPlayList.html b/docs/doxygen/nel/classNL3D_1_1UPlayList.html new file mode 100644 index 00000000..66c0df7c --- /dev/null +++ b/docs/doxygen/nel/classNL3D_1_1UPlayList.html @@ -0,0 +1,1445 @@ +<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> +<HTML> +<HEAD> + <TITLE>nevrax.org : docs</TITLE> + <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</HEAD> +<BODY MARGINHEIGHT="0" MARGINWIDTH="0"> + +<!-- uplinks --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD> + </TR> +</TABLE> + +<!-- banner Nevrax --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%> + <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR> +</TABLE> + +<!-- main table --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + + <!------ Begin Box ------> + <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black> + <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF> + <TABLE cellspacing=0 cellpadding=1 border=0> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT=""> +</td></tr></table> + + +<!-- block --> +<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD> + <TD><B>Documentation</B></TD> + <TD ALIGN=RIGHT> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>NL3D::UPlayList Class Reference</h1>A playlist/channelmixer, from which you setup your mix of animations (blend, skeleton template weight...). +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="u__play__list_8h-source.html">u_play_list.h</a>></code> +<p> +<p>Inheritance diagram for NL3D::UPlayList: +<p><center><img src="classNL3D_1_1UPlayList.gif" usemap="#NL3D::UPlayList_map" border="0"></center> +<map name="NL3D::UPlayList_map"> +<area href="classNL3D_1_1CPlayListUser.html" alt="NL3D::CPlayListUser" shape="rect" coords="0,56,129,80"> +</map> +<a href="classNL3D_1_1UPlayList-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Types</h2></td></tr> +<tr><td nowrap align=right valign=top>enum </td><td valign=bottom>{ <a class="el" href="classNL3D_1_1UPlayList.html#s5s0">empty</a> = 0xffffffff + }</td></tr> +<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#s6">TWrapMode</a> { <a class="el" href="classNL3D_1_1UPlayList.html#s6s1">Clamp</a> = 0, +<a class="el" href="classNL3D_1_1UPlayList.html#s6s2">Repeat</a>, +<a class="el" href="classNL3D_1_1UPlayList.html#s6s3">Disable</a>, +<a class="el" href="classNL3D_1_1UPlayList.html#s6s4">WrapModeCount</a> + }</td></tr> +<tr><td> </td><td><font size=-1><em>Wrap mode for the play list.</em> <a href="#s6">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td colspan="2"><div class="groupHeader">Animatable Link.</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z65_0">registerTransform</a> (<a class="el" href="classNL3D_1_1UTransform.html">UTransform</a> *object, const char *prefix="")=0</td></tr> +<tr><td> </td><td><font size=-1><em>register an Animatable object (<a class="el" href="classNL3D_1_1UTransform.html">UTransform</a>, <a class="el" href="classNL3D_1_1UCamera.html">UCamera</a>, <a class="el" href="classNL3D_1_1UInstance.html">UInstance</a>...) to the playlist.</em> <a href="#z65_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z65_1">resetAllChannels</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>Reset all channels so that no more Animatable object (Transforms etc...) are linked to this PLayList.</em> <a href="#z65_1">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Animation Setup.</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z66_0">emptyPlayList</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>Empty the playlist.</em> <a href="#z66_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z66_1">setAnimation</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot, <a class="el" href="memory__common_8h.html#a15">uint</a> animation)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the animation of a slot.</em> <a href="#z66_1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="memory__common_8h.html#a15">uint</a> </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z66_2">getAnimation</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the animation of a slot.</em> <a href="#z66_2">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Animation Time Setup.</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z67_0">setTimeOrigin</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot, <a class="el" href="namespaceNL3D.html#a2">TGlobalAnimationTime</a> timeOrigin)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set animation time origin, ie, the time in the playlist for which slot time is the startTime of the slot animation.</em> <a href="#z67_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespaceNL3D.html#a2">TGlobalAnimationTime</a> </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z67_1">getTimeOrigin</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get animation time origin, ie, the time in the playlist for which slot time is the startTime of the slot animation.</em> <a href="#z67_1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z67_2">setSpeedFactor</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot, float speedFactor)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set animation speed factor.</em> <a href="#z67_2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z67_3">getSpeedFactor</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get animation speed factor.</em> <a href="#z67_3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z67_4">setWrapMode</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot, <a class="el" href="classNL3D_1_1UPlayList.html#s6">TWrapMode</a> wrapMode)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the wrap mode to use in the play list.</em> <a href="#z67_4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classNL3D_1_1UPlayList.html#s6">TWrapMode</a> </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z67_5">getWrapMode</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the wrap mode in use in the play list.</em> <a href="#z67_5">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Animation Weight Setup.</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z68_0">setStartWeight</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot, float startWeight, <a class="el" href="namespaceNL3D.html#a2">TGlobalAnimationTime</a> time)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set animation start weight.</em> <a href="#z68_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z68_1">getStartWeight</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot, <a class="el" href="namespaceNL3D.html#a2">TGlobalAnimationTime</a> &time) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get animation start weight.</em> <a href="#z68_1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z68_2">setEndWeight</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot, float endWeight, <a class="el" href="namespaceNL3D.html#a2">TGlobalAnimationTime</a> time)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set animation end weight.</em> <a href="#z68_2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z68_3">getEndWeight</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot, <a class="el" href="namespaceNL3D.html#a2">TGlobalAnimationTime</a> &time) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get animation end weight.</em> <a href="#z68_3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z68_4">setWeightSmoothness</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot, float smoothness)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set weight smoothness.</em> <a href="#z68_4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z68_5">getWeightSmoothness</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get weight smoothness.</em> <a href="#z68_5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z68_6">setWeight</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot, float weight)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Setup a constant animation weight.</em> <a href="#z68_6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespaceNL3D.html#a1">TAnimationTime</a> </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z68_7">getLocalTime</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot, <a class="el" href="namespaceNL3D.html#a2">TGlobalAnimationTime</a> globalTime, const <a class="el" href="classNL3D_1_1UAnimationSet.html">UAnimationSet</a> &animSet) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Convert a playlist global time in local time in a slot animation including wrap evaluation.</em> <a href="#z68_7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z68_8">getLocalWeight</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot, <a class="el" href="namespaceNL3D.html#a2">TGlobalAnimationTime</a> globalTime) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Compute weight of a slot at a given global playlist time.</em> <a href="#z68_8">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Skeleton Weight Setup.</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z69_0">setSkeletonWeight</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot, <a class="el" href="memory__common_8h.html#a15">uint</a> skeletonId, bool inverted=false)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the skeleton weight animation of a slot.</em> <a href="#z69_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="memory__common_8h.html#a15">uint</a> </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z69_1">getSkeletonWeight</a> (<a class="el" href="memory__common_8h.html#a7">uint8</a> slot, bool &inverted) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the skeleton weight of a slot.</em> <a href="#z69_1">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Special channel operation.</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z70_0">enableChannel</a> (<a class="el" href="memory__common_8h.html#a15">uint</a> channelId, bool enable)=0</td></tr> +<tr><td> </td><td><font size=-1><em>disabling a channel means it is no more modified during animation.</em> <a href="#z70_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#z70_1">isChannelEnabled</a> (<a class="el" href="memory__common_8h.html#a15">uint</a> channelId) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>see <a class="el" href="classNL3D_1_1UPlayList.html#z70_0">enableChannel</a>().</em> <a href="#z70_1">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#b0">UPlayList</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#b0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classNL3D_1_1UPlayList.html#b1">~UPlayList</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#b1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A playlist/channelmixer, from which you setup your mix of animations (blend, skeleton template weight...). +<p> +Once this <a class="el" href="classNL3D_1_1UPlayList.html">UPlayList</a> is created from the <a class="el" href="classNL3D_1_1UPlayListManager.html">UPlayListManager</a> (with an <a class="el" href="classNL3D_1_1UAnimationSet.html">UAnimationSet</a>), you just need to <a class="el" href="classNL3D_1_1UPlayList.html#z65_0">registerTransform</a>() your object(s) (eg: an <a class="el" href="classNL3D_1_1UInstance.html">UInstance</a>). Then you can use all the Animation setup function to blend, mix, setup time etc... +<p> +NB: a playlist is actually played through <a class="el" href="classNL3D_1_1UPlayListManager.html#a2">UPlayListManager::animate</a>(). NB: all AnimationTime are in second. <dl compact><dt><b> +Author: </b><dd> +Lionel Berenguier , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2001 </dl> +<p> + +<p> +Definition at line <a class="el" href="u__play__list_8h-source.html#l00053">53</a> of file <a class="el" href="u__play__list_8h-source.html">u_play_list.h</a>.<hr><h2>Member Enumeration Documentation</h2> +<a name="s5" doxytag="NL3D::UPlayList::@2"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> anonymous enum + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<dl compact><dt><b> +Enumeration values:</b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em><a name="s5s0" doxytag="empty"></a><em>empty</em></em> </td><td> +</td></tr> +</table> +</dl> + +<p> +Definition at line <a class="el" href="u__play__list_8h-source.html#l00063">63</a> of file <a class="el" href="u__play__list_8h-source.html">u_play_list.h</a>. </td> + </tr> +</table> +<a name="s6" doxytag="NL3D::UPlayList::TWrapMode"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> enum NL3D::UPlayList::TWrapMode + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Wrap mode for the play list. +<p> +<dl compact><dt><b> +Enumeration values:</b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em><a name="s6s1" doxytag="Clamp"></a><em>Clamp</em></em> </td><td> +Clamp the animation time. (default).</td></tr> +<tr><td valign=top><em><a name="s6s2" doxytag="Repeat"></a><em>Repeat</em></em> </td><td> +Repeat the animation.</td></tr> +<tr><td valign=top><em><a name="s6s3" doxytag="Disable"></a><em>Disable</em></em> </td><td> +Disable the animation.</td></tr> +<tr><td valign=top><em><a name="s6s4" doxytag="WrapModeCount"></a><em>WrapModeCount</em></em> </td><td> +</td></tr> +</table> +</dl> + +<p> +Definition at line <a class="el" href="u__play__list_8h-source.html#l00070">70</a> of file <a class="el" href="u__play__list_8h-source.html">u_play_list.h</a>. </td> + </tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a name="b0" doxytag="NL3D::UPlayList::UPlayList"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NL3D::UPlayList::UPlayList </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> + +<p> +Definition at line <a class="el" href="u__play__list_8h-source.html#l00058">58</a> of file <a class="el" href="u__play__list_8h-source.html">u_play_list.h</a>. </td> + </tr> +</table> +<a name="b1" doxytag="NL3D::UPlayList::~UPlayList"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual NL3D::UPlayList::~UPlayList </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, protected, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> + +<p> +Definition at line <a class="el" href="u__play__list_8h-source.html#l00060">60</a> of file <a class="el" href="u__play__list_8h-source.html">u_play_list.h</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="z66_0" doxytag="NL3D::UPlayList::emptyPlayList"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NL3D::UPlayList::emptyPlayList </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Empty the playlist. +<p> +Each slot is set to its default value. +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z692_0">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z70_0" doxytag="NL3D::UPlayList::enableChannel"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NL3D::UPlayList::enableChannel </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a15">uint</a> </td> + <td class="mdname" nowrap> <em>channelId</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>enable</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +disabling a channel means it is no more modified during animation. +<p> +Default is enabled. NB: this channel must have been added (via <a class="el" href="classNL3D_1_1UPlayList.html#z65_0">registerTransform</a>()....). <dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>channelId</em> </td><td> +channelId get from <a class="el" href="classNL3D_1_1UAnimationSet.html#z7_0">UAnimationSet::getChannelIdByName</a>(). </td></tr> +</table> +</dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z696_0">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z66_2" doxytag="NL3D::UPlayList::getAnimation"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="memory__common_8h.html#a15">uint</a> NL3D::UPlayList::getAnimation </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname1" valign="top" nowrap> <em>slot</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the animation of a slot. +<p> +Default value is empty.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>slot</em> </td><td> +is the id of the slot to set. </td></tr> +</table> +</dl><dl compact><dt><b> +Returns: </b><dd> +the animation number in use in this slot. Return <a class="el" href="classNL3D_1_1UPlayList.html#s5s0">UPlayList::empty</a> if the slot is empty. </dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z692_2">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z68_3" doxytag="NL3D::UPlayList::getEndWeight"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual float NL3D::UPlayList::getEndWeight </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname" nowrap> <em>slot</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="namespaceNL3D.html#a2">TGlobalAnimationTime</a> & </td> + <td class="mdname" nowrap> <em>time</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get animation end weight. +<p> +Default value is 1.f.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>slot</em> </td><td> +is the id to get the slot. </td></tr> +<tr><td valign=top><em>time</em> </td><td> +will get the playlist time for which the start weight is set. Default is 0.f. </td></tr> +</table> +</dl><dl compact><dt><b> +Returns: </b><dd> +the end weight used in the slot. </dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z694_3">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z68_7" doxytag="NL3D::UPlayList::getLocalTime"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceNL3D.html#a1">TAnimationTime</a> NL3D::UPlayList::getLocalTime </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname" nowrap> <em>slot</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="namespaceNL3D.html#a2">TGlobalAnimationTime</a> </td> + <td class="mdname" nowrap> <em>globalTime</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const <a class="el" href="classNL3D_1_1UAnimationSet.html">UAnimationSet</a> & </td> + <td class="mdname" nowrap> <em>animSet</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Convert a playlist global time in local time in a slot animation including wrap evaluation. +<p> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>slot</em> </td><td> +is the slot in which the local time must be computed </td></tr> +<tr><td valign=top><em>time</em> </td><td> +is the global time of the playlist</td></tr> +</table> +</dl><dl compact><dt><b> +Returns: </b><dd> +the local time in the slot. If no animation are set in the slot, globalTime is returned. </dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z694_7">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z68_8" doxytag="NL3D::UPlayList::getLocalWeight"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual float NL3D::UPlayList::getLocalWeight </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname" nowrap> <em>slot</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="namespaceNL3D.html#a2">TGlobalAnimationTime</a> </td> + <td class="mdname" nowrap> <em>globalTime</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Compute weight of a slot at a given global playlist time. +<p> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>slot</em> </td><td> +is the slot in which the weight must be computed </td></tr> +<tr><td valign=top><em>time</em> </td><td> +is the global time of the playlist</td></tr> +</table> +</dl><dl compact><dt><b> +Returns: </b><dd> +the weight of the slot for the given time. </dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z694_8">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z69_1" doxytag="NL3D::UPlayList::getSkeletonWeight"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="memory__common_8h.html#a15">uint</a> NL3D::UPlayList::getSkeletonWeight </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname" nowrap> <em>slot</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool & </td> + <td class="mdname" nowrap> <em>inverted</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the skeleton weight of a slot. +<p> +Default value is empty.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>slot</em> </td><td> +is the id of the slot to set. </td></tr> +<tr><td valign=top><em>inverted</em> </td><td> +will receive the invert flag. </td></tr> +</table> +</dl><dl compact><dt><b> +Returns: </b><dd> +the skeleton weight number in use in this slot. Return <a class="el" href="classNL3D_1_1UPlayList.html#s5s0">UPlayList::empty</a> if the slot is empty. </dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z695_1">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z67_3" doxytag="NL3D::UPlayList::getSpeedFactor"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual float NL3D::UPlayList::getSpeedFactor </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname1" valign="top" nowrap> <em>slot</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get animation speed factor. +<p> +Default value is 1.f.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>slot</em> </td><td> +is the id to get the slot. </td></tr> +</table> +</dl><dl compact><dt><b> +Returns: </b><dd> +the speed factor used in the slot. </dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z693_3">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z68_1" doxytag="NL3D::UPlayList::getStartWeight"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual float NL3D::UPlayList::getStartWeight </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname" nowrap> <em>slot</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="namespaceNL3D.html#a2">TGlobalAnimationTime</a> & </td> + <td class="mdname" nowrap> <em>time</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get animation start weight. +<p> +Default value is 1.f.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>slot</em> </td><td> +is the id to get the slot. </td></tr> +<tr><td valign=top><em>time</em> </td><td> +will get the playlist time for which the start weight is set. Default is 0.f. </td></tr> +</table> +</dl><dl compact><dt><b> +Returns: </b><dd> +the start weight used in the slot. </dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z694_1">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z67_1" doxytag="NL3D::UPlayList::getTimeOrigin"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceNL3D.html#a2">TGlobalAnimationTime</a> NL3D::UPlayList::getTimeOrigin </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname1" valign="top" nowrap> <em>slot</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get animation time origin, ie, the time in the playlist for which slot time is the startTime of the slot animation. +<p> +Default value is 0.f.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>slot</em> </td><td> +is the id to get the slot. </td></tr> +</table> +</dl><dl compact><dt><b> +Returns: </b><dd> +time origin used in the slot. </dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z693_1">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z68_5" doxytag="NL3D::UPlayList::getWeightSmoothness"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual float NL3D::UPlayList::getWeightSmoothness </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname1" valign="top" nowrap> <em>slot</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get weight smoothness. +<p> +This is the smoothness of the weight interpolation. Must be between 0.f and 1.f. 0.f is a sharp interpolation (linear), 1.f is a smooth interpolation (quadratic). Default value is 0.f.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>slot</em> </td><td> +is the id of the slot to set. </td></tr> +</table> +</dl><dl compact><dt><b> +Returns: </b><dd> +the smoothness value. </dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z694_5">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z67_5" doxytag="NL3D::UPlayList::getWrapMode"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="classNL3D_1_1UPlayList.html#s6">TWrapMode</a> NL3D::UPlayList::getWrapMode </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname1" valign="top" nowrap> <em>slot</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the wrap mode in use in the play list. +<p> +Wrap mode tells the play list how to use an animation when current time is not in the animation. <dl compact><dt><b> +Returns: </b><dd> +the wrap mode in use. </dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z693_5">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z70_1" doxytag="NL3D::UPlayList::isChannelEnabled"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual bool NL3D::UPlayList::isChannelEnabled </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a15">uint</a> </td> + <td class="mdname1" valign="top" nowrap> <em>channelId</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +see <a class="el" href="classNL3D_1_1UPlayList.html#z70_0">enableChannel</a>(). +<p> +return false if channel do not exist... NB: this channel must have been added (via <a class="el" href="classNL3D_1_1UPlayList.html#z65_0">registerTransform</a>()....). <dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>channelId</em> </td><td> +channelId get from <a class="el" href="classNL3D_1_1UAnimationSet.html#z7_0">UAnimationSet::getChannelIdByName</a>(). </td></tr> +</table> +</dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z696_1">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z65_0" doxytag="NL3D::UPlayList::registerTransform"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NL3D::UPlayList::registerTransform </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNL3D_1_1UTransform.html">UTransform</a> * </td> + <td class="mdname" nowrap> <em>object</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>prefix</em> = ""</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +register an Animatable object (<a class="el" href="classNL3D_1_1UTransform.html">UTransform</a>, <a class="el" href="classNL3D_1_1UCamera.html">UCamera</a>, <a class="el" href="classNL3D_1_1UInstance.html">UInstance</a>...) to the playlist. +<p> +Before deleting this Animatable object, you SHOULD <a class="el" href="classNL3D_1_1UPlayList.html#z65_1">UPlayList::resetAllChannels</a>() or delete the playlist from the playlistmanager.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>object</em> </td><td> +is the object which will be affected by this animation playlist. </td></tr> +</table> +</dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z691_0">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z65_1" doxytag="NL3D::UPlayList::resetAllChannels"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NL3D::UPlayList::resetAllChannels </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Reset all channels so that no more Animatable object (Transforms etc...) are linked to this PLayList. +<p> +Hence, the playlist has no effect on anything. +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z691_1">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z66_1" doxytag="NL3D::UPlayList::setAnimation"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NL3D::UPlayList::setAnimation </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname" nowrap> <em>slot</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="memory__common_8h.html#a15">uint</a> </td> + <td class="mdname" nowrap> <em>animation</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the animation of a slot. +<p> +Default value is empty.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>slot</em> </td><td> +is the id of the slot to set. </td></tr> +<tr><td valign=top><em>animation</em> </td><td> +is the animation number to use in this slot. To empty the slot, use <a class="el" href="classNL3D_1_1UPlayList.html#s5s0">UPlayList::empty</a>. </td></tr> +</table> +</dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z692_1">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z68_2" doxytag="NL3D::UPlayList::setEndWeight"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NL3D::UPlayList::setEndWeight </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname" nowrap> <em>slot</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>endWeight</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="namespaceNL3D.html#a2">TGlobalAnimationTime</a> </td> + <td class="mdname" nowrap> <em>time</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set animation end weight. +<p> +This is the weight for this animation use at the end of the animation slot. Default value is 1.f.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>slot</em> </td><td> +is the id of the slot to set. </td></tr> +<tr><td valign=top><em>time</em> </td><td> +is the playlist time for which the start weight is set. Default is 1.f. </td></tr> +<tr><td valign=top><em>endWeight</em> </td><td> +is the factor to use in this slot. </td></tr> +</table> +</dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z694_2">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z69_0" doxytag="NL3D::UPlayList::setSkeletonWeight"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NL3D::UPlayList::setSkeletonWeight </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname" nowrap> <em>slot</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="memory__common_8h.html#a15">uint</a> </td> + <td class="mdname" nowrap> <em>skeletonId</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>inverted</em> = false</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the skeleton weight animation of a slot. +<p> +Default value is empty.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>slot</em> </td><td> +is the id of the slot to set. </td></tr> +<tr><td valign=top><em>skeletonId</em> </td><td> +is the skeleton weight number to use in this slot. To empty the slot, use <a class="el" href="classNL3D_1_1UPlayList.html#s5s0">UPlayList::empty</a>. </td></tr> +<tr><td valign=top><em>inverted</em> </td><td> +is false if the weights must be used as they are, true if the weights to used are 1.f - weight. </td></tr> +</table> +</dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z695_0">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z67_2" doxytag="NL3D::UPlayList::setSpeedFactor"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NL3D::UPlayList::setSpeedFactor </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname" nowrap> <em>slot</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>speedFactor</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set animation speed factor. +<p> +Default value is 1.f.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>slot</em> </td><td> +is the id of the slot to set. </td></tr> +<tr><td valign=top><em>speedFactor</em> </td><td> +is the factor to use in this slot. The animation will go speedFactor* faster. </td></tr> +</table> +</dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z693_2">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z68_0" doxytag="NL3D::UPlayList::setStartWeight"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NL3D::UPlayList::setStartWeight </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname" nowrap> <em>slot</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>startWeight</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="namespaceNL3D.html#a2">TGlobalAnimationTime</a> </td> + <td class="mdname" nowrap> <em>time</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set animation start weight. +<p> +This is the weight for this animation use at the beginning of the animation slot. Default value is 1.f.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>slot</em> </td><td> +is the id of the slot to set. </td></tr> +<tr><td valign=top><em>startWeight</em> </td><td> +is the factor to use in this slot. </td></tr> +<tr><td valign=top><em>time</em> </td><td> +is the playlist time for which the start weight is set. Default is 0.f. </td></tr> +</table> +</dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z694_0">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z67_0" doxytag="NL3D::UPlayList::setTimeOrigin"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NL3D::UPlayList::setTimeOrigin </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname" nowrap> <em>slot</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="namespaceNL3D.html#a2">TGlobalAnimationTime</a> </td> + <td class="mdname" nowrap> <em>timeOrigin</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set animation time origin, ie, the time in the playlist for which slot time is the startTime of the slot animation. +<p> +Default value is 0.f.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>slot</em> </td><td> +is the id of the slot to set. </td></tr> +<tr><td valign=top><em>timeOrigin</em> </td><td> +time origin to use in the slot. </td></tr> +</table> +</dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z693_0">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z68_6" doxytag="NL3D::UPlayList::setWeight"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NL3D::UPlayList::setWeight </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname" nowrap> <em>slot</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>weight</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Setup a constant animation weight. +<p> +NB: this is equivalent as following code:<ul> +<li>setStartWeight(slot, weight, 0);<li>setEndWeight(slot, weight, 0);</ul> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>slot</em> </td><td> +is the id of the slot to set. </td></tr> +<tr><td valign=top><em>weight</em> </td><td> +is the factor to use in this slot. </td></tr> +</table> +</dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z694_6">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z68_4" doxytag="NL3D::UPlayList::setWeightSmoothness"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NL3D::UPlayList::setWeightSmoothness </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname" nowrap> <em>slot</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>smoothness</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set weight smoothness. +<p> +This is the smoothness of the weight interpolation. Must be between 0.f and 1.f. 0.f is a sharp interpolation (linear), 1.f is a smooth interpolation (quadratic). Default value is 0.f.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>slot</em> </td><td> +is the id of the slot to set. </td></tr> +<tr><td valign=top><em>smoothness</em> </td><td> +is the smoothness value. </td></tr> +</table> +</dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z694_4">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<a name="z67_4" doxytag="NL3D::UPlayList::setWrapMode"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NL3D::UPlayList::setWrapMode </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a7">uint8</a> </td> + <td class="mdname" nowrap> <em>slot</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="classNL3D_1_1UPlayList.html#s6">TWrapMode</a> </td> + <td class="mdname" nowrap> <em>wrapMode</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the wrap mode to use in the play list. +<p> +Wrap mode tells the play list how to use an animation when current time is not in the animation. <dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>wrapMode</em> </td><td> +is the mode to use. </td></tr> +</table> +</dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CPlayListUser.html#z693_4">NL3D::CPlayListUser</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="u__play__list_8h-source.html">u_play_list.h</a></ul> + + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |