1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 span.virtual_style 22 { 23 font-size : 8pt; 24 color : white; 25 font-weight : bold; 26 background : #0a0; 27 border-left : solid 1px #0f0; 28 border-top : solid 1px #0f0; 29 border-right : solid 1px #060; 30 border-bottom : solid 1px #060; 31 padding-left : 2px; 32 padding-right : 2px; 33 } 34 span.protected_style 35 { 36 font-size : 8pt; 37 color : white; 38 font-weight : bold; 39 background : #444; 40 border-left : solid 1px #ccc; 41 border-top : solid 1px #ccc; 42 border-right : solid 1px #222; 43 border-bottom : solid 1px #222; 44 padding-left : 2px; 45 padding-right : 2px; 46 } 47 --></style> 48 <title>nw::gfx::BaseAnimEvaluator</title> 49 </head> 50 <body> 51 <h1><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/gfx/Overview.html">gfx</a>::BaseAnimEvaluator Class</h1> 52 <h2>Syntax</h2> 53 <div class="section"> 54 <pre class="definition">class BaseAnimEvaluator : public <a href="../../../nw/gfx/AnimObject/Overview.html">nw::gfx::AnimObject</a></pre> 55 </div> 56 <h2>Description</h2> 57 <div class="section"> 58 <p>Base class for animation evaluators. Because this is an abstract class, it cannot be instantiated.</p> 59 </div> 60 <a name="function" id="function"> 61 <h2>Member Functions</h2> 62 <div class="section"> 63 <table class="members"> 64 <tr> 65 <th class="category" colspan="3">Constructors and Destructors</th> 66 </tr> 67 <tr> 68 <td width="100"> </td> 69 <th> 70 <a href="../../../nw/gfx/BaseAnimEvaluator/BaseAnimEvaluator.html"><CODE>BaseAnimEvaluator</CODE></a> 71 </th> 72 <td>Constructor.</td> 73 </tr> 74 <tr> 75 <td width="100"> <span class="virtual_style" title="virtual">V</span> 76 </td> 77 <th> 78 <a href="../../../nw/gfx/BaseAnimEvaluator/~BaseAnimEvaluator.html"><CODE>~BaseAnimEvaluator</CODE></a> 79 </th> 80 <td>Destructor.</td> 81 </tr> 82 <tr> 83 <th class="category" colspan="3">Basic Operations</th> 84 </tr> 85 <tr> 86 <td width="100"> <span class="virtual_style" title="virtual">V</span> 87 </td> 88 <th> 89 <a href="../../../nw/gfx/BaseAnimEvaluator/TryBind.html">TryBind</a> 90 </th> 91 <td>Binds animations.</td> 92 </tr> 93 <tr> 94 <td width="100"> <span class="virtual_style" title="virtual">V</span> 95 </td> 96 <th> 97 <a href="../../../nw/gfx/BaseAnimEvaluator/Release.html"><CODE>Release</CODE></a> 98 </th> 99 <td>Clears a bound animation.</td> 100 </tr> 101 <tr> 102 <td width="100"> <span class="virtual_style" title="virtual">V</span> 103 </td> 104 <th> 105 <a href="../../../nw/gfx/BaseAnimEvaluator/UpdateFrame.html">UpdateFrame</a> 106 </th> 107 <td>Updates frames.</td> 108 </tr> 109 <tr> 110 <td width="100"> <span class="virtual_style" title="virtual">V</span> 111 </td> 112 <th> 113 <a href="../../../nw/gfx/BaseAnimEvaluator/ChangeAnim.html">ChangeAnim</a> 114 </th> 115 <td>Changes animations.</td> 116 </tr> 117 <tr> 118 <td width="100"> </td> 119 <th> 120 <a href="../../../nw/gfx/BaseAnimEvaluator/Reset.html"><CODE>Reset</CODE></a> 121 </th> 122 <td>Restores the specified member to its state at time of creation.</td> 123 </tr> 124 <tr> 125 <td width="100"> </td> 126 <th> 127 <a href="../../../nw/gfx/BaseAnimEvaluator/ResetMember.html">ResetMember</a> 128 </th> 129 <td>Resets the specified member to its state when created.</td> 130 </tr> 131 <tr> 132 <td width="100"> </td> 133 <th> 134 <a href="../../../nw/gfx/AnimObject/Bind.html"><CODE>Bind</CODE></a> 135 </th> 136 <td>Binds animations.(Inherited from <a href="../../../nw/gfx/GfxObject/Overview.html"><CODE>AnimObject</CODE></a>.</td> 137 </tr> 138 <tr> 139 <th class="category" colspan="3">Frame Control</th> 140 </tr> 141 <tr> 142 <td width="100"> </td> 143 <th> 144 <a href="../../../nw/gfx/BaseAnimEvaluator/GetFrame.html">GetFrame</a> 145 </th> 146 <td>Gets a frame.</td> 147 </tr> 148 <tr> 149 <td width="100"> </td> 150 <th> 151 <a href="../../../nw/gfx/BaseAnimEvaluator/SetFrame.html">SetFrame</a> 152 </th> 153 <td>Sets a frame.</td> 154 </tr> 155 <tr> 156 <td width="100"> </td> 157 <th> 158 <a href="../../../nw/gfx/BaseAnimEvaluator/ResetFrame.html"><CODE>ResetFrame</CODE></a> 159 </th> 160 <td>Resets the frame.</td> 161 </tr> 162 <tr> 163 <td width="100"> </td> 164 <th> 165 <a href="../../../nw/gfx/BaseAnimEvaluator/GetStepFrame.html"><CODE>GetStepFrame</CODE></a> 166 </th> 167 <td>Gets the frame step (the amount of increase per frame).</td> 168 </tr> 169 <tr> 170 <td width="100"> </td> 171 <th> 172 <a href="../../../nw/gfx/BaseAnimEvaluator/SetStepFrame.html"><CODE>SetStepFrame</CODE></a> 173 </th> 174 <td>Sets the frame's step.</td> 175 </tr> 176 <tr> 177 <td width="100"> </td> 178 <th> 179 <a href="../../../nw/gfx/BaseAnimEvaluator/GetStartFrame.html">GetStartFrame</a> 180 </th> 181 <td>Gets the starting frame.</td> 182 </tr> 183 <tr> 184 <td width="100"> </td> 185 <th> 186 <a href="../../../nw/gfx/BaseAnimEvaluator/SetStartFrame.html">SetStartFrame</a> 187 </th> 188 <td>Sets the start frame.</td> 189 </tr> 190 <tr> 191 <td width="100"> </td> 192 <th> 193 <a href="../../../nw/gfx/BaseAnimEvaluator/GetEndFrame.html">GetEndFrame</a> 194 </th> 195 <td>Gets the end frame.</td> 196 </tr> 197 <tr> 198 <td width="100"> </td> 199 <th> 200 <a href="../../../nw/gfx/BaseAnimEvaluator/SetEndFrame.html">SetEndFrame</a> 201 </th> 202 <td>Sets the end frame.</td> 203 </tr> 204 <tr> 205 <td width="100"> </td> 206 <th> 207 <a href="../../../nw/gfx/BaseAnimEvaluator/GetPlayPolicy.html">GetPlayPolicy</a> 208 </th> 209 <td>Gets the animation playback method.</td> 210 </tr> 211 <tr> 212 <td width="100"> </td> 213 <th> 214 <a href="../../../nw/gfx/BaseAnimEvaluator/SetPlayPolicy.html">SetPlayPolicy</a> 215 </th> 216 <td>Sets the animation playback method.</td> 217 </tr> 218 <tr> 219 <td width="100"> </td> 220 <th> 221 <a href="../../../nw/gfx/BaseAnimEvaluator/AnimFrameController.html"><CODE>AnimFrameController</CODE></a> 222 </th> 223 <td>Gets the animation frame control information.</td> 224 </tr> 225 <tr> 226 <th class="category" colspan="3">Set/Get</th> 227 </tr> 228 <tr> 229 <td width="100"> </td> 230 <th> 231 <a href="../../../nw/gfx/BaseAnimEvaluator/GetUserData.html"><CODE>GetUserData</CODE></a> 232 </th> 233 <td>Gets the user data.</td> 234 </tr> 235 <tr> 236 <td width="100"> </td> 237 <th> 238 <a href="../../../nw/gfx/BaseAnimEvaluator/SetUserData.html">SetUserData</a> 239 </th> 240 <td>Sets the user data.</td> 241 </tr> 242 <tr> 243 <td width="100"> </td> 244 <th> 245 <a href="../../../nw/gfx/BaseAnimEvaluator/BindIndexTable.html"><CODE>BindIndexTable</CODE></a> 246 </th> 247 <td>Gets a converstion table for converting from a ResAnimGroupMember index to a ResMemberAnim index.</td> 248 </tr> 249 <tr> 250 <td width="100"> </td> 251 <th> 252 <a href="../../../nw/gfx/BaseAnimEvaluator/ReverseBindIndexTable.html">ReverseBindIndexTable</a> 253 </th> 254 <td>Gets a converstion table for converting from a ResMemberAnim index to a ResAnimGroupMember index.</td> 255 </tr> 256 <tr> 257 <td width="100"> </td> 258 <th> 259 <a href="../../../nw/gfx/BaseAnimEvaluator/GetAnimData.html"><CODE>GetAnimData</CODE></a> 260 </th> 261 <td>Gets animation data.</td> 262 </tr> 263 <tr> 264 <td width="100"> </td> 265 <th> 266 <a href="../../../nw/gfx/AnimObject/GetAnimGroup.html"><CODE>GetAnimGroup</CODE></a> 267 </th> 268 <td>Gets the animation group.(Inherited from <a href="../../../nw/gfx/GfxObject/Overview.html"><CODE>AnimObject</CODE></a>.</td> 269 </tr> 270 <tr> 271 <td width="100"> </td> 272 <th> 273 <a href="../../../nw/gfx/AnimObject/SetAnimGroup.html"><CODE>SetAnimGroup</CODE></a> 274 </th> 275 <td>Sets the animation group.(Inherited from <a href="../../../nw/gfx/GfxObject/Overview.html"><CODE>AnimObject</CODE></a>.</td> 276 </tr> 277 <tr> 278 <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span> 279 </td> 280 <th> 281 <a href="../../../nw/gfx/BaseAnimEvaluator/HasMemberAnim.html"><CODE>HasMemberAnim</CODE></a> 282 </th> 283 <td>Gets a value indicating whether there are any animations bound to the member.</td> 284 </tr> 285 <tr> 286 <th class="category" colspan="3">Cache</th> 287 </tr> 288 <tr> 289 <td width="100"> <span class="virtual_style" title="virtual">V</span> 290 </td> 291 <th> 292 <a href="../../../nw/gfx/BaseAnimEvaluator/GetCacheBuffer.html"><CODE>GetCacheBuffer</CODE></a> 293 </th> 294 <td>Gets the cache buffer.</td> 295 </tr> 296 <tr> 297 <td width="100"> <span class="virtual_style" title="virtual">V</span> 298 </td> 299 <th> 300 <a href="../../../nw/gfx/BaseAnimEvaluator/GetCacheBufferSizeNeeded.html"><CODE>GetCacheBufferSizeNeeded</CODE></a> 301 </th> 302 <td>Gets the size (in bytes) required for the cache buffer.</td> 303 </tr> 304 <tr> 305 <td width="100"> <span class="virtual_style" title="virtual">V</span> 306 </td> 307 <th> 308 <a href="../../../nw/gfx/BaseAnimEvaluator/SetCacheBuffer.html"><CODE>SetCacheBuffer</CODE></a> 309 </th> 310 <td>Sets the cache buffer. The cache buffer specified by this function will not be freed by the destructor.</td> 311 </tr> 312 <tr> 313 <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span> 314 </td> 315 <th> 316 <a href="../../../nw/gfx/BaseAnimEvaluator/UpdateCache.html"><CODE>UpdateCache</CODE></a> 317 </th> 318 <td>Updates the internal cache within the animation evaluation results if it is out of date.</td> 319 </tr> 320 <tr> 321 <th class="category" colspan="3">Evaluation</th> 322 </tr> 323 <tr> 324 <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span> 325 </td> 326 <th> 327 <a href="../../../nw/gfx/BaseAnimEvaluator/GetResult.html"><CODE>GetResult</CODE></a> 328 </th> 329 <td>Gets the animation result for a given member.</td> 330 </tr> 331 <tr> 332 <th class="category" colspan="3">Create/Destroy</th> 333 </tr> 334 <tr> 335 <td width="100"> </td> 336 <th> 337 <a href="../../../nw/gfx/GfxObject/Destroy.html"><CODE>Destroy</CODE></a> 338 </th> 339 <td>Destroys an object.(Derived from <a href="../../../nw/gfx/GfxObject/Overview.html"><CODE>GfxObject</CODE></a>.)</td> 340 </tr> </table> 341 </div> 342 </a> 343 <h2>Class Hierarchy</h2> 344 <div class="section"> 345 <p class="hierarchy"><a href="../../../nw/gfx/GfxObject/Overview.html">nw::gfx::GfxObject</a><br /> <a href="../../../nw/gfx/AnimObject/Overview.html">nw::gfx::AnimObject</a><br /> <b>nw::gfx::BaseAnimEvaluator</b> 346 </p> 347 </div> 348 <hr><p>CONFIDENTIAL</p></body> 349</html> 350