Skip to content

Commit 9f4693c

Browse files
committed
Completed Box3 documentation
1 parent 8faa50b commit 9f4693c

File tree

3 files changed

+135
-97
lines changed

3 files changed

+135
-97
lines changed

docs/api/math/Box2.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ <h2>Methods</h2>
4343

4444

4545

46-
<h3>.set([page:Vector2 min], [page:Vector2 max]) [page:todo]</h3>
46+
<h3>.set([page:Vector2 min], [page:Vector2 max]) [page:Box2 this]</h3>
4747
<div>
4848
min -- Lower (x, y) boundary of the box. <br />
4949
max -- Upper (x, y) boundary of the box.
@@ -52,7 +52,7 @@ <h3>.set([page:Vector2 min], [page:Vector2 max]) [page:todo]</h3>
5252
Sets the lower and upper (x, y) boundaries of this box.
5353
</div>
5454

55-
<h3>.expandByPoint([page:Vector2 point]) [page:Box2]</h3>
55+
<h3>.expandByPoint([page:Vector2 point]) [page:Box2 this]</h3>
5656
<div>
5757
point -- Point that should be included in the box.
5858
</div>
@@ -77,7 +77,7 @@ <h3>.isIntersectionBox([page:Box2 box]) [page:Boolean]</h3>
7777
Determines whether or not this box intersects *box*.
7878
</div>
7979

80-
<h3>.setFromPoints([page:Array points]) [page:Box2]</h3>
80+
<h3>.setFromPoints([page:Array points]) [page:Box2 this]</h3>
8181
<div>
8282
points -- Set of points that the resulting box will envelop.
8383
</div>
@@ -103,15 +103,15 @@ <h3>.union([page:Box2 box]) [page:Box2]</h3>
103103
lower bounds.
104104
</div>
105105

106-
<h3>.getParameter([page:Vector2 point]) [page:Vector2]</h3>
106+
<h3>.getParameter([page:Vector2 point], [page:Vector2 optionalTarget]) [page:Vector2]</h3>
107107
<div>
108108
point -- Point to parametrize.
109109
</div>
110110
<div>
111111
Returns point as a proportion of this box's width and height.
112112
</div>
113113

114-
<h3>.expandByScalar([page:float scalar]) [page:Box2]</h3>
114+
<h3>.expandByScalar([page:float scalar]) [page:Box2 this]</h3>
115115
<div>
116116
scalar -- Distance to expand.
117117
</div>
@@ -120,7 +120,7 @@ <h3>.expandByScalar([page:float scalar]) [page:Box2]</h3>
120120
will be contracted.
121121
</div>
122122

123-
<h3>.intersect([page:Box2 box]) [page:Box2]</h3>
123+
<h3>.intersect([page:Box2 box]) [page:Box2 this]</h3>
124124
<div>
125125
box -- Box to intersect with.
126126
</div>
@@ -139,7 +139,7 @@ <h3>.containsBox([page:Box2 box]) [page:Boolean]</h3>
139139
this function also returns true.
140140
</div>
141141

142-
<h3>.translate([page:Vector2 offset]) [page:Box2]</h3>
142+
<h3>.translate([page:Vector2 offset]) [page:Box2 this]</h3>
143143
<div>
144144
offset -- Direction and distance of offset.
145145
</div>
@@ -168,7 +168,7 @@ <h3>.equals([page:Box2 box]) [page:Boolean]</h3>
168168
Returns true if this box and *box* share the same lower and upper bounds.
169169
</div>
170170

171-
<h3>.expandByVector([page:Vector2 vector]) [page:Box2]</h3>
171+
<h3>.expandByVector([page:Vector2 vector]) [page:Box2 this]</h3>
172172
<div>
173173
vector -- Amount to expand this box in each dimension.
174174
</div>
@@ -178,15 +178,15 @@ <h3>.expandByVector([page:Vector2 vector]) [page:Box2]</h3>
178178
this box will be expanded by the y component of *vector* in both directions.
179179
</div>
180180

181-
<h3>.copy([page:Box2 box]) [page:Box2]</h3>
181+
<h3>.copy([page:Box2 box]) [page:Box2 this]</h3>
182182
<div>
183183
box -- Box to copy.
184184
</div>
185185
<div>
186186
Copies the values of *box* to this box.
187187
</div>
188188

189-
<h3>.makeEmpty() [page:Box2]</h3>
189+
<h3>.makeEmpty() [page:Box2 this]</h3>
190190
<div>
191191
Makes this box empty.
192192
</div>
@@ -210,13 +210,13 @@ <h3>.distanceToPoint([page:Vector2 point]) [page:Float]</h3>
210210

211211
<h3>.containsPoint([page:Vector2 point]) [page:Boolean]</h3>
212212
<div>
213-
point -- Point to check for inclusion.
213+
point -- [page:Vector2] to check for inclusion.
214214
</div>
215215
<div>
216216
Returns true if the specified point lies within the boundaries of this box.
217217
</div>
218218

219-
<h3>.setFromCenterAndSize([page:Vector2 center], [page:Vector2 size]) [page:Box2]</h3>
219+
<h3>.setFromCenterAndSize([page:Vector2 center], [page:Vector2 size]) [page:Box2 this]</h3>
220220
<div>
221221
center -- Desired center position of the box. <br />
222222
size -- Desired x and y dimensions of the box.

0 commit comments

Comments
 (0)