Skip to content
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.

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

Docs: Removed internal is* properties. #18217

Merged
merged 1 commit into from
Dec 20, 2019
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: 0 additions & 7 deletions docs/api/en/cameras/Camera.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,6 @@ <h3>[name]()</h3>
<h2>Properties</h2>
<p>See the base [page:Object3D] class for common properties.</p>

<h3>[property:Boolean isCamera]</h3>
<p>
Used to check whether this or derived classes are cameras. Default is *true*.<br /><br />

You should not change this, as it used internally by the renderer for optimisation.
</p>

<h3>[property:Layers layers]</h3>
<p>
The [page:Layers layers] that the camera is a member of. This is an inherited
Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/cameras/OrthographicCamera.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,6 @@ <h3>[property:Float far]</h3>
The valid range is between the current value of the [page:.near near] plane and infinity.
</p>

<h3>[property:Boolean isOrthographicCamera]</h3>
<p>
Used to test whether this or derived classes are OrthographicCameras. Default is *true*.<br /><br />

This should not be changed as it is used internally by the renderer for optimisation.
</p>

<h3>[property:Float left]</h3>
<p>Camera frustum left plane.</p>

Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/cameras/PerspectiveCamera.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,13 +77,6 @@ <h3>[property:Float focus]</h3>
<h3>[property:Float fov]</h3>
<p>Camera frustum vertical field of view, from bottom to top of view, in degrees. Default is *50*.</p>

<h3>[property:Boolean isPerspectiveCamera]</h3>
<p>
Used to test whether this or derived classes are PerspectiveCameras. Default is *true*.<br /><br />

This should not be changed as it is used internally by the renderer for optimisation.
</p>


<h3>[property:Float near]</h3>
<p>
Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/core/BufferAttribute.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,6 @@ <h3>[property:Integer count]</h3>
then this will count the number of such vectors stored.
</p>

<h3>[property:Boolean isBufferAttribute]</h3>
<p>
Used to check whether this or derived classes are BufferAttributes. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>

<h3>[property:Integer itemSize]</h3>
<p>The length of vectors that are being stored in the [page:BufferAttribute.array array].</p>

Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/core/BufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -132,13 +132,6 @@ <h3>[property:BufferAttribute index]</h3>
Default is *null*.
</p>

<h3>[property:Boolean isBufferGeometry]</h3>
<p>
Used to check whether this or derived classes are BufferGeometries. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>

<h3>[property:Object morphAttributes]</h3>
<p>
Hashmap of [page:BufferAttribute]s holding details of the geometry's [page:Geometry.morphTargets morphTargets].
Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/core/Geometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,6 @@ <h3>[property:Array faceVertexUvs]</h3>
<h3>[property:Integer id]</h3>
<p>Unique number for this geometry instance.</p>

<h3>[property:Boolean isGeometry]</h3>
<p>
Used to check whether this or derived classes are Geometries. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>

<h3>[property:array lineDistances]</h3>
<p>
An array containing distances between vertices for Line geometries.
Expand Down
5 changes: 0 additions & 5 deletions docs/api/en/core/InstancedBufferAttribute.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,6 @@ <h3>[property:Number meshPerAttribute]</h3>
Default is *1*.
</p>

<h3>[property:Boolean isInstancedBufferAttribute]</h3>
<p>
Default is *true*.
</p>

<h2>Methods</h2>
<p>See [page:BufferAttribute] for inherited methods.</p>

Expand Down
5 changes: 0 additions & 5 deletions docs/api/en/core/InstancedBufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,6 @@ <h3>[property:Number maxInstancedCount]</h3>
Default is *undefined*.
</p>

<h3>[property:Boolean isInstancedBufferGeometry]</h3>
<p>
Default is *true*.
</p>

<h2>Methods</h2>
<p>See [page:BufferAttribute] for inherited methods.</p>

Expand Down
5 changes: 0 additions & 5 deletions docs/api/en/core/InstancedInterleavedBuffer.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,6 @@ <h3>[property:Number meshPerAttribute]</h3>
Default is *1*.
</p>

<h3>[property:Boolean isInstancedInterleavedBuffer]</h3>
<p>
Default is *true*.
</p>

<h2>Methods</h2>
<p>
See [page:InterleavedBuffer] for inherited methods.
Expand Down
5 changes: 0 additions & 5 deletions docs/api/en/core/InterleavedBuffer.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,6 @@ <h3>[property:Integer version]</h3>
A version number, incremented every time the needsUpdate property is set to true.
</p>

<h3>[property:Boolean isInterleavedBuffer]</h3>
<p>
Default is *true*.
</p>

<h3>[property:Boolean needsUpdate]</h3>
<p>
Default is *false*. Setting this to true increments [page:InterleavedBuffer.version version].
Expand Down
5 changes: 0 additions & 5 deletions docs/api/en/core/InterleavedBufferAttribute.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,6 @@ <h3>[property:Boolean normalized]</h3>
Default is *false*.
</p>

<h3>[property:Boolean isInterleavedBufferAttribute]</h3>
<p>
Default is *true*.
</p>

<h2>Methods</h2>

<h3>[method:this applyMatrix4]( [param:Matrix4 m] )</h3>
Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/core/Object3D.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,6 @@ <h3>[property:Boolean frustumCulled]</h3>
<h3>[property:Integer id]</h3>
<p>readonly – Unique number for this object instance.</p>

<h3>[property:Boolean isObject3D]</h3>
<p>
Used to check whether this or derived classes are Object3Ds. Default is *true*.<br /><br />

You should not change this, as it is used internally for optimisation.
</p>

<h3>[property:Layers layers]</h3>
<p>
The layer membership of the object. The object is only visible if it has at least one
Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/extras/core/Font.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,6 @@ <h2>Properties</h2>
<h3>[property:array data]</h3>
<p>The JSON data passed in the constructor.</p>

<h3>[property:Boolean isFont]</h3>
<p>
Used to check whether this or derived classes are fonts. Default is *true*.<br /><br />

You should not change this, as it used internally by the renderer for optimisation.
</p>

<h2>Methods</h2>

<h3>[method:null generateShapes]( [param:String text], [param:Float size] )</h3>
Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/extras/curves/ArcCurve.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,6 @@ <h1>[name]</h1>
<h2>Properties</h2>
<p>See the [page:EllipseCurve] class for common properties.</p>

<h3>[property:Boolean isArcCurve]</h3>
<p>
Used to check whether this or derived classes are ArcCurves. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>


<h2>Source</h2>

Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/extras/curves/CatmullRomCurve3.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,6 @@ <h3>[name]( [param:Array points], [param:Boolean closed], [param:String curveTyp
<h2>Properties</h2>
<p>See the base [page:Curve] class for common properties.</p>

<h3>[property:Boolean isCatmullRomCurve3]</h3>
<p>
Used to check whether this or derived classes are CatmullRomCurve3s. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>

<h3>[property:Array points]</h3>
<p>The array of [page:Vector3] points that define the curve. It needs at least two entries.</p>

Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/extras/curves/CubicBezierCurve.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,6 @@ <h3>[name] ( [param:Vector2 v0], [param:Vector2 v1], [param:Vector2 v2], [param:
<h2>Properties</h2>
<p>See the base [page:Curve] class for common properties.</p>

<h3>[property:Boolean isCubicBezierCurve]</h3>
<p>
Used to check whether this or derived classes are CubicBezierCurves. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>

<h3>[property:Vector2 v0]</h3>
<p>The starting point.</p>

Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/extras/curves/CubicBezierCurve3.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,6 @@ <h3>[name]( [param:Vector3 v0], [param:Vector3 v1], [param:Vector3 v2], [param:V
<h2>Properties</h2>
<p>See the base [page:Curve] class for common properties.</p>

<h3>[property:Boolean isCubicBezierCurve3]</h3>
<p>
Used to check whether this or derived classes are CubicBezierCurve3s. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>

<h3>[property:Vector2 v0]</h3>
<p>The starting point.</p>

Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/extras/curves/EllipseCurve.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,6 @@ <h3>[name]( [param:Float aX], [param:Float aY], [param:Float xRadius], [param:Fl
<h2>Properties</h2>
<p>See the base [page:Curve] class for common properties.</p>

<h3>[property:Boolean isEllipseCurve]</h3>
<p>
Used to check whether this or derived classes are EllipseCurves. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>

<h3>[property:Float aX]</h3>
<p>The X center of the ellipse.</p>

Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/extras/curves/LineCurve.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,6 @@ <h3>[name]( [param:Vector2 v1], [param:Vector2 v2] )</h3>
<h2>Properties</h2>
<p>See the base [page:Curve] class for common properties.</p>

<h3>[property:Boolean isLineCurve]</h3>
<p>
Used to check whether this or derived classes are LineCurves. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>

<h3>[property:Vector2 v1]</h3>
<p>The start point.</p>

Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/extras/curves/LineCurve3.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,6 @@ <h3>[name]( [param:Vector3 v1], [param:Vector3 v2] )</h3>
<h2>Properties</h2>
<p>See the base [page:Curve] class for common properties.</p>

<h3>[property:Boolean isLineCurve3]</h3>
<p>
Used to check whether this or derived classes are LineCurve3s. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>

<h3>[property:Vector3 v1]</h3>
<p>The start point.</p>

Expand Down
8 changes: 0 additions & 8 deletions docs/api/en/extras/curves/QuadraticBezierCurve.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,6 @@ <h3>[name]( [param:Vector2 v0], [param:Vector2 v1], [param:Vector2 v2] )</h3>
<h2>Properties</h2>
<p>See the base [page:Curve] class for common properties.</p>

<h3>[property:Boolean isQuadraticBezierCurve]</h3>
<p>
Used to check whether this or derived classes are QuadraticBezierCurves. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>


<h3>[property:Vector2 v0]</h3>
<p>The startpoint.</p>

Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/extras/curves/QuadraticBezierCurve3.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,6 @@ <h3>[name]( [param:Vector3 v0], [param:Vector3 v1], [param:Vector3 v2] )</h3>
<h2>Properties</h2>
<p>See the base [page:Curve] class for common properties.</p>

<h3>[property:Boolean isQuadraticBezierCurve3]</h3>
<p>
Used to check whether this or derived classes are QuadraticBezierCurve3s. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>

<h3>[property:Vector3 v0]</h3>
<p>The startpoint.</p>

Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/extras/curves/SplineCurve.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,6 @@ <h3>[name]( [param:Array points] )</h3>
<h2>Properties</h2>
<p>See the base [page:Curve] class for common properties.</p>

<h3>[property:Boolean isSplineCurve]</h3>
<p>
Used to check whether this or derived classes are SplineCurves. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>

<h3>[property:Array points]</h3>
<p>The array of [page:Vector2] points that define the curve.</p>

Expand Down
9 changes: 0 additions & 9 deletions docs/api/en/lights/AmbientLight.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,6 @@ <h3>[property:Boolean castShadow]</h3>
</p>


<h3>[property:Boolean isAmbientLight]</h3>
<p>
Used to check whether this or derived classes are ambient lights. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>



<h2>Methods</h2>
<p>
See the base [page:Light Light] class for common methods.
Expand Down
8 changes: 0 additions & 8 deletions docs/api/en/lights/DirectionalLight.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,14 +76,6 @@ <h3>[property:Boolean castShadow]</h3>
The default is *false*.
</p>

<h3>[property:Boolean isDirectionalLight]</h3>
<p>
Used to check whether this or derived classes are directional lights. Default is *true*.<br /><br />

You should not change this, as it is used internally for optimisation.
</p>


<h3>[property:Vector3 position]</h3>
<p>
This is set equal to [page:Object3D.DefaultUp] (0, 1, 0), so that the light shines from the top down.
Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/lights/HemisphereLight.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,6 @@ <h3>[property:Float groundColor]</h3>
Default is a new [page:Color] set to white (0xffffff).
</p>

<h3>[property:Boolean isHemisphereLight]</h3>
<p>
Used to check whether this or derived classes are hemisphere lights. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>

<h3>[property:Vector3 position]</h3>
<p>
This is set equal to [page:Object3D.DefaultUp] (0, 1, 0), so that the light shines from the top down.
Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/lights/Light.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,6 @@ <h3>[property:Float intensity]</h3>
Default - *1.0*.
</p>

<h3>[property:Boolean isLight]</h3>
<p>
Used to check whether this or derived classes are lights. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>


<h2>Methods</h2>
<p>
Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/lights/PointLight.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,6 @@ <h3>[property:Float distance]</h3>
Default is *0.0*.
</p>

<h3>[property:Boolean isPointLight]</h3>
<p>
Used to check whether this or derived classes are point lights. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>

<h3>[property:Float power]</h3>
<p>
The light's power.<br />
Expand Down
7 changes: 0 additions & 7 deletions docs/api/en/lights/RectAreaLight.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,6 @@ <h2>Properties</h2>
See the base [page:Light Light] class for common properties.
</p>

<h3>[property:Boolean isRectAreaLight]</h3>
<p>
Used to check whether this or derived classes are RectAreaLights. Default is *true*.<br /><br />

You should not change this, as it used internally for optimisation.
</p>

<h2>Methods</h2>
<p>
See the base [page:Light Light] class for common methods.
Expand Down
Loading