Skip to content

T
three.js

车家大少爷 / three.js
与 Fork 源项目一致

从无法访问的项目Fork

通知 2
Star 0
Fork 0
T
three.js

前往新版Gitcode，体验更适合开发者的 AI 搜索 >>

切换分支/标签
查找文件 普通视图历史永久链接Permalink
Object3D.html 5.7 KB
Newer Older
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
1 2 3 
<!DOCTYPE html>
<html lang="en">
	<head>
C
prepare documentation for programmatic additions  
cjshannon 已提交
4 
		<meta charset="utf-8" />
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
5 6 7 8 9 10 11 
		<script src="../../list.js"></script>
		<script src="../../page.js"></script>
		<link type="text/css" rel="stylesheet" href="../../page.css" />
	</head>
	<body>
		<h1>[name]</h1>
Y
Spelling and grammar fixes.  
Yuri Feldman 已提交
12 
		<div class="desc">Base class for scene graph objects.</div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 


		<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>
S
Couple corrections to Object3D docs.  
sole 已提交
29 
		Optional name of the object (doesn't need to be unique).
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
30 
		</div>
M
Added placeholder for all the objects.  
Mr.doob 已提交
31
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
32 33 
		<h3>.[page:Object3D parent]</h3>
		<div>
S
Object3D +'the'  
sole 已提交
34 
		Object's parent in the scene graph.
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
35 
		</div>
M
Added placeholder for all the objects.  
Mr.doob 已提交
36
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
37 38 39 40 41 42 43 44 45 46 47 48 
		<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>
S
Couple corrections to Object3D docs.  
sole 已提交
49 
		Object's local rotation (<a href="https://en.wikipedia.org/wiki/Euler_angles">Euler angles</a>), in radians.
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 
		</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>
S
Couple of small fixes in Object3D docs.  
sole 已提交
67 
		<h3>.[page:Matrix4 matrix]</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
68 69 70 71 72 73 
		<div>
		Local transform.
		</div>

		<h3>.[page:Quaternion quaternion]</h3>
		<div>
O
update Object3D documentation  
OpenShift guest 已提交
74 
		Object's local rotation as [page:Quaternion Quaternion]. Only used when useQuaternion is set to true.
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 
		</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>
O
update Object3D documentation  
OpenShift guest 已提交
103 104 105 
		<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>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
106 107 

		<h3>.[page:Boolean matrixAutoUpdate]</h3>
O
update Object3D documentation  
OpenShift guest 已提交
108 109 110 
		<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>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
111 112 

		<h3>.[page:Boolean matrixWorldNeedsUpdate]</h3>
O
update Object3D documentation  
OpenShift guest 已提交
113 114 115 
		<div>
		When this is set, it calculates the matrixWorld in that frame and resets this property to false.
		</div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
116 117 

		<h3>.[page:Boolean rotationAutoUpdate]</h3>
O
update Object3D documentation  
OpenShift guest 已提交
118 119 120 
		<div>
		When this is set, then the rotationMatrix gets calculated every frame.
		</div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
121
C
additions to documentation  
cjshannon 已提交
122 123 124 125 126 127 128 129 130 131 
		<h3>.[page:object userData]</h3>
		<div>
		todo
		</div> 

		<h3>.[page:Matrix4 matrixWorld]</h3>
		<div>
		todo
		</div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
132 
		<h2>Methods</h2>
O
update Object3D documentation  
OpenShift guest 已提交
133 134 135 136 137 138 139 140 141 
		
		<h3>.applyMatrix( [page:Matrix4 matrix])</h3>
		<div>
		matrix - matrix
		</div>
		<div>
		This updates the position, rotation and scale with the matrix.
		</div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
142 143 
		<h3>.translateX( [page:Float distance] )</h3>
		<div>
O
update Object3D documentation  
OpenShift guest 已提交
144 145 146 
		distance - Distance.<br />
		</div>
		<div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
147 148 149 150 151 
		Translates object along x axis by distance.
		</div>

		<h3>.translateY( [page:Float distance] )</h3>
		<div>
O
update Object3D documentation  
OpenShift guest 已提交
152 153 154 
		distance - Distance.<br />
		</div>
		<div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
155 156 157 158 159 
		Translates object along y axis by distance.
		</div>

		<h3>.translateZ( [page:Float distance] )</h3>
		<div>
O
update Object3D documentation  
OpenShift guest 已提交
160 161 162 
		distance - Distance.<br />
		</div>
		<div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
163 164 
		Translates object along z axis by distance.
		</div>
O
update Object3D documentation  
OpenShift guest 已提交
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 
		
		<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>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
181 182 183 

		<h3>.lookAt( [page:Vector3 vector] )</h3>
		<div>
O
update Object3D documentation  
OpenShift guest 已提交
184 185 186 
		vector - A world vector to look at.<br />
		</div>
		<div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
187 188 189 190 191 
		Rotates object to face point in space.
		</div>

		<h3>.add( [page:Object3D object] )</h3>
		<div>
O
update Object3D documentation  
OpenShift guest 已提交
192 193 194 
		object - An object.<br />
		</div>
		<div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
195 196 197 198 199 
		Adds *object* as child of this object.
		</div>

		<h3>.remove( [page:Object3D object] )</h3>
		<div>
O
update Object3D documentation  
OpenShift guest 已提交
200 201 202 
		object - An object.<br />
		</div>
		<div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
203 204 205 
		Removes *object* as child of this object.
		</div>
O
update Object3D documentation  
OpenShift guest 已提交
206 207 208 209 210 211 212 213 
		<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>
M
Simplified Object3D's .getDescendants() code.  
Mr.doob 已提交
214 
		<h3>.getDescendants( [page:Array array] )</h3>
L
add documentation  
libra guest 已提交
215 
		<div>
M
Simplified Object3D's .getDescendants() code.  
Mr.doob 已提交
216 
		array - optional argument that returns the the array with descendants.<br />
L
add documentation  
libra guest 已提交
217 218 
		</div>
		<div>
M
Simplified Object3D's .getDescendants() code.  
Mr.doob 已提交
219 
		Searches whole subgraph recursively to add all objects in the array.
L
add documentation  
libra guest 已提交
220 
		</div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
221 222 223 224 225 226 227 228 229 230 231 

		<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>
O
update Object3D documentation  
OpenShift guest 已提交
232 233 234 235 236 
		<h3>.clone()</h3>
		<div>
		Creates a new clone of this object and all descendants.
		</div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
237
C
additions to documentation  
cjshannon 已提交
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 
		<h3>.getObjectByName([page:todo name], [page:todo recursive]) [page:todo]</h3>
		<div>
		name -- todo <br />
		recursive -- todo
		</div>
		<div>
		todo
		</div>

		<h3>.translateOnAxis([page:todo axis], [page:todo distance]) [page:todo]</h3>
		<div>
		axis -- todo <br />
		distance -- todo
		</div>
		<div>
		todo
		</div>

		<h3>.getObjectById([page:todo id], [page:todo recursive]) [page:todo]</h3>
		<div>
		id -- todo <br />
		recursive -- todo
		</div>
		<div>
		todo
		</div>

		<h3>.rotateOnAxis([page:todo axis], [page:todo angle]) [page:todo]</h3>
		<div>
		axis -- todo <br />
		angle -- todo
		</div>
		<div>
		todo
		</div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
274 275 276 277 278 
		<h2>Source</h2>

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