Skip to content

T
three.js

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

从无法访问的项目Fork

通知 2
Star 0
Fork 0
T
three.js

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

切换分支/标签
查找文件 普通视图历史永久链接Permalink
Object3D.html 6.9 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 
		<div>
G
Filled in TODOs  
Greg Tatum 已提交
20 
		The constructor takes no arguments.
C
added constructors to documentation  
cjshannon 已提交
21 
		</div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
22 23 24 25 


		<h2>Properties</h2>
C
Reformatted docs to add property anchors  
Casey Grun 已提交
26 
		<h3>[property:Integer id]</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
27 
		<div>
M
Docs: Id definition clean up.  
Mr.doob 已提交
28 
		Unique number for this object instance.
G
add uuid to docs  
gero3 已提交
29 
		</div>
M
Docs: Invisibles clean up. Started using Atom...  
Mr.doob 已提交
30
C
Reformatted docs to add property anchors  
Casey Grun 已提交
31 
		<h3>[property:String uuid]</h3>
G
add uuid to docs  
gero3 已提交
32 
		<div>
M
Docs: Invisibles clean up. Started using Atom...  
Mr.doob 已提交
33 
		[link:http://en.wikipedia.org/wiki/Universally_unique_identifier UUID] of this object instance.
G
add uuid to docs  
gero3 已提交
34 
		This gets automatically assigned, so this shouldn't be edited.
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
35 36 
		</div>
C
Reformatted docs to add property anchors  
Casey Grun 已提交
37 
		<h3>[property:String name]</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
38 
		<div>
S
Couple corrections to Object3D docs.  
sole 已提交
39 
		Optional name of the object (doesn't need to be unique).
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
40 
		</div>
M
Added placeholder for all the objects.  
Mr.doob 已提交
41
C
Reformatted docs to add property anchors  
Casey Grun 已提交
42 
		<h3>[property:Object3D parent]</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
43 
		<div>
S
Object3D +'the'  
sole 已提交
44 
		Object's parent in the scene graph.
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
45 
		</div>
M
Added placeholder for all the objects.  
Mr.doob 已提交
46
C
Reformatted docs to add property anchors  
Casey Grun 已提交
47 
		<h3>[property:Object3D children]</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
48 49 50 51 
		<div>
		Array with object's children.
		</div>
C
Reformatted docs to add property anchors  
Casey Grun 已提交
52 
		<h3>[property:Vector3 position]</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
53 54 55 56 
		<div>
		Object's local position.
		</div>
C
Reformatted docs to add property anchors  
Casey Grun 已提交
57 
		<h3>[property:Euler rotation]</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
58 
		<div>
G
Filled in TODOs  
Greg Tatum 已提交
59 
		Object's local rotation (<a href="https://en.wikipedia.org/wiki/Euler_angles" target="_blank">Euler angles</a>), in radians.
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
60 61 
		</div>
C
Reformatted docs to add property anchors  
Casey Grun 已提交
62 
		<h3>[property:String eulerOrder]</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
63 64 65 66 
		<div>
		Order of axis for Euler angles.
		</div>
C
Reformatted docs to add property anchors  
Casey Grun 已提交
67 
		<h3>[property:Vector3 scale]</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
68 69 70 71 
		<div>
		Object's local scale.
		</div>
C
Reformatted docs to add property anchors  
Casey Grun 已提交
72 
		<h3>[property:Vector3 up]</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
73 74 75 76 
		<div>
		Up direction.
		</div>
C
Reformatted docs to add property anchors  
Casey Grun 已提交
77 
		<h3>[property:Matrix4 matrix]</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
78 79 80 81 
		<div>
		Local transform.
		</div>
C
Reformatted docs to add property anchors  
Casey Grun 已提交
82 
		<h3>[property:Quaternion quaternion]</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
83 
		<div>
O
update Object3D documentation  
OpenShift guest 已提交
84 
		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 已提交
85 86 
		</div>
C
Reformatted docs to add property anchors  
Casey Grun 已提交
87 
		<h3>[property:Boolean useQuaternion]</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
88 89 90 91 
		<div>
		Use quaternion instead of Euler angles for specifying local rotation.
		</div>
C
Reformatted docs to add property anchors  
Casey Grun 已提交
92 
		<h3>[property:Boolean visible]</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
93 94 95 96 
		<div>
		Object gets rendered if *true*.
		</div>
C
Reformatted docs to add property anchors  
Casey Grun 已提交
97 
		<h3>[property:Boolean castShadow]</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
98 99 100 101 
		<div>
		Gets rendered into shadow map.
		</div>
C
Reformatted docs to add property anchors  
Casey Grun 已提交
102 
		<h3>[property:Boolean receiveShadow]</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
103 104 105 106 
		<div>
		Material gets baked in shadow receiving.
		</div>
C
Reformatted docs to add property anchors  
Casey Grun 已提交
107 
		<h3>[property:Boolean frustumCulled]</h3>
O
update Object3D documentation  
OpenShift guest 已提交
108 109 110 
		<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 已提交
111
C
Reformatted docs to add property anchors  
Casey Grun 已提交
112 
		<h3>[property:Boolean matrixAutoUpdate]</h3>
O
update Object3D documentation  
OpenShift guest 已提交
113 114 115 
		<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 已提交
116
C
Reformatted docs to add property anchors  
Casey Grun 已提交
117 
		<h3>[property:Boolean matrixWorldNeedsUpdate]</h3>
O
update Object3D documentation  
OpenShift guest 已提交
118 119 120 
		<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 已提交
121
C
Reformatted docs to add property anchors  
Casey Grun 已提交
122 
		<h3>[property:Boolean rotationAutoUpdate]</h3>
O
update Object3D documentation  
OpenShift guest 已提交
123 124 125 
		<div>
		When this is set, then the rotationMatrix gets calculated every frame.
		</div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
126
C
Reformatted docs to add property anchors  
Casey Grun 已提交
127 
		<h3>[property:object userData]</h3>
C
additions to documentation  
cjshannon 已提交
128 
		<div>
G
Filled in TODOs  
Greg Tatum 已提交
129 
		An object that can be used to store custom data about the Object3d. It should not hold references to functions as these will not be cloned.
M
Docs: Invisibles clean up. Started using Atom...  
Mr.doob 已提交
130 
		</div>
C
additions to documentation  
cjshannon 已提交
131
C
Reformatted docs to add property anchors  
Casey Grun 已提交
132 
		<h3>[property:Matrix4 matrixWorld]</h3>
C
additions to documentation  
cjshannon 已提交
133 
		<div>
G
Filled in TODOs  
Greg Tatum 已提交
134 
		The global transform of the object. If the Object3d has no parent, then it's identical to the local transform.
M
Docs: Invisibles clean up. Started using Atom...  
Mr.doob 已提交
135 136 
		</div>
C
additions to documentation  
cjshannon 已提交
137
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
138 
		<h2>Methods</h2>
M
Docs: Invisibles clean up. Started using Atom...  
Mr.doob 已提交
139
G
Filled in TODOs  
Greg Tatum 已提交
140 
		<h3>[page:EventDispatcher EventDispatcher] methods are available on this class.</h3>
M
Docs: Invisibles clean up. Started using Atom...  
Mr.doob 已提交
141
C
Reformatted docs to add method anchors  
Casey Grun 已提交
142 
		<h3>[method:null applyMatrix]( [page:Matrix4 matrix])</h3>
O
update Object3D documentation  
OpenShift guest 已提交
143 144 145 146 147 148 
		<div>
		matrix - matrix
		</div>
		<div>
		This updates the position, rotation and scale with the matrix.
		</div>
M
Docs: Invisibles clean up. Started using Atom...  
Mr.doob 已提交
149
C
Reformatted docs to add method anchors  
Casey Grun 已提交
150 
		<h3>[method:null translateX]( [page:Float distance] )</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
151 
		<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 
		Translates object along x axis by distance.
		</div>
C
Reformatted docs to add method anchors  
Casey Grun 已提交
158 
		<h3>[method:null translateY]( [page:Float distance] )</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
159 
		<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 165 
		Translates object along y axis by distance.
		</div>
C
Reformatted docs to add method anchors  
Casey Grun 已提交
166 
		<h3>[method:null translateZ]( [page:Float distance] )</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
167 
		<div>
O
update Object3D documentation  
OpenShift guest 已提交
168 169 170 
		distance - Distance.<br />
		</div>
		<div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
171 172 
		Translates object along z axis by distance.
		</div>
M
Docs: Invisibles clean up. Started using Atom...  
Mr.doob 已提交
173
C
Reformatted docs to add method anchors  
Casey Grun 已提交
174 
		<h3>[method:Vector3 localToWorld]( [page:Vector3 vector] )</h3>
O
update Object3D documentation  
OpenShift guest 已提交
175 176 177 178 179 180 181 
		<div>
		vector - A local vector.<br />
		</div>
		<div>
		Updates the vector from local space to world space.
		</div>
C
Reformatted docs to add method anchors  
Casey Grun 已提交
182 
		<h3>[method:Vector3 worldToLocal]( [page:Vector3 vector] )</h3>
O
update Object3D documentation  
OpenShift guest 已提交
183 184 185 186 187 188 
		<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 已提交
189
C
Reformatted docs to add method anchors  
Casey Grun 已提交
190 
		<h3>[method:null lookAt]( [page:Vector3 vector] )</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
191 
		<div>
O
update Object3D documentation  
OpenShift guest 已提交
192 193 194 
		vector - A world vector to look at.<br />
		</div>
		<div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
195 196 197 
		Rotates object to face point in space.
		</div>
C
Reformatted docs to add method anchors  
Casey Grun 已提交
198 
		<h3>[method:null add]( [page:Object3D object] )</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
199 
		<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 
		Adds *object* as child of this object.
		</div>
C
Reformatted docs to add method anchors  
Casey Grun 已提交
206 
		<h3>[method:null remove]( [page:Object3D object] )</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
207 
		<div>
O
update Object3D documentation  
OpenShift guest 已提交
208 209 210 
		object - An object.<br />
		</div>
		<div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
211 212 213 
		Removes *object* as child of this object.
		</div>
C
Reformatted docs to add method anchors  
Casey Grun 已提交
214 
		<h3>[method:null traverse]( [page:Function callback] )</h3>
O
update Object3D documentation  
OpenShift guest 已提交
215 216 217 218 
		<div>
		callback - An Function with as first argument an object3D object.<br />
		</div>
		<div>
M
Docs: Invisibles clean up. Started using Atom...  
Mr.doob 已提交
219 
		Executes the callback on this object and all descendants.
O
update Object3D documentation  
OpenShift guest 已提交
220 221 
		</div>
C
Reformatted docs to add method anchors  
Casey Grun 已提交
222 
		<h3>[method:null updateMatrix]()</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
223 224 225 226 
		<div>
		Updates local transform.
		</div>
C
Reformatted docs to add method anchors  
Casey Grun 已提交
227 
		<h3>[method:null updateMatrixWorld]( [page:Boolean force] )</h3>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
228 229 230 231 
		<div>
		Updates global transform of the object and its children.
		</div>
C
Reformatted docs to add method anchors  
Casey Grun 已提交
232 
		<h3>[method:Object3D clone]()</h3>
O
update Object3D documentation  
OpenShift guest 已提交
233 234 235 236 
		<div>
		Creates a new clone of this object and all descendants.
		</div>
M
Refactored documentation system. No more XMLHttpRequest.  
Mr.doob 已提交
237
C
Reformatted docs to add method anchors  
Casey Grun 已提交
238 
		<h3>[method:Object3D getObjectByName]([page:String name], [page:Boolean recursive])</h3>
C
additions to documentation  
cjshannon 已提交
239 
		<div>
G
Filled in TODOs  
Greg Tatum 已提交
240 241 
		name -- String to match to the children's Object3d.name property. <br />
		recursive -- Boolean whether to search through the children's children. Default is false.
C
additions to documentation  
cjshannon 已提交
242 243 
		</div>
		<div>
G
Filled in TODOs  
Greg Tatum 已提交
244 
		Searches through the object's children and returns the first with a matching name, optionally recursive.
C
additions to documentation  
cjshannon 已提交
245 246 
		</div>
C
Reformatted docs to add method anchors  
Casey Grun 已提交
247 
		<h3>[method:Object3D getObjectById]([page:Integer id], [page:Boolean recursive])</h3>
C
additions to documentation  
cjshannon 已提交
248 
		<div>
G
Filled in TODOs  
Greg Tatum 已提交
249 250 
		id -- Unique number of the object instance<br />
		recursive -- Boolean whether to search through the children's children. Default is false.
C
additions to documentation  
cjshannon 已提交
251 252 
		</div>
		<div>
G
Filled in TODOs  
Greg Tatum 已提交
253 
		Searches through the object's children and returns the first with a matching id, optionally recursive.
C
additions to documentation  
cjshannon 已提交
254 
		</div>
M
Docs: Invisibles clean up. Started using Atom...  
Mr.doob 已提交
255
C
Reformatted docs to add method anchors  
Casey Grun 已提交
256 
		<h3>[method:Object3D translateOnAxis]([page:Vector3 axis], [page:Float distance])</h3>
C
additions to documentation  
cjshannon 已提交
257 
		<div>
G
Filled in TODOs  
Greg Tatum 已提交
258 259 
		axis -- A normalized vector in object space.<br />
		distance -- The distance to translate.
C
additions to documentation  
cjshannon 已提交
260 261 
		</div>
		<div>
G
Filled in TODOs  
Greg Tatum 已提交
262 
		Translate an object by distance along an axis in object space. The axis is assumed to be normalized.
C
additions to documentation  
cjshannon 已提交
263 
		</div>
M
Docs: Invisibles clean up. Started using Atom...  
Mr.doob 已提交
264
C
Reformatted docs to add method anchors  
Casey Grun 已提交
265 
		<h3>[method:Object3D rotateOnAxis]([page:Vector3 axis], [page:Float angle])</h3>
C
additions to documentation  
cjshannon 已提交
266 
		<div>
G
Filled in TODOs  
Greg Tatum 已提交
267 268 
		axis -- A normalized vector in object space. <br />
		angle -- The angle in radians.
C
additions to documentation  
cjshannon 已提交
269 270 
		</div>
		<div>
G
Filled in TODOs  
Greg Tatum 已提交
271 
		Rotate an object along an axis in object space. The axis is assumed to be normalized.
C
additions to documentation  
cjshannon 已提交
272 273 
		</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>