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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>CSS2DRenderer - 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">CSS2DRenderer</h1>
		<section>
			<header>
				<div class="class-description"><p>This renderer is a simplified version of <a href="CSS3DRenderer.html">CSS3DRenderer</a>. The only transformation that is
supported is translation.</p>
<p>The renderer is very useful if you want to combine HTML based labels with 3D objects. Here too,
the respective DOM elements are wrapped into an instance of <a href="CSS2DObject.html">CSS2DObject</a> and added to the
scene graph. All other types of renderable 3D objects (like meshes or point clouds) are ignored.</p>
<p><code>CSS2DRenderer</code> only supports 100% browser and display zoom.</p></div>
			</header>
			<article>
				<h2 class="subsection-title">Import</h2>
				<p><span translate="no">CSS2DRenderer</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank">Installation#Addons</a>.</p>
				<pre><code class="language-js">import { CSS2DRenderer } from 'three/addons/renderers/CSS2DRenderer.js';</code></pre>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="CSS2DRenderer" translate="no">new <a href="#CSS2DRenderer">CSS2DRenderer</a><span class="signature">( parameters : <span class="param-type">CSS2DRenderer~Parameters</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new CSS2D renderer.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>parameters</code></td>
									<td class="description last"><p>The parameters.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="domElement" translate="no">.<a href="#domElement">domElement</a><span class="type-signature"> : HTMLElement</span> </h3>
					<div class="description">
						<p>The DOM where the renderer appends its child-elements.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="sortObjects" translate="no">.<a href="#sortObjects">sortObjects</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>Controls whether the renderer assigns <code>z-index</code> values to CSS2DObject DOM elements.
If set to <code>true</code>, z-index values are assigned first based on the <code>renderOrder</code>
and secondly - the distance to the camera. If set to <code>false</code>, no z-index values are assigned.<br/>Default is <code>true</code>.</p>
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="getSize" translate="no">.<a href="#getSize">getSize</a><span class="signature">()</span><span class="type-signature"> : Object</span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns an object containing the width and height of the renderer.</p>
						</div>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> The size of the renderer.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="render" translate="no">.<a href="#render">render</a><span class="signature">( scene : <span class="param-type">Object3D</span>, camera : <span class="param-type">Camera</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Renders the given scene using the given camera.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>scene</code></td>
									<td class="description last"><p>A scene or any other type of 3D object.</p></td>
								</tr>
								<tr>
									<td class="name"><code>camera</code></td>
									<td class="description last"><p>The camera.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="setSize" translate="no">.<a href="#setSize">setSize</a><span class="signature">( width : <span class="param-type">number</span>, height : <span class="param-type">number</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Resizes the renderer to the given width and height.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>width</code></td>
									<td class="description last"><p>The width of the renderer.</p></td>
								</tr>
								<tr>
									<td class="name"><code>height</code></td>
									<td class="description last"><p>The height of the renderer.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
				<h2 class="subsection-title">Type Definitions</h2>
				<div class="member">
					<h3 class="name" id="~Parameters" translate="no">.<a href="#~Parameters">Parameters</a> </h3>
					<div class="description">
						<p>Constructor parameters of <code>CSS2DRenderer</code>.</p>
					</div>
						<h5 class="subsection-title">Properties:</h5>
<table class="props">
	<thead>
	<tr>
		<th>Name</th>
		<th>Type</th>
		<th>Attributes</th>
		<th class="last">Description</th>
	</tr>
	</thead>
	<tbody>
		<tr>
				<td class="name"><code>element</code></td>
			<td class="type">
<span class="param-type">HTMLElement</span>
			</td>
				<td class="attributes">
					&lt;optional><br>
				</td>
			<td class="description last"><p>A DOM element where the renderer appends its child-elements.
If not passed in here, a new div element will be created.</p></td>
		</tr>
	</tbody>
</table>
				</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/renderers/CSS2DRenderer.js" target="_blank" rel="noopener" translate="no">examples/jsm/renderers/CSS2DRenderer.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>