javascript
/
three.js
mirror de https://github.com/tazdij/three.js.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250
							<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<script src="../../list.js"></script>
		<script src="../../page.js"></script>
		<link type="text/css" rel="stylesheet" href="../../page.css" />
	</head>
	<body>
		<h1>[name]</h1>

		<div class="desc">Base class for scene graph objects.</div>


		<h2>Constructor</h2>

		<h3>[name]()</h3>


		<h2>Properties</h2>

		<h3>.[page:Integer id]</h3>
		<div>
		Unique number of this object instance.
		</div>

		<h3>.[page:String name]</h3>
		<div>
		Optional name of the object (doesn't need to be unique).
		</div>

		<h3>.[page:Object3D parent]</h3>
		<div>
		Object's parent in the scene graph.
		</div>

		<h3>.[page:Object3D children]</h3>
		<div>
		Array with object's children.
		</div>

		<h3>.[page:Vector3 position]</h3>
		<div>
		Object's local position.
		</div>

		<h3>.[page:Vector3 rotation]</h3>
		<div>
		Object's local rotation (<a href="https://en.wikipedia.org/wiki/Euler_angles">Euler angles</a>), in radians.
		</div>

		<h3>.[page:String eulerOrder]</h3>
		<div>
		Order of axis for Euler angles.
		</div>

		<h3>.[page:Vector3 scale]</h3>
		<div>
		Object's local scale.
		</div>

		<h3>.[page:Vector3 up]</h3>
		<div>
		Up direction.
		</div>

		<h3>.[page:Matrix4 matrix]</h3>
		<div>
		Local transform.
		</div>

		<h3>.[page:Quaternion quaternion]</h3>
		<div>
		Object's local rotation as [page:Quaternion Quaternion]. Only used when useQuaternion is set to true.
		</div>

		<h3>.[page:Boolean useQuaternion]</h3>
		<div>
		Use quaternion instead of Euler angles for specifying local rotation.
		</div>

		<h3>.[page:Float renderDepth]</h3>
		<div>
		Override depth-sorting order if non *null*.
		</div>

		<h3>.[page:Boolean visible]</h3>
		<div>
		Object gets rendered if *true*.
		</div>

		<h3>.[page:Boolean castShadow]</h3>
		<div>
		Gets rendered into shadow map.
		</div>

		<h3>.[page:Boolean receiveShadow]</h3>
		<div>
		Material gets baked in shadow receiving.
		</div>

		<h3>.[page:Boolean frustumCulled]</h3>
		<div>
		When this is set, it checks every frame if the object is in the frustum of the camera. Otherwise the object gets drawn every frame even if it isn't visible.
		</div>

		<h3>.[page:Boolean matrixAutoUpdate]</h3>
		<div>
		When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also recalculates the matrixWorld property.
		</div>

		<h3>.[page:Boolean matrixWorldNeedsUpdate]</h3>
		<div>
		When this is set, it calculates the matrixWorld in that frame and resets this property to false.
		</div>

		<h3>.[page:Boolean rotationAutoUpdate]</h3>
		<div>
		When this is set, then the rotationMatrix gets calculated every frame.
		</div>

		<h2>Methods</h2>
		
		<h3>.applyMatrix( [page:Matrix4 matrix])</h3>
		<div>
		matrix - matrix
		</div>
		<div>
		This updates the position, rotation and scale with the matrix.
		</div>
		
		<h3>.translate( [page:Float distance], [page:Vector3 axis] )</h3>
		<div>
		distance - Distance.<br />
		axis - Translation direction.
		</div>
		<div>
		Translates object along arbitrary *axis* by *distance*.
		</div>

		<h3>.translateX( [page:Float distance] )</h3>
		<div>
		distance - Distance.<br />
		</div>
		<div>
		Translates object along x axis by distance.
		</div>

		<h3>.translateY( [page:Float distance] )</h3>
		<div>
		distance - Distance.<br />
		</div>
		<div>
		Translates object along y axis by distance.
		</div>

		<h3>.translateZ( [page:Float distance] )</h3>
		<div>
		distance - Distance.<br />
		</div>
		<div>
		Translates object along z axis by distance.
		</div>
		
		<h3>.localToWorld( [page:Vector3 vector] )</h3>
		<div>
		vector - A local vector.<br />
		</div>
		<div>
		Updates the vector from local space to world space.
		</div>

		<h3>.worldToLocal( [page:Vector3 vector] )</h3>
		<div>
		vector - A world vector.<br />
		</div>
		<div>
		Updates the vector from world space to local space.
		</div>

		<h3>.lookAt( [page:Vector3 vector] )</h3>
		<div>
		vector - A world vector to look at.<br />
		</div>
		<div>
		Rotates object to face point in space.
		</div>

		<h3>.add( [page:Object3D object] )</h3>
		<div>
		object - An object.<br />
		</div>
		<div>
		Adds *object* as child of this object.
		</div>

		<h3>.remove( [page:Object3D object] )</h3>
		<div>
		object - An object.<br />
		</div>
		<div>
		Removes *object* as child of this object.
		</div>

		<h3>.traverse( [page:Function callback] )</h3>
		<div>
		callback - An Function with as first argument an object3D object.<br />
		</div>
		<div>
		Executes the callback on this object and all descendants. 
		</div>

		<h3>.getChildByName( [page:String name], [page:Boolean recursive] )</h3>
		<div>
		name - Object name.<br />
		recursive - Whether check in the objects's children.
		</div>
		<div>
		Gets first child with name matching the argument. Searches whole subgraph recursively if *recursive* is true.
		</div>
		
		<h3>.getDescendants( [page:Array array] )</h3>
		<div>
		array - optional argument that returns the the array with descendants.<br />
		</div>
		<div>
		Searches whole subgraph recursively to add all objects in the array.
		</div>

		<h3>.updateMatrix()</h3>
		<div>
		Updates local transform.
		</div>

		<h3>.updateMatrixWorld( [page:Boolean force] )</h3>
		<div>
		Updates global transform of the object and its children.
		</div>

		<h3>.clone()</h3>
		<div>
		Creates a new clone of this object and all descendants.
		</div>


		<h2>Source</h2>

		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
	</body>
</html>