samien
/
three.js
zrcadlo https://github.com/mrdoob/three.js.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>UniformGroupNode - 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>
		<p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → <a href="Node.html">Node</a> → </p>
	<h1 translate="no">UniformGroupNode</h1>
		<section>
			<header>
				<div class="class-description"><p>This node can be used to group single instances of <a href="UniformNode.html">UniformNode</a>
and manage them as a uniform buffer.</p>
<p>In most cases, the predefined nodes <code>objectGroup</code>, <code>renderGroup</code> and <code>frameGroup</code>
will be used when defining the <a href="UniformNode.html#groupNode">UniformNode#groupNode</a> property.</p>
<ul>
<li><code>objectGroup</code>: Uniform buffer per object.</li>
<li><code>renderGroup</code>: Shared uniform buffer, updated once per render call.</li>
<li><code>frameGroup</code>: Shared uniform buffer, updated once per frame.</li>
</ul></div>
			</header>
			<article>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="UniformGroupNode" translate="no">new <a href="#UniformGroupNode">UniformGroupNode</a><span class="signature">( name : <span class="param-type">string</span>, shared : <span class="param-type">boolean</span>, order : <span class="param-type">number</span>, updateType : <span class="param-type">string | null</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new uniform group node.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">name</strong>
									</td>
									<td class="description last">
										<p>The name of the uniform group node.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">shared</strong>
									</td>
									<td class="description last">
										<p>Whether this uniform group node is shared or not.</p>
										<p>Default is <code>false</code>.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">order</strong>
									</td>
									<td class="description last">
										<p>Influences the internal sorting.</p>
										<p>Default is <code>1</code>.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">updateType</strong>
									</td>
									<td class="description last">
										<p>The update type of the uniform group node.</p>
										<p>Default is <code>null</code>.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="isUniformGroup" translate="no">.<a href="#isUniformGroup">isUniformGroup</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
					<div class="description">
						<p>This flag can be used for type testing.</p>
						<p>Default is <code>true</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="name" translate="no">.<a href="#name">name</a><span class="type-signature"> : string</span> </h3>
					<div class="description">
						<p>The name of the uniform group node.</p>
					</div>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Node.html#name">Node#name</a></dt>
						</dl>
				</div>
				<div class="member">
					<h3 class="name" id="order" translate="no">.<a href="#order">order</a><span class="type-signature"> : number</span> </h3>
					<div class="description">
						<p>Influences the internal sorting.
TODO: Add details when this property should be changed.</p>
						<p>Default is <code>1</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="shared" translate="no">.<a href="#shared">shared</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>Whether this uniform group node is shared or not.</p>
						<p>Default is <code>false</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="updateType" translate="no">.<a href="#updateType">updateType</a><span class="type-signature"> : string | null</span> </h3>
					<div class="description">
						<p>The update type of the uniform group node.</p>
						<p>Default is <code>null</code>.</p>
					</div>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Node.html#updateType">Node#updateType</a></dt>
						</dl>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="deserialize" translate="no">.<a href="#deserialize">deserialize</a><span class="signature">( data : <span class="param-type">Object</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Deserializes the uniform group node from a JSON object.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">data</strong>
									</td>
									<td class="description last">
										<p>The object containing the serialized data.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Node.html#deserialize">Node#deserialize</a></dt>
						</dl>
					</div>
					<h3 class="name name-method" id="serialize" translate="no">.<a href="#serialize">serialize</a><span class="signature">( data : <span class="param-type">Object</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Serializes the uniform group node to a JSON object.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">data</strong>
									</td>
									<td class="description last">
										<p>The object to store the serialized data.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Node.html#serialize">Node#serialize</a></dt>
						</dl>
					</div>
					<h3 class="name name-method" id="update" translate="no">.<a href="#update">update</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Marks the uniform group node as needing an update.
This will trigger the necessary updates in the rendering process.</p>
						</div>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Node.html#update">Node#update</a></dt>
						</dl>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/src/nodes/core/UniformGroupNode.js" translate="no" target="_blank" rel="noopener">src/nodes/core/UniformGroupNode.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>