PageRenderTime 50ms CodeModel.GetById 21ms RepoModel.GetById 0ms app.codeStats 1ms

/cuzzo_as3lib/docs/asdoc/org/flintparticles/twoD/actions/Move.html

https://github.com/alonecuzzo/as3library
HTML | 49 lines | 36 code | 5 blank | 8 comment | 0 complexity | 154dc75704cb62b659cafe458197b75f MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../../../override.css" type="text/css"><meta name="keywords" content="Move,org.flintparticles.twoD.actions.Move,addedToEmitter,addedToEmitter,addedToEmitter,addedToEmitter,addedToEmitter,addedToEmitter,addedToEmitter,addedToEmitter,frameUpdate,frameUpdate,getDefaultPriority,getDefaultPriority,getDefaultPriority,getDefaultPriority,getDefaultPriority,getDefaultPriority,getDefaultPriority,getDefaultPriority,getDefaultPriority,getDefaultPriority,getDefaultPriority,getDefaultPriority,removedFromEmitter,removedFromEmitter,removedFromEmitter,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update,update"><title>org.flintparticles.twoD.actions.Move</title></head><body><script language="javascript" type="text/javascript" src="../../../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../../../help.js"></script><script language="javascript" type="text/javascript" src="../../../../cookies.js"></script><script language="javascript" type="text/javascript"><!--
    2. 

  2. 				asdocTitle = 'Move - API Documentation';
    3. 

  3. 				var baseRef = '../../../../';
    4. 

  4. 				window.onload = configPage;
    5. 

  5. 			--></script>
    6. 

  6. <script type="text/javascript">
    7. 

  7. 			scrollToNameAnchor();
    8. 

  8. 		</script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">API Documentation</td><td class="titleTableTopNav" align="right"><a href="../../../../package-summary.html" onclick="loadClassListFrame('../../../../all-classes.html')">All Packages</a>&nbsp;|&nbsp;<a href="../../../../class-summary.html" onclick="loadClassListFrame('../../../../all-classes.html')">All Classes</a>&nbsp;|&nbsp;<a href="../../../../all-index-A.html" onclick="loadClassListFrame('../../../../index-list.html')">Index</a>&nbsp;|&nbsp;<a id="framesLink1" href="../../../../index.html?org/flintparticles/twoD/actions/Move.html&amp;org/flintparticles/twoD/actions/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../../../images/logo.jpg" class="logoImage" alt=" Adobe Logo " title=" Adobe Logo "></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">Move</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3">&nbsp;</td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
    9. 

  9. 				<!--
    10. 

  10. 				
    11. 

  11. 					if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Move"); titleBar_setSubNav(false,false,false	,false,false,false,true,false,false	,false,false,false,false,false);}	
    12. 

  12. 				-->
    13. 

  13. 			</script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">org.flintparticles.twoD.actions</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public  class  Move</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">Move  <img src="../../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../../../org/flintparticles/common/actions/ActionBase.html">ActionBase</a> <img src="../../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr></table><p></p><p></p><p></p>
    14. 

  14. 	 The Move action updates the position of the particle based on its velocity.
    15. 

  15. 	 It uses a Euler integrator to calculate the new position. If you want an
    16. 

  16. 	 emitter's particles to move then you must add a Move action, or a similar 
    17. 

  17. 	 custom action, to the emitter
    18. 

  18. 	 <p></p><br/><hr></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><div class="showHideLinks"><div id="hideInheritedMethod" class="hideInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(false,'Method');"><img class="showHideLinkImage" src="../../../../images/expanded.gif"> Hide Inherited Public Methods</a></div><div id="showInheritedMethod" class="showInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(true,'Method');"><img class="showHideLinkImage" src="../../../../images/collapsed.gif"> Show Inherited Public Methods</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#Move()" class="signatureLink">Move</a>()</div><div class="summaryTableDescription">
    19. 

  19. 		 The constructor creates a Move action for use by an emitter.</div></td><td class="summaryTableOwnerCol">Move</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../../org/flintparticles/common/actions/ActionBase.html#addedToEmitter()" class="signatureLink">addedToEmitter</a>(emitter:<a href="../../../../org/flintparticles/common/emitters/Emitter.html">Emitter</a>):void</div><div class="summaryTableDescription">
    20. 

  20. 		 This method does nothing.</div></td><td class="summaryTableOwnerCol"><a href="../../../../org/flintparticles/common/actions/ActionBase.html">ActionBase</a></td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getDefaultPriority()" class="signatureLink">getDefaultPriority</a>():Number</div><div class="summaryTableDescription">[override] 
    21. 

  21. 		 Returns a value of -10, so that the Move action executes 
    22. 

  22. 		 after most other actions, particularly after actions that change the
    23. 

  23. 		 particle's velocity like Accelerate.</div></td><td class="summaryTableOwnerCol">Move</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../../org/flintparticles/common/actions/ActionBase.html#removedFromEmitter()" class="signatureLink">removedFromEmitter</a>(emitter:<a href="../../../../org/flintparticles/common/emitters/Emitter.html">Emitter</a>):void</div><div class="summaryTableDescription">
    24. 

  24. 		 This method does nothing.</div></td><td class="summaryTableOwnerCol"><a href="../../../../org/flintparticles/common/actions/ActionBase.html">ActionBase</a></td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#update()" class="signatureLink">update</a>(emitter:<a href="../../../../org/flintparticles/common/emitters/Emitter.html">Emitter</a>, particle:<a href="../../../../org/flintparticles/common/particles/Particle.html">Particle</a>, time:Number):void</div><div class="summaryTableDescription">[override] 
    25. 

  25. 		 Updates the particle's position based on its velocity and the period of 
    26. 

  26. 		 time indicated.</div></td><td class="summaryTableOwnerCol">Move</td></tr></table></div><script language="javascript" type="text/javascript"><!--
    27. 

  27. 										showHideInherited();
    28. 

  28. 										--></script><div class="MainContent"><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="Move()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">Move</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function Move()</code><p></p><p>
    29. 

  29. 		 The constructor creates a Move action for use by an emitter. 
    30. 

  30. 		 To add a Move to all particles created by an emitter, use the
    31. 

  31. 		 emitter's addAction method.
    32. 

  32. 		 
    33. 

  33. 		 </p><p><span class="label">See also</span></p><div class="seeAlso">org.flintparticles.common.emitters.Emitter::addAction()</div></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="getDefaultPriority()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getDefaultPriority</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code>override public function getDefaultPriority():Number</code><p></p><p></p><p>
    34. 

  34. 		 Returns a value of -10, so that the Move action executes 
    35. 

  35. 		 after most other actions, particularly after actions that change the
    36. 

  36. 		 particle's velocity like Accelerate.
    37. 

  37. 		 
    38. 

  38. 		 </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code></td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">org.flintparticles.common.actions.Action::getDefaultPriority()</div></div><a name="update()"></a><a name="update(org.flintparticles.common.emitters.Emitter,org.flintparticles.common.particles.Particle,Number)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">update</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>override public function update(emitter:<a href="../../../../org/flintparticles/common/emitters/Emitter.html">Emitter</a>, particle:<a href="../../../../org/flintparticles/common/particles/Particle.html">Particle</a>, time:Number):void</code><p></p><p></p><p>
    39. 

  39. 		 Updates the particle's position based on its velocity and the period of 
    40. 

  40. 		 time indicated.
    41. 

  41. 		 
    42. 

  42. 		 This method is called by the emitter and need not be called by the 
    43. 

  43. 		 user.
    44. 

  44. 		 
    45. 

  45. 		 </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">emitter</span>:<a href="../../../../org/flintparticles/common/emitters/Emitter.html">Emitter</a></code> &mdash; The Emitter that created the particle.
    46. 

  46. 		 </td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">particle</span>:<a href="../../../../org/flintparticles/common/particles/Particle.html">Particle</a></code> &mdash; The particle to be updated.
    47. 

  47. 		 </td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">time</span>:Number</code> &mdash; The duration of the frame - used for time based updates.
    48. 

  48. 		 
    49. 

  49. 		 </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">org.flintparticles.common.actions.Action::update()</div></div><br/><br/><hr><br/><p></p><center class="copyright"><footer></footer><br/>Thu May 21 2009, 12:12 PM -04:00  </center></div></body></html><!--<br/>Thu May 21 2009, 12:12 PM -04:00  -->
    50.