aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a03835.html
blob: 1f486334812deb6af85b3d1b7137ac708f817238 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>NeL: NL3D::IAnimatedValue class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.6 -->
<div class="qindex">  <form class="search" action="search.php" method="get">
<a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a>  | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
<h1>NL3D::IAnimatedValue Class Reference</h1><code>#include &lt;<a class="el" href="a05442.html">animated_value.h</a>&gt;</code>
<p>
<p>Inheritance diagram for NL3D::IAnimatedValue:
<p><center><img src="a03835.png" usemap="#NL3D::IAnimatedValue_map" border="0" alt=""></center>
<map name="NL3D::IAnimatedValue_map">
<area href="a02201.html" alt="NL3D::CAnimatedValueBlendable< T >" shape="rect" coords="353,56,696,80">
<area href="a02201.html" alt="NL3D::CAnimatedValueBlendable< CQuat >" shape="rect" coords="353,112,696,136">
<area href="a02201.html" alt="NL3D::CAnimatedValueBlendable< CVector >" shape="rect" coords="353,168,696,192">
<area href="a02201.html" alt="NL3D::CAnimatedValueBlendable< float >" shape="rect" coords="353,224,696,248">
<area href="a02201.html" alt="NL3D::CAnimatedValueBlendable< NLMISC::CAngleAxis >" shape="rect" coords="353,280,696,304">
<area href="a02201.html" alt="NL3D::CAnimatedValueBlendable< sint32 >" shape="rect" coords="353,336,696,360">
<area href="a02204.html" alt="NL3D::CAnimatedValueNotBlendable< T >" shape="rect" coords="353,392,696,416">
<area href="a02204.html" alt="NL3D::CAnimatedValueNotBlendable< bool >" shape="rect" coords="353,448,696,472">
<area href="a02204.html" alt="NL3D::CAnimatedValueNotBlendable< std::string >" shape="rect" coords="353,504,696,528">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A value handled by the animation system. This value must be managed by a <a class="el" href="a02197.html">IAnimatable</a> object.<p>
<dl compact><dt><b>Author:</b></dt><dd>Cyril 'Hulud' Corvazier <p>
Nevrax France </dd></dl>
<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl>

<p>

<p>
Definition at line <a class="el" href="a05442.html#l00047">47</a> of file <a class="el" href="a05442.html">animated_value.h</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&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03835.html#NL3D_1_1IAnimatedValuea0">affect</a> (const <a class="el" href="a03835.html">IAnimatedValue</a> &amp;<a class="el" href="a04223.html#a658">value</a>)=0</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03835.html#NL3D_1_1IAnimatedValuea1">blend</a> (const <a class="el" href="a03835.html">IAnimatedValue</a> &amp;<a class="el" href="a04223.html#a658">value</a>, float blendFactor)=0</td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="NL3D_1_1IAnimatedValuea0" doxytag="NL3D::IAnimatedValue::affect" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual void NL3D::IAnimatedValue::affect </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="a03835.html">IAnimatedValue</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>value</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [pure virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
An assignation method. This method assign a values in the object.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>value</em>&nbsp;</td><td>is the new value.</td></tr>
  </table>
</dl>

<p>
Implemented in <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea0">NL3D::CAnimatedValueBlendable&lt; T &gt;</a>, <a class="el" href="a02204.html#NL3D_1_1CAnimatedValueNotBlendablea0">NL3D::CAnimatedValueNotBlendable&lt; T &gt;</a>, <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea0">NL3D::CAnimatedValueBlendable&lt; float &gt;</a>, <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea0">NL3D::CAnimatedValueBlendable&lt; NLMISC::CQuat &gt;</a>, <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea0">NL3D::CAnimatedValueBlendable&lt; NLMISC::CRGBA &gt;</a>, <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea0">NL3D::CAnimatedValueBlendable&lt; NLMISC::CAngleAxis &gt;</a>, <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea0">NL3D::CAnimatedValueBlendable&lt; NLMISC::CVector &gt;</a>, <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea0">NL3D::CAnimatedValueBlendable&lt; CQuat &gt;</a>, <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea0">NL3D::CAnimatedValueBlendable&lt; sint32 &gt;</a>, <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea0">NL3D::CAnimatedValueBlendable&lt; CVector &gt;</a>, <a class="el" href="a02204.html#NL3D_1_1CAnimatedValueNotBlendablea0">NL3D::CAnimatedValueNotBlendable&lt; std::string &gt;</a>, and <a class="el" href="a02204.html#NL3D_1_1CAnimatedValueNotBlendablea0">NL3D::CAnimatedValueNotBlendable&lt; bool &gt;</a>.
<p>
Referenced by <a class="el" href="a05543.html#l00154">NL3D::CChannelMixer::eval()</a>, <a class="el" href="a05543.html#l00083">NL3D::CChannelMixer::evalSingleChannel()</a>, and <a class="el" href="a05543.html#l00621">NL3D::CChannelMixer::refreshList()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="NL3D_1_1IAnimatedValuea1" doxytag="NL3D::IAnimatedValue::blend" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual void NL3D::IAnimatedValue::blend </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="a03835.html">IAnimatedValue</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>value</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>float&nbsp;</td>
          <td class="mdname" nowrap> <em>blendFactor</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</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>
      &nbsp;
    </td>
    <td>

<p>
The blend method. This method blend two the animated values and store the result in the object. The two first args can be reference on the object itself. Idealy, it performs the operation this-&gt;value=(this-&gt;value*blendFactor + value*(1.f-blendFactor))<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>value</em>&nbsp;</td><td>is the first value in the blend operation. </td></tr>
    <tr><td valign=top><em>blendFactor</em>&nbsp;</td><td>must be in the range [0..1].</td></tr>
  </table>
</dl>

<p>
Implemented in <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea1">NL3D::CAnimatedValueBlendable&lt; T &gt;</a>, <a class="el" href="a02204.html#NL3D_1_1CAnimatedValueNotBlendablea1">NL3D::CAnimatedValueNotBlendable&lt; T &gt;</a>, <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea1">NL3D::CAnimatedValueBlendable&lt; float &gt;</a>, <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea1">NL3D::CAnimatedValueBlendable&lt; NLMISC::CQuat &gt;</a>, <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea1">NL3D::CAnimatedValueBlendable&lt; NLMISC::CRGBA &gt;</a>, <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea1">NL3D::CAnimatedValueBlendable&lt; NLMISC::CAngleAxis &gt;</a>, <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea1">NL3D::CAnimatedValueBlendable&lt; NLMISC::CVector &gt;</a>, <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea1">NL3D::CAnimatedValueBlendable&lt; CQuat &gt;</a>, <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea1">NL3D::CAnimatedValueBlendable&lt; sint32 &gt;</a>, <a class="el" href="a02201.html#NL3D_1_1CAnimatedValueBlendablea1">NL3D::CAnimatedValueBlendable&lt; CVector &gt;</a>, <a class="el" href="a02204.html#NL3D_1_1CAnimatedValueNotBlendablea1">NL3D::CAnimatedValueNotBlendable&lt; std::string &gt;</a>, and <a class="el" href="a02204.html#NL3D_1_1CAnimatedValueNotBlendablea1">NL3D::CAnimatedValueNotBlendable&lt; bool &gt;</a>.
<p>
Referenced by <a class="el" href="a05543.html#l00083">NL3D::CChannelMixer::evalSingleChannel()</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a05442.html">animated_value.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 08:37:14 2004 for NeL by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 > 
</a>1.3.6 </small></address>
</body>
</html>