Skip to content

Commit b948e1f

Browse files
s-rigaudSamuel Rigaud
and
Samuel Rigaud
authored
Docs: fix some typos (#30664)
Co-authored-by: Samuel Rigaud <[email protected]>
1 parent fe2a12c commit b948e1f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+72
-72
lines changed

examples/jsm/animation/AnimationClipCreator.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import {
1515
class AnimationClipCreator {
1616

1717
/**
18-
* Creates an animation clip that rotates a 3D object 360 degress
18+
* Creates an animation clip that rotates a 3D object 360 degrees
1919
* in the given period of time around the given axis.
2020
*
2121
* @param {number} period - The duration of the animation.
@@ -115,7 +115,7 @@ class AnimationClipCreator {
115115
}
116116

117117
/**
118-
* Creates an animation clip that toggles the visbility of a 3D object.
118+
* Creates an animation clip that toggles the visibility of a 3D object.
119119
*
120120
* @param {number} duration - The duration of the animation.
121121
* @return {AnimationClip} The created animation clip.

examples/jsm/animation/CCDIKSolver.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ class CCDIKSolver {
253253
}
254254

255255
/**
256-
* Creates a helper for visualizing tehh CCDIK.
256+
* Creates a helper for visualizing the CCDIK.
257257
*
258258
* @param {number} sphereSize - The sphere size.
259259
* @return {CCDIKHelper} The created helper.
@@ -395,7 +395,7 @@ class CCDIKHelper extends Object3D {
395395
} );
396396

397397
/**
398-
* A global line matreial.
398+
* A global line material.
399399
*
400400
* @type {LineBasicMaterial}
401401
*/

examples/jsm/controls/ArcballControls.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1532,7 +1532,7 @@ class ArcballControls extends Controls {
15321532
}
15331533

15341534
/**
1535-
* Applys a transformation matrix, to the camera and gizmos.
1535+
* Applies a transformation matrix, to the camera and gizmos.
15361536
*
15371537
* @private
15381538
* @param {Object} transformation - Object containing matrices to apply to camera and gizmos.

examples/jsm/csm/CSMFrustum.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ class CSMFrustum {
5757
/**
5858
* Setups this CSM frustum from the given projection matrix and max far value.
5959
*
60-
* @param {Matrix4} projectionMatrix - The projection matrix, ususally of the scene's camera.
60+
* @param {Matrix4} projectionMatrix - The projection matrix, usually of the scene's camera.
6161
* @param {number} maxFar - The maximum far value.
6262
* @returns {Object} An object representing the vertices of the near and far plane in view space.
6363
*/

examples/jsm/csm/CSMShadowNode.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ class CSMShadowNode extends ShadowBaseNode {
282282
}
283283

284284
/**
285-
* Sets the ligth breaks.
285+
* Sets the light breaks.
286286
*
287287
* @private
288288
*/

examples/jsm/exporters/EXRExporter.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class EXRExporter {
3232
/**
3333
* This method has two variants.
3434
*
35-
* - When exporting a data texture, it receives two paramters. The texture and the exporter options.
35+
* - When exporting a data texture, it receives two parameters. The texture and the exporter options.
3636
* - When exporting a render target (e.g. a PMREM), it receives three parameters. The renderer, the
3737
* render target and the exporter options.
3838
*

examples/jsm/exporters/GLTFExporter.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ class GLTFExporter {
201201
}
202202

203203
/**
204-
* Registers a plugin callback. This API is iternally used to implement the various
204+
* Registers a plugin callback. This API is internally used to implement the various
205205
* glTF extensions but can also used by third-party code to add additional logic
206206
* to the exporter.
207207
*

examples/jsm/exporters/KTX2Exporter.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ export class KTX2Exporter {
140140
/**
141141
* This method has two variants.
142142
*
143-
* - When exporting a data texture, it receives one paramter. The data or 3D data texture.
143+
* - When exporting a data texture, it receives one parameter. The data or 3D data texture.
144144
* - When exporting a render target (e.g. a PMREM), it receives two parameters. The renderer and the
145145
* render target.
146146
*

examples/jsm/exporters/PLYExporter.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ import {
99
/**
1010
* An exporter for PLY.
1111
*
12-
* PLY (Polygon or Stanford Triangle Format) is a file format for efficient delivery and l
13-
* oading of simple, static 3D content in a dense format. Both binary and ascii formats are
12+
* PLY (Polygon or Stanford Triangle Format) is a file format for efficient delivery and
13+
* loading of simple, static 3D content in a dense format. Both binary and ascii formats are
1414
* supported. PLY can store vertex positions, colors, normals and uv coordinates. No textures
1515
* or texture references are saved.
1616
*

examples/jsm/exporters/USDZExporter.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -824,12 +824,12 @@ function buildCamera( camera ) {
824824
* Export options of `USDZExporter`.
825825
*
826826
* @typedef {Object} USDZExporter~Options
827-
* @property {number} [maxTextureSize=1024] - The maxiumum texture size that is going to be exported.
827+
* @property {number} [maxTextureSize=1024] - The maximum texture size that is going to be exported.
828828
* @property {boolean} [includeAnchoringProperties=false] - Whether to include anchoring properties or not.
829829
* @property {Object} [ar] - If `includeAnchoringProperties` is set to `true`, the anchoring type and alignment
830830
* can be configured via `ar.anchoring.type` and `ar.planeAnchoring.alignment`.
831831
* @property {boolean} [quickLookCompatible=false] - Whether to make the exported USDZ compatible to QuickLook
832-
* which means the asset is modified to accomodate the bugs FB10036297 and FB11442287 (Apple Feedback).
832+
* which means the asset is modified to accommodate the bugs FB10036297 and FB11442287 (Apple Feedback).
833833
**/
834834

835835
/**

examples/jsm/geometries/DecalGeometry.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import {
1212
* This class can be used to create a decal mesh that serves different kinds of purposes e.g.
1313
* adding unique details to models, performing dynamic visual environmental changes or covering seams.
1414
*
15-
* Please not that decal projections can be distored when used around corners. More information at
15+
* Please not that decal projections can be distorted when used around corners. More information at
1616
* this GitHub issue: [Decal projections without distortions]{@link https://github.com/mrdoob/three.js/issues/21187}.
1717
*
1818
* Reference: [How to project decals]{@link http://blog.wolfire.com/2009/06/how-to-project-decals/}

examples/jsm/geometries/ParametricGeometry.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import {
55
} from 'three';
66

77
/**
8-
* This class can be used to generate a geometry based on a paremtric surface.
8+
* This class can be used to generate a geometry based on a parametric surface.
99
*
1010
* Reference: [Mesh Generation with Python]{@link https://prideout.net/blog/old/blog/index.html@p=44.html}
1111
*

examples/jsm/geometries/TextGeometry.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import {
1313
*
1414
* ```js
1515
* const loader = new FontLoader();
16-
* const fonst = await loader.loadAsync( 'fonts/helvetiker_regular.typeface.json' );
16+
* const font = await loader.loadAsync( 'fonts/helvetiker_regular.typeface.json' );
1717
* const geometry = new TextGeometry( 'Hello three.js!', {
1818
* font: font,
1919
* size: 80,

examples/jsm/interactive/InteractiveGroup.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ class InteractiveGroup extends Group {
131131

132132
/**
133133
* Calling this method makes sure the interactive group listens to Pointer and Mouse events.
134-
* The taret is the `domElement` of the given renderer. The camera is required for the internal
134+
* The target is the `domElement` of the given renderer. The camera is required for the internal
135135
* raycasting so 3D objects can be detected based on the events.
136136
*
137137
* @param {(WebGPURenderer|WebGLRenderer)} renderer - The renderer.

examples/jsm/interactive/SelectionBox.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -64,14 +64,14 @@ class SelectionBox {
6464
this.scene = scene;
6565

6666
/**
67-
* The start point of the selction.
67+
* The start point of the selection.
6868
*
6969
* @type {Vector3}
7070
*/
7171
this.startPoint = new Vector3();
7272

7373
/**
74-
* The end point of the selction.
74+
* The end point of the selection.
7575
*
7676
* @type {Vector3}
7777
*/

examples/jsm/lines/LineGeometry.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ class LineGeometry extends LineSegmentsGeometry {
4141
}
4242

4343
/**
44-
* Sets the given line positions for this goemetry.
44+
* Sets the given line positions for this geometry.
4545
*
4646
* @param {Float32|Array} array - The position data to set.
4747
* @return {LineGeometry} A reference to this geometry.
@@ -72,7 +72,7 @@ class LineGeometry extends LineSegmentsGeometry {
7272
}
7373

7474
/**
75-
* Sets the given line colors for this goemetry.
75+
* Sets the given line colors for this geometry.
7676
*
7777
* @param {Float32|Array} array - The position data to set.
7878
* @return {LineGeometry} A reference to this geometry.

examples/jsm/lines/LineSegmentsGeometry.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ class LineSegmentsGeometry extends InstancedBufferGeometry {
5050
}
5151

5252
/**
53-
* Applies the given 4x4 tranformation matrix to the geometry.
53+
* Applies the given 4x4 transformation matrix to the geometry.
5454
*
5555
* @param {Matrix4} matrix - The matrix to apply.
5656
* @return {LineSegmentsGeometry} A reference to this instance.
@@ -87,7 +87,7 @@ class LineSegmentsGeometry extends InstancedBufferGeometry {
8787
}
8888

8989
/**
90-
* Sets the given line positions for this goemetry. The length must be a multiple of six since
90+
* Sets the given line positions for this geometry. The length must be a multiple of six since
9191
* each line segment is defined by a start end vertex in the pattern `(xyz xyz)`.
9292
*
9393
* @param {Float32|Array} array - The position data to set.
@@ -124,7 +124,7 @@ class LineSegmentsGeometry extends InstancedBufferGeometry {
124124
}
125125

126126
/**
127-
* Sets the given line colors for this goemetry. The length must be a multiple of six since
127+
* Sets the given line colors for this geometry. The length must be a multiple of six since
128128
* each line segment is defined by a start end color in the pattern `(rgb rgb)`.
129129
*
130130
* @param {Float32|Array} array - The position data to set.

examples/jsm/math/ConvexHull.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ class ConvexHull {
150150
*
151151
* @param {Ray} ray - The ray to test.
152152
* @param {Vector3} target - The target vector that is used to store the method's result.
153-
* @return {Vector3|null} The intersection point. Returns `null` if not intesection was detected.
153+
* @return {Vector3|null} The intersection point. Returns `null` if not intersection was detected.
154154
*/
155155
intersectRay( ray, target ) {
156156

@@ -1575,7 +1575,7 @@ class VertexList {
15751575
}
15761576

15771577
/**
1578-
* ppends a chain of vertices where the given vertex is the head.
1578+
* Appends a chain of vertices where the given vertex is the head.
15791579
*
15801580
* @private
15811581
* @param {VertexNode} vertex - The head vertex of a chain of vertices.

examples/jsm/math/Octree.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ class Octree {
136136
}
137137

138138
/**
139-
* Adds the given triangle to the Octree. The triangle vertices are clampled if they exceed
139+
* Adds the given triangle to the Octree. The triangle vertices are clamped if they exceed
140140
* the bounds of the Octree.
141141
*
142142
* @param {Triangle} triangle - The triangle to add.

examples/jsm/math/SimplexNoise.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ class SimplexNoise {
1010
* Constructs a new simplex noise object.
1111
*
1212
* @param {Object} [r=Math] - A math utility class that holds a `random()` method. This makes it
13-
* possiblet o pass in custom random number generator.
13+
* possible to pass in custom random number generator.
1414
*/
1515
constructor( r = Math ) {
1616

examples/jsm/modifiers/CurveModifierGPU.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ function initSplineTexture( numberOfCurves = 1 ) {
4747
/**
4848
* Write the curve description to the data texture.
4949
*
50-
* @privaate
50+
* @private
5151
* @param {DataTexture} texture - The data texture to write to.
5252
* @param {Curve} splineCurve - The curve to describe.
5353
* @param {number} [offset=0] - Which curve slot to write to.

examples/jsm/modifiers/EdgeSplitModifier.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ class EdgeSplitModifier {
2222

2323
/**
2424
* Returns a new, modified version of the given geometry by applying an edge-split operation.
25-
* Please note that the resutling geometry is always indexed.
25+
* Please note that the resulting geometry is always indexed.
2626
*
2727
* @param {BufferGeometry} geometry - The geometry to modify.
2828
* @param {number} cutOffAngle - The cut off angle in radians.
2929
* @param {boolean} [tryKeepNormals=true] - Whether to try to keep normals or not.
30-
* @return {BufferGeometry} A new, modified goemetry.
30+
* @return {BufferGeometry} A new, modified geometry.
3131
*/
3232
modify( geometry, cutOffAngle, tryKeepNormals = true ) {
3333

examples/jsm/modifiers/SimplifyModifier.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ class SimplifyModifier {
2626

2727
/**
2828
* Returns a new, modified version of the given geometry by applying a simplification.
29-
* Please note that the resutling geometry is always non-indexed.
29+
* Please note that the resulting geometry is always non-indexed.
3030
*
3131
* @param {BufferGeometry} geometry - The geometry to modify.
3232
* @param {number} count - The number of vertices to remove.
33-
* @return {BufferGeometry} A new, modified goemetry.
33+
* @return {BufferGeometry} A new, modified geometry.
3434
*/
3535
modify( geometry, count ) {
3636

examples/jsm/modifiers/TessellateModifier.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ class TessellateModifier {
4545

4646
/**
4747
* Returns a new, modified version of the given geometry by applying a tesselation.
48-
* Please note that the resutling geometry is always non-indexed.
48+
* Please note that the resulting geometry is always non-indexed.
4949
*
5050
* @param {BufferGeometry} geometry - The geometry to modify.
51-
* @return {BufferGeometry} A new, modified goemetry.
51+
* @return {BufferGeometry} A new, modified geometry.
5252
*/
5353
modify( geometry ) {
5454

examples/jsm/renderers/Projector.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ class RenderableSprite {
123123
/**
124124
* This class can project a given scene in 3D space into a 2D representation
125125
* used for rendering with a 2D API. `Projector` is currently used by {@link SVGRenderer}
126-
* and was previosuly used by the legacy `CanvasRenderer`.
126+
* and was previously used by the legacy `CanvasRenderer`.
127127
*/
128128
class Projector {
129129

examples/jsm/renderers/SVGRenderer.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ class SVGRenderer {
273273
}
274274

275275
/**
276-
* Performs a manual clear with the defined clera color.
276+
* Performs a manual clear with the defined clear color.
277277
*/
278278
this.clear = function () {
279279

manual/ru/primitives.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ <h1>Примитивы </h1>
217217
как то, что справа.</p>
218218
<p>Другие исключения - это 2-строчные примеры для <a href="/docs/#api/en/geometries/EdgesGeometry"><code class="notranslate" translate="no">EdgesGeometry</code></a>
219219
и <a href="/docs/#api/en/geometries/WireframeGeometry"><code class="notranslate" translate="no">WireframeGeometry</code></a>. Вместо того, чтобы вызвать <code class="notranslate" translate="no">addSolidGeometry</code>
220-
они вызвают <code class="notranslate" translate="no">addLineGeomtry</code> который выглядит так</p>
220+
они вызвают <code class="notranslate" translate="no">addLineGeometry</code> который выглядит так</p>
221221
<pre class="prettyprint showlinemods notranslate notranslate" translate="no">function addLineGeometry(x, y, geometry) {
222222
const material = new THREE.LineBasicMaterial({color: 0x000000});
223223
const mesh = new THREE.LineSegments(geometry, material);

src/animation/AnimationAction.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ class AnimationAction {
124124
this.paused = false;
125125

126126
/**
127-
* If set to `false`, the action is disabeled so it has no impact.
127+
* If set to `false`, the action is disabled so it has no impact.
128128
*
129129
* When the action is re-enabled, the animation continues from its current
130130
* time (setting `enabled` to `false` doesn't reset the action).

src/animation/AnimationMixer.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -543,7 +543,7 @@ class AnimationMixer extends EventDispatcher {
543543
* will be created by this method. Calling this method several times with the
544544
* same clip and root parameters always returns the same action.
545545
*
546-
* @param {AnimationClip|string} clip - An animaion clip or alternatively the name of the animation clip.
546+
* @param {AnimationClip|string} clip - An animation clip or alternatively the name of the animation clip.
547547
* @param {Object3D} [optionalRoot] - An alternative root object.
548548
* @param {(NormalAnimationBlendMode|AdditiveAnimationBlendMode)} [blendMode] - The blend mode.
549549
* @return {?AnimationAction} The animation action.
@@ -612,7 +612,7 @@ class AnimationMixer extends EventDispatcher {
612612
/**
613613
* Returns an existing animation action for the passed clip.
614614
*
615-
* @param {AnimationClip|string} clip - An animaion clip or alternatively the name of the animation clip.
615+
* @param {AnimationClip|string} clip - An animation clip or alternatively the name of the animation clip.
616616
* @param {Object3D} [optionalRoot] - An alternative root object.
617617
* @return {?AnimationAction} The animation action. Returns `null` if no action was found.
618618
*/
@@ -833,7 +833,7 @@ class AnimationMixer extends EventDispatcher {
833833
* given clip and an optional root object. Before using this method make
834834
* sure to call {@link AnimationAction#stop} to deactivate the action.
835835
*
836-
* @param {AnimationClip|string} clip - An animaion clip or alternatively the name of the animation clip.
836+
* @param {AnimationClip|string} clip - An animation clip or alternatively the name of the animation clip.
837837
* @param {Object3D} [optionalRoot] - An alternative root object.
838838
*/
839839
uncacheAction( clip, optionalRoot ) {

0 commit comments

Comments
 (0)