Skip to content

Commit a8b443a

Browse files
tschwmrdoob
tschw
authored and
mrdoob
committed
Documented Box3.applyMatrix4 doesn't work on empty boxes. (mrdoob#8621)
* Documented Box3.applyMatrix4 doesn't work on empty boxes. - See mrdoob#8620 * Updated math Box classes' docs, style consistency.
1 parent 2b55f4c commit a8b443a

File tree

2 files changed

+48
-47
lines changed

2 files changed

+48
-47
lines changed

‎docs/api/math/Box2.html‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ <h1>[name]</h1>
1616
<h2>Constructor</h2>
1717

1818

19-
<h3>[name]([page:Vector2 min], [page:Vector2 max])</h3>
19+
<h3>[name]( [page:Vector2 min], [page:Vector2 max] )</h3>
2020
<div>
2121
min -- Lower (x, y) boundary of the box.<br />
2222
max -- Upper (x, y) boundary of the box.
@@ -44,7 +44,7 @@ <h2>Methods</h2>
4444

4545

4646

47-
<h3>[method:Box2 set]([page:Vector2 min], [page:Vector2 max]) [page:Box2 this]</h3>
47+
<h3>[method:Box2 set]( [page:Vector2 min], [page:Vector2 max] ) [page:Box2 this]</h3>
4848
<div>
4949
min -- Lower (x, y) boundary of the box. <br />
5050
max -- Upper (x, y) boundary of the box.
@@ -53,15 +53,15 @@ <h3>[method:Box2 set]([page:Vector2 min], [page:Vector2 max]) [page:Box2 this]</
5353
Sets the lower and upper (x, y) boundaries of this box.
5454
</div>
5555

56-
<h3>[method:Box2 expandByPoint]([page:Vector2 point]) [page:Box2 this]</h3>
56+
<h3>[method:Box2 expandByPoint]( [page:Vector2 point] ) [page:Box2 this]</h3>
5757
<div>
5858
point -- Point that should be included in the box.
5959
</div>
6060
<div>
6161
Expands the boundaries of this box to include *point*.
6262
</div>
6363

64-
<h3>[method:Vector2 clampPoint]([page:Vector2 point], [page:Vector2 optionalTarget])</h3>
64+
<h3>[method:Vector2 clampPoint]( [page:Vector2 point], [page:Vector2 optionalTarget] ) [page:Box2 this]</h3>
6565
<div>
6666
point -- Position to clamp. <br />
6767
optionalTarget -- If specified, the clamped result will be copied here.
@@ -70,31 +70,31 @@ <h3>[method:Vector2 clampPoint]([page:Vector2 point], [page:Vector2 optionalTarg
7070
Clamps *point* within the bounds of this box.
7171
</div>
7272

73-
<h3>[method:Boolean intersectsBox]([page:Box2 box])</h3>
73+
<h3>[method:Boolean intersectsBox]( [page:Box2 box] ) [page:Box2 this]</h3>
7474
<div>
7575
box -- Box to check for intersection against.
7676
</div>
7777
<div>
7878
Determines whether or not this box intersects *box*.
7979
</div>
8080

81-
<h3>[method:Box2 setFromPoints]([page:Array points]) [page:Box2 this]</h3>
81+
<h3>[method:Box2 setFromPoints]( [page:Array points] ) [page:Box2 this]</h3>
8282
<div>
8383
points -- Set of points that the resulting box will envelop.
8484
</div>
8585
<div>
8686
Sets the upper and lower bounds of this box to include all of the points in *points*.
8787
</div>
8888

89-
<h3>[method:Vector2 size]([page:Vector2 optionalTarget])</h3>
89+
<h3>[method:Vector2 size]( [page:Vector2 optionalTarget] ) [page:Box2 this]</h3>
9090
<div>
9191
optionalTarget -- If specified, the result will be copied here.
9292
</div>
9393
<div>
9494
Returns the width and height of this box.
9595
</div>
9696

97-
<h3>[method:Box2 union]([page:Box2 box]) [page:Box2 this]</h3>
97+
<h3>[method:Box2 union]( [page:Box2 box] ) [page:Box2 this]</h3>
9898
<div>
9999
box -- Box that will be unioned with this box.
100100
</div>
@@ -104,7 +104,7 @@ <h3>[method:Box2 union]([page:Box2 box]) [page:Box2 this]</h3>
104104
lower bounds.
105105
</div>
106106

107-
<h3>[method:Vector2 getParameter]([page:Vector2 point], [page:Vector2 optionalTarget])</h3>
107+
<h3>[method:Vector2 getParameter]( [page:Vector2 point], [page:Vector2 optionalTarget] ) [page:Box2 this]</h3>
108108
<div>
109109
point -- [page:Vector2]<br/>
110110
optionalTarget -- [page:Vector2]<br/>
@@ -114,7 +114,7 @@ <h3>[method:Vector2 getParameter]([page:Vector2 point], [page:Vector2 optionalTa
114114
Returns a point as a proportion of this box's width and height.
115115
</div>
116116

117-
<h3>[method:Box2 expandByScalar]([page:float scalar]) [page:Box2 this]</h3>
117+
<h3>[method:Box2 expandByScalar]( [page:float scalar] ) [page:Box2 this]</h3>
118118
<div>
119119
scalar -- Distance to expand.
120120
</div>
@@ -123,7 +123,7 @@ <h3>[method:Box2 expandByScalar]([page:float scalar]) [page:Box2 this]</h3>
123123
will be contracted.
124124
</div>
125125

126-
<h3>[method:Box2 intersect]([page:Box2 box]) [page:Box2 this]</h3>
126+
<h3>[method:Box2 intersect]( [page:Box2 box] ) [page:Box2 this]</h3>
127127
<div>
128128
box -- Box to intersect with.
129129
</div>
@@ -133,7 +133,7 @@ <h3>[method:Box2 intersect]([page:Box2 box]) [page:Box2 this]</h3>
133133
lower bounds.
134134
</div>
135135

136-
<h3>[method:Boolean containsBox]([page:Box2 box])</h3>
136+
<h3>[method:Boolean containsBox]( [page:Box2 box] ) [page:Box2 this]</h3>
137137
<div>
138138
box -- Box to test for inclusion.
139139
</div>
@@ -142,7 +142,7 @@ <h3>[method:Boolean containsBox]([page:Box2 box])</h3>
142142
this function also returns true.
143143
</div>
144144

145-
<h3>[method:Box2 translate]([page:Vector2 offset]) [page:Box2 this]</h3>
145+
<h3>[method:Box2 translate]( [page:Vector2 offset] ) [page:Box2 this]</h3>
146146
<div>
147147
offset -- Direction and distance of offset.
148148
</div>
@@ -151,27 +151,27 @@ <h3>[method:Box2 translate]([page:Vector2 offset]) [page:Box2 this]</h3>
151151
*offset* units in 2D space.
152152
</div>
153153

154-
<h3>[method:Boolean isEmpty]()</h3>
154+
<h3>[method:Boolean isEmpty]() [page:Box2 this]</h3>
155155
<div>
156156
Returns true if this box includes zero points within its bounds.</br>
157157
Note that a box with equal lower and upper bounds still includes one point, the
158158
one both bounds share.
159159
</div>
160160

161-
<h3>[method:Box2 clone]()</h3>
161+
<h3>[method:Box2 clone]() [page:Box2 this]</h3>
162162
<div>
163163
Returns a copy of this box.
164164
</div>
165165

166-
<h3>[method:Boolean equals]([page:Box2 box])</h3>
166+
<h3>[method:Boolean equals]( [page:Box2 box] ) [page:Box2 this]</h3>
167167
<div>
168168
box -- Box to compare.
169169
</div>
170170
<div>
171171
Returns true if this box and *box* share the same lower and upper bounds.
172172
</div>
173173

174-
<h3>[method:Box2 expandByVector]([page:Vector2 vector]) [page:Box2 this]</h3>
174+
<h3>[method:Box2 expandByVector]( [page:Vector2 vector] ) [page:Box2 this]</h3>
175175
<div>
176176
vector -- Amount to expand this box in each dimension.
177177
</div>
@@ -181,7 +181,7 @@ <h3>[method:Box2 expandByVector]([page:Vector2 vector]) [page:Box2 this]</h3>
181181
this box will be expanded by the y component of *vector* in both directions.
182182
</div>
183183

184-
<h3>[method:Box2 copy]([page:Box2 box]) [page:Box2 this]</h3>
184+
<h3>[method:Box2 copy]( [page:Box2 box] ) [page:Box2 this]</h3>
185185
<div>
186186
box -- Box to copy.
187187
</div>
@@ -194,15 +194,15 @@ <h3>[method:Box2 makeEmpty]() [page:Box2 this]</h3>
194194
Makes this box empty.
195195
</div>
196196

197-
<h3>[method:Vector2 center]([page:Vector2 optionalTarget])</h3>
197+
<h3>[method:Vector2 center]( [page:Vector2 optionalTarget] ) [page:Box2 this]</h3>
198198
<div>
199199
optionalTarget -- If specified, the result will be copied here.
200200
</div>
201201
<div>
202202
Returns the center point of this box.
203203
</div>
204204

205-
<h3>[method:Float distanceToPoint]([page:Vector2 point])</h3>
205+
<h3>[method:Float distanceToPoint]( [page:Vector2 point] ) [page:Box2 this]</h3>
206206
<div>
207207
point -- Point to measure distance to.
208208
</div>
@@ -211,15 +211,15 @@ <h3>[method:Float distanceToPoint]([page:Vector2 point])</h3>
211211
If the point lies inside of this box, the distance will be 0.
212212
</div>
213213

214-
<h3>[method:Boolean containsPoint]([page:Vector2 point])</h3>
214+
<h3>[method:Boolean containsPoint]( [page:Vector2 point] ) [page:Box2 this]</h3>
215215
<div>
216216
point -- [page:Vector2] to check for inclusion.
217217
</div>
218218
<div>
219219
Returns true if the specified point lies within the boundaries of this box.
220220
</div>
221221

222-
<h3>[method:Box2 setFromCenterAndSize]([page:Vector2 center], [page:Vector2 size]) [page:Box2 this]</h3>
222+
<h3>[method:Box2 setFromCenterAndSize]( [page:Vector2 center], [page:Vector2 size] ) [page:Box2 this]</h3>
223223
<div>
224224
center -- Desired center position of the box. <br />
225225
size -- Desired x and y dimensions of the box.

0 commit comments

Comments
 (0)