Skip to content

Docs: Improved BoxBufferGeometry #15129

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 3 commits into from
Dec 19, 2018
Merged

Docs: Improved BoxBufferGeometry #15129

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a86575e
Update BoxBufferGeometry.html
rexdk Oct 24, 2018
e5e3d19
Update BoxBufferGeometry.html
rexdk Oct 26, 2018
9a30f28
Update BoxBufferGeometry.html
rexdk Nov 30, 2018
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
28 changes: 15 additions & 13 deletions docs/api/en/geometries/BoxBufferGeometry.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,29 +44,31 @@ <h2>Constructor</h2>

<h3>[name]([param:Float width], [param:Float height], [param:Float depth], [param:Integer widthSegments], [param:Integer heightSegments], [param:Integer depthSegments])</h3>
<p>
width — Width of the sides on the X axis. Default is 1.<br />
height — Height of the sides on the Y axis. Default is 1.<br />
depth — Depth of the sides on the Z axis. Default is 1.<br />
widthSegments — Optional. Number of segmented faces along the width of the sides. Default is 1.<br />
heightSegments — Optional. Number of segmented faces along the height of the sides. Default is 1.<br />
depthSegments — Optional. Number of segmented faces along the depth of the sides. Default is 1.
width — Width; that is, the length of the edges parallel to the X axis. Optional; defaults to 1.<br />
height — Height; that is, the length of the edges parallel to the Y axis. Optional; defaults to 1.<br />
depth — Depth; that is, the length of the edges parallel to the Z axis. Optional; defaults to 1.<br />
widthSegments — Number of segmented rectangular faces along the width of the sides. Optional; defaults to 1.<br />
heightSegments — Number of segmented rectangular faces along the height of the sides. Optional; defaults to 1.<br />
depthSegments — Number of segmented rectangular faces along the depth of the sides. Optional; defaults to 1.<br />
</p>

<h2>Properties</h2>

<h3>[property:Object parameters]</h3>
<p>
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>
<p>
Using the above example code above as our basis:
<code>
geometry.parameters; // outputs an object {width: 1, height: 1, depth: 1, widthSegments: undefined, heightSegments: undefined}
Using the above example:
<code>
geometry.parameters; // {width: 1, height: 1, depth: 1, widthSegments: undefined, heightSegments: undefined, depthSegments: undefined}
cube.geometry.parameters; // as above
cube.geometry.parameters.width; // === 1
cube.geometry.parameters.widthSegments // === undefined.
</code>
</p>
cube.geometry.parameters.widthSegments; // === undefined.
</code>
</p>

<h2>Methods</h2>

<h2>Source</h2>

Expand Down