Skip to content

Improve docs for Box3 and BoxHelper #16339

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
merged 10 commits into from
May 17, 2019
Merged

Improve docs for Box3 and BoxHelper #16339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
11721f4
improve docs for BoxHelper
jotaro-sama Apr 27, 2019
469b967
fix typos in code example
jotaro-sama Apr 27, 2019
aa0c14e
make introduction clearer
jotaro-sama Apr 27, 2019
13bb331
change minimum to axis-aligned bounding boxes
jotaro-sama Apr 27, 2019
aed16bc
correct box3 description
jotaro-sama Apr 28, 2019
fab275a
make boxhelper docs clearer
jotaro-sama Apr 28, 2019
0762988
remove "which are used for collision detection"
jotaro-sama Apr 29, 2019
789f648
fix code example
jotaro-sama Apr 29, 2019
7878fbf
revert boxhelper example, add box3 example
jotaro-sama May 2, 2019
480fd36
fix box3 example
jotaro-sama May 3, 2019
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
12 changes: 6 additions & 6 deletions docs/api/en/helpers/BoxHelper.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
<h1>[name]</h1>

<p class="desc">
Helper object to show the world-axis-aligned bounding box around an object.

Helper object to graphically show the world-axis-aligned bounding box around an object. The actual bounding box is handled with [page:Box3], this is just a visual helper for debugging.
It can be automatically resized with the [page:BoxHelper.update] method when the object it's created from is transformed.
Note that the object must have a [page:Geometry] or [page:BufferGeometry] for this to work,
so it won't work with [page:Sprite Sprites].
</p>
Expand All @@ -28,10 +28,10 @@ <h2>Example</h2>


<code>
var sphere = new THREE.SphereGeometry();
var object = new THREE.Mesh( sphere, new THREE.MeshBasicMaterial( 0xff0000 ) );
var box = new THREE.BoxHelper( object, 0xffff00 );
scene.add( box );
var sphere = new THREE.SphereGeometry();
var object = new THREE.Mesh( sphere, new THREE.MeshBasicMaterial( 0xff0000 ) );
var box = new THREE.BoxHelper( object, 0xffff00 );
scene.add( box );
</code>


Expand Down
24 changes: 22 additions & 2 deletions docs/api/en/math/Box3.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,31 @@ <h1>[name]</h1>

<p class="desc">
Represents a box or cube in 3D space. The main purpose of this is to represent
the [link:https://en.wikipedia.org/wiki/Minimum_bounding_box Minimum Bounding Boxes]
for objects.
the world-axis-aligned bounding boxes for objects.
</p>


<h2>Example</h2>

<code>
// Creating the object whose bounding box we want to compute
var sphereObject = new THREE.Mesh(
new THREE.SphereGeometry(),
new THREE.MeshBasicMaterial( 0xff0000 )
);
// Creating the actual bounding box with Box3
sphereObject.geometry.computeBoundingBox();
var box = sphereObject.geometry.boundingBox.clone();

// ...

// In the animation loop, to keep the bounding box updated after move/rotate/scale operations
sphereObject.updateMatrixWorld( true );
box.copy( sphereObject.geometry.boundingBox ).applyMatrix4( sphereObject.matrixWorld );
</code>



<h2>Constructor</h2>


Expand Down