Hilo/docs/api-en/symbols/ParticleSystem.html
2016-05-18 14:08:55 +08:00

980 lines
28 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="JsDoc Toolkit"/>
<title>ParticleSystem - Hilo API Document</title>
<style>
iframe{
border:1px solid #333;
}
</style>
<link href="../../bootstrap3.0.3/css/bootstrap.min.css" rel="stylesheet">
<link href="../../bootstrap3.0.3/css/bootstrap-theme.min.css" rel="stylesheet">
<link href="../../css/prettify.min.css" rel="stylesheet">
<link href="../../css/api.min.css" rel="stylesheet">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="#">
<span>Hilo</span><span></span>
</a>
</div>
<div class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="http://hiloteam.github.io/index.html">首页</a></li>
<li><a href="https://github.com/hiloteam/Hilo" target="_blank">源码下载</a></li>
<li class="active"><a href="../index.html">API文档</a></li>
<li><a href="http://hiloteam.github.io/tutorial/index.html">教程文档</a></li>
<li><a href="http://hiloteam.github.io/examples/index.html">作品演示</a></li>
</u>
</div>
</div>
</div>
<div class="container main">
<div class="col-md-3">
<div class="bs-sidebar well">
<!-- <div class="hilo-header">类列表</div> -->
<ul class="nav bs-sidenav">
<li class="nav-pkg">core<span></span></li>
<li class="nav-class"><a href="../symbols/Class.html">Class</a></li>
<li class="nav-class"><a href="../symbols/Hilo.html">Hilo</a></li>
<li class="nav-pkg">event<span></span></li>
<li class="nav-class"><a href="../symbols/EventMixin.html">EventMixin</a></li>
<li class="nav-pkg">game<span></span></li>
<li class="nav-class"><a href="../symbols/Camera.html">Camera</a></li>
<li class="nav-class"><a href="../symbols/Camera3d.html">Camera3d</a></li>
<li class="nav-class"><a href="../symbols/ParticleSystem.html">ParticleSystem</a></li>
<li class="nav-pkg">geom<span></span></li>
<li class="nav-class"><a href="../symbols/Matrix.html">Matrix</a></li>
<li class="nav-pkg">loader<span></span></li>
<li class="nav-class"><a href="../symbols/LoadQueue.html">LoadQueue</a></li>
<li class="nav-pkg">media<span></span></li>
<li class="nav-class"><a href="../symbols/HTMLAudio.html">HTMLAudio</a></li>
<li class="nav-class"><a href="../symbols/WebAudio.html">WebAudio</a></li>
<li class="nav-class"><a href="../symbols/WebSound.html">WebSound</a></li>
<li class="nav-pkg">renderer<span></span></li>
<li class="nav-class"><a href="../symbols/CanvasRenderer.html">CanvasRenderer</a></li>
<li class="nav-class"><a href="../symbols/DOMRenderer.html">DOMRenderer</a></li>
<li class="nav-class"><a href="../symbols/Renderer.html">Renderer</a></li>
<li class="nav-class"><a href="../symbols/WebGLRenderer.html">WebGLRenderer</a></li>
<li class="nav-pkg">tween<span></span></li>
<li class="nav-class"><a href="../symbols/Ease.html">Ease</a></li>
<li class="nav-class"><a href="../symbols/Tween.html">Tween</a></li>
<li class="nav-pkg">util<span></span></li>
<li class="nav-class"><a href="../symbols/TextureAtlas.html">TextureAtlas</a></li>
<li class="nav-class"><a href="../symbols/Ticker.html">Ticker</a></li>
<li class="nav-class"><a href="../symbols/drag.html">drag</a></li>
<li class="nav-pkg">view<span></span></li>
<li class="nav-class"><a href="../symbols/Bitmap.html">Bitmap</a></li>
<li class="nav-class"><a href="../symbols/BitmapText.html">BitmapText</a></li>
<li class="nav-class"><a href="../symbols/Button.html">Button</a></li>
<li class="nav-class"><a href="../symbols/CacheMixin.html">CacheMixin</a></li>
<li class="nav-class"><a href="../symbols/Container.html">Container</a></li>
<li class="nav-class"><a href="../symbols/DOMElement.html">DOMElement</a></li>
<li class="nav-class"><a href="../symbols/Drawable.html">Drawable</a></li>
<li class="nav-class"><a href="../symbols/Graphics.html">Graphics</a></li>
<li class="nav-class"><a href="../symbols/Sprite.html">Sprite</a></li>
<li class="nav-class"><a href="../symbols/Stage.html">Stage</a></li>
<li class="nav-class"><a href="../symbols/Text.html">Text</a></li>
<li class="nav-class"><a href="../symbols/View.html">View</a></li>
</ul>
</div>
</div>
<div class="col-md-9">
<!-- ============================== class title ============================ -->
<h1 style="margin-top:0;">
ParticleSystem
</h1><hr style="margin-top:10px;" />
<!-- ============================== class summary ========================== -->
<p class="description">
<span style="display:block;margin:0 0 2px 0;">
<b style="margin-right:10px;">Module</b> hilo/game/ParticleSystem
</span>
<span style="display:block;margin:0 0 2px 0;">
<b style="margin-right:10px;">Requires</b>
<span><a href="../symbols/Hilo.html">hilo/core/Hilo</a></span>, <span><a href="../symbols/Class.html">hilo/core/Class</a></span>, <span><a href="../symbols/View.html">hilo/view/View</a></span>, <span><a href="../symbols/Container.html">hilo/view/Container</a></span>, <span><a href="../symbols/Bitmap.html">hilo/view/Bitmap</a></span>, <span><a href="../symbols/Drawable.html">hilo/view/Drawable</a></span>
</span>
<span style="display:block;margin:0 0 2px 0;">
<b style="margin-right:10px;">Source</b>
<a href="../symbols/src/docs_api-en_code_game_ParticleSystem.js.html">ParticleSystem.js</a>
</span>
<br>
ParticleSystem A particle system.
<br><br><iframe src='../../../examples/ParticleSystem.html?noHeader' width = '550' height = '400' scrolling='no'></iframe>
<br/>
</p>
<!-- ============================== properties summary ===================== -->
<div style="margin:30px 0 5px 0;">
<h3 style="display:inline;margin-right:10px;">Properties</h3>
</div>
<table class="table table-striped table-bordered table-condensed table-symbol" cellspacing="0">
<thead>
<tr>
<th scope="col"></th>
<th scope="col">Property </th>
<th scope="col">Defined</th>
</tr>
</thead>
<tbody>
<tr >
<td>
</td>
<td class="fixedFont">
<div>
<!-- -->
<b><a href="../symbols/ParticleSystem.html#emitNum">emitNum</a></b>:Number
</div>
<div class="description">
Emit number.
</div>
</td>
<td>
ParticleSystem
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div>
<!-- -->
<b><a href="../symbols/ParticleSystem.html#emitNumVar">emitNumVar</a></b>:Number
</div>
<div class="description">
Emit number variances.
</div>
</td>
<td>
ParticleSystem
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div>
<!-- -->
<b><a href="../symbols/ParticleSystem.html#emitterX">emitterX</a></b>:Number
</div>
<div class="description">
The emitter x position.
</div>
</td>
<td>
ParticleSystem
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div>
<!-- -->
<b><a href="../symbols/ParticleSystem.html#emitterY">emitterY</a></b>:Number
</div>
<div class="description">
The emitter y position.
</div>
</td>
<td>
ParticleSystem
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div>
<!-- -->
<b><a href="../symbols/ParticleSystem.html#emitTime">emitTime</a></b>:Number
</div>
<div class="description">
Emit time interval.
</div>
</td>
<td>
ParticleSystem
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div>
<!-- -->
<b><a href="../symbols/ParticleSystem.html#emitTimeVar">emitTimeVar</a></b>:Number
</div>
<div class="description">
Emit time interval variances.
</div>
</td>
<td>
ParticleSystem
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div>
<!-- -->
<b><a href="../symbols/ParticleSystem.html#gx">gx</a></b>:Number
</div>
<div class="description">
The gravity x value.
</div>
</td>
<td>
ParticleSystem
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div>
<!-- -->
<b><a href="../symbols/ParticleSystem.html#gy">gy</a></b>:Number
</div>
<div class="description">
The gravity y value.
</div>
</td>
<td>
ParticleSystem
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div>
<!-- -->
<b><a href="../symbols/ParticleSystem.html#totalTime">totalTime</a></b>:Number
</div>
<div class="description">
Total time.
</div>
</td>
<td>
ParticleSystem
</td>
</tr>
</tbody>
</table>
<script type="text/javascript">
function toggleProperties(){
var alink = $('#propToggleIcon');
if(alink.hasClass('glyphicon-circle-arrow-right')){
alink.removeClass('glyphicon-circle-arrow-right');
alink.addClass('glyphicon-circle-arrow-down');
$('#propToggleTip').html('Hide Inherited Properties');
$('.inheritProp').show();
}else{
alink.removeClass('glyphicon-circle-arrow-down');
alink.addClass('glyphicon-circle-arrow-right');
$('#propToggleTip').html('Show Inherited Properties');
$('.inheritProp').hide();
}
}
</script>
<!-- ============================== methods summary ======================== -->
<div style="margin:30px 0 5px; 0">
<h3 style="display:inline;margin-right:10px;">Methods</h3>
</div>
<table class="table table-striped table-bordered table-condensed table-symbol" cellspacing="0">
<thead>
<tr>
<th scope="col"></th>
<th scope="col">Method</th>
<th scope="col">Defined</th>
</tr>
</thead>
<tbody>
<tr>
<td></td>
<td>
<div class="fixedFont">
<b><a href="#constructor">ParticleSystem</a></b>(properties:Object)
</div>
<div class="description">Constructor</div>
</td>
<td>ParticleSystem</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div><b><a href="../symbols/ParticleSystem.html#onUpdate">onUpdate</a></b>(dt:Number)
</div>
<div class="description">
更新
</div>
</td>
<td>
ParticleSystem
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div><b><a href="../symbols/ParticleSystem.html#reset">reset</a></b>(cfg:Object)
</div>
<div class="description">
Reset the properties.
</div>
</td>
<td>
ParticleSystem
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div><b><a href="../symbols/ParticleSystem.html#start">start</a></b>()
</div>
<div class="description">
Start emit particles.
</div>
</td>
<td>
ParticleSystem
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div><b><a href="../symbols/ParticleSystem.html#stop">stop</a></b>(clear:Boolean)
</div>
<div class="description">
Stop emit particles.
</div>
</td>
<td>
ParticleSystem
</td>
</tr>
</tbody>
</table>
<script type="text/javascript">
function toggleMethods(){
var alink = $('#methodToggleIcon');
if(alink.hasClass('glyphicon-circle-arrow-right')){
alink.removeClass('glyphicon-circle-arrow-right');
alink.addClass('glyphicon-circle-arrow-down');
$('#methodToggleTip').html('Hide Inherited Methods');
$('.inheritMethod').show();
}else{
alink.removeClass('glyphicon-circle-arrow-down');
alink.addClass('glyphicon-circle-arrow-right');
$('#methodToggleTip').html('Show Inherited Methods');
$('.inheritMethod').hide();
}
}
</script>
<!-- ============================== field details ========================== -->
<br/>
<div class="">
<h3 style="margin-bottom:15px;">Property Detail</h3>
</div>
<a class="anchor" name="emitNum"> </a>
<div class="member-box">
<div class="member-header">
<b>emitNum</b><span class="light">:Number</span>
</div>
<div class="description">
Emit number.
</div>
</div>
<a class="anchor" name="emitNumVar"> </a>
<div class="member-box">
<div class="member-header">
<b>emitNumVar</b><span class="light">:Number</span>
</div>
<div class="description">
Emit number variances.
</div>
</div>
<a class="anchor" name="emitterX"> </a>
<div class="member-box">
<div class="member-header">
<b>emitterX</b><span class="light">:Number</span>
</div>
<div class="description">
The emitter x position.
</div>
</div>
<a class="anchor" name="emitterY"> </a>
<div class="member-box">
<div class="member-header">
<b>emitterY</b><span class="light">:Number</span>
</div>
<div class="description">
The emitter y position.
</div>
</div>
<a class="anchor" name="emitTime"> </a>
<div class="member-box">
<div class="member-header">
<b>emitTime</b><span class="light">:Number</span>
</div>
<div class="description">
Emit time interval.
</div>
</div>
<a class="anchor" name="emitTimeVar"> </a>
<div class="member-box">
<div class="member-header">
<b>emitTimeVar</b><span class="light">:Number</span>
</div>
<div class="description">
Emit time interval variances.
</div>
</div>
<a class="anchor" name="gx"> </a>
<div class="member-box">
<div class="member-header">
<b>gx</b><span class="light">:Number</span>
</div>
<div class="description">
The gravity x value.
</div>
</div>
<a class="anchor" name="gy"> </a>
<div class="member-box">
<div class="member-header">
<b>gy</b><span class="light">:Number</span>
</div>
<div class="description">
The gravity y value.
</div>
</div>
<a class="anchor" name="totalTime"> </a>
<div class="member-box">
<div class="member-header">
<b>totalTime</b><span class="light">:Number</span>
</div>
<div class="description">
Total time.
</div>
</div>
<!-- ============================== constructor details ==================== -->
<br/>
<div class="details">
<a class="anchor" name="constructor"> </a>
<div class="">
<h3 style="margin-bottom:15px;">Constructor</h3>
</div>
<div class="member-box">
<div class="member-header">
<b>ParticleSystem</b>(properties:Object)
</div>
<dl class="detailList">
<dt class="heading"><span class="label">parameters</span></dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>properties</b>:<span>Object</span>
— properties The properties to create a view object, contains all writeable props of this class
</dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>properties.particle</b>:<span>Object</span>
— The config of particle.
</dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>properties.particle.x</b>:<span>Number</span>
— The x position.
</dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>properties.particle.y</b>:<span>Number</span>
— The y position
</dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>properties.particle.vx</b>:<span>Number</span>
— The x velocity.
</dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>properties.particle.vy</b>:<span>Number</span>
— The y velocity.
</dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>properties.particle.ax</b>:<span>Number</span>
— The x acceleration.
</dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>properties.particle.ay</b>:<span>Number</span>
— The y acceleration.
</dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>properties.particle.life</b>:<span>Number</span>
— The time particle lives(in second).
</dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>properties.particle.alpha</b>:<span>Number</span>
— The alpha.
</dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>properties.particle.alphaV</b>:<span>Number</span>
— The alpha decline rate.
</dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>properties.particle.scale</b>:<span>Number</span>
— The scale.
</dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>properties.particle.scaleV</b>:<span>Number</span>
— The scale decline rate.
</dt>
</dl>
</div>
</div>
<!-- ============================== method details ========================= -->
<br/>
<div class=""><h3 style="margin-bottom:15px;">Method Detail</h3></div>
<a class="anchor" name="onUpdate"> </a>
<div class="member-box">
<div class="member-header">
<b>onUpdate</b>(dt:Number)
</div>
<div class="description">更新</div>
<dl class="detailList">
<dt class="heading"><span class="label">parameters</span></dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>dt</b>:<span>Number</span>
— delta time(in milliseconds)
</dt>
</dl>
</div>
<a class="anchor" name="reset"> </a>
<div class="member-box">
<div class="member-header">
<b>reset</b>(cfg:Object)
</div>
<div class="description">Reset the properties.</div>
<dl class="detailList">
<dt class="heading"><span class="label">parameters</span></dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>cfg</b>:<span>Object</span>
</dt>
</dl>
</div>
<a class="anchor" name="start"> </a>
<div class="member-box">
<div class="member-header">
<b>start</b>()
</div>
<div class="description">Start emit particles.</div>
</div>
<a class="anchor" name="stop"> </a>
<div class="member-box">
<div class="member-header">
<b>stop</b>(clear:Boolean)
</div>
<div class="description">Stop emit particles.</div>
<dl class="detailList">
<dt class="heading"><span class="label">parameters</span></dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>clear</b>:<span>Boolean</span>
— Whether or not clear all the particles.
</dt>
</dl>
</div>
</div>
</div>
<footer class="col-md-12">
<hr>
<p>&copy; Hilo 2016</p>
</footer>
<script src="../../js/jquery.min.js"></script>
<script src="../../bootstrap3.0.3/js/bootstrap.min.js"></script>
<script src="../../js/prettify.min.js"></script>
<script type="text/javascript">
//make code pretty
$('pre').addClass('prettyprint linenums fixedFont');
window.prettyPrint && prettyPrint();
</script>
</body>
</html>