Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 5 additions & 2 deletions docs/api/geometries/BoxBufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,12 @@ <h3>[name]([param:Float width], [param:Float height], [param:Float depth], [para

<h2>Properties</h2>

<h3>.parameters</h3>
<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>
<p>Using the above example code above as our basis:</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}
cube.geometry.parameters; // as above
Expand Down
7 changes: 5 additions & 2 deletions docs/api/geometries/BoxGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,12 @@ <h3>[name]([param:Float width], [param:Float height], [param:Float depth], [para

<h2>Properties</h2>

<h3>.parameters</h3>
<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>
<p>Using the above example code above as our basis:</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}
cube.geometry.parameters; // as above
Expand Down
7 changes: 7 additions & 0 deletions docs/api/geometries/CircleBufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,13 @@ <h3>[name]([param:Float radius], [param:Integer segments], [param:Float thetaSta
thetaLength — The central angle, often called theta, of the circular sector. The default is 2*Pi, which makes for a complete circle.
</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>

<h2>Source</h2>

[link:https://github.com/mrdoob/three.js/blob/master/src/geometries/CircleGeometry.js src/geometries/CircleGeometry.js]
Expand Down
7 changes: 7 additions & 0 deletions docs/api/geometries/CircleGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,13 @@ <h3>[name]([param:Float radius], [param:Integer segments], [param:Float thetaSta
thetaLength — The central angle, often called theta, of the circular sector. The default is 2*Pi, which makes for a complete circle.
</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>

<h2>Source</h2>

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
Expand Down
3 changes: 2 additions & 1 deletion docs/api/geometries/ConeBufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,9 @@ <h3>[name]([param:Float radius], [param:Float height], [param:Integer radialSegm

<h2>Properties</h2>

<h3>[property:Object parameters]</h3>
<p>
Each of the constructor parameters is accessible as a property of the same name. Any modification of these properties after instantiation does not change the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>

<h2>Source</h2>
Expand Down
3 changes: 2 additions & 1 deletion docs/api/geometries/ConeGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,9 @@ <h3>[name]([param:Float radius], [param:Float height], [param:Integer radialSegm

<h2>Properties</h2>

<h3>[property:Object parameters]</h3>
<p>
Each of the constructor parameters is accessible as a property of the same name. Any modification of these properties after instantiation does not change the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>

<h2>Source</h2>
Expand Down
3 changes: 2 additions & 1 deletion docs/api/geometries/CylinderBufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,9 @@ <h3>[name]([param:Float radiusTop], [param:Float radiusBottom], [param:Float hei

<h2>Properties</h2>

<h3>[property:Object parameters]</h3>
<p>
Each of the constructor parameters is accessible as a property of the same name. Any modification of these properties after instantiation does not change the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>

<h2>Source</h2>
Expand Down
3 changes: 2 additions & 1 deletion docs/api/geometries/CylinderGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,9 @@ <h3>[name]([param:Float radiusTop], [param:Float radiusBottom], [param:Float hei

<h2>Properties</h2>

<h3>[property:Object parameters]</h3>
<p>
Each of the constructor parameters is accessible as a property of the same name. Any modification of these properties after instantiation does not change the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>

<h2>Source</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/geometries/DodecahedronBufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ <h2>Properties</h2>

<h3>[property:Object parameters]</h3>
<p>
An object with all of the parameters that were used to generate the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>

<h2>Source</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/geometries/DodecahedronGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ <h2>Properties</h2>

<h3>[property:Object parameters]</h3>
<p>
An object with all of the parameters that were used to generate the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>

<h2>Source</h2>
Expand Down
7 changes: 7 additions & 0 deletions docs/api/geometries/EdgesGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,13 @@ <h3>[name]( [param:Geometry geometry], [param:Integer thresholdAngle] )</h3>
thresholdAngle — An edge is only rendered if the angle (in degrees) between the face normals of the adjoining faces exceeds this value. default = 1 degree.
</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>

<h2>Source</h2>

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
Expand Down
7 changes: 7 additions & 0 deletions docs/api/geometries/ExtrudeBufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,13 @@ <h3>[name]([param:Array shapes], [param:Object options])</h3>
applied to the face; the second material will be applied to the sides.
</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>

<h2>Source</h2>

[link:https://github.com/mrdoob/three.js/blob/master/src/geometries/ExtrudeGeometry.js src/geometries/ExtrudeGeometry.js]
Expand Down
7 changes: 7 additions & 0 deletions docs/api/geometries/ExtrudeGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,13 @@ <h3>[name]([param:Array shapes], [param:Object options])</h3>
applied to the face; the second material will be applied to the sides.
</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>

<h2>Source</h2>

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
Expand Down
2 changes: 1 addition & 1 deletion docs/api/geometries/IcosahedronBufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ <h2>Properties</h2>

<h3>[property:Object parameters]</h3>
<p>
An object with all of the parameters that were used to generate the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>

<h2>Source</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/geometries/IcosahedronGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ <h2>Properties</h2>

<h3>[property:Object parameters]</h3>
<p>
An object with all of the parameters that were used to generate the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>

<h2>Source</h2>
Expand Down
7 changes: 7 additions & 0 deletions docs/api/geometries/LatheBufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,13 @@ <h3>[name]([param:Array points], [param:Integer segments], [param:Float phiStart
This creates a LatheBufferGeometry based on the parameters.
</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>

<h2>Source</h2>

[link:https://github.com/mrdoob/three.js/blob/master/src/geometries/LatheGeometry.js src/geometries/LatheGeometry.js]
Expand Down
7 changes: 7 additions & 0 deletions docs/api/geometries/LatheGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,13 @@ <h3>[name]([param:Array points], [param:Integer segments], [param:Float phiStart
This creates a LatheGeometry based on the parameters.
</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>

<h2>Source</h2>

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
Expand Down
2 changes: 1 addition & 1 deletion docs/api/geometries/OctahedronBufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ <h2>Properties</h2>

<h3>[property:Object parameters]</h3>
<p>
An object with all of the parameters that were used to generate the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>

<h2>Source</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/geometries/OctahedronGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ <h2>Properties</h2>

<h3>[property:Object parameters]</h3>
<p>
An object with all of the parameters that were used to generate the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>

<h2>Source</h2>
Expand Down
7 changes: 7 additions & 0 deletions docs/api/geometries/ParametricBufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,13 @@ <h3>[name]([param:Function func], [param:Integer slices], [param:Integer stacks]
stacks — The count of stacks to use for the parametric function
</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>


<h2>Source</h2>

Expand Down
8 changes: 8 additions & 0 deletions docs/api/geometries/ParametricGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,14 @@ <h3>[name]([param:Function func], [param:Integer slices], [param:Integer stacks]
</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>


<h2>Source</h2>

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
Expand Down
3 changes: 2 additions & 1 deletion docs/api/geometries/PlaneBufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,9 @@ <h3>[name]([param:Float width], [param:Float height], [param:Integer widthSegmen

<h2>Properties</h2>

<h3>.parameters</h3>
<p>
Each of the contructor parameters is accessible as a property of the same name. Any modification of these properties after instantiation does not change the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>

<h2>Source</h2>
Expand Down
3 changes: 2 additions & 1 deletion docs/api/geometries/PlaneGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,9 @@ <h3>[name]([param:Float width], [param:Float height], [param:Integer widthSegmen

<h2>Properties</h2>

<h3>.parameters</h3>
Copy link
Collaborator

@Mugen87 Mugen87 Jun 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there are reason why you have added this line only in certain files? It would be consistent if you apply this change to all geometry pages. Same for the subsequent description.

Copy link
Contributor Author

@taybenlor taybenlor Jun 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've made it more consistent now. Also for the subsequent description. From cursory browsing .parameters is mentioned in the other Geometry classes, in a slightly different way. I just found + replaced the ones that were all using the same wording.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are still pages like CircleGeometry that don't have any docs about their parameters. Besides, the formatting of parameters should be similar to the one in DodecahedronGeometry.

<h3>[property:Object parameters]</h3>

In this way it is more consistent to the rest of the docs.

<p>
Each of the contructor parameters is accessible in the parameters property of the object. Any modification of these properties after instantiation does not change the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>

<h2>Source</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/geometries/PolyhedronBufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ <h2>Properties</h2>

<h3>[property:Object parameters]</h3>
<p>
An object with all of the parameters that were used to generate the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>


Expand Down
2 changes: 1 addition & 1 deletion docs/api/geometries/PolyhedronGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ <h2>Properties</h2>

<h3>[property:Object parameters]</h3>
<p>
An object with all of the parameters that were used to generate the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>


Expand Down
9 changes: 9 additions & 0 deletions docs/api/geometries/RingBufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,15 @@ <h3>[name]([param:Float innerRadius], [param:Float outerRadius], [param:Integer
thetaLength — Central angle. Default is Math.PI * 2.
</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>


<h2>Source</h2>

[link:https://github.com/mrdoob/three.js/blob/master/src/geometries/RingGeometry.js src/geometries/RingGeometry.js]
Expand Down
8 changes: 8 additions & 0 deletions docs/api/geometries/RingGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,14 @@ <h3>[name]([param:Float innerRadius], [param:Float outerRadius], [param:Integer
thetaLength — Central angle. Default is Math.PI * 2.
</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>


<h2>Source</h2>

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
Expand Down
7 changes: 7 additions & 0 deletions docs/api/geometries/ShapeBufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,13 @@ <h3>[name]([param:Array shapes], [param:Integer curveSegments])</h3>
curveSegments - [page:Integer] - Number of segments per shape. Default is 12.
</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>

<h2>Source</h2>

[link:https://github.com/mrdoob/three.js/blob/master/src/geometries/ShapeGeometry.js src/geometries/ShapeGeometry.js]
Expand Down
7 changes: 7 additions & 0 deletions docs/api/geometries/ShapeGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,13 @@ <h3>[name]([param:Array shapes], [param:Integer curveSegments])</h3>
curveSegments - [page:Integer] - Number of segments per shape. Default is 12.
</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>


<h2>Source</h2>

Expand Down
3 changes: 2 additions & 1 deletion docs/api/geometries/SphereBufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,9 @@ <h3>[name]([param:Float radius], [param:Integer widthSegments], [param:Integer h

<h2>Properties</h2>

<h3>.parameters</h3>
<p>
Each of the contructor parameters is accessible as a property of the same name. Any modification of these properties after instantiation does not change the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>

<h2>Source</h2>
Expand Down
3 changes: 2 additions & 1 deletion docs/api/geometries/SphereGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,9 @@ <h3>[name]([param:Float radius], [param:Integer widthSegments], [param:Integer h

<h2>Properties</h2>

<h3>.parameters</h3>
<p>
Each of the contructor parameters is accessible as a property of the same name. Any modification of these properties after instantiation does not change the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>

<h2>Source</h2>
Expand Down
4 changes: 3 additions & 1 deletion docs/api/geometries/TetrahedronBufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,11 @@ <h2>Properties</h2>

<h3>[property:Object parameters]</h3>
<p>
An object with all of the parameters that were used to generate the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>



<h2>Source</h2>

[link:https://github.com/mrdoob/three.js/blob/master/src/geometries/TetrahedronGeometry.js src/geometries/TetrahedronGeometry.js]
Expand Down
2 changes: 1 addition & 1 deletion docs/api/geometries/TetrahedronGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ <h2>Properties</h2>

<h3>[property:Object parameters]</h3>
<p>
An object with all of the parameters that were used to generate the geometry.
An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
</p>

<h2>Source</h2>
Expand Down
Loading