Skip to content

Docs: Update Box3 #19664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mrdoob merged 1 commit into from
Jun 16, 2020
Merged

Docs: Update Box3 #19664

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions docs/api/en/math/Box3.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ <h3>[property:Vector3 max]</h3>

<h2>Methods</h2>

<h3>[method:Box3 applyMatrix4]( [param:Matrix4 matrix] )</h3>
<h3>[method:this applyMatrix4]( [param:Matrix4 matrix] )</h3>
<p>
[page:Matrix4 matrix] - The [page:Matrix4] to apply<br /><br />

Expand Down Expand Up @@ -99,7 +99,7 @@ <h3>[method:Boolean containsPoint]( [param:Vector3 point] )</h3>
Returns true if the specified [page:Vector3 point] lies within or on the boundaries of this box.
</p>

<h3>[method:Box3 copy]( [param:Box3 box] )</h3>
<h3>[method:this copy]( [param:Box3 box] )</h3>
<p>
[page:Box3 box] - [page:Box3] to copy.<br /><br />

Expand All @@ -122,7 +122,7 @@ <h3>[method:Boolean equals]( [param:Box3 box] )</h3>
Returns true if this box and [page:Box3 box] share the same lower and upper bounds.
</p>

<h3>[method:Box3 expandByObject]( [param:Object3D object] )</h3>
<h3>[method:this expandByObject]( [param:Object3D object] )</h3>
<p>
[page:Object3D object] - [page:Object3D] to expand the box by.<br /><br />

Expand All @@ -132,22 +132,22 @@ <h3>[method:Box3 expandByObject]( [param:Object3D object] )</h3>

</p>

<h3>[method:Box3 expandByPoint]( [param:Vector3 point] )</h3>
<h3>[method:this expandByPoint]( [param:Vector3 point] )</h3>
<p>
[page:Vector3 point] - [page:Vector3] that should be included in the box.<br /><br />

Expands the boundaries of this box to include [page:Vector3 point].
</p>

<h3>[method:Box3 expandByScalar]( [param:float scalar] )</h3>
<h3>[method:this expandByScalar]( [param:float scalar] )</h3>
<p>
[page:float scalar] - Distance to expand the box by.<br /><br />

Expands each dimension of the box by [page:float scalar]. If negative, the dimensions of the box
will be contracted.
</p>

<h3>[method:Box3 expandByVector]( [param:Vector3 vector] )</h3>
<h3>[method:this expandByVector]( [param:Vector3 vector] )</h3>
<p>
[page:Vector3 vector] - [page:Vector3] to expand the box by.<br /><br />

Expand Down Expand Up @@ -186,13 +186,13 @@ <h3>[method:Vector3 getSize]( [param:Vector3 target] )</h3>
Returns the width, height and depth of this box.
</p>

<h3>[method:Box3 intersect]( [param:Box3 box] )</h3>
<h3>[method:this intersect]( [param:Box3 box] )</h3>
<p>
[page:Box3 box] - Box to intersect with.<br /><br />

Returns the intersection of this and [page:Box3 box], setting the upper bound of this box to the lesser
Computes the intersection of this and [page:Box3 box], setting the upper bound of this box to the lesser
of the two boxes' upper bounds and the lower bound of this box to the greater of the two boxes'
lower bounds.
lower bounds. If there's no overlap, makes this box empty.
</p>

<h3>[method:Boolean intersectsBox]( [param:Box3 box] )</h3>
Expand Down Expand Up @@ -230,10 +230,10 @@ <h3>[method:Boolean isEmpty]()</h3>
the one both bounds share.
</p>

<h3>[method:Box3 makeEmpty]()</h3>
<h3>[method:this makeEmpty]()</h3>
<p>Makes this box empty.</p>

<h3>[method:Box3 set]( [param:Vector3 min], [param:Vector3 max] )</h3>
<h3>[method:this set]( [param:Vector3 min], [param:Vector3 max] )</h3>
<p>
[page:Vector3 min] - [page:Vector3] representing the lower (x, y, z) boundary of the box.<br />
[page:Vector3 max] - [page:Vector3] representing the lower upper (x, y, z) boundary of the box.<br /><br />
Expand All @@ -242,21 +242,21 @@ <h3>[method:Box3 set]( [param:Vector3 min], [param:Vector3 max] )</h3>
Please note that this method only copies the values from the given objects.
</p>

<h3>[method:Box3 setFromArray]( [param:Array array] ) [param:Box3 this]</h3>
<h3>[method:this setFromArray]( [param:Array array] )</h3>
<p>
array -- An array of position data that the resulting box will envelop.<br /><br />

Sets the upper and lower bounds of this box to include all of the data in *array*.
</p>

<h3>[method:Box3 setFromBufferAttribute]( [param:BufferAttribute attribute] ) [param:Box3 this]</h3>
<h3>[method:this setFromBufferAttribute]( [param:BufferAttribute attribute] )</h3>
<p>
[page:BufferAttribute attribute] - A buffer attribute of position data that the resulting box will envelop.<br /><br />

Sets the upper and lower bounds of this box to include all of the data in [page:BufferAttribute attribute].
</p>

<h3>[method:Box3 setFromCenterAndSize]( [param:Vector3 center], [param:Vector3 size] ) [param:Box3 this]</h3>
<h3>[method:this setFromCenterAndSize]( [param:Vector3 center], [param:Vector3 size] )</h3>
<p>
[page:Vector3 center], - Desired center position of the box. <br>
[page:Vector3 size] - Desired x, y and z dimensions of the box.<br /><br />
Expand All @@ -265,7 +265,7 @@ <h3>[method:Box3 setFromCenterAndSize]( [param:Vector3 center], [param:Vector3 s
in [page:Vector3 size]
</p>

<h3>[method:Box3 setFromObject]( [param:Object3D object] )</h3>
<h3>[method:this setFromObject]( [param:Object3D object] )</h3>
<p>
[page:Object3D object] - [page:Object3D] to compute the bounding box of.<br /><br />

Expand All @@ -275,26 +275,26 @@ <h3>[method:Box3 setFromObject]( [param:Object3D object] )</h3>

</p>

<h3>[method:Box3 setFromPoints]( [param:Array points] )</h3>
<h3>[method:this setFromPoints]( [param:Array points] )</h3>
<p>
[page:Array points] - Array of [page:Vector3 Vector3s] that the resulting box will contain.<br /><br />

Sets the upper and lower bounds of this box to include all of the points in [page:Array points].
</p>

<h3>[method:Box3 translate]( [param:Vector3 offset] )</h3>
<h3>[method:this translate]( [param:Vector3 offset] )</h3>
<p>
[page:Vector3 offset] - Direction and distance of offset.<br /><br />

Adds [page:Vector3 offset] to both the upper and lower bounds of this box, effectively moving this box
[page:Vector3 offset] units in 3D space.
</p>

<h3>[method:Box3 union]( [param:Box3 box] )</h3>
<h3>[method:this union]( [param:Box3 box] )</h3>
<p>
[page:Box3 box] - Box that will be unioned with this box.<br /><br />

Unions this box with [page:Box3 box], setting the upper bound of this box to the greater of the
Computes the union of this box and [page:Box3 box], setting the upper bound of this box to the greater of the
two boxes' upper bounds and the lower bound of this box to the lesser of the two boxes'
lower bounds.
</p>
Expand Down