samien
/
three.js
mirror de https://github.com/mrdoob/three.js.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>InspectorBase - Three.js Docs</title>
	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
	<script src="../scripts/highlight.min.js"></script>
	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
	<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
	<h1 translate="no">InspectorBase</h1>
		<section>
			<header>
			</header>
			<article>
				<div class="container-overview">
					<h3 class="name name-method" id="InspectorBase" translate="no">new <a href="#InspectorBase">InspectorBase</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>InspectorBase is the base class for all inspectors.</p>
						</div>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="currentFrame" translate="no">.<a href="#currentFrame">currentFrame</a><span class="type-signature"> : Object</span> </h3>
					<div class="description">
						<p>The current frame being processed.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="nodeFrame" translate="no">.<a href="#nodeFrame">nodeFrame</a> </h3>
					<div class="description">
						<p>Returns the node frame for the current renderer.</p>
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="begin" translate="no">.<a href="#begin">begin</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Called when a frame begins.</p>
						</div>
					</div>
					<h3 class="name name-method" id="beginCompute" translate="no">.<a href="#beginCompute">beginCompute</a><span class="signature">( uid : <span class="param-type">string</span>, computeNode : <span class="param-type">ComputeNode</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Called when a compute operation begins.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>uid</code></td>
									<td class="description last"><p>A unique identifier for the render context.</p></td>
								</tr>
								<tr>
									<td class="name"><code>computeNode</code></td>
									<td class="description last"><p>The compute node being executed.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="beginRender" translate="no">.<a href="#beginRender">beginRender</a><span class="signature">( uid : <span class="param-type">string</span>, scene : <span class="param-type">Scene</span>, camera : <span class="param-type">Camera</span>, renderTarget : <span class="param-type">WebGLRenderTarget</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Called when a render operation begins.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>uid</code></td>
									<td class="description last"><p>A unique identifier for the render context.</p></td>
								</tr>
								<tr>
									<td class="name"><code>scene</code></td>
									<td class="description last"><p>The scene being rendered.</p></td>
								</tr>
								<tr>
									<td class="name"><code>camera</code></td>
									<td class="description last"><p>The camera being used for rendering.</p></td>
								</tr>
								<tr>
									<td class="name"><code>renderTarget</code></td>
									<td class="description last"><p>The render target, if any.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="computeAsync" translate="no">.<a href="#computeAsync">computeAsync</a><span class="signature">( computeNode : <span class="param-type">ComputeNode</span>, dispatchSizeOrCount : <span class="param-type">number | Array.&lt;number></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>When a compute operation is performed.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>computeNode</code></td>
									<td class="description last"><p>The compute node being executed.</p></td>
								</tr>
								<tr>
									<td class="name"><code>dispatchSizeOrCount</code></td>
									<td class="description last"><p>The dispatch size or count.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="copyFramebufferToTexture" translate="no">.<a href="#copyFramebufferToTexture">copyFramebufferToTexture</a><span class="signature">( framebufferTexture : <span class="param-type">Texture</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Called when a framebuffer copy operation is performed.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>framebufferTexture</code></td>
									<td class="description last"><p>The texture associated with the framebuffer.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="copyTextureToTexture" translate="no">.<a href="#copyTextureToTexture">copyTextureToTexture</a><span class="signature">( srcTexture : <span class="param-type">Texture</span>, dstTexture : <span class="param-type">Texture</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Called when a texture copy operation is performed.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>srcTexture</code></td>
									<td class="description last"><p>The source texture.</p></td>
								</tr>
								<tr>
									<td class="name"><code>dstTexture</code></td>
									<td class="description last"><p>The destination texture.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="finish" translate="no">.<a href="#finish">finish</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Called when a frame ends.</p>
						</div>
					</div>
					<h3 class="name name-method" id="finishCompute" translate="no">.<a href="#finishCompute">finishCompute</a><span class="signature">( uid : <span class="param-type">string</span>, computeNode : <span class="param-type">ComputeNode</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Called when a compute operation ends.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>uid</code></td>
									<td class="description last"><p>A unique identifier for the render context.</p></td>
								</tr>
								<tr>
									<td class="name"><code>computeNode</code></td>
									<td class="description last"><p>The compute node being executed.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="finishRender" translate="no">.<a href="#finishRender">finishRender</a><span class="signature">( uid : <span class="param-type">string</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Called when an animation loop ends.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>uid</code></td>
									<td class="description last"><p>A unique identifier for the render context.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="getRenderer" translate="no">.<a href="#getRenderer">getRenderer</a><span class="signature">()</span><span class="type-signature"> : <a href="WebGLRenderer.html">WebGLRenderer</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns the renderer associated with this inspector.</p>
						</div>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> The associated renderer.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="init" translate="no">.<a href="#init">init</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Initializes the inspector.</p>
						</div>
					</div>
					<h3 class="name name-method" id="inspect" translate="no">.<a href="#inspect">inspect</a><span class="signature">( node : <span class="param-type">Node</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Inspects a node.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>node</code></td>
									<td class="description last"><p>The node to inspect.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="setRenderer" translate="no">.<a href="#setRenderer">setRenderer</a><span class="signature">( renderer : <span class="param-type">WebGLRenderer</span> )</span><span class="type-signature"> : <a href="InspectorBase.html">InspectorBase</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Sets the renderer for this inspector.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>renderer</code></td>
									<td class="description last"><p>The renderer to associate with this inspector.</p></td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> This inspector instance.</dt>
						</dl>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/src/renderers/common/InspectorBase.js" target="_blank" rel="noopener" translate="no">src/renderers/common/InspectorBase.js</a>
				</p>
			</article>
		</section>
		<section>
			<header>
			</header>
			<article>
				<div class="container-overview">
					<h3 class="name name-method" id="InspectorBase" translate="no">new <a href="#InspectorBase">InspectorBase</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Creates a new InspectorBase.</p>
						</div>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="currentFrame" translate="no">.<a href="#currentFrame">currentFrame</a><span class="type-signature"> : Object</span> </h3>
					<div class="description">
						<p>The current frame being processed.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="nodeFrame" translate="no">.<a href="#nodeFrame">nodeFrame</a> </h3>
					<div class="description">
						<p>Returns the node frame for the current renderer.</p>
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="begin" translate="no">.<a href="#begin">begin</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Called when a frame begins.</p>
						</div>
					</div>
					<h3 class="name name-method" id="beginCompute" translate="no">.<a href="#beginCompute">beginCompute</a><span class="signature">( uid : <span class="param-type">string</span>, computeNode : <span class="param-type">ComputeNode</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Called when a compute operation begins.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>uid</code></td>
									<td class="description last"><p>A unique identifier for the render context.</p></td>
								</tr>
								<tr>
									<td class="name"><code>computeNode</code></td>
									<td class="description last"><p>The compute node being executed.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="beginRender" translate="no">.<a href="#beginRender">beginRender</a><span class="signature">( uid : <span class="param-type">string</span>, scene : <span class="param-type">Scene</span>, camera : <span class="param-type">Camera</span>, renderTarget : <span class="param-type">WebGLRenderTarget</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Called when a render operation begins.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>uid</code></td>
									<td class="description last"><p>A unique identifier for the render context.</p></td>
								</tr>
								<tr>
									<td class="name"><code>scene</code></td>
									<td class="description last"><p>The scene being rendered.</p></td>
								</tr>
								<tr>
									<td class="name"><code>camera</code></td>
									<td class="description last"><p>The camera being used for rendering.</p></td>
								</tr>
								<tr>
									<td class="name"><code>renderTarget</code></td>
									<td class="description last"><p>The render target, if any.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="computeAsync" translate="no">.<a href="#computeAsync">computeAsync</a><span class="signature">( computeNode : <span class="param-type">ComputeNode</span>, dispatchSizeOrCount : <span class="param-type">number | Array.&lt;number></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>When a compute operation is performed.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>computeNode</code></td>
									<td class="description last"><p>The compute node being executed.</p></td>
								</tr>
								<tr>
									<td class="name"><code>dispatchSizeOrCount</code></td>
									<td class="description last"><p>The dispatch size or count.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="copyFramebufferToTexture" translate="no">.<a href="#copyFramebufferToTexture">copyFramebufferToTexture</a><span class="signature">( framebufferTexture : <span class="param-type">Texture</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Called when a framebuffer copy operation is performed.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>framebufferTexture</code></td>
									<td class="description last"><p>The texture associated with the framebuffer.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="copyTextureToTexture" translate="no">.<a href="#copyTextureToTexture">copyTextureToTexture</a><span class="signature">( srcTexture : <span class="param-type">Texture</span>, dstTexture : <span class="param-type">Texture</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Called when a texture copy operation is performed.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>srcTexture</code></td>
									<td class="description last"><p>The source texture.</p></td>
								</tr>
								<tr>
									<td class="name"><code>dstTexture</code></td>
									<td class="description last"><p>The destination texture.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="finish" translate="no">.<a href="#finish">finish</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Called when a frame ends.</p>
						</div>
					</div>
					<h3 class="name name-method" id="finishCompute" translate="no">.<a href="#finishCompute">finishCompute</a><span class="signature">( uid : <span class="param-type">string</span>, computeNode : <span class="param-type">ComputeNode</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Called when a compute operation ends.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>uid</code></td>
									<td class="description last"><p>A unique identifier for the render context.</p></td>
								</tr>
								<tr>
									<td class="name"><code>computeNode</code></td>
									<td class="description last"><p>The compute node being executed.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="finishRender" translate="no">.<a href="#finishRender">finishRender</a><span class="signature">( uid : <span class="param-type">string</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Called when an animation loop ends.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>uid</code></td>
									<td class="description last"><p>A unique identifier for the render context.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="getRenderer" translate="no">.<a href="#getRenderer">getRenderer</a><span class="signature">()</span><span class="type-signature"> : <a href="WebGLRenderer.html">WebGLRenderer</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns the renderer associated with this inspector.</p>
						</div>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> The associated renderer.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="init" translate="no">.<a href="#init">init</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Initializes the inspector.</p>
						</div>
					</div>
					<h3 class="name name-method" id="inspect" translate="no">.<a href="#inspect">inspect</a><span class="signature">( node : <span class="param-type">Node</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Inspects a node.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>node</code></td>
									<td class="description last"><p>The node to inspect.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="setRenderer" translate="no">.<a href="#setRenderer">setRenderer</a><span class="signature">( renderer : <span class="param-type">WebGLRenderer</span> )</span><span class="type-signature"> : <a href="InspectorBase.html">InspectorBase</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Sets the renderer for this inspector.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>renderer</code></td>
									<td class="description last"><p>The renderer to associate with this inspector.</p></td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> This inspector instance.</dt>
						</dl>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/src/renderers/common/InspectorBase.js" target="_blank" rel="noopener" translate="no">src/renderers/common/InspectorBase.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>