Skip to content

Commit 7f50ffc

Browse files
mrdoobmrdoob
authored
Merge pull request #18217 from mrdoob/docs
Docs: Removed internal is* properties.
2 parents ff397bd + 8badf77 commit 7f50ffc

File tree

133 files changed

+0
-900
lines changed

Some content is hidden

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

133 files changed

+0
-900
lines changed

‎docs/api/en/cameras/Camera.html

-7
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,6 @@ <h3>[name]()</h3>
3030
<h2>Properties</h2>
3131
<p>See the base [page:Object3D] class for common properties.</p>
3232

33-
<h3>[property:Boolean isCamera]</h3>
34-
<p>
35-
Used to check whether this or derived classes are cameras. Default is *true*.<br /><br />
36-
37-
You should not change this, as it used internally by the renderer for optimisation.
38-
</p>
39-
4033
<h3>[property:Layers layers]</h3>
4134
<p>
4235
The [page:Layers layers] that the camera is a member of. This is an inherited

‎docs/api/en/cameras/OrthographicCamera.html

-7
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,6 @@ <h3>[property:Float far]</h3>
7171
The valid range is between the current value of the [page:.near near] plane and infinity.
7272
</p>
7373

74-
<h3>[property:Boolean isOrthographicCamera]</h3>
75-
<p>
76-
Used to test whether this or derived classes are OrthographicCameras. Default is *true*.<br /><br />
77-
78-
This should not be changed as it is used internally by the renderer for optimisation.
79-
</p>
80-
8174
<h3>[property:Float left]</h3>
8275
<p>Camera frustum left plane.</p>
8376

‎docs/api/en/cameras/PerspectiveCamera.html

-7
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,6 @@ <h3>[property:Float focus]</h3>
7777
<h3>[property:Float fov]</h3>
7878
<p>Camera frustum vertical field of view, from bottom to top of view, in degrees. Default is *50*.</p>
7979

80-
<h3>[property:Boolean isPerspectiveCamera]</h3>
81-
<p>
82-
Used to test whether this or derived classes are PerspectiveCameras. Default is *true*.<br /><br />
83-
84-
This should not be changed as it is used internally by the renderer for optimisation.
85-
</p>
86-
8780

8881
<h3>[property:Float near]</h3>
8982
<p>

‎docs/api/en/core/BufferAttribute.html

-7
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,6 @@ <h3>[property:Integer count]</h3>
5858
then this will count the number of such vectors stored.
5959
</p>
6060

61-
<h3>[property:Boolean isBufferAttribute]</h3>
62-
<p>
63-
Used to check whether this or derived classes are BufferAttributes. Default is *true*.<br /><br />
64-
65-
You should not change this, as it used internally for optimisation.
66-
</p>
67-
6861
<h3>[property:Integer itemSize]</h3>
6962
<p>The length of vectors that are being stored in the [page:BufferAttribute.array array].</p>
7063

‎docs/api/en/core/BufferGeometry.html

-7
Original file line numberDiff line numberDiff line change
@@ -132,13 +132,6 @@ <h3>[property:BufferAttribute index]</h3>
132132
Default is *null*.
133133
</p>
134134

135-
<h3>[property:Boolean isBufferGeometry]</h3>
136-
<p>
137-
Used to check whether this or derived classes are BufferGeometries. Default is *true*.<br /><br />
138-
139-
You should not change this, as it used internally for optimisation.
140-
</p>
141-
142135
<h3>[property:Object morphAttributes]</h3>
143136
<p>
144137
Hashmap of [page:BufferAttribute]s holding details of the geometry's [page:Geometry.morphTargets morphTargets].

‎docs/api/en/core/Geometry.html

-7
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,6 @@ <h3>[property:Array faceVertexUvs]</h3>
9898
<h3>[property:Integer id]</h3>
9999
<p>Unique number for this geometry instance.</p>
100100

101-
<h3>[property:Boolean isGeometry]</h3>
102-
<p>
103-
Used to check whether this or derived classes are Geometries. Default is *true*.<br /><br />
104-
105-
You should not change this, as it used internally for optimisation.
106-
</p>
107-
108101
<h3>[property:array lineDistances]</h3>
109102
<p>
110103
An array containing distances between vertices for Line geometries.

‎docs/api/en/core/InstancedBufferAttribute.html

-5
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,6 @@ <h3>[property:Number meshPerAttribute]</h3>
2929
Default is *1*.
3030
</p>
3131

32-
<h3>[property:Boolean isInstancedBufferAttribute]</h3>
33-
<p>
34-
Default is *true*.
35-
</p>
36-
3732
<h2>Methods</h2>
3833
<p>See [page:BufferAttribute] for inherited methods.</p>
3934

‎docs/api/en/core/InstancedBufferGeometry.html

-5
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,6 @@ <h3>[property:Number maxInstancedCount]</h3>
2929
Default is *undefined*.
3030
</p>
3131

32-
<h3>[property:Boolean isInstancedBufferGeometry]</h3>
33-
<p>
34-
Default is *true*.
35-
</p>
36-
3732
<h2>Methods</h2>
3833
<p>See [page:BufferAttribute] for inherited methods.</p>
3934

‎docs/api/en/core/InstancedInterleavedBuffer.html

-5
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,6 @@ <h3>[property:Number meshPerAttribute]</h3>
3131
Default is *1*.
3232
</p>
3333

34-
<h3>[property:Boolean isInstancedInterleavedBuffer]</h3>
35-
<p>
36-
Default is *true*.
37-
</p>
38-
3934
<h2>Methods</h2>
4035
<p>
4136
See [page:InterleavedBuffer] for inherited methods.

‎docs/api/en/core/InterleavedBuffer.html

-5
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,6 @@ <h3>[property:Integer version]</h3>
6464
A version number, incremented every time the needsUpdate property is set to true.
6565
</p>
6666

67-
<h3>[property:Boolean isInterleavedBuffer]</h3>
68-
<p>
69-
Default is *true*.
70-
</p>
71-
7267
<h3>[property:Boolean needsUpdate]</h3>
7368
<p>
7469
Default is *false*. Setting this to true increments [page:InterleavedBuffer.version version].

‎docs/api/en/core/InterleavedBufferAttribute.html

-5
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,6 @@ <h3>[property:Boolean normalized]</h3>
5555
Default is *false*.
5656
</p>
5757

58-
<h3>[property:Boolean isInterleavedBufferAttribute]</h3>
59-
<p>
60-
Default is *true*.
61-
</p>
62-
6358
<h2>Methods</h2>
6459

6560
<h3>[method:this applyMatrix4]( [param:Matrix4 m] )</h3>

‎docs/api/en/core/Object3D.html

-7
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,6 @@ <h3>[property:Boolean frustumCulled]</h3>
5858
<h3>[property:Integer id]</h3>
5959
<p>readonly – Unique number for this object instance.</p>
6060

61-
<h3>[property:Boolean isObject3D]</h3>
62-
<p>
63-
Used to check whether this or derived classes are Object3Ds. Default is *true*.<br /><br />
64-
65-
You should not change this, as it is used internally for optimisation.
66-
</p>
67-
6861
<h3>[property:Layers layers]</h3>
6962
<p>
7063
The layer membership of the object. The object is only visible if it has at least one

‎docs/api/en/extras/core/Font.html

-7
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,6 @@ <h2>Properties</h2>
3737
<h3>[property:array data]</h3>
3838
<p>The JSON data passed in the constructor.</p>
3939

40-
<h3>[property:Boolean isFont]</h3>
41-
<p>
42-
Used to check whether this or derived classes are fonts. Default is *true*.<br /><br />
43-
44-
You should not change this, as it used internally by the renderer for optimisation.
45-
</p>
46-
4740
<h2>Methods</h2>
4841

4942
<h3>[method:null generateShapes]( [param:String text], [param:Float size] )</h3>

‎docs/api/en/extras/curves/ArcCurve.html

-7
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,6 @@ <h1>[name]</h1>
1717
<h2>Properties</h2>
1818
<p>See the [page:EllipseCurve] class for common properties.</p>
1919

20-
<h3>[property:Boolean isArcCurve]</h3>
21-
<p>
22-
Used to check whether this or derived classes are ArcCurves. Default is *true*.<br /><br />
23-
24-
You should not change this, as it used internally for optimisation.
25-
</p>
26-
2720

2821
<h2>Source</h2>
2922

‎docs/api/en/extras/curves/CatmullRomCurve3.html

-7
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,6 @@ <h3>[name]( [param:Array points], [param:Boolean closed], [param:String curveTyp
5353
<h2>Properties</h2>
5454
<p>See the base [page:Curve] class for common properties.</p>
5555

56-
<h3>[property:Boolean isCatmullRomCurve3]</h3>
57-
<p>
58-
Used to check whether this or derived classes are CatmullRomCurve3s. Default is *true*.<br /><br />
59-
60-
You should not change this, as it used internally for optimisation.
61-
</p>
62-
6356
<h3>[property:Array points]</h3>
6457
<p>The array of [page:Vector3] points that define the curve. It needs at least two entries.</p>
6558

‎docs/api/en/extras/curves/CubicBezierCurve.html

-7
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,6 @@ <h3>[name] ( [param:Vector2 v0], [param:Vector2 v1], [param:Vector2 v2], [param:
5151
<h2>Properties</h2>
5252
<p>See the base [page:Curve] class for common properties.</p>
5353

54-
<h3>[property:Boolean isCubicBezierCurve]</h3>
55-
<p>
56-
Used to check whether this or derived classes are CubicBezierCurves. Default is *true*.<br /><br />
57-
58-
You should not change this, as it used internally for optimisation.
59-
</p>
60-
6154
<h3>[property:Vector2 v0]</h3>
6255
<p>The starting point.</p>
6356

‎docs/api/en/extras/curves/CubicBezierCurve3.html

-7
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,6 @@ <h3>[name]( [param:Vector3 v0], [param:Vector3 v1], [param:Vector3 v2], [param:V
5252
<h2>Properties</h2>
5353
<p>See the base [page:Curve] class for common properties.</p>
5454

55-
<h3>[property:Boolean isCubicBezierCurve3]</h3>
56-
<p>
57-
Used to check whether this or derived classes are CubicBezierCurve3s. Default is *true*.<br /><br />
58-
59-
You should not change this, as it used internally for optimisation.
60-
</p>
61-
6255
<h3>[property:Vector2 v0]</h3>
6356
<p>The starting point.</p>
6457

‎docs/api/en/extras/curves/EllipseCurve.html

-7
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,6 @@ <h3>[name]( [param:Float aX], [param:Float aY], [param:Float xRadius], [param:Fl
5555
<h2>Properties</h2>
5656
<p>See the base [page:Curve] class for common properties.</p>
5757

58-
<h3>[property:Boolean isEllipseCurve]</h3>
59-
<p>
60-
Used to check whether this or derived classes are EllipseCurves. Default is *true*.<br /><br />
61-
62-
You should not change this, as it used internally for optimisation.
63-
</p>
64-
6558
<h3>[property:Float aX]</h3>
6659
<p>The X center of the ellipse.</p>
6760

‎docs/api/en/extras/curves/LineCurve.html

-7
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,6 @@ <h3>[name]( [param:Vector2 v1], [param:Vector2 v2] )</h3>
2727
<h2>Properties</h2>
2828
<p>See the base [page:Curve] class for common properties.</p>
2929

30-
<h3>[property:Boolean isLineCurve]</h3>
31-
<p>
32-
Used to check whether this or derived classes are LineCurves. Default is *true*.<br /><br />
33-
34-
You should not change this, as it used internally for optimisation.
35-
</p>
36-
3730
<h3>[property:Vector2 v1]</h3>
3831
<p>The start point.</p>
3932

‎docs/api/en/extras/curves/LineCurve3.html

-7
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,6 @@ <h3>[name]( [param:Vector3 v1], [param:Vector3 v2] )</h3>
2727
<h2>Properties</h2>
2828
<p>See the base [page:Curve] class for common properties.</p>
2929

30-
<h3>[property:Boolean isLineCurve3]</h3>
31-
<p>
32-
Used to check whether this or derived classes are LineCurve3s. Default is *true*.<br /><br />
33-
34-
You should not change this, as it used internally for optimisation.
35-
</p>
36-
3730
<h3>[property:Vector3 v1]</h3>
3831
<p>The start point.</p>
3932

‎docs/api/en/extras/curves/QuadraticBezierCurve.html

-8
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,6 @@ <h3>[name]( [param:Vector2 v0], [param:Vector2 v1], [param:Vector2 v2] )</h3>
5050
<h2>Properties</h2>
5151
<p>See the base [page:Curve] class for common properties.</p>
5252

53-
<h3>[property:Boolean isQuadraticBezierCurve]</h3>
54-
<p>
55-
Used to check whether this or derived classes are QuadraticBezierCurves. Default is *true*.<br /><br />
56-
57-
You should not change this, as it used internally for optimisation.
58-
</p>
59-
60-
6153
<h3>[property:Vector2 v0]</h3>
6254
<p>The startpoint.</p>
6355

‎docs/api/en/extras/curves/QuadraticBezierCurve3.html

-7
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,6 @@ <h3>[name]( [param:Vector3 v0], [param:Vector3 v1], [param:Vector3 v2] )</h3>
5151
<h2>Properties</h2>
5252
<p>See the base [page:Curve] class for common properties.</p>
5353

54-
<h3>[property:Boolean isQuadraticBezierCurve3]</h3>
55-
<p>
56-
Used to check whether this or derived classes are QuadraticBezierCurve3s. Default is *true*.<br /><br />
57-
58-
You should not change this, as it used internally for optimisation.
59-
</p>
60-
6154
<h3>[property:Vector3 v0]</h3>
6255
<p>The startpoint.</p>
6356

‎docs/api/en/extras/curves/SplineCurve.html

-7
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,6 @@ <h3>[name]( [param:Array points] )</h3>
4848
<h2>Properties</h2>
4949
<p>See the base [page:Curve] class for common properties.</p>
5050

51-
<h3>[property:Boolean isSplineCurve]</h3>
52-
<p>
53-
Used to check whether this or derived classes are SplineCurves. Default is *true*.<br /><br />
54-
55-
You should not change this, as it used internally for optimisation.
56-
</p>
57-
5851
<h3>[property:Array points]</h3>
5952
<p>The array of [page:Vector2] points that define the curve.</p>
6053

‎docs/api/en/lights/AmbientLight.html

-9
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,6 @@ <h3>[property:Boolean castShadow]</h3>
4949
</p>
5050

5151

52-
<h3>[property:Boolean isAmbientLight]</h3>
53-
<p>
54-
Used to check whether this or derived classes are ambient lights. Default is *true*.<br /><br />
55-
56-
You should not change this, as it used internally for optimisation.
57-
</p>
58-
59-
60-
6152
<h2>Methods</h2>
6253
<p>
6354
See the base [page:Light Light] class for common methods.

‎docs/api/en/lights/DirectionalLight.html

-8
Original file line numberDiff line numberDiff line change
@@ -76,14 +76,6 @@ <h3>[property:Boolean castShadow]</h3>
7676
The default is *false*.
7777
</p>
7878

79-
<h3>[property:Boolean isDirectionalLight]</h3>
80-
<p>
81-
Used to check whether this or derived classes are directional lights. Default is *true*.<br /><br />
82-
83-
You should not change this, as it is used internally for optimisation.
84-
</p>
85-
86-
8779
<h3>[property:Vector3 position]</h3>
8880
<p>
8981
This is set equal to [page:Object3D.DefaultUp] (0, 1, 0), so that the light shines from the top down.

‎docs/api/en/lights/HemisphereLight.html

-7
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,6 @@ <h3>[property:Float groundColor]</h3>
6868
Default is a new [page:Color] set to white (0xffffff).
6969
</p>
7070

71-
<h3>[property:Boolean isHemisphereLight]</h3>
72-
<p>
73-
Used to check whether this or derived classes are hemisphere lights. Default is *true*.<br /><br />
74-
75-
You should not change this, as it used internally for optimisation.
76-
</p>
77-
7871
<h3>[property:Vector3 position]</h3>
7972
<p>
8073
This is set equal to [page:Object3D.DefaultUp] (0, 1, 0), so that the light shines from the top down.

‎docs/api/en/lights/Light.html

-7
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,6 @@ <h3>[property:Float intensity]</h3>
4747
Default - *1.0*.
4848
</p>
4949

50-
<h3>[property:Boolean isLight]</h3>
51-
<p>
52-
Used to check whether this or derived classes are lights. Default is *true*.<br /><br />
53-
54-
You should not change this, as it used internally for optimisation.
55-
</p>
56-
5750

5851
<h2>Methods</h2>
5952
<p>

‎docs/api/en/lights/PointLight.html

-7
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,6 @@ <h3>[property:Float distance]</h3>
8080
Default is *0.0*.
8181
</p>
8282

83-
<h3>[property:Boolean isPointLight]</h3>
84-
<p>
85-
Used to check whether this or derived classes are point lights. Default is *true*.<br /><br />
86-
87-
You should not change this, as it used internally for optimisation.
88-
</p>
89-
9083
<h3>[property:Float power]</h3>
9184
<p>
9285
The light's power.<br />

‎docs/api/en/lights/RectAreaLight.html

-7
Original file line numberDiff line numberDiff line change
@@ -65,13 +65,6 @@ <h2>Properties</h2>
6565
See the base [page:Light Light] class for common properties.
6666
</p>
6767

68-
<h3>[property:Boolean isRectAreaLight]</h3>
69-
<p>
70-
Used to check whether this or derived classes are RectAreaLights. Default is *true*.<br /><br />
71-
72-
You should not change this, as it used internally for optimisation.
73-
</p>
74-
7568
<h2>Methods</h2>
7669
<p>
7770
See the base [page:Light Light] class for common methods.

0 commit comments

Comments
 (0)