368 lines
18 KiB
HTML
368 lines
18 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>IRenderable | @esengine/egret-framework</title>
|
|
<meta name="description" content="Documentation for @esengine/egret-framework">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="../index.html" class="title">@esengine/egret-framework</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../globals.html">Globals</a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/_graphics_renderers_irenderable_.html">"Graphics/Renderers/IRenderable"</a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/_graphics_renderers_irenderable_.es.html">es</a>
|
|
</li>
|
|
<li>
|
|
<a href="_graphics_renderers_irenderable_.es.irenderable.html">IRenderable</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface IRenderable</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>当该接口应用到组件时，它将注册组件以场景渲染器显示
|
|
该接口请谨慎实现</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">IRenderable</span>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel">
|
|
<h3>Implemented by</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li><a href="../classes/_ecs_components_renderables_mesh_.es.mesh.html" class="tsd-signature-type">Mesh</a></li>
|
|
<li><a href="../classes/_graphics_renderers_polygonlight_polylight_.es.polylight.html" class="tsd-signature-type">PolyLight</a></li>
|
|
<li><a href="../classes/_ecs_components_renderables_renderablecomponent_.es.renderablecomponent.html" class="tsd-signature-type">RenderableComponent</a></li>
|
|
<li><a href="../classes/_ecs_components_renderables_sprites_scrollingspriterenderer_.es.scrollingspriterenderer.html" class="tsd-signature-type">ScrollingSpriteRenderer</a></li>
|
|
<li><a href="../classes/_ecs_components_renderables_sprites_spriteanimator_.es.spriteanimator.html" class="tsd-signature-type">SpriteAnimator</a></li>
|
|
<li><a href="../classes/_ecs_components_renderables_sprites_spriterenderer_.es.spriterenderer.html" class="tsd-signature-type">SpriteRenderer</a></li>
|
|
<li><a href="../classes/_ecs_components_renderables_sprites_staticspritecontainerrenderer_.es.staticspritecontainerrenderer.html" class="tsd-signature-type">StaticSpriteContainerRenderer</a></li>
|
|
<li><a href="../classes/_ecs_components_renderables_sprites_tiledmaprenderer_.es.tiledmaprenderer.html" class="tsd-signature-type">TiledMapRenderer</a></li>
|
|
<li><a href="../classes/_ecs_components_renderables_sprites_tiledspriterenderer_.es.tiledspriterenderer.html" class="tsd-signature-type">TiledSpriteRenderer</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_graphics_renderers_irenderable_.es.irenderable.html#bounds" class="tsd-kind-icon">bounds</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_graphics_renderers_irenderable_.es.irenderable.html#enabled" class="tsd-kind-icon">enabled</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_graphics_renderers_irenderable_.es.irenderable.html#isvisible" class="tsd-kind-icon">is<wbr>Visible</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_graphics_renderers_irenderable_.es.irenderable.html#renderlayer" class="tsd-kind-icon">render<wbr>Layer</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_graphics_renderers_irenderable_.es.irenderable.html#debugrender" class="tsd-kind-icon">debug<wbr>Render</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_graphics_renderers_irenderable_.es.irenderable.html#isvisiblefromcamera" class="tsd-kind-icon">is<wbr>Visible<wbr>From<wbr>Camera</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_graphics_renderers_irenderable_.es.irenderable.html#render" class="tsd-kind-icon">render</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="bounds" class="tsd-anchor"></a>
|
|
<h3>bounds</h3>
|
|
<div class="tsd-signature tsd-kind-icon">bounds<span class="tsd-signature-symbol">:</span> <a href="../classes/_math_rectangle_.es.rectangle.html" class="tsd-signature-type">Rectangle</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/IRenderable.ts#L10">src/Graphics/Renderers/IRenderable.ts:10</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>对象的AABB用于相机剔除</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="enabled" class="tsd-anchor"></a>
|
|
<h3>enabled</h3>
|
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/IRenderable.ts#L14">src/Graphics/Renderers/IRenderable.ts:14</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>这个组件是否应该被渲染</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="isvisible" class="tsd-anchor"></a>
|
|
<h3>is<wbr>Visible</h3>
|
|
<div class="tsd-signature tsd-kind-icon">is<wbr>Visible<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/IRenderable.ts#L22">src/Graphics/Renderers/IRenderable.ts:22</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>可渲染的可见性。状态的改变会调用onBecameVisible/onBecameInvisible方法</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="renderlayer" class="tsd-anchor"></a>
|
|
<h3>render<wbr>Layer</h3>
|
|
<div class="tsd-signature tsd-kind-icon">render<wbr>Layer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/IRenderable.ts#L18">src/Graphics/Renderers/IRenderable.ts:18</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>较低的渲染层在前面，较高的在后面</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="debugrender" class="tsd-anchor"></a>
|
|
<h3>debug<wbr>Render</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">debug<wbr>Render<span class="tsd-signature-symbol">(</span>camera<span class="tsd-signature-symbol">: </span><a href="../classes/_ecs_components_camera_.es.camera.html" class="tsd-signature-type">Camera</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/IRenderable.ts#L41">src/Graphics/Renderers/IRenderable.ts:41</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>只有在没有碰撞器时才呈现边界。总是在原点上渲染一个正方形。</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>camera: <a href="../classes/_ecs_components_camera_.es.camera.html" class="tsd-signature-type">Camera</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="isvisiblefromcamera" class="tsd-anchor"></a>
|
|
<h3>is<wbr>Visible<wbr>From<wbr>Camera</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Visible<wbr>From<wbr>Camera<span class="tsd-signature-symbol">(</span>camera<span class="tsd-signature-symbol">: </span><a href="../classes/_ecs_components_camera_.es.camera.html" class="tsd-signature-type">Camera</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/IRenderable.ts#L30">src/Graphics/Renderers/IRenderable.ts:30</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>如果renderableComponent的边界与camera.bounds相交 返回true
|
|
用于处理isVisible标志的状态开关
|
|
在渲染方法中使用这个方法来决定是否渲染</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>camera: <a href="../classes/_ecs_components_camera_.es.camera.html" class="tsd-signature-type">Camera</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="render" class="tsd-anchor"></a>
|
|
<h3>render</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">render<span class="tsd-signature-symbol">(</span>camera<span class="tsd-signature-symbol">: </span><a href="../classes/_ecs_components_camera_.es.camera.html" class="tsd-signature-type">Camera</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Renderers/IRenderable.ts#L36">src/Graphics/Renderers/IRenderable.ts:36</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>由渲染器调用。可以使用摄像机进行剔除</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>camera: <a href="../classes/_ecs_components_camera_.es.camera.html" class="tsd-signature-type">Camera</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class="globals ">
|
|
<a href="../globals.html"><em>Globals</em></a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="../modules/_graphics_renderers_irenderable_.html">"<wbr>Graphics/<wbr>Renderers/IRenderable"</a>
|
|
<ul>
|
|
<li class="current tsd-kind-namespace tsd-parent-kind-module">
|
|
<a href="../modules/_graphics_renderers_irenderable_.es.html">es</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-class tsd-parent-kind-namespace">
|
|
<a href="../classes/_graphics_renderers_irenderable_.es.renderablecomparer.html" class="tsd-kind-icon">Renderable<wbr>Comparer</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-interface tsd-parent-kind-namespace">
|
|
<a href="_graphics_renderers_irenderable_.es.irenderable.html" class="tsd-kind-icon">IRenderable</a>
|
|
<ul>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="_graphics_renderers_irenderable_.es.irenderable.html#bounds" class="tsd-kind-icon">bounds</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="_graphics_renderers_irenderable_.es.irenderable.html#enabled" class="tsd-kind-icon">enabled</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="_graphics_renderers_irenderable_.es.irenderable.html#isvisible" class="tsd-kind-icon">is<wbr>Visible</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="_graphics_renderers_irenderable_.es.irenderable.html#renderlayer" class="tsd-kind-icon">render<wbr>Layer</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="_graphics_renderers_irenderable_.es.irenderable.html#debugrender" class="tsd-kind-icon">debug<wbr>Render</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="_graphics_renderers_irenderable_.es.irenderable.html#isvisiblefromcamera" class="tsd-kind-icon">is<wbr>Visible<wbr>From<wbr>Camera</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="_graphics_renderers_irenderable_.es.irenderable.html#render" class="tsd-kind-icon">render</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
|
</body>
|
|
</html> |