diff options
Diffstat (limited to 'docs/doxygen/nel/classNL3D_1_1UAnimation.html')
| -rw-r--r-- | docs/doxygen/nel/classNL3D_1_1UAnimation.html | 385 |
1 files changed, 385 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNL3D_1_1UAnimation.html b/docs/doxygen/nel/classNL3D_1_1UAnimation.html new file mode 100644 index 00000000..4daad41d --- /dev/null +++ b/docs/doxygen/nel/classNL3D_1_1UAnimation.html @@ -0,0 +1,385 @@ +<!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::UAnimation Class Reference</h1>Give manual access to the animation functions. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="u__animation_8h-source.html">u_animation.h</a>></code> +<p> +<p>Inheritance diagram for NL3D::UAnimation: +<p><center><img src="classNL3D_1_1UAnimation.gif" usemap="#NL3D::UAnimation_map" border="0"></center> +<map name="NL3D::UAnimation_map"> +<area href="classNL3D_1_1CAnimation.html" alt="NL3D::CAnimation" shape="rect" coords="0,56,114,80"> +</map> +<a href="classNL3D_1_1UAnimation-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classNL3D_1_1UTrack.html">UTrack</a> * </td><td valign=bottom><a class="el" href="classNL3D_1_1UAnimation.html#a0">getTrackByName</a> (const char *name)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get an animation track with its name.</em> <a href="#a0">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_1UAnimation.html#a1">releaseTrack</a> (<a class="el" href="classNL3D_1_1UTrack.html">UTrack</a> *track)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Relase a track interface.</em> <a href="#a1">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_1UAnimation.html#a2">getBeginTime</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get begin time of the animation.</em> <a href="#a2">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_1UAnimation.html#a3">getEndTime</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get end time of the animation.</em> <a href="#a3">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_1UAnimation.html#a4">allTrackLoop</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Say if all track of this animation loop.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td colspan="2"><div class="groupHeader">Create / delete animations</div></td></tr> +<tr><td nowrap align=right valign=top>UAnimation * </td><td valign=bottom><a class="el" href="classNL3D_1_1UAnimation.html#z3_0">createAnimation</a> (const char *sPath)</td></tr> +<tr><td> </td><td><font size=-1><em>Load an animation.</em> <a href="#z3_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNL3D_1_1UAnimation.html#z3_1">releaseAnimation</a> (UAnimation *animation)</td></tr> +<tr><td> </td><td><font size=-1><em>Release an animation.</em> <a href="#z3_1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Give manual access to the animation functions. +<p> +By this interface, you can load animations, get tracks from this animation with there names, and interpolate manually value from those tracks. +<p> +This interface is not made to work with <a class="el" href="classNL3D_1_1UAnimationSet.html">UAnimationSet</a> or <a class="el" href="classNL3D_1_1UPlayList.html">UPlayList</a>. <a class="el" href="classNL3D_1_1UAnimation.html">UAnimation</a> has its own methods to load / release animations. +<p> +<dl compact><dt><b> +Author: </b><dd> +Cyril 'Hulud' Corvazier , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2001 </dl> +<p> + +<p> +Definition at line <a class="el" href="u__animation_8h-source.html#l00050">50</a> of file <a class="el" href="u__animation_8h-source.html">u_animation.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a4" doxytag="NL3D::UAnimation::allTrackLoop"></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::UAnimation::allTrackLoop </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </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> +Say if all track of this animation loop. +<p> +NB: If no tracks in the animation, return true +<p> +Implemented in <a class="el" href="classNL3D_1_1CAnimation.html#z377_4">NL3D::CAnimation</a>. </td> + </tr> +</table> +<a name="z3_0" doxytag="NL3D::UAnimation::createAnimation"></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"> UAnimation * NL3D::UAnimation::createAnimation </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const char * </td> + <td class="mdname1" valign="top" nowrap> <em>sPath</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Load an animation. +<p> +This method will use CPath to find the good animation file. (*.anim). You should call releaseAnimation to delete the animation.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>sPath</em> </td><td> +is the animation file path. </td></tr> +</table> +</dl><dl compact><dt><b> +Returns: </b><dd> +NULL if the file is not found. Else return the pointer on the animation interface. </dl> +<p> +Definition at line <a class="el" href="animation_8cpp-source.html#l00259">259</a> of file <a class="el" href="animation_8cpp-source.html">animation.cpp</a>. +<p> +References <a class="el" href="cf__lexical_8cpp-source.html#l02654">file</a>, <a class="el" href="path_8cpp-source.html#l00201">NLMISC::CPath::lookup</a>, <a class="el" href="animation_8cpp-source.html#l00040">NL3D_HAUTO_UI_ANIMATION</a>, <a class="el" href="animation_8h-source.html#l00045">NL3D_MEM_ANIMATION</a>, <a class="el" href="file_8cpp-source.html#l00115">NLMISC::CIFile::open</a>, and <a class="el" href="stream_8h-source.html#l00222">NLMISC::IStream::serial</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NL3D::UAnimation::getBeginTime"></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::UAnimation::getBeginTime </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </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 begin time of the animation. +<p> +<dl compact><dt><b> +Returns: </b><dd> +the begin time. </dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CAnimation.html#z377_2">NL3D::CAnimation</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NL3D::UAnimation::getEndTime"></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::UAnimation::getEndTime </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </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 end time of the animation. +<p> +<dl compact><dt><b> +Returns: </b><dd> +the end time. </dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CAnimation.html#z377_3">NL3D::CAnimation</a>. </td> + </tr> +</table> +<a name="a0" doxytag="NL3D::UAnimation::getTrackByName"></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_1UTrack.html">UTrack</a>* NL3D::UAnimation::getTrackByName </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const char * </td> + <td class="mdname1" valign="top" nowrap> <em>name</em> </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> +Get an animation track with its name. +<p> +The track interface should be released with releaseTrack.<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>name</em> </td><td> +is the name of the track to get. </td></tr> +</table> +</dl><dl compact><dt><b> +Returns: </b><dd> +NULL if the track is not found, else a pointer on the track interface. </dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CAnimation.html#z377_0">NL3D::CAnimation</a>. </td> + </tr> +</table> +<a name="z3_1" doxytag="NL3D::UAnimation::releaseAnimation"></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"> void NL3D::UAnimation::releaseAnimation </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">UAnimation * </td> + <td class="mdname1" valign="top" nowrap> <em>animation</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Release an animation. +<p> +This animation must have been created will <a class="el" href="classNL3D_1_1UAnimation.html#z3_0">createAnimation</a>().<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>animation</em> </td><td> +is the animation to release. </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="animation_8cpp-source.html#l00286">286</a> of file <a class="el" href="animation_8cpp-source.html">animation.cpp</a>. +<p> +References <a class="el" href="animation_8cpp-source.html#l00040">NL3D_HAUTO_UI_ANIMATION</a>, and <a class="el" href="animation_8h-source.html#l00045">NL3D_MEM_ANIMATION</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NL3D::UAnimation::releaseTrack"></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::UAnimation::releaseTrack </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNL3D_1_1UTrack.html">UTrack</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>track</em> </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> +Relase a track interface. +<p> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>track</em> </td><td> +is a pointer on the track interface to release. </td></tr> +</table> +</dl> +<p> +Implemented in <a class="el" href="classNL3D_1_1CAnimation.html#z377_1">NL3D::CAnimation</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="u__animation_8h-source.html">u_animation.h</a><li><a class="el" href="animation_8cpp-source.html">animation.cpp</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> |