Skip to content

T
three.js

Ablesons / three.js
与 Fork 源项目一致

从无法访问的项目Fork

通知 2
Star 0
Fork 0
T
three.js

体验新版 GitCode，发现更多精彩内容 >>

切换分支/标签
查找文件 普通视图历史永久链接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 


		<h2>Constructor</h2>
C
added constructors to documentation  
cjshannon 已提交
17
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
18 
		<h3>[name]()</h3>
C
added constructors to documentation  
cjshannon 已提交
19 20 21 
		<div>
		todo
		</div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
22 23 24 25 26 27 28 29 30 31 32 


		<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 已提交
33 
		Optional name of the object (doesn't need to be unique).
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
34 
		</div>
M
Added placeholder for all the objects.  
Mr.doob 已提交
35
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
36 37 
		<h3>.[page:Object3D parent]</h3>
		<div>
S
Object3D +'the'  
sole 已提交
38 
		Object's parent in the scene graph.
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
39 
		</div>
M
Added placeholder for all the objects.  
Mr.doob 已提交
40
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
41 42 43 44 45 46 47 48 49 50 51 52 
		<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 已提交
53 
		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 已提交
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 
		</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 已提交
71 
		<h3>.[page:Matrix4 matrix]</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
72 73 74 75 76 77 
		<div>
		Local transform.
		</div>

		<h3>.[page:Quaternion quaternion]</h3>
		<div>
O
update Object3D documentation  
OpenShift guest 已提交
78 
		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 已提交
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 
		</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 已提交
107 108 109 
		<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 已提交
110 111 

		<h3>.[page:Boolean matrixAutoUpdate]</h3>
O
update Object3D documentation  
OpenShift guest 已提交
112 113 114 
		<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 已提交
115 116 

		<h3>.[page:Boolean matrixWorldNeedsUpdate]</h3>
O
update Object3D documentation  
OpenShift guest 已提交
117 118 119 
		<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 已提交
120 121 

		<h3>.[page:Boolean rotationAutoUpdate]</h3>
O
update Object3D documentation  
OpenShift guest 已提交
122 123 124 
		<div>
		When this is set, then the rotationMatrix gets calculated every frame.
		</div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
125
C
additions to documentation  
cjshannon 已提交
126 127 128 129 130 131 132 133 134 135 
		<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 已提交
136 
		<h2>Methods</h2>
O
update Object3D documentation  
OpenShift guest 已提交
137 138 139 140 141 142 143 144 145 
		
		<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 已提交
146 147 
		<h3>.translateX( [page:Float distance] )</h3>
		<div>
O
update Object3D documentation  
OpenShift guest 已提交
148 149 150 
		distance - Distance.<br />
		</div>
		<div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
151 152 153 154 155 
		Translates object along x axis by distance.
		</div>

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

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

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

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

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

		<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 已提交
236 237 238 239 240 
		<h3>.clone()</h3>
		<div>
		Creates a new clone of this object and all descendants.
		</div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
241
C
additions to documentation  
cjshannon 已提交
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 274 275 276 277 
		<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 已提交
278 279 280 281 282 
		<h2>Source</h2>

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