From 7f00e655646674995ced483fb73f67d71a99f382 Mon Sep 17 00:00:00 2001 From: Michael Herzog Date: Mon, 8 Nov 2021 13:14:35 +0100 Subject: [PATCH] Docs: Consistent use of "return this". (#22799) --- docs/api/ar/animation/AnimationAction.html | 34 ++++---- docs/api/ar/animation/AnimationMixer.html | 6 +- docs/api/ar/audio/Audio.html | 32 ++++---- docs/api/ar/audio/AudioListener.html | 4 +- docs/api/ar/audio/PositionalAudio.html | 10 +-- docs/api/ar/cameras/Camera.html | 2 +- docs/api/en/animation/AnimationAction.html | 36 ++++----- docs/api/en/animation/AnimationMixer.html | 6 +- docs/api/en/audio/Audio.html | 32 ++++---- docs/api/en/audio/AudioListener.html | 6 +- docs/api/en/audio/PositionalAudio.html | 10 +-- docs/api/en/cameras/Camera.html | 2 +- docs/api/en/core/BufferAttribute.html | 30 +++---- docs/api/en/core/BufferGeometry.html | 22 +++--- docs/api/en/core/InstancedBufferGeometry.html | 2 +- docs/api/en/core/InterleavedBuffer.html | 10 +-- docs/api/en/extras/core/Curve.html | 4 +- docs/api/en/helpers/BoxHelper.html | 2 +- docs/api/en/lights/DirectionalLight.html | 2 +- docs/api/en/lights/HemisphereLight.html | 2 +- docs/api/en/lights/Light.html | 2 +- docs/api/en/lights/PointLight.html | 2 +- docs/api/en/lights/RectAreaLight.html | 2 +- docs/api/en/lights/SpotLight.html | 2 +- docs/api/en/lights/shadows/LightShadow.html | 2 +- docs/api/en/loaders/FileLoader.html | 6 +- docs/api/en/loaders/ImageBitmapLoader.html | 2 +- docs/api/en/loaders/Loader.html | 10 +-- docs/api/en/loaders/MaterialLoader.html | 2 +- docs/api/en/loaders/ObjectLoader.html | 10 +-- .../en/loaders/managers/LoadingManager.html | 4 +- docs/api/en/materials/Material.html | 2 +- docs/api/en/math/Box2.html | 22 +++--- docs/api/en/math/Color.html | 52 ++++++------- docs/api/en/math/Cylindrical.html | 8 +- docs/api/en/math/Euler.html | 14 ++-- docs/api/en/math/Frustum.html | 2 +- docs/api/en/math/Line3.html | 6 +- docs/api/en/math/Plane.html | 18 ++--- docs/api/en/math/Quaternion.html | 34 ++++---- docs/api/en/math/Ray.html | 10 +-- docs/api/en/math/Sphere.html | 12 +-- docs/api/en/math/Spherical.html | 10 +-- docs/api/en/math/SphericalHarmonics3.html | 16 ++-- docs/api/en/math/Triangle.html | 8 +- docs/api/en/objects/Line.html | 2 +- docs/api/en/objects/Sprite.html | 2 +- .../en/renderers/WebGLCubeRenderTarget.html | 2 +- docs/api/en/renderers/WebGLRenderTarget.html | 2 +- docs/api/en/scenes/Fog.html | 2 +- docs/api/en/scenes/FogExp2.html | 2 +- docs/api/en/textures/CompressedTexture.html | 4 +- docs/api/ko/animation/AnimationAction.html | 78 +++++++++---------- docs/api/ko/animation/AnimationMixer.html | 6 +- docs/api/ko/audio/Audio.html | 32 ++++---- docs/api/ko/audio/AudioListener.html | 6 +- docs/api/ko/audio/PositionalAudio.html | 10 +-- docs/api/ko/cameras/Camera.html | 2 +- docs/api/ko/core/BufferAttribute.html | 30 +++---- docs/api/ko/core/BufferGeometry.html | 22 +++--- docs/api/ko/core/InterleavedBuffer.html | 14 ++-- docs/api/ko/extras/core/Curve.html | 4 +- docs/api/zh/animation/AnimationAction.html | 34 ++++---- docs/api/zh/animation/AnimationMixer.html | 19 +++-- docs/api/zh/audio/Audio.html | 32 ++++---- docs/api/zh/audio/AudioListener.html | 6 +- docs/api/zh/audio/PositionalAudio.html | 10 +-- docs/api/zh/cameras/Camera.html | 2 +- docs/api/zh/core/BufferAttribute.html | 28 +++---- docs/api/zh/core/BufferGeometry.html | 22 +++--- docs/api/zh/core/InstancedBufferGeometry.html | 2 +- docs/api/zh/core/InterleavedBuffer.html | 10 +-- docs/api/zh/core/Object3D.html | 2 +- docs/api/zh/extras/core/Curve.html | 4 +- docs/api/zh/helpers/BoxHelper.html | 2 +- docs/api/zh/lights/DirectionalLight.html | 2 +- docs/api/zh/lights/HemisphereLight.html | 2 +- docs/api/zh/lights/Light.html | 4 +- docs/api/zh/lights/PointLight.html | 2 +- docs/api/zh/lights/RectAreaLight.html | 2 +- docs/api/zh/lights/SpotLight.html | 2 +- docs/api/zh/lights/shadows/LightShadow.html | 2 +- docs/api/zh/loaders/FileLoader.html | 20 +---- docs/api/zh/loaders/ImageBitmapLoader.html | 2 +- docs/api/zh/loaders/ImageLoader.html | 2 +- docs/api/zh/loaders/Loader.html | 10 +-- docs/api/zh/loaders/ObjectLoader.html | 10 +-- .../zh/loaders/managers/LoadingManager.html | 4 +- docs/api/zh/materials/Material.html | 2 +- docs/api/zh/math/Box2.html | 22 +++--- docs/api/zh/math/Color.html | 52 ++++++------- docs/api/zh/math/Cylindrical.html | 8 +- docs/api/zh/math/Euler.html | 14 ++-- docs/api/zh/math/Frustum.html | 2 +- docs/api/zh/math/Line3.html | 8 +- docs/api/zh/math/Plane.html | 18 ++--- docs/api/zh/math/Quaternion.html | 32 ++++---- docs/api/zh/math/Ray.html | 10 +-- docs/api/zh/math/Sphere.html | 12 +-- docs/api/zh/math/Spherical.html | 10 +-- docs/api/zh/math/Triangle.html | 8 +- docs/api/zh/objects/Line.html | 2 +- docs/api/zh/objects/Sprite.html | 2 +- .../zh/renderers/WebGLCubeRenderTarget.html | 2 +- docs/api/zh/renderers/WebGLRenderTarget.html | 2 +- docs/api/zh/scenes/Fog.html | 2 +- docs/api/zh/scenes/FogExp2.html | 2 +- docs/api/zh/scenes/Scene.html | 2 +- docs/api/zh/textures/CompressedTexture.html | 4 +- docs/examples/en/animations/CCDIKSolver.html | 4 +- docs/examples/en/animations/MMDPhysics.html | 8 +- docs/examples/en/loaders/MMDLoader.html | 2 +- docs/examples/en/loaders/MTLLoader.html | 2 +- docs/examples/en/loaders/OBJLoader.html | 2 +- docs/examples/en/math/Lut.html | 8 +- .../en/math/convexhull/ConvexHull.html | 30 +++---- docs/examples/en/math/convexhull/Face.html | 2 +- .../examples/en/math/convexhull/HalfEdge.html | 2 +- .../en/math/convexhull/VertexList.html | 14 ++-- docs/examples/zh/animations/CCDIKSolver.html | 4 +- docs/examples/zh/animations/MMDPhysics.html | 8 +- docs/examples/zh/loaders/MMDLoader.html | 2 +- docs/examples/zh/loaders/MTLLoader.html | 2 +- docs/examples/zh/loaders/OBJLoader.html | 2 +- docs/examples/zh/math/Lut.html | 8 +- .../zh/math/convexhull/ConvexHull.html | 30 +++---- docs/examples/zh/math/convexhull/Face.html | 2 +- .../examples/zh/math/convexhull/HalfEdge.html | 2 +- .../zh/math/convexhull/VertexList.html | 14 ++-- 129 files changed, 661 insertions(+), 672 deletions(-) diff --git a/docs/api/ar/animation/AnimationAction.html b/docs/api/ar/animation/AnimationAction.html index 095f8394a1f649..39b0bfa436ab85 100644 --- a/docs/api/ar/animation/AnimationAction.html +++ b/docs/api/ar/animation/AnimationAction.html @@ -128,7 +128,7 @@

[property:Boolean zeroSlopeAtStart]

الوظائف (Methods)

-

[method:AnimationAction crossFadeFrom]( [param:AnimationAction fadeOutAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )

+

[method:this crossFadeFrom]( [param:AnimationAction fadeOutAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )

يؤدي هذا الإجراء إلى تلاشي [page:.fadeIn fade in] ، مما يؤدي إلى تلاشي إجراء آخر في نفس الوقت ، خلال الفترة الزمنية المنقضية. يمكن تقييد هذه الطريقة.

@@ -138,7 +138,7 @@

[method:AnimationAction crossFadeFrom]( [param:AnimationAction fadeOutAction

-

[method:AnimationAction crossFadeTo]( [param:AnimationAction fadeInAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )

+

[method:this crossFadeTo]( [param:AnimationAction fadeInAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )

يؤدي هذا الإجراء إلى تلاشي [page:.fadeOut fade out] ، يتلاشى في إجراء آخر في وقت واحد ، خلال الفترة الزمنية المنقضية. يمكن تقييد هذه الطريقة ضمن سلسلة.

إذا كانت warpBoolean صحيحة ، فسيتم تطبيق [page:.warp warping] إضافيًا (تغييرات تدريجية في المقاييس الزمنية).

@@ -146,12 +146,12 @@

[method:AnimationAction crossFadeTo]( [param:AnimationAction fadeInAction], ملاحظة: كما هو الحال مع *fadeIn*/*fadeOut* ، يبدأ / ينتهي التلاشي بوزن 1.

-

[method:AnimationAction fadeIn]( [param:Number durationInSeconds] )

+

[method:this fadeIn]( [param:Number durationInSeconds] )

يزيد [page:.weight weight] هذا الإجراء تدريجياً من 0 إلى 1 ، خلال الفترة الزمنية المنقضية. يمكن تقييد هذه الطريقة ضمن سلسلة.

-

[method:AnimationAction fadeOut]( [param:Number durationInSeconds] )

+

[method:this fadeOut]( [param:Number durationInSeconds] )

يقلل [page:.weight weight] هذا الإجراء تدريجيًا من 1 إلى 0 ، خلال الفترة الزمنية المنقضية. يمكن تقييد هذه الطريقة ضمن سلسلة.

@@ -181,7 +181,7 @@

[method:Object3D getRoot]()

تُرجع الكائن الجذر الذي تم تنفيذ هذا الإجراء عليه.

-

[method:AnimationAction halt]( [param:Number durationInSeconds] )

+

[method:this halt]( [param:Number durationInSeconds] )

تعمل على إبطاء سرعة هذه الرسوم المتحركة إلى 0 من خلال إنقاص [page:.timeScale timeScale] تدريجيًا (بدءًا من قيمتها الحالية) ، خلال الفترة الزمنية المنقضية. يمكن تقييد هذه الطريقة ضمن سلسلة.

@@ -205,7 +205,7 @@

[method:Boolean isScheduled]()

ملاحظة: هذا لا يعني بالضرورة أن الرسوم المتحركة تعمل بالفعل (قارن الشروط الإضافية لـ [page:.isRunning isRunning]).

-

[method:AnimationAction play]()

+

[method:this play]()

يعلم الخالط بضرورة البدء في تنشيط الحدث (action). يمكن تقييد هذه الطريقة ضمن سلسلة.

@@ -214,7 +214,7 @@

[method:AnimationAction play]()

[page:.weight weight]=0, [page:.timeScale timeScale]=0) منع تشغيل الرسوم المتحركة أيضًا.

-

[method:AnimationAction reset]()

+

[method:this reset]()

يتم إعادة الحدث إلى وضع البداية. يمكن تقييد هذه الطريقة ضمن سلسلة.

@@ -224,12 +224,12 @@

[method:AnimationAction reset]()

هذا يعني: إذا كنت تريد كلاهما ، reset وstop ، لا تتصل بـ *reset* بل إتصل بـ *stop* بدلا من ذلك.

-

[method:AnimationAction setDuration]( [param:Number durationInSeconds] )

+

[method:this setDuration]( [param:Number durationInSeconds] )

يضبط المدة لحلقة واحدة من هذا الإجراء (بضبط [page:.timeScale timeScale] وإيقاف أي إلتفاف مجدول). يمكن تقييد هذه الطريقة ضمن سلسلة.

-

[method:AnimationAction setEffectiveTimeScale]( [param:Number timeScale] )

+

[method:this setEffectiveTimeScale]( [param:Number timeScale] )

يضبط [page:.timeScale timeScale] ويوقف أي إلتفاف مجدول. يمكن تقييد هذه الطريقة ضمن سلسلة.

@@ -239,7 +239,7 @@

[method:AnimationAction setEffectiveTimeScale]( [param:Number timeScale] ) -

[method:AnimationAction setEffectiveWeight]( [param:Number weight] )

+

[method:this setEffectiveWeight]( [param:Number weight] )

تضبط [page:.weight weight] وتوقف أي تضاؤل مجدول. يمكن تقييد هذه الطريقة ضمن سلسلة.

@@ -249,12 +249,12 @@

[method:AnimationAction setEffectiveWeight]( [param:Number weight] )

ملاحظة: لن يتم تحويل *enabled* إلى false تلقائيًا ، إذا تم ضبط *weight* على 0 بهذه الطريقة.

-

[method:AnimationAction setLoop]( [param:Number loopMode], [param:Number repetitions] )

+

[method:this setLoop]( [param:Number loopMode], [param:Number repetitions] )

يعين [page:.loop loop mode] وعدد [page:.repetitions repetitions]. يمكن تقييد هذه الطريقة ضمن سلسلة

-

[method:AnimationAction startAt]( [param:Number startTimeInSeconds] )

+

[method:this startAt]( [param:Number startTimeInSeconds] )

يحدد وقت البداية المتأخرة (عادةً ما يتم تمريره كـ [page:AnimationMixer.time] + deltaTimeInSeconds). يمكن تقييد هذه الطريقة ضمن سلسلة.

@@ -262,7 +262,7 @@

[method:AnimationAction startAt]( [param:Number startTimeInSeconds] )

أو إذا تم بالفعل تنشيط الإجراء في الخالط (عن طريق استدعاء سابق لـ. *play* ، دون إيقافه أو إعادة تعيينه في هذه الأثناء).

-

[method:AnimationAction stop]()

+

[method:this stop]()

يخبر الخالط بإلغاء تنشيط هذا الإجراء. يمكن تقييد هذه الطريقة ضمن سلسلة.

@@ -271,17 +271,17 @@

[method:AnimationAction stop]()

ملاحظة: يمكنك إيقاف جميع الإجراءات النشطة على نفس الخالط دفعة واحدة عبر [page:AnimationMixer.stopAllAction mixer.stopAllAction].

-

[method:AnimationAction stopFading]()

+

[method:this stopFading]()

يوقف أي [page:.fadeIn fading] مجدولًا يتم تطبيقه على هذا الحدث. يمكن تقييد هذه الطريقة ضمن سلسلة.

-

[method:AnimationAction stopWarping]()

+

[method:this stopWarping]()

يوقف أي [page:.warp warping] مجدولًا يتم تطبيقه على هذا الحدث. يمكن تقييد هذه الوظيفة ضمن سلسلة.

-

[method:AnimationAction syncWith]( [param:AnimationAction otherAction] )

+

[method:this syncWith]( [param:AnimationAction otherAction] )

يزامن هذا الإجراء مع الإجراء الآخر الذي تم تمريره. يمكن تقييد هذه الوظيفة ضمن سلسلة.

@@ -290,7 +290,7 @@

[method:AnimationAction syncWith]( [param:AnimationAction otherAction] )

-

[method:AnimationAction warp]( [param:Number startTimeScale], [param:Number endTimeScale], [param:Number durationInSeconds] )

+

[method:this warp]( [param:Number startTimeScale], [param:Number endTimeScale], [param:Number durationInSeconds] )

يغير سرعة التشغيل ، خلال الفترة الزمنية المنقضية ، عن طريق تعديل [page:.timeScale timeScale] تدريجيًا من *startTimeScale* إلى *endTimeScale*.يمكن تقييد هذه الوظيفة ضمن سلسلة.

diff --git a/docs/api/ar/animation/AnimationMixer.html b/docs/api/ar/animation/AnimationMixer.html index be52b1516b2efa..e2ff0c7f15240e 100644 --- a/docs/api/ar/animation/AnimationMixer.html +++ b/docs/api/ar/animation/AnimationMixer.html @@ -63,19 +63,19 @@

[method:Object3D getRoot]()

إرجاع جذركائن الخالط.

-

[method:AnimationMixer stopAllAction]()

+

[method:this stopAllAction]()

يقوم بإلغاء تنشيط كافة الإجراءات المجدولة مسبقًا على هذا الخالط.

-

[method:AnimationMixer update]([param:Number deltaTimeInSeconds])

+

[method:this update]([param:Number deltaTimeInSeconds])

يعمل على تقدم وقت الخالط العالمي وتحديث الرسوم المتحركة.

يتم ذلك عادةً في حلقة العرض ، حيث يتم تمرير [page:Clock.getDelta clock.getDelta] مقياسًا بواسطة جهاز الخلاط [page:.timeScale timeScale]).

-

[method:AnimationMixer setTime]([param:Number timeInSeconds])

+

[method:this setTime]([param:Number timeInSeconds])

يضبط الخالط العام على وقت محدد ويقوم بتحديث الرسوم المتحركة وفقًا لذلك.

diff --git a/docs/api/ar/audio/Audio.html b/docs/api/ar/audio/Audio.html index 50a57cbe0b1c34..acdd9729d82d94 100644 --- a/docs/api/ar/audio/Audio.html +++ b/docs/api/ar/audio/Audio.html @@ -101,12 +101,12 @@

[property:String type]

الوظائف (Methods)

-

[method:Audio connect]()

+

[method:this connect]()

متصل بـ [page:Audio.source]. يستخدم هذا داخليًا عند التهيئة وعند ضبط / إزالة المرشحات.

-

[method:Audio disconnect]()

+

[method:this disconnect]()

قطع الاتصال من [page:Audio.source]. يستخدم هذا داخليًا عند تعيين / إزالة المرشحات.

@@ -141,12 +141,12 @@

[method:Float getVolume]( value )

إعادة الحجم الحالي.

-

[method:Audio play]( delay )

+

[method:this play]( delay )

إذا كانت [page:Audio.hasPlaybackControl hasPlaybackControl] تحمل قيمة *true* ، يبدأ التشغيل.

-

[method:Audio pause]()

+

[method:this pause]()

إذا كانت [page:Audio.hasPlaybackControl hasPlaybackControl] تحمل قيمة *true* ، يقوم بإقاف التشغيل.

@@ -156,67 +156,67 @@

[method:undefined onEnded]()

يتم مناداته تلقائيًا عند انتهاء التشغيل.

-

[method:Audio setBuffer]( audioBuffer )

+

[method:this setBuffer]( audioBuffer )

تقوم بإعداد [page:Audio.source source] إلى *audioBuffer* ، وتقوم بتعيين [page:Audio.sourceType sourceType] إلى 'buffer'.
إذا كان [page:Audio.autoplay autoplay] ، يبدأ التشغيل أيضًا.

-

[method:Audio setFilter]( filter )

+

[method:this setFilter]( filter )

Applies a single filter node to the audio.

-

[method:Audio setFilters]( [param:Array value] )

+

[method:this setFilters]( [param:Array value] )

value - arrays of filters.
Applies an array of filter nodes to the audio.

-

[method:Audio setLoop]( [param:Boolean value] )

+

[method:this setLoop]( [param:Boolean value] )

يضبط [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loop source.loop] على *value* (ما إذا كان يجب تكرار التشغيل).

-

[method:Audio setLoopStart]( [param:Float value] )

+

[method:this setLoopStart]( [param:Float value] )

يضبط [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopStart source.loopStart] على *value*.

-

[method:Audio setLoopEnd]( [param:Float value] )

+

[method:this setLoopEnd]( [param:Float value] )

يضبط [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopEnd source.loopEnd] على *value*.

-

[method:Audio setMediaElementSource]( mediaElement )

+

[method:this setMediaElementSource]( mediaElement )

يطبق الكائن المحدد من النوع [link:https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement HTMLMediaElement] كمصدر لهذا الصوت.
يحدد أيضًا [page:Audio.hasPlaybackControl hasPlaybackControl] إلى false.

-

[method:Audio setMediaStreamSource]( mediaStream )

+

[method:this setMediaStreamSource]( mediaStream )

يطبق الكائن المحدد من النوع [link:https://developer.mozilla.org/en-US/docs/Web/API/MediaStream MediaStream] كمصدر لهذا الصوت.
يحدد أيضًا [page:Audio.hasPlaybackControl hasPlaybackControl] إلى false.

-

[method:Audio setNodeSource]( audioNode )

+

[method:this setNodeSource]( audioNode )

يقوم بإعداد [page:Audio.source source] إلى audioBuffer ، ويقوم بتعيين [page:Audio.sourceType sourceType] على 'audioNode'.
يضبط أيضًا [page:Audio.hasPlaybackControl hasPlaybackControl] إلى false.

-

[method:Audio setPlaybackRate]( [param:Float value] )

+

[method:this setPlaybackRate]( [param:Float value] )

إذا تم تمكين [page:Audio.hasPlaybackControl hasPlaybackControl] ، فيتم ضبط [page:Audio.playbackRate playbackRate] على *value*.

-

[method:Audio setVolume]( [param:Float value] )

+

[method:this setVolume]( [param:Float value] )

تضبط مستوى الصوت.

-

[method:Audio stop]()

+

[method:this stop]()

إذا تم تمكين [page:Audio.hasPlaybackControl hasPlaybackControl] ، فسيتوقف عن التشغيل.

diff --git a/docs/api/ar/audio/AudioListener.html b/docs/api/ar/audio/AudioListener.html index 2f1fc77e527c27..6835ac8ca37f2a 100644 --- a/docs/api/ar/audio/AudioListener.html +++ b/docs/api/ar/audio/AudioListener.html @@ -86,7 +86,7 @@

[method:AudioNode getFilter]()

ترجع قيمة الخاصة بـ[page:AudioListener.filter filter].

-

[method:AudioListener setFilter]( [param:AudioNode value] )

+

[method:this setFilter]( [param:AudioNode value] )

تقوم بتعيين خاصية [page:AudioListener.filter filter] إلى *value*.

@@ -96,7 +96,7 @@

[method:Float getMasterVolume]()

إعادة *volume*.

-

[method:AudioListener setMasterVolume]( [param:Number value] )

+

[method:this setMasterVolume]( [param:Number value] )

ضبط مستوى الصوت (volume).

diff --git a/docs/api/ar/audio/PositionalAudio.html b/docs/api/ar/audio/PositionalAudio.html index 383b602e7db5d2..9c0594c279c037 100644 --- a/docs/api/ar/audio/PositionalAudio.html +++ b/docs/api/ar/audio/PositionalAudio.html @@ -87,7 +87,7 @@

[method:Float getRefDistance]()

تُرجع القيمة [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/refDistance panner.refDistance].

-

[method:PositionalAudio setRefDistance]( [param:Float value] )

+

[method:this setRefDistance]( [param:Float value] )

يضبط قيمة [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/refDistance panner.refDistance].

@@ -97,7 +97,7 @@

[method:Float getRolloffFactor]()

تُرجع القيمة [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/rolloffFactor panner.rolloffFactor].

-

[method:PositionalAudio setRolloffFactor]( [param:Float value] )

+

[method:this setRolloffFactor]( [param:Float value] )

يضبط قيمة [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/rolloffFactor panner.rolloffFactor].

@@ -107,7 +107,7 @@

[method:String getDistanceModel]()

تُرجع القيمة [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/distanceModel panner.distanceModel].

-

[method:PositionalAudio setDistanceModel]( [param:String value] )

+

[method:this setDistanceModel]( [param:String value] )

يضبط قيمة [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/distanceModel panner.distanceModel].

@@ -117,12 +117,12 @@

[method:Float getMaxDistance]()

تُرجع القيمة [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/maxDistance panner.maxDistance].

-

[method:PositionalAudio setMaxDistance]( [param:Float value] )

+

[method:this setMaxDistance]( [param:Float value] )

يضبط قيمة [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/maxDistance panner.maxDistance].

-

[method:PositionalAudio setDirectionalCone]( [param:Float coneInnerAngle], [param:Float coneOuterAngle], [param:Float coneOuterGain] )

+

[method:this setDirectionalCone]( [param:Float coneInnerAngle], [param:Float coneOuterAngle], [param:Float coneOuterGain] )

يمكن استخدام هذه الطريقة لتحويل الصوت متعدد الاتجاهات إلى [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode directional sound].

diff --git a/docs/api/ar/cameras/Camera.html b/docs/api/ar/cameras/Camera.html index d40f76cd0b6943..d1378feb8b85f7 100644 --- a/docs/api/ar/cameras/Camera.html +++ b/docs/api/ar/cameras/Camera.html @@ -56,7 +56,7 @@

[method:Camera clone]( )

ترجع كاميرا جديدة بنفس خصائص هذه الكاميرا.

-

[method:Camera copy]( [param:Camera source], [param:Boolean recursive] )

+

[method:this copy]( [param:Camera source], [param:Boolean recursive] )

تنسخ الخصائص من الكاميرا المصدر إلى هذه الكاميرا.

diff --git a/docs/api/en/animation/AnimationAction.html b/docs/api/en/animation/AnimationAction.html index 6f611fd44f2789..77655fee5423bb 100644 --- a/docs/api/en/animation/AnimationAction.html +++ b/docs/api/en/animation/AnimationAction.html @@ -146,7 +146,7 @@

[property:Boolean zeroSlopeAtStart]

Methods

-

[method:AnimationAction crossFadeFrom]( [param:AnimationAction fadeOutAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )

+

[method:this crossFadeFrom]( [param:AnimationAction fadeOutAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )

Causes this action to [page:.fadeIn fade in], fading out another action simultaneously, within the passed time interval. This method can be chained.

@@ -158,7 +158,7 @@

[method:AnimationAction crossFadeFrom]( [param:AnimationAction fadeOutAction

-

[method:AnimationAction crossFadeTo]( [param:AnimationAction fadeInAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )

+

[method:this crossFadeTo]( [param:AnimationAction fadeInAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )

Causes this action to [page:.fadeOut fade out], fading in another action simultaneously, within the passed time interval. This method can be chained.

@@ -168,13 +168,13 @@

[method:AnimationAction crossFadeTo]( [param:AnimationAction fadeInAction], Note: Like with *fadeIn*/*fadeOut*, the fading starts/ends with a weight of 1.

-

[method:AnimationAction fadeIn]( [param:Number durationInSeconds] )

+

[method:this fadeIn]( [param:Number durationInSeconds] )

Increases the [page:.weight weight] of this action gradually from 0 to 1, within the passed time interval. This method can be chained.

-

[method:AnimationAction fadeOut]( [param:Number durationInSeconds] )

+

[method:this fadeOut]( [param:Number durationInSeconds] )

Decreases the [page:.weight weight] of this action gradually from 1 to 0, within the passed time interval. This method can be chained. @@ -186,7 +186,7 @@

[method:Number getEffectiveTimeScale]()

[page:.paused paused]).

-

[method:number getEffectiveWeight]()

+

[method:Number getEffectiveWeight]()

Returns the effective weight (considering the current states of fading and [page:.enabled enabled]). @@ -207,7 +207,7 @@

[method:Object3D getRoot]()

Returns the root object on which this action is performed.

-

[method:AnimationAction halt]( [param:Number durationInSeconds] )

+

[method:this halt]( [param:Number durationInSeconds] )

Decelerates this animation's speed to 0 by decreasing [page:.timeScale timeScale] gradually (starting from its current value), within the passed time interval. This method can be chained. @@ -233,7 +233,7 @@

[method:Boolean isScheduled]()

conditions for [page:.isRunning isRunning]).

-

[method:AnimationAction play]()

+

[method:this play]()

Tells the mixer to activate the action. This method can be chained.

@@ -245,7 +245,7 @@

[method:AnimationAction play]()

too.

-

[method:AnimationAction reset]()

+

[method:this reset]()

Resets the action. This method can be chained.

@@ -257,13 +257,13 @@

[method:AnimationAction reset]()

This means: If you want both, resetting and stopping, don’t call .*reset*; call .*stop* instead.

-

[method:AnimationAction setDuration]( [param:Number durationInSeconds] )

+

[method:this setDuration]( [param:Number durationInSeconds] )

Sets the duration for a single loop of this action (by adjusting [page:.timeScale timeScale] and stopping any scheduled warping). This method can be chained.

-

[method:AnimationAction setEffectiveTimeScale]( [param:Number timeScale] )

+

[method:this setEffectiveTimeScale]( [param:Number timeScale] )

Sets the [page:.timeScale timeScale] and stops any scheduled warping. This method can be chained.

@@ -275,7 +275,7 @@

[method:AnimationAction setEffectiveTimeScale]( [param:Number timeScale] ) -

[method:AnimationAction setEffectiveWeight]( [param:Number weight] )

+

[method:this setEffectiveWeight]( [param:Number weight] )

Sets the [page:.weight weight] and stops any scheduled fading. This method can be chained.

@@ -287,13 +287,13 @@

[method:AnimationAction setEffectiveWeight]( [param:Number weight] )

this method.

-

[method:AnimationAction setLoop]( [param:Number loopMode], [param:Number repetitions] )

+

[method:this setLoop]( [param:Number loopMode], [param:Number repetitions] )

Sets the [page:.loop loop mode] and the number of [page:.repetitions repetitions]. This method can be chained.

-

[method:AnimationAction startAt]( [param:Number startTimeInSeconds] )

+

[method:this startAt]( [param:Number startTimeInSeconds] )

Defines the time for a delayed start (usually passed as [page:AnimationMixer.time] + deltaTimeInSeconds). This method can be chained.

@@ -303,7 +303,7 @@

[method:AnimationAction startAt]( [param:Number startTimeInSeconds] )

call of .*play*, without stopping or resetting it in the meantime).

-

[method:AnimationAction stop]()

+

[method:this stop]()

Tells the mixer to deactivate this action. This method can be chained.

@@ -313,19 +313,19 @@

[method:AnimationAction stop]()

[page:AnimationMixer.stopAllAction mixer.stopAllAction].

-

[method:AnimationAction stopFading]()

+

[method:this stopFading]()

Stops any scheduled [page:.fadeIn fading] which is applied to this action. This method can be chained.

-

[method:AnimationAction stopWarping]()

+

[method:this stopWarping]()

Stops any scheduled [page:.warp warping] which is applied to this action. This method can be chained.

-

[method:AnimationAction syncWith]( [param:AnimationAction otherAction] )

+

[method:this syncWith]( [param:AnimationAction otherAction] )

Synchronizes this action with the passed other action. This method can be chained.

@@ -335,7 +335,7 @@

[method:AnimationAction syncWith]( [param:AnimationAction otherAction] )

-

[method:AnimationAction warp]( [param:Number startTimeScale], [param:Number endTimeScale], [param:Number durationInSeconds] )

+

[method:this warp]( [param:Number startTimeScale], [param:Number endTimeScale], [param:Number durationInSeconds] )

Changes the playback speed, within the passed time interval, by modifying [page:.timeScale timeScale] gradually from *startTimeScale* to *endTimeScale*. This method can diff --git a/docs/api/en/animation/AnimationMixer.html b/docs/api/en/animation/AnimationMixer.html index 345a93072e832e..8b71b362d7de26 100644 --- a/docs/api/en/animation/AnimationMixer.html +++ b/docs/api/en/animation/AnimationMixer.html @@ -72,19 +72,19 @@

[method:Object3D getRoot]()

Returns this mixer's root object.

-

[method:AnimationMixer stopAllAction]()

+

[method:this stopAllAction]()

Deactivates all previously scheduled actions on this mixer.

-

[method:AnimationMixer update]([param:Number deltaTimeInSeconds])

+

[method:this update]([param:Number deltaTimeInSeconds])

Advances the global mixer time and updates the animation.

This is usually done in the render loop, passing [page:Clock.getDelta clock.getDelta] scaled by the mixer's [page:.timeScale timeScale]).

-

[method:AnimationMixer setTime]([param:Number timeInSeconds])

+

[method:this setTime]([param:Number timeInSeconds])

Sets the global mixer to a specific time and updates the animation accordingly.

diff --git a/docs/api/en/audio/Audio.html b/docs/api/en/audio/Audio.html index fd00c8a39654d2..38d833ad4a8fb5 100644 --- a/docs/api/en/audio/Audio.html +++ b/docs/api/en/audio/Audio.html @@ -104,13 +104,13 @@

[property:String type]

Methods

-

[method:Audio connect]()

+

[method:this connect]()

Connect to the [page:Audio.source]. This is used internally on initialisation and when setting / removing filters.

-

[method:Audio disconnect]()

+

[method:this disconnect]()

Disconnect from the [page:Audio.source]. This is used internally when setting / removing filters. @@ -147,12 +147,12 @@

[method:Float getVolume]( value )

Return the current volume.

-

[method:Audio play]( delay )

+

[method:this play]( delay )

If [page:Audio.hasPlaybackControl hasPlaybackControl] is true, starts playback.

-

[method:Audio pause]()

+

[method:this pause]()

If [page:Audio.hasPlaybackControl hasPlaybackControl] is true, pauses playback.

@@ -162,69 +162,69 @@

[method:undefined onEnded]()

Called automatically when playback finished.

-

[method:Audio setBuffer]( audioBuffer )

+

[method:this setBuffer]( audioBuffer )

Setup the [page:Audio.source source] to the audioBuffer, and sets [page:Audio.sourceType sourceType] to 'buffer'.
If [page:Audio.autoplay autoplay], also starts playback.

-

[method:Audio setFilter]( filter )

+

[method:this setFilter]( filter )

Applies a single filter node to the audio.

-

[method:Audio setFilters]( [param:Array value] )

+

[method:this setFilters]( [param:Array value] )

value - arrays of filters.
Applies an array of filter nodes to the audio.

-

[method:Audio setLoop]( [param:Boolean value] )

+

[method:this setLoop]( [param:Boolean value] )

Set [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loop source.loop] to *value* (whether playback should loop).

-

[method:Audio setLoopStart]( [param:Float value] )

+

[method:this setLoopStart]( [param:Float value] )

Set [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopStart source.loopStart] to *value*.

-

[method:Audio setLoopEnd]( [param:Float value] )

+

[method:this setLoopEnd]( [param:Float value] )

Set [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopEnd source.loopEnd] to *value*.

-

[method:Audio setMediaElementSource]( mediaElement )

+

[method:this setMediaElementSource]( mediaElement )

Applies the given object of type [link:https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement HTMLMediaElement] as the source of this audio.
Also sets [page:Audio.hasPlaybackControl hasPlaybackControl] to false.

-

[method:Audio setMediaStreamSource]( mediaStream )

+

[method:this setMediaStreamSource]( mediaStream )

Applies the given object of type [link:https://developer.mozilla.org/en-US/docs/Web/API/MediaStream MediaStream] as the source of this audio.
Also sets [page:Audio.hasPlaybackControl hasPlaybackControl] to false.

-

[method:Audio setNodeSource]( audioNode )

+

[method:this setNodeSource]( audioNode )

Setup the [page:Audio.source source] to the audioBuffer, and sets [page:Audio.sourceType sourceType] to 'audioNode'.
Also sets [page:Audio.hasPlaybackControl hasPlaybackControl] to false.

-

[method:Audio setPlaybackRate]( [param:Float value] )

+

[method:this setPlaybackRate]( [param:Float value] )

If [page:Audio.hasPlaybackControl hasPlaybackControl] is enabled, set the [page:Audio.playbackRate playbackRate] to *value*.

-

[method:Audio setVolume]( [param:Float value] )

+

[method:this setVolume]( [param:Float value] )

Set the volume.

-

[method:Audio stop]()

+

[method:this stop]()

If [page:Audio.hasPlaybackControl hasPlaybackControl] is enabled, stops playback.

diff --git a/docs/api/en/audio/AudioListener.html b/docs/api/en/audio/AudioListener.html index 0fd767a747b616..06d57ced5f0fdb 100644 --- a/docs/api/en/audio/AudioListener.html +++ b/docs/api/en/audio/AudioListener.html @@ -77,7 +77,7 @@

[method:GainNode getInput]()

Return the [page:AudioListener.gain gainNode].

-

[method:AudioListener removeFilter]()

+

[method:this removeFilter]()

Set the [page:AudioListener.filter filter] property to *null*.

@@ -87,7 +87,7 @@

[method:AudioNode getFilter]()

Returns the value of the [page:AudioListener.filter filter] property.

-

[method:AudioListener setFilter]( [param:AudioNode value] )

+

[method:this setFilter]( [param:AudioNode value] )

Set the [page:AudioListener.filter filter] property to *value*.

@@ -97,7 +97,7 @@

[method:Float getMasterVolume]()

Return the volume.

-

[method:AudioListener setMasterVolume]( [param:Number value] )

+

[method:this setMasterVolume]( [param:Number value] )

Set the volume.

diff --git a/docs/api/en/audio/PositionalAudio.html b/docs/api/en/audio/PositionalAudio.html index 09cf2d27dbe769..92b90098f89a45 100644 --- a/docs/api/en/audio/PositionalAudio.html +++ b/docs/api/en/audio/PositionalAudio.html @@ -87,7 +87,7 @@

[method:Float getRefDistance]()

Returns the value of [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/refDistance panner.refDistance].

-

[method:PositionalAudio setRefDistance]( [param:Float value] )

+

[method:this setRefDistance]( [param:Float value] )

Sets the value of [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/refDistance panner.refDistance].

@@ -97,7 +97,7 @@

[method:Float getRolloffFactor]()

Returns the value of [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/rolloffFactor panner.rolloffFactor].

-

[method:PositionalAudio setRolloffFactor]( [param:Float value] )

+

[method:this setRolloffFactor]( [param:Float value] )

Sets the value of [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/rolloffFactor panner.rolloffFactor].

@@ -107,7 +107,7 @@

[method:String getDistanceModel]()

Returns the value of [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/distanceModel panner.distanceModel].

-

[method:PositionalAudio setDistanceModel]( [param:String value] )

+

[method:this setDistanceModel]( [param:String value] )

Sets the value of [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/distanceModel panner.distanceModel].

@@ -117,12 +117,12 @@

[method:Float getMaxDistance]()

Returns the value of [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/maxDistance panner.maxDistance].

-

[method:PositionalAudio setMaxDistance]( [param:Float value] )

+

[method:this setMaxDistance]( [param:Float value] )

Sets the value of [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/maxDistance panner.maxDistance].

-

[method:PositionalAudio setDirectionalCone]( [param:Float coneInnerAngle], [param:Float coneOuterAngle], [param:Float coneOuterGain] )

+

[method:this setDirectionalCone]( [param:Float coneInnerAngle], [param:Float coneOuterAngle], [param:Float coneOuterGain] )

This method can be used in order to transform an omnidirectional sound into a [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode directional sound].

diff --git a/docs/api/en/cameras/Camera.html b/docs/api/en/cameras/Camera.html index 463ddbaedde670..6acf429282b519 100644 --- a/docs/api/en/cameras/Camera.html +++ b/docs/api/en/cameras/Camera.html @@ -59,7 +59,7 @@

[method:Camera clone]( )

Return a new camera with the same properties as this one.

-

[method:Camera copy]( [param:Camera source], [param:Boolean recursive] )

+

[method:this copy]( [param:Camera source], [param:Boolean recursive] )

Copy the properties from the source camera into this one.

diff --git a/docs/api/en/core/BufferAttribute.html b/docs/api/en/core/BufferAttribute.html index a68031fcec2c19..9f5ded52b1c536 100644 --- a/docs/api/en/core/BufferAttribute.html +++ b/docs/api/en/core/BufferAttribute.html @@ -120,10 +120,10 @@

[method:this transformDirection]( [param:Matrix4 m] )

[method:BufferAttribute clone]()

Return a copy of this bufferAttribute.

-

[method:BufferAttribute copy]( [param:BufferAttribute bufferAttribute] )

+

[method:this copy]( [param:BufferAttribute bufferAttribute] )

Copies another BufferAttribute to this BufferAttribute.

-

[method:BufferAttribute copyArray]( array )

+

[method:this copyArray]( array )

Copy the array given here (which can be a normal array or TypedArray) into [page:BufferAttribute.array array].

@@ -134,16 +134,16 @@

[method:BufferAttribute copyArray]( array )

[method:this copyAt] ( [param:Integer index1], [param:BufferAttribute bufferAttribute], [param:Integer index2] )

Copy a vector from bufferAttribute[index2] to [page:BufferAttribute.array array][index1].

-

[method:BufferAttribute copyColorsArray]( [param:Array colors] )

+

[method:this copyColorsArray]( [param:Array colors] )

Copy an array representing RGB color values into [page:BufferAttribute.array array].

-

[method:BufferAttribute copyVector2sArray]( [param:Array vectors] )

+

[method:this copyVector2sArray]( [param:Array vectors] )

Copy an array representing [page:Vector2]s into [page:BufferAttribute.array array].

-

[method:BufferAttribute copyVector3sArray]( [param:Array vectors] )

+

[method:this copyVector3sArray]( [param:Array vectors] )

Copy an array representing [page:Vector3]s into [page:BufferAttribute.array array].

-

[method:BufferAttribute copyVector4sArray]( [param:Array vectors] )

+

[method:this copyVector4sArray]( [param:Array vectors] )

Copy an array representing [page:Vector4]s into [page:BufferAttribute.array array].

[method:Number getX]( [param:Integer index] )

@@ -166,7 +166,7 @@

[method:this onUpload]( [param:Function callback] )

after the buffer has been transferred to the GPU.

-

[method:BufferAttribute set] ( [param:Array value], [param:Integer offset] )

+

[method:this set] ( [param:Array value], [param:Integer offset] )

value -- an [page:Array] or [page:TypedArray] from which to copy values.
offset -- (optional) index of the [page:BufferAttribute.array array] at which to start copying.

@@ -178,28 +178,28 @@

[method:BufferAttribute set] ( [param:Array value], [param:Integer offset] ) being a [page:TypedArray].

-

[method:BufferAttribute setUsage] ( [param:Usage value] )

+

[method:this setUsage] ( [param:Usage value] )

Set [page:BufferAttribute.usage usage] to value. See usage [page:BufferAttributeUsage constants] for all possible input values.

-

[method:BufferAttribute setX]( [param:Integer index], [param:Float x] )

+

[method:this setX]( [param:Integer index], [param:Float x] )

Sets the x component of the vector at the given index.

-

[method:BufferAttribute setY]( [param:Integer index], [param:Float y] )

+

[method:this setY]( [param:Integer index], [param:Float y] )

Sets the y component of the vector at the given index.

-

[method:BufferAttribute setZ]( [param:Integer index], [param:Float z] )

+

[method:this setZ]( [param:Integer index], [param:Float z] )

Sets the z component of the vector at the given index.

-

[method:BufferAttribute setW]( [param:Integer index], [param:Float w] )

+

[method:this setW]( [param:Integer index], [param:Float w] )

Sets the w component of the vector at the given index.

-

[method:BufferAttribute setXY]( [param:Integer index], [param:Float x], [param:Float y] )

+

[method:this setXY]( [param:Integer index], [param:Float x], [param:Float y] )

Sets the x and y components of the vector at the given index.

-

[method:BufferAttribute setXYZ]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z] )

+

[method:this setXYZ]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z] )

Sets the x, y and z components of the vector at the given index.

-

[method:BufferAttribute setXYZW]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z], [param:Float w] )

+

[method:this setXYZW]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z], [param:Float w] )

Sets the x, y, z and w components of the vector at the given index.

diff --git a/docs/api/en/core/BufferGeometry.html b/docs/api/en/core/BufferGeometry.html index e0279aa8239a8d..0bf4c329d20ab8 100644 --- a/docs/api/en/core/BufferGeometry.html +++ b/docs/api/en/core/BufferGeometry.html @@ -162,7 +162,7 @@

Methods

[page:EventDispatcher EventDispatcher] methods are available on this class.

-

[method:BufferGeometry setAttribute]( [param:String name], [param:BufferAttribute attribute] )

+

[method:this setAttribute]( [param:String name], [param:BufferAttribute attribute] )

Sets an attribute to this geometry. Use this rather than the attributes property, because an internal hashmap of [page:.attributes] is maintained to speed up iterating over @@ -182,13 +182,13 @@

[method:this applyMatrix4]( [param:Matrix4 matrix] )

[method:this applyQuaternion]( [param:Quaternion quaternion] )

Applies the rotation represented by the quaternion to the geometry.

-

[method:BufferGeometry center] ()

+

[method:this center] ()

Center the geometry based on the bounding box.

[method:BufferGeometry clone]()

Creates a clone of this BufferGeometry.

-

[method:BufferGeometry copy]( [param:BufferGeometry bufferGeometry] )

+

[method:this copy]( [param:BufferGeometry bufferGeometry] )

Copies another BufferGeometry to this BufferGeometry.

[method:undefined clearGroups]( )

@@ -230,7 +230,7 @@

[method:BufferAttribute getIndex] ()

[method:Boolean hasAttribute]( [param:String name] )

Returns *true* if the attribute with the specified name exists.

-

[method:BufferGeometry lookAt] ( [param:Vector3 vector] )

+

[method:this lookAt] ( [param:Vector3 vector] )

vector - A world vector to look at.

@@ -250,38 +250,38 @@

[method:undefined normalizeNormals]()

[method:BufferAttribute deleteAttribute]( [param:String name] )

Deletes the [page:BufferAttribute attribute] with the specified name.

-

[method:BufferGeometry rotateX] ( [param:Float radians] )

+

[method:this rotateX] ( [param:Float radians] )

Rotate the geometry about the X axis. This is typically done as a one time operation, and not during a loop. Use [page:Object3D.rotation] for typical real-time mesh rotation.

-

[method:BufferGeometry rotateY] ( [param:Float radians] )

+

[method:this rotateY] ( [param:Float radians] )

Rotate the geometry about the Y axis. This is typically done as a one time operation, and not during a loop. Use [page:Object3D.rotation] for typical real-time mesh rotation.

-

[method:BufferGeometry rotateZ] ( [param:Float radians] )

+

[method:this rotateZ] ( [param:Float radians] )

Rotate the geometry about the Z axis. This is typically done as a one time operation, and not during a loop. Use [page:Object3D.rotation] for typical real-time mesh rotation.

-

[method:BufferGeometry scale] ( [param:Float x], [param:Float y], [param:Float z] )

+

[method:this scale] ( [param:Float x], [param:Float y], [param:Float z] )

Scale the geometry data. This is typically done as a one time operation, and not during a loop. Use [page:Object3D.scale] for typical real-time mesh scaling.

-

[method:BufferGeometry setIndex] ( [param:BufferAttribute index] )

+

[method:this setIndex] ( [param:BufferAttribute index] )

Set the [page:.index] buffer.

[method:undefined setDrawRange] ( [param:Integer start], [param:Integer count] )

Set the [page:.drawRange] property. For non-indexed BufferGeometry, count is the number of vertices to render. For indexed BufferGeometry, count is the number of indices to render.

-

[method:BufferGeometry setFromPoints] ( [param:Array points] )

+

[method:this setFromPoints] ( [param:Array points] )

Sets the attributes for this BufferGeometry from an array of points.

[method:Object toJSON]()

@@ -290,7 +290,7 @@

[method:Object toJSON]()

[method:BufferGeometry toNonIndexed]()

Return a non-index version of an indexed BufferGeometry.

-

[method:BufferGeometry translate] ( [param:Float x], [param:Float y], [param:Float z] )

+

[method:this translate] ( [param:Float x], [param:Float y], [param:Float z] )

Translate the geometry. This is typically done as a one time operation, and not during a loop. Use [page:Object3D.position] for typical real-time mesh translation. diff --git a/docs/api/en/core/InstancedBufferGeometry.html b/docs/api/en/core/InstancedBufferGeometry.html index aff6ece571a9e2..58bb0598d9b9ec 100644 --- a/docs/api/en/core/InstancedBufferGeometry.html +++ b/docs/api/en/core/InstancedBufferGeometry.html @@ -31,7 +31,7 @@

[property:Number instanceCount]

Methods

See [page:BufferGeometry] for inherited methods.

-

[method:InstancedBufferGeometry copy]( [param:InstancedBufferGeometry source] )

+

[method:this copy]( [param:InstancedBufferGeometry source] )

Copies the given [name] to this instance.

Source

diff --git a/docs/api/en/core/InterleavedBuffer.html b/docs/api/en/core/InterleavedBuffer.html index 8bf4e989913fca..471f67e4c79ba6 100644 --- a/docs/api/en/core/InterleavedBuffer.html +++ b/docs/api/en/core/InterleavedBuffer.html @@ -81,15 +81,15 @@

[property:Usage usage]

Methods

-

[method:InterleavedBuffer copy]( [param:InterleavedBuffer source] )

+

[method:this copy]( [param:InterleavedBuffer source] )

Copies another [name] to this [name].

-

[method:InterleavedBuffer copyAt]( [param:Integer index1], [param:InterleavedBuffer attribute], [param:Integer index2] )

+

[method:this copyAt]( [param:Integer index1], [param:InterleavedBuffer attribute], [param:Integer index2] )

Copies data from attribute[index2] to [page:InterleavedBuffer.array array][index1].

-

[method:InterleavedBuffer set]( [param:TypedArray value], [param:Integer offset] )

+

[method:this set]( [param:TypedArray value], [param:Integer offset] )

value - The source (typed) array.
offset - The offset into the target array at which to begin writing values from the source array. Default is *0*.

@@ -104,10 +104,10 @@

[method:InterleavedBuffer clone]( [param:Object data] )

Creates a clone of this [name].

-

[method:InterleavedBuffer setUsage] ( [param:Usage value] )

+

[method:this setUsage] ( [param:Usage value] )

Set [page:InterleavedBuffer.usage usage] to value.

-

[method:InterleavedBuffer toJSON]( [param:Object data] )

+

[method:Object toJSON]( [param:Object data] )

data - This object holds shared array buffers required for properly serializing geometries with interleaved attributes.

diff --git a/docs/api/en/extras/core/Curve.html b/docs/api/en/extras/core/Curve.html index a9f51783b4ea57..51d5819d5b20f6 100644 --- a/docs/api/en/extras/core/Curve.html +++ b/docs/api/en/extras/core/Curve.html @@ -111,13 +111,13 @@

[method:Object computeFrenetFrames]( [param:Integer segments], [param:Boolea

[method:Curve clone]()

Creates a clone of this instance.

-

[method:Curve copy]( [param:Curve source] )

+

[method:this copy]( [param:Curve source] )

Copies another [name] object to this instance.

[method:Object toJSON]()

Returns a JSON object representation of this instance.

-

[method:Curve fromJSON]( [param:Object json] )

+

[method:this fromJSON]( [param:Object json] )

Copies the data from the given JSON object to this instance.

Source

diff --git a/docs/api/en/helpers/BoxHelper.html b/docs/api/en/helpers/BoxHelper.html index f3010f72b39f83..f041a6a4182505 100644 --- a/docs/api/en/helpers/BoxHelper.html +++ b/docs/api/en/helpers/BoxHelper.html @@ -60,7 +60,7 @@

[method:undefined update]()

of the object, including any children. See [page:Box3.setFromObject].

-

[method:BoxHelper setFromObject]( [param:Object3D object] )

+

[method:this setFromObject]( [param:Object3D object] )

[page:Object3D object] - [page:Object3D] to create the helper of.

diff --git a/docs/api/en/lights/DirectionalLight.html b/docs/api/en/lights/DirectionalLight.html index 49e9cfb13f74fc..a0eccb1f982a2d 100644 --- a/docs/api/en/lights/DirectionalLight.html +++ b/docs/api/en/lights/DirectionalLight.html @@ -123,7 +123,7 @@

[method:undefined dispose]()

Disposes of this light's [page:DirectionalLightShadow shadow].

-

[method:DirectionalLight copy]( [param:DirectionalLight source] )

+

[method:this copy]( [param:DirectionalLight source] )

Copies value of all the properties from the [page:DirectionalLight source] to this DirectionalLight. diff --git a/docs/api/en/lights/HemisphereLight.html b/docs/api/en/lights/HemisphereLight.html index 315f61bb9664da..732ccc9c74b8da 100644 --- a/docs/api/en/lights/HemisphereLight.html +++ b/docs/api/en/lights/HemisphereLight.html @@ -73,7 +73,7 @@

Methods

See the base [page:Light Light] class for common methods.

-

[method:HemisphereLight copy]( [param:HemisphereLight source] )

+

[method:this copy]( [param:HemisphereLight source] )

Copies the value of [page:.color color], [page:.intensity intensity] and [page:.groundColor groundColor] from the [page:Light source] light into this one. diff --git a/docs/api/en/lights/Light.html b/docs/api/en/lights/Light.html index 3dd2e29ae57897..2098ee3d84fbf6 100644 --- a/docs/api/en/lights/Light.html +++ b/docs/api/en/lights/Light.html @@ -56,7 +56,7 @@

[method:undefined dispose]()

Abstract dispose method for lights; implemented by subclasses that have disposable resources.

-

[method:Light copy]( [param:Light source] )

+

[method:this copy]( [param:Light source] )

Copies the value of [page:.color color] and [page:.intensity intensity] from the [page:Light source] light into this one. diff --git a/docs/api/en/lights/PointLight.html b/docs/api/en/lights/PointLight.html index ae586330c1fc18..062b656d270161 100644 --- a/docs/api/en/lights/PointLight.html +++ b/docs/api/en/lights/PointLight.html @@ -117,7 +117,7 @@

[method:undefined dispose]()

Disposes of this light's [page:PointLightShadow shadow].

-

[method:PointLight copy]( [param:PointLight source] )

+

[method:this copy]( [param:PointLight source] )

Copies value of all the properties from the [page:PointLight source] to this PointLight. diff --git a/docs/api/en/lights/RectAreaLight.html b/docs/api/en/lights/RectAreaLight.html index f33330f199f172..7cadcb4f2681ea 100644 --- a/docs/api/en/lights/RectAreaLight.html +++ b/docs/api/en/lights/RectAreaLight.html @@ -87,7 +87,7 @@

Methods

-

[method:RectAreaLight copy]( [param:RectAreaLight source] )

+

[method:this copy]( [param:RectAreaLight source] )

Copies value of all the properties from the [page:RectAreaLight source] to this RectAreaLight. diff --git a/docs/api/en/lights/SpotLight.html b/docs/api/en/lights/SpotLight.html index cf92ba052dcfcc..13e288800d2717 100644 --- a/docs/api/en/lights/SpotLight.html +++ b/docs/api/en/lights/SpotLight.html @@ -176,7 +176,7 @@

[method:undefined dispose]()

Disposes of this light's [page:SpotLightShadow shadow].

-

[method:SpotLight copy]( [param:SpotLight source] )

+

[method:this copy]( [param:SpotLight source] )

Copies value of all the properties from the [page:SpotLight source] to this SpotLight. diff --git a/docs/api/en/lights/shadows/LightShadow.html b/docs/api/en/lights/shadows/LightShadow.html index 41d9065b533816..9a3f04454fc8bc 100644 --- a/docs/api/en/lights/shadows/LightShadow.html +++ b/docs/api/en/lights/shadows/LightShadow.html @@ -132,7 +132,7 @@

[method:undefined dispose]()

Disposes of this shadow's textures ([page:LightShadow.map map] and [page:LightShadow.mapPass mapPass]).

-

[method:LightShadow copy]( [param:LightShadow source] )

+

[method:this copy]( [param:LightShadow source] )

Copies value of all the properties from the [page:LightShadow source] to this Light. diff --git a/docs/api/en/loaders/FileLoader.html b/docs/api/en/loaders/FileLoader.html index 5dc24b64493f36..d2655ec77d9b9e 100644 --- a/docs/api/en/loaders/FileLoader.html +++ b/docs/api/en/loaders/FileLoader.html @@ -74,7 +74,7 @@

[property:String responseType]

Methods

See the base [page:Loader] class for common methods.

-

[method:XMLHttpRequest load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )

+

[method:undefined load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )

[page:String url] — the path or URL to the file. This can also be a [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
@@ -86,13 +86,13 @@

[method:XMLHttpRequest load]( [param:String url], [param:Function onLoad], [ Load the URL and pass the response to the onLoad function.

-

[method:FileLoader setMimeType]( [param:String mimeType] )

+

[method:this setMimeType]( [param:String mimeType] )

Set the expected [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types mimeType] of the file being loaded. Note that in many cases this will be determined automatically, so by default it is *undefined*.

-

[method:FileLoader setResponseType]( [param:String responseType] )

+

[method:this setResponseType]( [param:String responseType] )

Change the response type. Valid values are:
[page:String text] or empty string (default) - returns the data as [page:String String].
diff --git a/docs/api/en/loaders/ImageBitmapLoader.html b/docs/api/en/loaders/ImageBitmapLoader.html index f1a140fdbe9240..580eb771d53459 100644 --- a/docs/api/en/loaders/ImageBitmapLoader.html +++ b/docs/api/en/loaders/ImageBitmapLoader.html @@ -90,7 +90,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param Begin loading from url and return the [page:ImageBitmap image] object that will contain the data.

-

[method:ImageBitmapLoader setOptions]( [param:Object options] )

+

[method:this setOptions]( [param:Object options] )

Sets the options object for [link:https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/createImageBitmap createImageBitmap].

diff --git a/docs/api/en/loaders/Loader.html b/docs/api/en/loaders/Loader.html index 6a3e0a0e0a6fd6..c8508de67c01ca 100644 --- a/docs/api/en/loaders/Loader.html +++ b/docs/api/en/loaders/Loader.html @@ -84,29 +84,29 @@

[method:undefined parse]()

This method needs to be implement by all concrete loaders. It holds the logic for parsing the asset into three.js entities.

-

[method:Loader setCrossOrigin]( [param:String crossOrigin] )

+

[method:this setCrossOrigin]( [param:String crossOrigin] )

[page:String crossOrigin] — The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.

-

[method:Loader setWithCredentials]( [param:Boolean value] )

+

[method:this setWithCredentials]( [param:Boolean value] )

Whether the XMLHttpRequest uses credentials such as cookies, authorization headers or TLS client certificates. See [link:https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials XMLHttpRequest.withCredentials].
Note that this has no effect if you are loading files locally or from the same domain.

-

[method:Loader setPath]( [param:String path] )

+

[method:this setPath]( [param:String path] )

[page:String path] — Set the base path for the asset.

-

[method:Loader setResourcePath]( [param:String resourcePath] )

+

[method:this setResourcePath]( [param:String resourcePath] )

[page:String resourcePath] — Set the base path for dependent resources like textures.

-

[method:Loader setRequestHeader]( [param:Object requestHeader] )

+

[method:this setRequestHeader]( [param:Object requestHeader] )

[page:Object requestHeader] - key: The name of the header whose value is to be set. value: The value to set as the body of the header.

diff --git a/docs/api/en/loaders/MaterialLoader.html b/docs/api/en/loaders/MaterialLoader.html index 021daff43f8283..decee0c3e3b167 100644 --- a/docs/api/en/loaders/MaterialLoader.html +++ b/docs/api/en/loaders/MaterialLoader.html @@ -80,7 +80,7 @@

[method:Material parse]( [param:Object json] )

Parse a JSON structure and create a new [page:Material] of the type [page:String json.type] with parameters defined in the json object.

-

[method:MaterialLoader setTextures]( [param:Object textures] )

+

[method:this setTextures]( [param:Object textures] )

[page:Object textures] — object containing any textures used by the material.

diff --git a/docs/api/en/loaders/ObjectLoader.html b/docs/api/en/loaders/ObjectLoader.html index a692b4d2850e59..51b8c7a51ab0bc 100644 --- a/docs/api/en/loaders/ObjectLoader.html +++ b/docs/api/en/loaders/ObjectLoader.html @@ -94,35 +94,35 @@

[method:Object3D parse]( [param:Object json], [param:Function onLoad] )

-

[method:Object3D parseGeometries]( [param:Object json] )

+

[method:Object parseGeometries]( [param:Object json] )

[page:Object json] — required. The JSON source to parse.

This is used by [page:.parse]() to parse any [page:BufferGeometry geometries] in the JSON structure.

-

[method:Object3D parseMaterials]( [param:Object json] )

+

[method:Object parseMaterials]( [param:Object json] )

[page:Object json] — required. The JSON source to parse.

This is used by [page:.parse]() to parse any materials in the JSON structure using [page:MaterialLoader].

-

[method:Object3D parseAnimations]( [param:Object json] )

+

[method:Object parseAnimations]( [param:Object json] )

[page:Object json] — required. The JSON source to parse.

This is used by [page:.parse]() to parse any animations in the JSON structure, using [page:AnimationClip.parse]().

-

[method:Object3D parseImages]( [param:Object json] )

+

[method:Object parseImages]( [param:Object json] )

[page:Object json] — required. The JSON source to parse.

This is used by [page:.parse]() to parse any images in the JSON structure, using [page:ImageLoader].

-

[method:Object3D parseTextures]( [param:Object json] )

+

[method:Object parseTextures]( [param:Object json] )

[page:Object json] — required. The JSON source to parse.

diff --git a/docs/api/en/loaders/managers/LoadingManager.html b/docs/api/en/loaders/managers/LoadingManager.html index 7588654061fc8b..92c21641d29bf1 100644 --- a/docs/api/en/loaders/managers/LoadingManager.html +++ b/docs/api/en/loaders/managers/LoadingManager.html @@ -158,7 +158,7 @@

[property:Function onError]

Methods

-

[method:LoadingManager addHandler]( [param:Object regex], [param:Loader loader] )

+

[method:this addHandler]( [param:Object regex], [param:Loader loader] )

[page:Object regex] — A regular expression.
[page:Loader loader] — The loader. @@ -178,7 +178,7 @@

[method:Loader getHandler]( [param:String file] )

Can be used to retrieve the registered loader for the given file path.

-

[method:LoadingManager removeHandler]( [param:Object regex] )

+

[method:this removeHandler]( [param:Object regex] )

[page:Object regex] — A regular expression.

diff --git a/docs/api/en/materials/Material.html b/docs/api/en/materials/Material.html index 6fe52f765a8a9f..aafcdc6f6374a5 100644 --- a/docs/api/en/materials/Material.html +++ b/docs/api/en/materials/Material.html @@ -321,7 +321,7 @@

[page:EventDispatcher EventDispatcher] methods are available on this class.<

[method:Material clone]( )

Return a new material with the same parameters as this material.

-

[method:Material copy]( [param:material material] )

+

[method:this copy]( [param:material material] )

Copy the parameters from the passed material into this material.

[method:undefined dispose]()

diff --git a/docs/api/en/math/Box2.html b/docs/api/en/math/Box2.html index 66c6a55ead301c..40f62e07dcafa1 100644 --- a/docs/api/en/math/Box2.html +++ b/docs/api/en/math/Box2.html @@ -75,7 +75,7 @@

[method:Boolean containsPoint]( [param:Vector2 point] )

Returns true if the specified [page:Vector2 point] lies within or on the boundaries of this box.

-

[method:Box2 copy]( [param:Box2 box] )

+

[method:this copy]( [param:Box2 box] )

Copies the [page:.min min] and [page:.max max] from [page:Box2 box] to this box.

@@ -95,14 +95,14 @@

[method:Boolean equals]( [param:Box2 box] )

Returns true if this box and [page:Box2 box] share the same lower and upper bounds.

-

[method:Box2 expandByPoint]( [param:Vector2 point] )

+

[method:this expandByPoint]( [param:Vector2 point] )

[page:Vector2 point] - [page:Vector2] that should be included in the box.

Expands the boundaries of this box to include [page:Vector2 point].

-

[method:Box2 expandByScalar]( [param:Float scalar] )

+

[method:this expandByScalar]( [param:Float scalar] )

[page:Float scalar] - Distance to expand the box by.

@@ -110,7 +110,7 @@

[method:Box2 expandByScalar]( [param:Float scalar] )

will be contracted.

-

[method:Box2 expandByVector]( [param:Vector2 vector] )

+

[method:this expandByVector]( [param:Vector2 vector] )

[page:Vector2 vector] - [page:Vector2] to expand the box by.

@@ -141,7 +141,7 @@

[method:Vector2 getSize]( [param:Vector2 target] )

Returns the width and height of this box.

-

[method:Box2 intersect]( [param:Box2 box] )

+

[method:this intersect]( [param:Box2 box] )

[page:Box2 box] - Box to intersect with.

@@ -164,11 +164,11 @@

[method:Boolean isEmpty]()

one both bounds share.

-

[method:Box2 makeEmpty]()

+

[method:this makeEmpty]()

Makes this box empty.

-

[method:Box2 set]( [param:Vector2 min], [param:Vector2 max] )

+

[method:this set]( [param:Vector2 min], [param:Vector2 max] )

[page:Vector2 min] - (required ) [page:Vector2] representing the lower (x, y) boundary of the box.
[page:Vector2 max] - (required) [page:Vector2] representing the upper (x, y) boundary of the box.

@@ -177,7 +177,7 @@

[method:Box2 set]( [param:Vector2 min], [param:Vector2 max] )

Please note that this method only copies the values from the given objects.

-

[method:Box2 setFromCenterAndSize]( [param:Vector2 center], [param:Vector2 size] )

+

[method:this setFromCenterAndSize]( [param:Vector2 center], [param:Vector2 size] )

[page:Vector2 center] - Desired center position of the box ([page:Vector2]).
[page:Vector2 size] - Desired x and y dimensions of the box ([page:Vector2]).

@@ -186,14 +186,14 @@

[method:Box2 setFromCenterAndSize]( [param:Vector2 center], [param:Vector2 s in [page:Vector2 size].

-

[method:Box2 setFromPoints]( [param:Array points] )

+

[method:this setFromPoints]( [param:Array points] )

[page:Array points] - Array of [page:Vector2 Vector2s] that the resulting box will contain.

Sets the upper and lower bounds of this box to include all of the points in [page:Array points].

-

[method:Box2 translate]( [param:Vector2 offset] )

+

[method:this translate]( [param:Vector2 offset] )

[page:Vector2 offset] - Direction and distance of offset.

@@ -201,7 +201,7 @@

[method:Box2 translate]( [param:Vector2 offset] )

[page:Vector2 offset] units in 2D space.

-

[method:Box2 union]( [param:Box2 box] )

+

[method:this union]( [param:Box2 box] )

[page:Box2 box] - Box that will be unioned with this box.

diff --git a/docs/api/en/math/Color.html b/docs/api/en/math/Color.html index adfdf427f88a46..fe63b8e85cd934 100644 --- a/docs/api/en/math/Color.html +++ b/docs/api/en/math/Color.html @@ -96,46 +96,46 @@

[property:Float b]

Methods

-

[method:Color add]( [param:Color color] )

+

[method:this add]( [param:Color color] )

Adds the RGB values of [page:Color color] to the RGB values of this color.

-

[method:Color addColors]( [param:Color color1], [param:Color color2] )

+

[method:this addColors]( [param:Color color1], [param:Color color2] )

Sets this color's RGB values to the sum of the RGB values of [page:Color color1] and [page:Color color2].

-

[method:Color addScalar]( [param:Number s] )

+

[method:this addScalar]( [param:Number s] )

Adds [page:Number s] to the RGB values of this color.

[method:Color clone]()

Returns a new Color with the same [page:.r r], [page:.g g] and [page:.b b] values as this one.

-

[method:Color copy]( [param:Color color] )

+

[method:this copy]( [param:Color color] )

Copies the [page:.r r], [page:.g g] and [page:.b b] parameters from [page:Color color] in to this color.

-

[method:Color convertGammaToLinear]( [param:Float gammaFactor] )

+

[method:this convertGammaToLinear]( [param:Float gammaFactor] )

[page:Float gammaFactor] - (optional). Default is *2.0*.

Converts this color from gamma space to linear space by taking [page:.r r], [page:.g g] and [page:.b b] to the power of [page:Float gammaFactor].

-

[method:Color convertLinearToGamma]( [param:Float gammaFactor] )

+

[method:this convertLinearToGamma]( [param:Float gammaFactor] )

[page:Float gammaFactor] - (optional). Default is *2.0*.

Converts this color from linear space to gamma space by taking [page:.r r], [page:.g g] and [page:.b b] to the power of 1 / [page:Float gammaFactor].

-

[method:Color convertLinearToSRGB]()

+

[method:this convertLinearToSRGB]()

Converts this color from linear space to sRGB space.

-

[method:Color convertSRGBToLinear]()

+

[method:this convertSRGBToLinear]()

Converts this color from sRGB space to linear space.

-

[method:Color copyGammaToLinear]( [param:Color color], [param:Float gammaFactor] )

+

[method:this copyGammaToLinear]( [param:Color color], [param:Float gammaFactor] )

[page:Color color] — Color to copy.
[page:Float gammaFactor] - (optional). Default is *2.0*.

@@ -144,7 +144,7 @@

[method:Color copyGammaToLinear]( [param:Color color], [param:Float gammaFac by taking [page:.r r], [page:.g g] and [page:.b b] to the power of [page:Float gammaFactor].

-

[method:Color copyLinearToGamma]( [param:Color color], [param:Float gammaFactor] )

+

[method:this copyLinearToGamma]( [param:Color color], [param:Float gammaFactor] )

[page:Color color] — Color to copy.
[page:Float gammaFactor] - (optional). Default is *2.0*.

@@ -153,14 +153,14 @@

[method:Color copyLinearToGamma]( [param:Color color], [param:Float gammaFac by taking [page:.r r], [page:.g g] and [page:.b b] to the power of 1 / [page:Float gammaFactor].

-

[method:Color copyLinearToSRGB]( [param:Color color]] )

+

[method:this copyLinearToSRGB]( [param:Color color]] )

[page:Color color] — Color to copy.
Copies the given color into this color, and then converts this color from linear space to sRGB space.

-

[method:Color copySRGBToLinear]( [param:Color color] )

+

[method:this copySRGBToLinear]( [param:Color color] )

[page:Color color] — Color to copy.
@@ -170,7 +170,7 @@

[method:Color copySRGBToLinear]( [param:Color color] )

[method:Boolean equals]( [param:Color color] )

Compares the RGB values of [page:Color color] with those of this object. Returns true if they are the same, false otherwise.

-

[method:Color fromArray]( [param:Array array], [param:Integer offset] )

+

[method:this fromArray]( [param:Array array], [param:Integer offset] )

[page:Array array] - [page:Array] of floats in the form [ [page:Float r], [page:Float g], [page:Float b] ].
[page:Integer offset] - An optional offset into the array.

@@ -208,7 +208,7 @@

[method:Object getHSL]( [param:Object target] )

[method:String getStyle]()

Returns the value of this color as a CSS style string. Example: 'rgb(255,0,0)'.

-

[method:Color lerp]( [param:Color color], [param:Float alpha] )

+

[method:this lerp]( [param:Color color], [param:Float alpha] )

[page:Color color] - color to converge on.
[page:Float alpha] - interpolation factor in the closed interval [0, 1].

@@ -229,7 +229,7 @@

[method:this lerpColors]( [param:Color color1], [param:Color color2], [param - alpha = 0 will be [page:Color color1], and alpha = 1 will be [page:Color color2].

-

[method:Color lerpHSL]( [param:Color color], [param:Float alpha] )

+

[method:this lerpHSL]( [param:Color color], [param:Float alpha] )

[page:Color color] - color to converge on.
[page:Float alpha] - interpolation factor in the closed interval [0, 1].

@@ -241,20 +241,20 @@

[method:Color lerpHSL]( [param:Color color], [param:Float alpha] )

this color and 1.0 is the first argument.

-

[method:Color multiply]( [param:Color color] )

+

[method:this multiply]( [param:Color color] )

Multiplies this color's RGB values by the given [page:Color color]'s RGB values.

-

[method:Color multiplyScalar]( [param:Number s] )

+

[method:this multiplyScalar]( [param:Number s] )

Multiplies this color's RGB values by [page:Number s].

-

[method:Color offsetHSL]( [param:Float h], [param:Float s], [param:Float l] )

+

[method:this offsetHSL]( [param:Float h], [param:Float s], [param:Float l] )

Adds the given [page:Float h], [page:Float s], and [page:Float l] to this color's values. Internally, this converts the color's [page:.r r], [page:.g g] and [page:.b b] values to HSL, adds [page:Float h], [page:Float s], and [page:Float l], and then converts the color back to RGB.

-

[method:Color set]( [param:Color_Hex_or_String value] )

+

[method:this set]( [param:Color_Hex_or_String value] )

[page:Color_Hex_or_String value] - Value to set this color to.

@@ -262,14 +262,14 @@

[method:Color set]( [param:Color_Hex_or_String value] )

Delegates to [page:.copy], [page:.setStyle], or [page:.setHex] depending on input type.

-

[method:Color setHex]( [param:Integer hex] )

+

[method:this setHex]( [param:Integer hex] )

[page:Integer hex] — [link:https://en.wikipedia.org/wiki/Web_colors#Hex_triplet hexadecimal triplet] format.

Sets this color from a hexadecimal value.

-

[method:Color setHSL]( [param:Float h], [param:Float s], [param:Float l] )

+

[method:this setHSL]( [param:Float h], [param:Float s], [param:Float l] )

[page:Float h] — hue value between 0.0 and 1.0
[page:Float s] — saturation value between 0.0 and 1.0
@@ -278,7 +278,7 @@

[method:Color setHSL]( [param:Float h], [param:Float s], [param:Float l] ) < Sets color from HSL values.

-

[method:Color setRGB]( [param:Float r], [param:Float g], [param:Float b] )

+

[method:this setRGB]( [param:Float r], [param:Float g], [param:Float b] )

[page:Float r] — Red channel value between 0.0 and 1.0.
[page:Float g] — Green channel value between 0.0 and 1.0.
@@ -287,14 +287,14 @@

[method:Color setRGB]( [param:Float r], [param:Float g], [param:Float b] ) < Sets this color from RGB values.

-

[method:Color setScalar]( [param:Float scalar] )

+

[method:this setScalar]( [param:Float scalar] )

[page:Float scalar] — a value between 0.0 and 1.0.

Sets all three color components to the value [page:Float scalar].

-

[method:Color setStyle]( [param:String style] )

+

[method:this setStyle]( [param:String style] )

[page:String style] — color as a CSS-style string.

@@ -313,7 +313,7 @@

[method:Color setStyle]( [param:String style] )

Note that for X11 color names, multiple words such as Dark Orange become the string 'darkorange'.

-

[method:Color setColorName]( [param:String style] )

+

[method:this setColorName]( [param:String style] )

[page:String style] — color name ( from [link:https://en.wikipedia.org/wiki/X11_color_names#Color_name_chart X11 color names] ).

@@ -322,7 +322,7 @@

[method:Color setColorName]( [param:String style] )

For convenience, the list of names is exposed in Color.NAMES as a hash: Color.NAMES.aliceblue // returns 0xF0F8FF

-

[method:Color sub]( [param:Color color] )

+

[method:this sub]( [param:Color color] )

Subtracts the RGB components of the given color from the RGB components of this color. If this results in a negative component, that component is set to zero. diff --git a/docs/api/en/math/Cylindrical.html b/docs/api/en/math/Cylindrical.html index 2727b4e1702251..f2a2cab20d155a 100644 --- a/docs/api/en/math/Cylindrical.html +++ b/docs/api/en/math/Cylindrical.html @@ -43,23 +43,23 @@

[method:Cylindrical clone]()

and [page:.y y] properties as this one.

-

[method:Cylindrical copy]( [param:Cylindrical other] )

+

[method:this copy]( [param:Cylindrical other] )

Copies the values of the passed Cylindrical's [page:.radius radius], [page:.theta theta] and [page:.y y] properties to this cylindrical.

-

[method:Cylindrical set]( [param:Float radius], [param:Float theta], [param:Float y] )

+

[method:this set]( [param:Float radius], [param:Float theta], [param:Float y] )

Sets values of this cylindrical's [page:.radius radius], [page:.theta theta] and [page:.y y] properties.

-

[method:Cylindrical setFromVector3]( [param:Vector3 vec3] )

+

[method:this setFromVector3]( [param:Vector3 vec3] )

Sets values of this cylindrical's [page:.radius radius], [page:.theta theta] and [page:.y y] properties from the [page:Vector3 Vector3].

-

[method:Cylindrical setFromCartesianCoords]( [param:Float x], [param:Float y], [param:Float z] )

+

[method:this setFromCartesianCoords]( [param:Float x], [param:Float y], [param:Float z] )

Sets values of this cylindrical's [page:.radius radius], [page:.theta theta] and [page:.y y] properties from Cartesian coordinates. diff --git a/docs/api/en/math/Euler.html b/docs/api/en/math/Euler.html index e8779d8be57cd0..cfe12a641ec670 100644 --- a/docs/api/en/math/Euler.html +++ b/docs/api/en/math/Euler.html @@ -69,7 +69,7 @@

[property:Float z]

Methods

-

[method:Euler copy]( [param:Euler euler] )

+

[method:this copy]( [param:Euler euler] )

Copies value of [page:Euler euler] to this euler.

[method:Euler clone]()

@@ -78,7 +78,7 @@

[method:Euler clone]()

[method:Boolean equals]( [param:Euler euler] )

Checks for strict equality of this euler and [page:Euler euler].

-

[method:Euler fromArray]( [param:Array array] )

+

[method:this fromArray]( [param:Array array] )

[page:Array array] of length 3 or 4. The optional 4th argument corresponds to the [page:.order order].

@@ -88,7 +88,7 @@

[method:Euler fromArray]( [param:Array array] )

Optionally assigns this euler's [page:.order order] to array[3].

-

[method:Euler reorder]( [param:String newOrder] )

+

[method:this reorder]( [param:String newOrder] )

Resets the euler angle with a new order by creating a quaternion from this euler angle and then setting this euler angle with the quaternion and the new order.

@@ -96,7 +96,7 @@

[method:Euler reorder]( [param:String newOrder] )

WARNING: this discards revolution information.

-

[method:Euler set]( [param:Float x], [param:Float y], [param:Float z], [param:String order] )

+

[method:this set]( [param:Float x], [param:Float y], [param:Float z], [param:String order] )

[page:.x x] - the angle of the x axis in radians.
[page:.y y] - the angle of the y axis in radians.
@@ -106,7 +106,7 @@

[method:Euler set]( [param:Float x], [param:Float y], [param:Float z], [para Sets the angles of this euler transform and optionally the [page:.order order].

-

[method:Euler setFromRotationMatrix]( [param:Matrix4 m], [param:String order] )

+

[method:this setFromRotationMatrix]( [param:Matrix4 m], [param:String order] )

[page:Matrix4 m] - a [page:Matrix4] of which the upper 3x3 of matrix is a pure [link:https://en.wikipedia.org/wiki/Rotation_matrix rotation matrix] (i.e. unscaled).
@@ -116,7 +116,7 @@

[method:Euler setFromRotationMatrix]( [param:Matrix4 m], [param:String order specified by order.

-

[method:Euler setFromQuaternion]( [param:Quaternion q], [param:String order] )

+

[method:this setFromQuaternion]( [param:Quaternion q], [param:String order] )

[page:Quaternion q] - a normalized quaternion.
[page:.order order] - (optional) a string representing the order that the rotations are applied.
@@ -126,7 +126,7 @@

[method:Euler setFromQuaternion]( [param:Quaternion q], [param:String order]

-

[method:Euler setFromVector3]( [param:Vector3 vector], [param:String order] )

+

[method:this setFromVector3]( [param:Vector3 vector], [param:String order] )

[page:Vector3 vector] - [page:Vector3].
[page:.order order] - (optional) a string representing the order that the rotations are applied.

diff --git a/docs/api/en/math/Frustum.html b/docs/api/en/math/Frustum.html index ec9d62d7a0570a..1ccce770a2f33a 100644 --- a/docs/api/en/math/Frustum.html +++ b/docs/api/en/math/Frustum.html @@ -54,7 +54,7 @@

[method:Boolean containsPoint]( [param:Vector3 point] )

Checks to see if the frustum contains the [page:Vector3 point].

-

[method:Frustum copy]( [param:Frustum frustum] )

+

[method:this copy]( [param:Frustum frustum] )

[page:Frustum frustum] - The frustum to copy

diff --git a/docs/api/en/math/Line3.html b/docs/api/en/math/Line3.html index f1def36da64a44..a6b76f090df581 100644 --- a/docs/api/en/math/Line3.html +++ b/docs/api/en/math/Line3.html @@ -38,7 +38,7 @@

[property:Vector3 end]

Methods

-

[method:Line3 applyMatrix4]( [param:Matrix4 matrix] )

+

[method:this applyMatrix4]( [param:Matrix4 matrix] )

Applies a matrix transform to the line segment.

[method:Vector3 at]( [param:Float t], [param:Vector3 target] )

@@ -72,7 +72,7 @@

[method:Float closestPointToPointParameter]( [param:Vector3 point], [param:B If [page:Boolean clampToLine] is true, then the returned value will be between 0 and 1.

-

[method:Line3 copy]( [param:Line3 line] )

+

[method:this copy]( [param:Line3 line] )

Copies the passed line's [page:.start start] and [page:.end end] vectors to this line.

[method:Vector3 delta]( [param:Vector3 target] )

@@ -107,7 +107,7 @@

[method:Vector3 getCenter]( [param:Vector3 target] )

Returns the center of the line segment.

-

[method:Line3 set]( [param:Vector3 start], [param:Vector3 end] )

+

[method:this set]( [param:Vector3 start], [param:Vector3 end] )

[page:Vector3 start] - set the [page:.start start point] of the line.
[page:Vector3 end] - set the [page:.end end point] of the line.

diff --git a/docs/api/en/math/Plane.html b/docs/api/en/math/Plane.html index 56118e5b0e023d..49129dca195760 100644 --- a/docs/api/en/math/Plane.html +++ b/docs/api/en/math/Plane.html @@ -33,7 +33,7 @@

[property:Float constant]

Methods

-

[method:Plane applyMatrix4]( [param:Matrix4 matrix], [param:Matrix3 optionalNormalMatrix] )

+

[method:this applyMatrix4]( [param:Matrix4 matrix], [param:Matrix3 optionalNormalMatrix] )

[page:Matrix4 matrix] - the [Page:Matrix4] to apply.
[page:Matrix3 optionalNormalMatrix] - (optional) pre-computed normal [Page:Matrix3] of the Matrix4 being applied.

@@ -56,7 +56,7 @@

[method:Vector3 coplanarPoint]( [param:Vector3 target] )

normal vector at the origin onto the plane.

-

[method:Plane copy]( [param:Plane plane] )

+

[method:this copy]( [param:Plane plane] )

Copies the values of the passed plane's [page:.normal normal] and [page:.constant constant] properties to this plane. @@ -105,12 +105,12 @@

[method:Boolean intersectsSphere]( [param:Sphere sphere] )

Determines whether or not this plane intersects [page:Sphere sphere].

-

[method:Plane negate]()

+

[method:this negate]()

Negates both the normal vector and the constant.

-

[method:Plane normalize]()

+

[method:this normalize]()

Normalizes the [page:.normal normal] vector, and adjusts the [page:.constant constant] value accordingly. @@ -124,7 +124,7 @@

[method:Vector3 projectPoint]( [param:Vector3 point], [param:Vector3 target] Projects a [page:Vector3 point] onto the plane.

-

[method:Plane set]( [param:Vector3 normal], [param:Float constant] )

+

[method:this set]( [param:Vector3 normal], [param:Float constant] )

[page:Vector3 normal] - a unit length [page:Vector3] defining the normal of the plane.
[page:Float constant] - the signed distance from the origin to the plane. Default is *0*.

@@ -132,7 +132,7 @@

[method:Plane set]( [param:Vector3 normal], [param:Float constant] )

Sets this plane's [page:.normal normal] and [page:.constant constant] properties by copying the values from the given normal.

-

[method:Plane setComponents]( [param:Float x], [param:Float y], [param:Float z], [param:Float w] )

+

[method:this setComponents]( [param:Float x], [param:Float y], [param:Float z], [param:Float w] )

[page:Float x] - x value of the unit length normal vector.
[page:Float y] - y value of the unit length normal vector.
@@ -142,7 +142,7 @@

[method:Plane setComponents]( [param:Float x], [param:Float y], [param:Float Set the individual components that define the plane.

-

[method:Plane setFromCoplanarPoints]( [param:Vector3 a], [param:Vector3 b], [param:Vector3 c] )

+

[method:this setFromCoplanarPoints]( [param:Vector3 a], [param:Vector3 b], [param:Vector3 c] )

[page:Vector3 a] - first point on the plane.
[page:Vector3 b] - second point on the plane.
@@ -152,7 +152,7 @@

[method:Plane setFromCoplanarPoints]( [param:Vector3 a], [param:Vector3 b], and determines the direction of the [page:.normal normal].

-

[method:Plane setFromNormalAndCoplanarPoint]( [param:Vector3 normal], [param:Vector3 point] )

+

[method:this setFromNormalAndCoplanarPoint]( [param:Vector3 normal], [param:Vector3 point] )

[page:Vector3 normal] - a unit length [page:Vector3] defining the normal of the plane.
[page:Vector3 point] - [page:Vector3]

@@ -160,7 +160,7 @@

[method:Plane setFromNormalAndCoplanarPoint]( [param:Vector3 normal], [param Sets the plane's properties as defined by a [page:Vector3 normal] and an arbitrary coplanar [page:Vector3 point].

-

[method:Plane translate]( [param:Vector3 offset] )

+

[method:this translate]( [param:Vector3 offset] )

[page:Vector3 offset] - the amount to move the plane by.

diff --git a/docs/api/en/math/Quaternion.html b/docs/api/en/math/Quaternion.html index 065624cfa3d21a..7f2a1ee113bfd7 100644 --- a/docs/api/en/math/Quaternion.html +++ b/docs/api/en/math/Quaternion.html @@ -61,13 +61,13 @@

[method:Quaternion clone]()

[page:.z z] and [page:.w w] properties to this one.

-

[method:Quaternion conjugate]()

+

[method:this conjugate]()

Returns the rotational conjugate of this quaternion. The conjugate of a quaternion represents the same rotation in the opposite direction about the rotational axis.

-

[method:Quaternion copy]( [param:Quaternion q] )

+

[method:this copy]( [param:Quaternion q] )

Copies the [page:.x x], [page:.y y], [page:.z z] and [page:.w w] properties of [page:Quaternion q] into this quaternion. @@ -88,7 +88,7 @@

[method:Float dot]( [param:Quaternion v] )

quaternions [page:Quaternion v] and this one.

-

[method:Quaternion fromArray]( [param:Array array], [param:Integer offset] )

+

[method:this fromArray]( [param:Array array], [param:Integer offset] )

[page:Array array] - array of format (x, y, z, w) used to construct the quaternion.
[page:Integer offset] - (optional) an offset into the array.

@@ -97,12 +97,12 @@

[method:Quaternion fromArray]( [param:Array array], [param:Integer offset] ) from an array.

-

[method:Quaternion identity]()

+

[method:this identity]()

Sets this quaternion to the identity quaternion; that is, to the quaternion that represents "no rotation".

-

[method:Quaternion invert]()

+

[method:this invert]()

Inverts this quaternion - calculates the [page:.conjugate conjugate]. The quaternion is assumed to have unit length.

@@ -119,31 +119,31 @@

[method:Float lengthSq]()

as this is a slightly more efficient calculation than [page:.length length]().

-

[method:Quaternion normalize]()

+

[method:this normalize]()

[link:https://en.wikipedia.org/wiki/Normalized_vector Normalizes] this quaternion - that is, calculated the quaternion that performs the same rotation as this one, but has [page:.length length] equal to *1*.

-

[method:Quaternion multiply]( [param:Quaternion q] )

+

[method:this multiply]( [param:Quaternion q] )

Multiplies this quaternion by [page:Quaternion q].

-

[method:Quaternion multiplyQuaternions]( [param:Quaternion a], [param:Quaternion b] )

+

[method:this multiplyQuaternions]( [param:Quaternion a], [param:Quaternion b] )

Sets this quaternion to [page:Quaternion a] x [page:Quaternion b].
Adapted from the method outlined [link:http://www.euclideanspace.com/maths/algebra/realNormedAlgebra/quaternions/code/index.htm here].

-

[method:Quaternion premultiply]( [param:Quaternion q] )

+

[method:this premultiply]( [param:Quaternion q] )

Pre-multiplies this quaternion by [page:Quaternion q].

-

[method:Quaternion random]()

+

[method:this random]()

Sets this quaternion to a uniformly random, normalized quaternion.

-

[method:Quaternion rotateTowards]( [param:Quaternion q], [param:Float step] )

+

[method:this rotateTowards]( [param:Quaternion q], [param:Float step] )

[page:Quaternion q] - The target quaternion.
[page:Float step] - The angular step in radians.

@@ -152,7 +152,7 @@

[method:Quaternion rotateTowards]( [param:Quaternion q], [param:Float step] The method ensures that the final quaternion will not overshoot *q*.

-

[method:Quaternion slerp]( [param:Quaternion qb], [param:Float t] )

+

[method:this slerp]( [param:Quaternion qb], [param:Float t] )

[page:Quaternion qb] - The other quaternion rotation
[page:Float t] - interpolation factor in the closed interval [0, 1].

@@ -171,20 +171,20 @@

[method:Quaternion slerp]( [param:Quaternion qb], [param:Float t] )

[method:this slerpQuaternions]( [param:Quaternion qa], [param:Quaternion qb], [param:Float t] )

Performs a spherical linear interpolation between the given quaternions and stores the result in this quaternion.

-

[method:Quaternion set]( [param:Float x], [param:Float y], [param:Float z], [param:Float w] )

+

[method:this set]( [param:Float x], [param:Float y], [param:Float z], [param:Float w] )

Sets [page:.x x], [page:.y y], [page:.z z], [page:.w w] properties of this quaternion.

-

[method:Quaternion setFromAxisAngle]( [param:Vector3 axis], [param:Float angle] )

+

[method:this setFromAxisAngle]( [param:Vector3 axis], [param:Float angle] )

Sets this quaternion from rotation specified by [page:Vector3 axis] and [page:Float angle].
Adapted from the method [link:http://www.euclideanspace.com/maths/geometry/rotations/conversions/angleToQuaternion/index.htm here].
*Axis* is assumed to be normalized, *angle* is in radians.

-

[method:Quaternion setFromEuler]( [param:Euler euler] )

+

[method:this setFromEuler]( [param:Euler euler] )

Sets this quaternion from the rotation specified by [page:Euler] angle.

-

[method:Quaternion setFromRotationMatrix]( [param:Matrix4 m] )

+

[method:this setFromRotationMatrix]( [param:Matrix4 m] )

[page:Matrix4 m] - a [page:Matrix4] of which the upper 3x3 of matrix is a pure [link:https://en.wikipedia.org/wiki/Rotation_matrix rotation matrix] (i.e. unscaled).
@@ -192,7 +192,7 @@

[method:Quaternion setFromRotationMatrix]( [param:Matrix4 m] )

Adapted from the method [link:http://www.euclideanspace.com/maths/geometry/rotations/conversions/matrixToQuaternion/index.htm here].

-

[method:Quaternion setFromUnitVectors]( [param:Vector3 vFrom], [param:Vector3 vTo] )

+

[method:this setFromUnitVectors]( [param:Vector3 vFrom], [param:Vector3 vTo] )

Sets this quaternion to the rotation required to rotate direction vector [page:Vector3 vFrom] to direction vector [page:Vector3 vTo].
diff --git a/docs/api/en/math/Ray.html b/docs/api/en/math/Ray.html index b2a22f44ac4899..7b73eecb26ef21 100644 --- a/docs/api/en/math/Ray.html +++ b/docs/api/en/math/Ray.html @@ -45,7 +45,7 @@

[property:Vector3 direction]

Methods

-

[method:Ray applyMatrix4]( [param:Matrix4 matrix4] )

+

[method:this applyMatrix4]( [param:Matrix4 matrix4] )

[page:Matrix4 matrix4] - the [page:Matrix4] to apply to this [page:Ray].

@@ -73,7 +73,7 @@

[method:Vector3 closestPointToPoint]( [param:Vector3 point], [param:Vector3 Get the point along this [page:Ray] that is closest to the [page:Vector3] provided.

-

[method:Ray copy]( [param:Ray ray] )

+

[method:this copy]( [param:Ray ray] )

Copies the [page:.origin origin] and [page:.direction direction] properties of [page:Ray ray] into this ray. @@ -179,21 +179,21 @@

[method:Boolean intersectsSphere]( [param:Sphere sphere] )

Return true if this [page:Ray] intersects with the [page:Sphere].

-

[method:Ray lookAt]( [param:Vector3 v] )

+

[method:this lookAt]( [param:Vector3 v] )

[page:Vector3 v] - The [page:Vector3] to look at.

Adjusts the direction of the ray to point at the vector in world coordinates.

-

[method:Ray recast]( [param:Float t] )

+

[method:this recast]( [param:Float t] )

[page:Float t] - The distance along the [page:Ray] to interpolate.

Shift the origin of this [page:Ray] along its direction by the distance given.

-

[method:Ray set]( [param:Vector3 origin], [param:Vector3 direction] )

+

[method:this set]( [param:Vector3 origin], [param:Vector3 direction] )

[page:Vector3 origin] - the [page:.origin origin] of the [page:Ray].
[page:Vector3 origin] - the [page:.direction direction] of the [page:Ray]. diff --git a/docs/api/en/math/Sphere.html b/docs/api/en/math/Sphere.html index fbb7d09990a495..ab8304205ed935 100644 --- a/docs/api/en/math/Sphere.html +++ b/docs/api/en/math/Sphere.html @@ -33,7 +33,7 @@

[property:Float radius]

Methods

-

[method:Sphere applyMatrix4]( [param:Matrix4 matrix] )

+

[method:this applyMatrix4]( [param:Matrix4 matrix] )

[page:Matrix4 matrix] - the [Page:Matrix4] to apply

@@ -60,7 +60,7 @@

[method:Boolean containsPoint]( [param:Vector3 point] )

surface of the sphere.

-

[method:Sphere copy]( [param:Sphere sphere] )

+

[method:this copy]( [param:Sphere sphere] )

Copies the values of the passed sphere's [page:.center center] and [page:.radius radius] properties to this sphere. @@ -85,7 +85,7 @@

[method:Boolean isEmpty]()

Spheres with a radius of 0 contain only their center point and are not considered to be empty.

-

[method:Sphere makeEmpty]()

+

[method:this makeEmpty]()

Makes the sphere empty by setting [page:.center center] to (0, 0, 0) and [page:.radius radius] to -1.

[method:Boolean equals]( [param:Sphere sphere] )

@@ -121,7 +121,7 @@

[method:Boolean intersectsSphere]( [param:Sphere sphere] )

Checks to see if two spheres intersect.

-

[method:Sphere set]( [param:Vector3 center], [param:Float radius] )

+

[method:this set]( [param:Vector3 center], [param:Float radius] )

[page:Vector3 center] - center of the sphere.
[page:Float radius] - radius of the sphere.

@@ -130,7 +130,7 @@

[method:Sphere set]( [param:Vector3 center], [param:Float radius] )

Please note that this method only copies the values from the given center.

-

[method:Sphere setFromPoints]( [param:Array points], [param:Vector3 optionalCenter] )

+

[method:this setFromPoints]( [param:Array points], [param:Vector3 optionalCenter] )

[page:Array points] - an [page:Array] of [page:Vector3] positions.
[page:Vector3 optionalCenter] - Optional [page:Vector3] position for the sphere's center.

@@ -140,7 +140,7 @@

[method:Sphere setFromPoints]( [param:Array points], [param:Vector3 optional [page:Array points] is calculated.

-

[method:Sphere translate]( [param:Vector3 offset] )

+

[method:this translate]( [param:Vector3 offset] )

Translate the sphere's center by the provided offset [page:Vector3].

diff --git a/docs/api/en/math/Spherical.html b/docs/api/en/math/Spherical.html index 2455b2b35ab08e..2a6e544e9453e1 100644 --- a/docs/api/en/math/Spherical.html +++ b/docs/api/en/math/Spherical.html @@ -43,28 +43,28 @@

[method:Spherical clone]()

and [page:.theta theta] properties as this one.

-

[method:Spherical copy]( [param:Spherical s] )

+

[method:this copy]( [param:Spherical s] )

Copies the values of the passed Spherical's [page:.radius radius], [page:.phi phi] and [page:.theta theta] properties to this spherical.

-

[method:Spherical makeSafe]()

+

[method:this makeSafe]()

Restricts the polar angle [page:.phi phi] to be between 0.000001 and pi - 0.000001.

-

[method:Spherical set]( [param:Float radius], [param:Float phi], [param:Float theta] )

+

[method:this set]( [param:Float radius], [param:Float phi], [param:Float theta] )

Sets values of this spherical's [page:.radius radius], [page:.phi phi] and [page:.theta theta] properties.

-

[method:Spherical setFromVector3]( [param:Vector3 vec3] )

+

[method:this setFromVector3]( [param:Vector3 vec3] )

Sets values of this spherical's [page:.radius radius], [page:.phi phi] and [page:.theta theta] properties from the [page:Vector3 Vector3].

-

[method:Spherical setFromCartesianCoords]( [param:Float x], [param:Float y], [param:Float z] )

+

[method:this setFromCartesianCoords]( [param:Float x], [param:Float y], [param:Float z] )

Sets values of this spherical's [page:.radius radius], [page:.phi phi] and [page:.theta theta] properties from Cartesian coordinates. diff --git a/docs/api/en/math/SphericalHarmonics3.html b/docs/api/en/math/SphericalHarmonics3.html index 20d85f823d72d5..d29a8994243614 100644 --- a/docs/api/en/math/SphericalHarmonics3.html +++ b/docs/api/en/math/SphericalHarmonics3.html @@ -24,14 +24,14 @@

[property:Array coefficients]

Methods

-

[method:SphericalHarmonics3 add]( [param:SphericalHarmonics3 sh] )

+

[method:this add]( [param:SphericalHarmonics3 sh] )

[page:SphericalHarmonics3 sh] - The SH to add.

Adds the given SH to this instance.

-

[method:SphericalHarmonics3 addScaledSH]( [param:SphericalHarmonics3 sh], [param:Number scale] )

+

[method:this addScaledSH]( [param:SphericalHarmonics3 sh], [param:Number scale] )

[page:SphericalHarmonics3 sh] - The SH to add.
[page:Number scale] - The scale factor.

@@ -44,7 +44,7 @@

[method:SphericalHarmonics3 clone]()

Returns a new instance of [name] with equal coefficients.

-

[method:SphericalHarmonics3 copy]( [param:SphericalHarmonics3 sh] )

+

[method:this copy]( [param:SphericalHarmonics3 sh] )

[page:SphericalHarmonics3 sh] - The SH to copy.

@@ -58,7 +58,7 @@

[method:Boolean equals]( [param:SphericalHarmonics3 sh] )

Returns true if the given SH and this instance have equal coefficients.

-

[method:SphericalHarmonics3 fromArray]( [param:Array array], [param:Number offset] )

+

[method:this fromArray]( [param:Array array], [param:Number offset] )

[page:Array array] - The array holding the numbers of the SH coefficients.
[page:Number offset] - (optional) The array offset.

@@ -82,7 +82,7 @@

[method:Vector3 getIrradianceAt]( [param:Vector3 normal], [param:Vector3 tar Returns the irradiance (radiance convolved with cosine lobe) in the direction of the given normal.

-

[method:SphericalHarmonics3 lerp]( [param:SphericalHarmonics3 sh], [param:Number alpha] )

+

[method:this lerp]( [param:SphericalHarmonics3 sh], [param:Number alpha] )

[page:SphericalHarmonics3 sh] - The SH to interpolate with.
[page:Number alpha] - The alpha factor.

@@ -90,14 +90,14 @@

[method:SphericalHarmonics3 lerp]( [param:SphericalHarmonics3 sh], [param:Nu Linear interpolates between the given SH and this instance by the given alpha factor.

-

[method:SphericalHarmonics3 scale]( [param:Number scale] )

+

[method:this scale]( [param:Number scale] )

[page:Number scale] - The scale factor.

Scales this SH by the given scale factor.

-

[method:SphericalHarmonics3 set]( [param:Array coefficients] )

+

[method:this set]( [param:Array coefficients] )

[page:Array coefficients] - An array of SH coefficients.

@@ -113,7 +113,7 @@

[method:Array toArray]( [param:Array array], [param:Number offset] )

are represented as numbers.

-

[method:SphericalHarmonics3 zero]()

+

[method:this zero]()

Sets all SH coefficients to 0.

diff --git a/docs/api/en/math/Triangle.html b/docs/api/en/math/Triangle.html index d7693d606fab6e..76ef64d6c57ff5 100644 --- a/docs/api/en/math/Triangle.html +++ b/docs/api/en/math/Triangle.html @@ -67,7 +67,7 @@

[method:Boolean containsPoint]( [param:Vector3 point] )

Returns true if the passed point, when projected onto the plane of the triangle, lies within the triangle.

-

[method:Triangle copy]( [param:Triangle triangle] )

+

[method:this copy]( [param:Triangle triangle] )

Copies the values of the passed triangles's [page:.a a], [page:.b b] and [page:.c c] properties to this triangle. @@ -120,13 +120,13 @@

[method:Boolean intersectsBox]( [param:Box3 box] )

Determines whether or not this triangle intersects [page:Box3 box].

-

[method:Triangle set]( [param:Vector3 a], [param:Vector3 b], [param:Vector3 c] ) [param:Triangle this]

+

[method:this set]( [param:Vector3 a], [param:Vector3 b], [param:Vector3 c] ) [param:Triangle this]

Sets the triangle's [page:.a a], [page:.b b] and [page:.c c] properties to the passed [page:Vector3 vector3s].
Please note that this method only copies the values from the given objects.

-

[method:Triangle setFromAttributeAndIndices]( [param:BufferAttribute attribute], [param:Integer i0], [param:Integer i1], [param:Integer i2] ) [param:Triangle this]

+

[method:this setFromAttributeAndIndices]( [param:BufferAttribute attribute], [param:Integer i0], [param:Integer i1], [param:Integer i2] ) [param:Triangle this]

attribute - [page:BufferAttribute] of vertex data
i0 - [page:Integer] index
@@ -136,7 +136,7 @@

[method:Triangle setFromAttributeAndIndices]( [param:BufferAttribute attribu Sets the triangle's vertices from the buffer attribute vertex data.

-

[method:Triangle setFromPointsAndIndices]( [param:Array points], [param:Integer i0], [param:Integer i1], [param:Integer i2] ) [param:Triangle this]

+

[method:this setFromPointsAndIndices]( [param:Array points], [param:Integer i0], [param:Integer i1], [param:Integer i2] ) [param:Triangle this]

points - [page:Array] of [page:Vector3]s
i0 - [page:Integer] index
diff --git a/docs/api/en/objects/Line.html b/docs/api/en/objects/Line.html index ce86d4bd8e620b..7038c350c5ca99 100644 --- a/docs/api/en/objects/Line.html +++ b/docs/api/en/objects/Line.html @@ -74,7 +74,7 @@

[property:Object morphTargetDictionary]

Methods

See the base [page:Object3D] class for common methods.

-

[method:Line computeLineDistances]()

+

[method:this computeLineDistances]()

Computes an array of distance values which are necessary for [page:LineDashedMaterial]. For each vertex in the geometry, the method calculates the cumulative length from the current point to the very beginning of the line.

diff --git a/docs/api/en/objects/Sprite.html b/docs/api/en/objects/Sprite.html index 2c81115a4efcd1..20b186ca104766 100644 --- a/docs/api/en/objects/Sprite.html +++ b/docs/api/en/objects/Sprite.html @@ -63,7 +63,7 @@

[method:Sprite clone]()

Returns a clone of this Sprite object and any descendants.

-

[method:Sprite copy]( [param:Sprite sprite] )

+

[method:this copy]( [param:Sprite sprite] )

Copies the properties of the passed sprite to this one.

diff --git a/docs/api/en/renderers/WebGLCubeRenderTarget.html b/docs/api/en/renderers/WebGLCubeRenderTarget.html index 7522e099730cea..ba44204ff4f5a0 100644 --- a/docs/api/en/renderers/WebGLCubeRenderTarget.html +++ b/docs/api/en/renderers/WebGLCubeRenderTarget.html @@ -56,7 +56,7 @@

Methods

See [page:WebGLRenderTarget] for inherited methods

-

[method:WebGLCubeRenderTarget fromEquirectangularTexture]( [param:WebGLRenderer renderer], [param:Texture texture] )

+

[method:this fromEquirectangularTexture]( [param:WebGLRenderer renderer], [param:Texture texture] )

[page:WebGLRenderer renderer] — the renderer.
[page:Texture texture] — the equirectangular texture. diff --git a/docs/api/en/renderers/WebGLRenderTarget.html b/docs/api/en/renderers/WebGLRenderTarget.html index 7d0df6bf9c8b1c..7f264688672929 100644 --- a/docs/api/en/renderers/WebGLRenderTarget.html +++ b/docs/api/en/renderers/WebGLRenderTarget.html @@ -106,7 +106,7 @@

[method:WebGLRenderTarget clone]()

Creates a copy of this render target.

-

[method:WebGLRenderTarget copy]( [param:WebGLRenderTarget source] )

+

[method:this copy]( [param:WebGLRenderTarget source] )

Adopts the settings of the given render target.

diff --git a/docs/api/en/scenes/Fog.html b/docs/api/en/scenes/Fog.html index 6735d6b87b0736..4e1957470d605c 100644 --- a/docs/api/en/scenes/Fog.html +++ b/docs/api/en/scenes/Fog.html @@ -39,7 +39,7 @@

Methods

[method:Fog clone]()

Returns a new fog instance with the same parameters as this one.

-

[method:Fog toJSON]()

+

[method:Object toJSON]()

Return fog data in JSON format.

Source

diff --git a/docs/api/en/scenes/FogExp2.html b/docs/api/en/scenes/FogExp2.html index 3d6cfb99b767a1..80122d40669b13 100644 --- a/docs/api/en/scenes/FogExp2.html +++ b/docs/api/en/scenes/FogExp2.html @@ -35,7 +35,7 @@

Methods

[method:FogExp2 clone]()

Returns a new FogExp2 instance with the same parameters as this one.

-

[method:FogExp2 toJSON]()

+

[method:Object toJSON]()

Return FogExp2 data in JSON format.

Source

diff --git a/docs/api/en/textures/CompressedTexture.html b/docs/api/en/textures/CompressedTexture.html index 08cfae0f28e922..ea6f90f9ba6efe 100644 --- a/docs/api/en/textures/CompressedTexture.html +++ b/docs/api/en/textures/CompressedTexture.html @@ -78,7 +78,9 @@

[property:Boolean generateMipmaps]

Methods

- +

+ See the base [page:Texture Texture] class for common methods. +

Source

diff --git a/docs/api/ko/animation/AnimationAction.html b/docs/api/ko/animation/AnimationAction.html index 62837e2126e96d..bcdb3b5224adcd 100644 --- a/docs/api/ko/animation/AnimationAction.html +++ b/docs/api/ko/animation/AnimationAction.html @@ -45,7 +45,7 @@

[property:Boolean clampWhenFinished]

초기값은 *false* 입니다.

참고: *clampWhenFinished* 는 작업이 중단될 경우 아무런 영향을 주지 않습니다 (마지막 루프를 실제로 완료된 경우에만 효과가 있음). - +

[property:Boolean enabled]

@@ -54,8 +54,8 @@

[property:Boolean enabled]

애니메이션 액션이 다시 활성화되면, 현재 [page:.time time] 부터 연속적으로 애니메이션이 활성화 됩니다 (*enabled* 를 *false* 로 설정하면 애니메이션 액션이 초기화 되지 않습니다).

- 참고: *enabled* 를 *true* 로 설정해도 자동적으로 애니메이션이 재시작하지 않습니다. *enabled* 를 *true* 로 설정하면 다음 조건이 충족되는 경우에만 즉시 애니메이션을 시작합니다: - [page:.paused paused] 가 *false* 인 경우, - 그동안 애니메이션 액션은 비활성화 되지 않습니다 + 참고: *enabled* 를 *true* 로 설정해도 자동적으로 애니메이션이 재시작하지 않습니다. *enabled* 를 *true* 로 설정하면 다음 조건이 충족되는 경우에만 즉시 애니메이션을 시작합니다: + [page:.paused paused] 가 *false* 인 경우, - 그동안 애니메이션 액션은 비활성화 되지 않습니다 ( [page:.stop stop] 또는 [page:.reset reset] 명령을 실행하여) 그리고 [page:.weight weight], [page:.timeScale timeScale] 는 둘 다 0 이 아닙니다.

@@ -70,19 +70,19 @@

[property:Number loop]

[page:Animation THREE.LoopRepeat] - 클립의 끝에서 시작 부분으로 즉시 이동할 때마다 선택한 *repetitions* 수 만큼 클립 재생
[page:Animation THREE.LoopPingPong] - 선택한 *repetitions* 수 만큼 클립을 앞뒤로 재생

- + 애니메이션 액션에서 수행된 [page:AnimationClip] 의 반복 횟수입니다. [page:.setLoop setLoop]을 통해 설정할 수 있습니다. 기본값은 *무한대* 입니다.

[page:. loop loop mode] 가 [page:animation THREE.LoopOnce] 로 설정되어 있으면 숫자를 설정해도 아무런 영향을 미치지 않습니다. - +

[property:Number time]

애니메이션 액션의 로컬 시간 속성 (초 단위, 0부터 시작).

- 시간 속성은 값이 고정 되거나, 반복 상태에 따라 0 ... clip.duration 으로 래핑 됩니다. - [page:.timeScale timeScale] 을 변경하여 글로벌 믹서 타임을 상대적으로 확장할 수 있습니다 + 시간 속성은 값이 고정 되거나, 반복 상태에 따라 0 ... clip.duration 으로 래핑 됩니다. + [page:.timeScale timeScale] 을 변경하여 글로벌 믹서 타임을 상대적으로 확장할 수 있습니다 ([page:.setEffectiveTimeScale setEffectiveTimeScale] 또는 [page:.setDuration setDuration] 을 이용하여)

@@ -103,10 +103,10 @@

[property:Number timeScale]

[property:Number weight]

- 애니메이션 액션의 중요도에 대한 속성입니다 ([0,1] 간격). + 애니메이션 액션의 중요도에 대한 속성입니다 ([0,1] 간격). 값은 *0* (영향 없음) 과 *1* (최대 영향) 사이의 값을 사용할 수 있고, 여러 액션들을 혼합해서 사용할 수 있습니다. 기본값은 *1* 입니다.

- + *weight* 와 관련된 속성/메소드는: [page:.crossFadeFrom crossFadeFrom], [page:.crossFadeTo crossFadeTo], @@ -132,7 +132,7 @@

[property:Boolean zeroSlopeAtStart]

메소드

-

[method:AnimationAction crossFadeFrom]( [param:AnimationAction fadeOutAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )

+

[method:this crossFadeFrom]( [param:AnimationAction fadeOutAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )

해당 메소드는 [page:.fadeIn fade in] 을 수행하게 되고, 전달 된 시간 간격 내에서 동시에 다른 작업을 페이드 아웃을 수행합니다. 해당 메소드는 체인으로 연결될 수 있습니다.

@@ -143,24 +143,24 @@

[method:AnimationAction crossFadeFrom]( [param:AnimationAction fadeOutAction

-

[method:AnimationAction crossFadeTo]( [param:AnimationAction fadeInAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )

+

[method:this crossFadeTo]( [param:AnimationAction fadeInAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )

해당 메소드는 [page:.fadeOut fade out] 을 수행하게 되고, 전달 된 시간 간격 내에서 동시에 다른 작업을 페이드 인을 수행합니다. 해당 메소드는 체인으로 연결될 수 있습니다.

- + 만약 warpBoolean 이 true 일 경우, 추가적으로 [page.warp warping] 이 적용될 것입니다 (time scales 만큼 점차적으로 변경).

- + 참고: *fadeIn*/*fadeOut* 처럼, 페이딩의 시작/종료의 가중치 값이 1일 때 동작됩니다.

-

[method:AnimationAction fadeIn]( [param:Number durationInSeconds] )

+

[method:this fadeIn]( [param:Number durationInSeconds] )

- 전달된 시간 간격 내에서 페이드 인의 [page:.weight weight] 의 값을 0 에서 1으로 점차적으로 증가합니다. + 전달된 시간 간격 내에서 페이드 인의 [page:.weight weight] 의 값을 0 에서 1으로 점차적으로 증가합니다. 해당 메소드는 체인으로 연결할 수 있습니다.

-

[method:AnimationAction fadeOut]( [param:Number durationInSeconds] )

+

[method:this fadeOut]( [param:Number durationInSeconds] )

전달된 시간 간격 내에서 페이드 아웃의 [page:.weight weight] 의 값을 1 에서 0으로 점차적으로 감소합니다. 해당 메소드는 체인으로 연결할 수 있습니다. @@ -169,7 +169,7 @@

[method:AnimationAction fadeOut]( [param:Number durationInSeconds] )

[method:Number getEffectiveTimeScale]()

실질적인 타임 스케일을 반환합니다. (현재 워핑 상태 및 [page:.paused paused] 을 고려해야합니다). - +

[method:number getEffectiveWeight]()

@@ -192,7 +192,7 @@

[method:Object3D getRoot]()

애니메이션 액션이 수행되는 루트 객체를 반환합니다.

-

[method:AnimationAction halt]( [param:Number durationInSeconds] )

+

[method:this halt]( [param:Number durationInSeconds] )

전달 된 시간 간격 내에서 [page:.timeScale timeScale]을 점차적으로 애니메이션 속도를 0으로 감소시킵니다(현재 값에서부터 시작). 해당 메소드는 체인으로 연결할 수 있습니다. @@ -209,31 +209,31 @@

[method:Boolean isRunning]()

참고: *isRunning* 이 true 이여도 애니메이션이 실제 동작한다는 것을 의미하지는 않습니다. [page : .weight weight] 가 0이 아닌 값으로 추가로 설정된 경우에만 해당됩니다. - +

[method:Boolean isScheduled]()

만약 애니메이션 액션이 믹서에서 활성화 될 경우 true 를 반환합니다.

- + 참고: 해당 메소드는 애니메이션이 실제로 동작하고 있음을 의미하지는 않습니다. ([page:.isRunning isRunning] 에 대한 추가적인 비교 조건이 필요) - +

-

[method:AnimationAction play]()

+

[method:this play]()

믹서에 애니메이션 액션을 활성화하도록 요청합니다. 해당 메소드는 체인으로 연결할 수 있습니다.

- 참고: 해당 메소드를 활성화 할 경우 반드시 애니메이션이 실행되는 것을 의미하지는 않습니다: + 참고: 해당 메소드를 활성화 할 경우 반드시 애니메이션이 실행되는 것을 의미하지는 않습니다: 만약 애니메이션 액션 작업이 이미 완료되었거나 (마지막 루프의 끝에 도달하여), 지연된 시작 시간이 설정된 경우([page:.startAt startAt] 을 통해), 먼저 [page:.reset rest]을 처음으로 실행해야 합니다. 일부 다른 설정 ([page:.paused paused] = true, [page:.enabled enabled] = false, [page:.weight weight] = 0, [page:.timeScale timeScale] = 0) 으로 인해 애니메이션이 재생되지 않을 수 있습니다.

-

[method:AnimationAction reset]()

+

[method:this reset]()

애니메이션 액션을 재설정 합니다. 해당 메소드는 체인으로 연결할 수 있습니다.

- 해당 메소드는 + 해당 메소드는 [page:.paused paused] 를 false로 설정합니다, [page:.enabled enabled] 를 true로 설정합니다, [page:.time time] 을 0으로 설정합니다, @@ -243,14 +243,14 @@

[method:AnimationAction reset]()

기술: 만약 당신이 *stop* 과 *reset* 둘다 호출하기를 원하면, *reset* 은 호출하지 말고 *stop* 을 해야합니다.

-

[method:AnimationAction setDuration]( [param:Number durationInSeconds] )

+

[method:this setDuration]( [param:Number durationInSeconds] )

애니메이션 액션의 단일 루프의 기간을 설정합니다 ([page:.timeScale timeScale] 을 조정하고, 미리 예약된 워핑을 중단). 해당 메소드는 체인으로 연결할 수 있습니다. - +

-

[method:AnimationAction setEffectiveTimeScale]( [param:Number timeScale] )

+

[method:this setEffectiveTimeScale]( [param:Number timeScale] )

[page:.timeScale timeScale] 을 설정하고 예약된 워핑을 중단합니다. 해당 메소드는 체인으로 연결할 수 있습니다.

@@ -258,33 +258,33 @@

[method:AnimationAction setEffectiveTimeScale]( [param:Number timeScale] )
참고: 해당 메소드로 인해 *timeScale* 의 값이 0 으로 설정 되어도 .*paused* 값은 자동적으로 *true* 로 변경되지 않습니다. - +

-

[method:AnimationAction setEffectiveWeight]( [param:Number weight] )

+

[method:this setEffectiveWeight]( [param:Number weight] )

[page:.weight weight] 이 설정되고 예약된 페이딩을 중지 합니다. 해당 메소드는 체인으로 연결할 수 있습니다.

만약 [page:..enabled enabled] 이 true 일 경우, 실질적인 가중치 (내부 속성* 값은 해당 weight 값으로 설정됩니다; 그렇지 않으면, 실질적인 가중치 (현재 애니메이션에 직접적으로 영향을 미치는) 값은 0으로 설정됩니다.

- + 참고: 해당 메소드로 인해 *weight* 의 값이 0 으로 설정 되어도 .*enabled* 값은 자동적으로 *false*로 변경되지 않습니다.

-

[method:AnimationAction setLoop]( [param:Number loopMode], [param:Number repetitions] )

+

[method:this setLoop]( [param:Number loopMode], [param:Number repetitions] )

[page:.loop loop mode] 및 [page:.repetitions repetitions] 의 횟수를 설정합니다. 해당 메소드는 체인으로 연결할 수 있습니다.

-

[method:AnimationAction startAt]( [param:Number startTimeInSeconds] )

+

[method:this startAt]( [param:Number startTimeInSeconds] )

- + 지연된 시작 이벤트를 정의합니다 (일반적으로 AnimationMixer.time + deltaTimeInSeconds에서 전달됨). 해당 메소드는 체인으로 연결할 수 있습니다.

참고: .[page:.startAt startAt] 메소드가 [page:.play play] 메소드와 함께 연결되어 있거나 애니메이션이 믹서에서 활성화 된 경우 (중지 또는 재설정없이 .*play* 를 먼저 호출하여) 애니메이션은 지정된 시간에만 시작됩니다.

-

[method:AnimationAction stop]()

+

[method:this stop]()

믹서에게 애니메이션 액션을 비활성화하도록 설정합니다. 해당 메소드는 체인으로 연결할 수 있습니다.

@@ -294,17 +294,17 @@

[method:AnimationAction stop]()

-

[method:AnimationAction stopFading]()

+

[method:this stopFading]()

애니메이션 액션에 적용되어 있는 [page:.fadeIn fading] 을 종료합니다. 해당 메소드는 체인으로 연결할 수 있습니다.

-

[method:AnimationAction stopWarping]()

+

[method:this stopWarping]()

애니메이션 액션에 적용되어 있는 [page:.warp warping] 을 종료합니다. 해당 메소드는 체인으로 연결할 수 있습니다.

-

[method:AnimationAction syncWith]( [param:AnimationAction otherAction] )

+

[method:this syncWith]( [param:AnimationAction otherAction] )

애니메이션 액션을 전달된 다른 작업과 함께 동기화를 합니다. 해당 메소드는 체인으로 연결할 수 있습니다.

@@ -313,7 +313,7 @@

[method:AnimationAction syncWith]( [param:AnimationAction otherAction] )

-

[method:AnimationAction warp]( [param:Number startTimeScale], [param:Number endTimeScale], [param:Number durationInSeconds] )

+

[method:this warp]( [param:Number startTimeScale], [param:Number endTimeScale], [param:Number durationInSeconds] )

들어오는 이벤트 간격에서 [page:.timeScale timeScale] 을 *startTimeScale* 에서 *endTimeScale* 로 점차적으로 재생 속도를 변경합니다. 해당 메소드는 체인으로 연결할 수 있습니다.

diff --git a/docs/api/ko/animation/AnimationMixer.html b/docs/api/ko/animation/AnimationMixer.html index 1b03a874a55a8e..1a6f2deb3199ec 100644 --- a/docs/api/ko/animation/AnimationMixer.html +++ b/docs/api/ko/animation/AnimationMixer.html @@ -67,19 +67,19 @@

[method:Object3D getRoot]()

믹서의 루트 오브젝트를 리턴합니다.

-

[method:AnimationMixer stopAllAction]()

+

[method:this stopAllAction]()

믹서의 모든 이전 예약 동작들을 비활성화합니다.

-

[method:AnimationMixer update]([param:Number deltaTimeInSeconds])

+

[method:this update]([param:Number deltaTimeInSeconds])

글로벌 믹서 시간을 되돌리고 애니메이션을 업데이트합니다.

주로 렌더 루프에서 사용되며, [page:.timeScale timeScale]로 설정된 배율로 [page:Clock.getDelta clock.getDelta]를 넘겨줍니다.

-

[method:AnimationMixer setTime]([param:Number timeInSeconds])

+

[method:this setTime]([param:Number timeInSeconds])

글로벌 믹서의 특정 시간을 설정하고 그에 따라 애니메이션을 업데이트합니다.

diff --git a/docs/api/ko/audio/Audio.html b/docs/api/ko/audio/Audio.html index a1ca5834db88a2..3658a27374a930 100644 --- a/docs/api/ko/audio/Audio.html +++ b/docs/api/ko/audio/Audio.html @@ -104,12 +104,12 @@

[property:String type]

메서드

-

[method:Audio connect]()

+

[method:this connect]()

[page:Audio.source]에 연결합니다. 시작 및 필터 설정/제거 시에 내부적으로 사용됩니다.

-

[method:Audio disconnect]()

+

[method:this disconnect]()

[page:Audio.source] 연결을 해제합니다. 필터 설정/제거 시에 내부적으로 사용됩니다.

@@ -144,12 +144,12 @@

[method:Float getVolume]( value )

현재 볼륨을 리턴합니다.

-

[method:Audio play]( delay )

+

[method:this play]( delay )

[page:Audio.hasPlaybackControl hasPlaybackControl]가 true면, 재생을 시작합니다.

-

[method:Audio pause]()

+

[method:this pause]()

[page:Audio.hasPlaybackControl hasPlaybackControl]가 true면, 재생을 멈춥니다.

@@ -159,67 +159,67 @@

[method:undefined onEnded]()

재생이 끝나면 자동으로 호출됩니다.

-

[method:Audio setBuffer]( audioBuffer )

+

[method:this setBuffer]( audioBuffer )

[page:Audio.source source]를 audioBuffer에 설치하고, [page:Audio.sourceType sourceType]를 'buffer'에 설정합니다.
[page:Audio.autoplay autoplay]의 경우에는 재생도 시작합니다.

-

[method:Audio setFilter]( filter )

+

[method:this setFilter]( filter )

Applies a single filter node to the audio.

-

[method:Audio setFilters]( [param:Array value] )

+

[method:this setFilters]( [param:Array value] )

value - arrays of filters.
Applies an array of filter nodes to the audio.

-

[method:Audio setLoop]( [param:Boolean value] )

+

[method:this setLoop]( [param:Boolean value] )

*value*를 [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loop source.loop]로 설정합니다(재생이 반복되는지).

-

[method:Audio setLoopStart]( [param:Float value] )

+

[method:this setLoopStart]( [param:Float value] )

*value*를 [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopStart source.loopStart]로 설정합니다.

-

[method:Audio setLoopEnd]( [param:Float value] )

+

[method:this setLoopEnd]( [param:Float value] )

*value*를 [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopEnd source.loopEnd]로 설정합니다.

-

[method:Audio setMediaElementSource]( mediaElement )

+

[method:this setMediaElementSource]( mediaElement )

이 오디오 소스에 [link:https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement HTMLMediaElement]타입의 오브젝트를 적용합니다.
[page:Audio.hasPlaybackControl hasPlaybackControl]를 false로 설정합니다.

-

[method:Audio setMediaStreamSource]( mediaStream )

+

[method:this setMediaStreamSource]( mediaStream )

이 오디오 소스에 [link:https://developer.mozilla.org/en-US/docs/Web/API/MediaStream MediaStream]타입의 오브젝트를 적용합니다.
[page:Audio.hasPlaybackControl hasPlaybackControl]를 false로 설정합니다.

-

[method:Audio setNodeSource]( audioNode )

+

[method:this setNodeSource]( audioNode )

audioBuffer에 [page:Audio.source source]를 설치하고 'audioNode'를 [page:Audio.sourceType sourceType]로 설정합니다.
[page:Audio.hasPlaybackControl hasPlaybackControl]를 false로 설정합니다.

-

[method:Audio setPlaybackRate]( [param:Float value] )

+

[method:this setPlaybackRate]( [param:Float value] )

[page:Audio.hasPlaybackControl hasPlaybackControl]이 활성화되어 있으면 *value*를 [page:Audio.playbackRate playbackRate]로 설정합니다.

-

[method:Audio setVolume]( [param:Float value] )

+

[method:this setVolume]( [param:Float value] )

볼륨을 설정합니다.

-

[method:Audio stop]()

+

[method:this stop]()

[page:Audio.hasPlaybackControl hasPlaybackControl]가 활성화되어 있으면 재생을 중단합니다.

diff --git a/docs/api/ko/audio/AudioListener.html b/docs/api/ko/audio/AudioListener.html index b9c3dbc1779067..3e5e52bb3f9648 100644 --- a/docs/api/ko/audio/AudioListener.html +++ b/docs/api/ko/audio/AudioListener.html @@ -77,7 +77,7 @@

[method:GainNode getInput]()

[page:AudioListener.gain gainNode]를 리턴합니다.

-

[method:AudioListener removeFilter]()

+

[method:this removeFilter]()

[page:AudioListener.filter filter] 프로퍼티를 *null*로 설정합니다.

@@ -87,7 +87,7 @@

[method:AudioNode getFilter]()

[page:AudioListener.filter filter] 프로퍼티의 값을 리턴합니다.

-

[method:AudioListener setFilter]( [param:AudioNode value] )

+

[method:this setFilter]( [param:AudioNode value] )

[page:AudioListener.filter filter] 프로퍼티를 *value*로 설정합니다.

@@ -97,7 +97,7 @@

[method:Float getMasterVolume]()

볼륨을 리턴합니다.

-

[method:AudioListener setMasterVolume]( [param:Number value] )

+

[method:this setMasterVolume]( [param:Number value] )

볼륨을 설정합니다.

diff --git a/docs/api/ko/audio/PositionalAudio.html b/docs/api/ko/audio/PositionalAudio.html index f040502ab1e7c2..d9bc1d7542471f 100644 --- a/docs/api/ko/audio/PositionalAudio.html +++ b/docs/api/ko/audio/PositionalAudio.html @@ -87,7 +87,7 @@

[method:Float getRefDistance]()

[link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/refDistance panner.refDistance]의 값을 리턴합니다.

-

[method:PositionalAudio setRefDistance]( [param:Float value] )

+

[method:this setRefDistance]( [param:Float value] )

[link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/refDistance panner.refDistance]의 값을 설정합니다.

@@ -97,7 +97,7 @@

[method:Float getRolloffFactor]()

[link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/rolloffFactor panner.rolloffFactor]의 값을 리턴합니다.

-

[method:PositionalAudio setRolloffFactor]( [param:Float value] )

+

[method:this setRolloffFactor]( [param:Float value] )

[link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/rolloffFactor panner.rolloffFactor]의 값을 설정합니다.

@@ -107,7 +107,7 @@

[method:String getDistanceModel]()

[link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/distanceModel panner.distanceModel]의 값을 리턴합니다.

-

[method:PositionalAudio setDistanceModel]( [param:String value] )

+

[method:this setDistanceModel]( [param:String value] )

[link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/distanceModel panner.distanceModel]의 값을 설정합니다.

@@ -117,12 +117,12 @@

[method:Float getMaxDistance]()

[link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/maxDistance panner.maxDistance]의 값을 리턴합니다.

-

[method:PositionalAudio setMaxDistance]( [param:Float value] )

+

[method:this setMaxDistance]( [param:Float value] )

[link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/maxDistance panner.maxDistance]의 값을 리턴합니다.

-

[method:PositionalAudio setDirectionalCone]( [param:Float coneInnerAngle], [param:Float coneOuterAngle], [param:Float coneOuterGain] )

+

[method:this setDirectionalCone]( [param:Float coneInnerAngle], [param:Float coneOuterAngle], [param:Float coneOuterGain] )

이 메서드는 전방향 사운드를 [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode directional sound]로 변환하기 위해 사용할 수 있습니다.

diff --git a/docs/api/ko/cameras/Camera.html b/docs/api/ko/cameras/Camera.html index 41e01e3e08f90c..5b1d8dbff79a46 100644 --- a/docs/api/ko/cameras/Camera.html +++ b/docs/api/ko/cameras/Camera.html @@ -56,7 +56,7 @@

[method:Camera clone]( )

이 카메라와 같은 프로퍼티를 가진 새 카메라를 리턴합니다.

-

[method:Camera copy]( [param:Camera source], [param:Boolean recursive] )

+

[method:this copy]( [param:Camera source], [param:Boolean recursive] )

원본 카메라에서 이 카메라로 프로퍼티를 복사합니다.

diff --git a/docs/api/ko/core/BufferAttribute.html b/docs/api/ko/core/BufferAttribute.html index db35eb0d0e2d3f..69a16639b2f646 100644 --- a/docs/api/ko/core/BufferAttribute.html +++ b/docs/api/ko/core/BufferAttribute.html @@ -115,10 +115,10 @@

[method:this transformDirection]( [param:Matrix4 m] )

[method:BufferAttribute clone]()

bufferAttribute 사본을 리턴합니다.

-

[method:BufferAttribute copy]( [param:BufferAttribute bufferAttribute] )

+

[method:this copy]( [param:BufferAttribute bufferAttribute] )

현재의 BufferAttribute에 다른 BufferAttribute를 붙여 넣습니다.

-

[method:BufferAttribute copyArray]( array )

+

[method:this copyArray]( array )

[page:BufferAttribute.array array]에 해당 배열(일반 배열 혹은 TypedArray)을 복사합니다.

TypedArray를 복사할 때의 조건에 대한 주의사항은 [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/set TypedArray.set] @@ -128,16 +128,16 @@

[method:BufferAttribute copyArray]( array )

[method:this copyAt] ( [param:Integer index1], [param:BufferAttribute bufferAttribute], [param:Integer index2] )

bufferAttribute[index2]의 벡터를 [page:BufferAttribute.array array][index1]에 복사합니다.

-

[method:BufferAttribute copyColorsArray]( [param:Array colors] )

+

[method:this copyColorsArray]( [param:Array colors] )

RGB 색상 값을 나타내는 배열을 [page:BufferAttribute.array array]에 복사합니다.

-

[method:BufferAttribute copyVector2sArray]( [param:Array vectors] )

+

[method:this copyVector2sArray]( [param:Array vectors] )

[page:Vector2]값을 나타내는 배열을 [page:BufferAttribute.array array]에 복사합니다.

-

[method:BufferAttribute copyVector3sArray]( [param:Array vectors] )

+

[method:this copyVector3sArray]( [param:Array vectors] )

[page:Vector3]값을 나타내는 배열을 [page:BufferAttribute.array array]에 복사합니다.

-

[method:BufferAttribute copyVector4sArray]( [param:Array vectors] )

+

[method:this copyVector4sArray]( [param:Array vectors] )

[page:Vector4]값을 나타내는 배열을 [page:BufferAttribute.array array]에 복사합니다.

[method:Number getX]( [param:Integer index] )

@@ -159,7 +159,7 @@

[method:this onUpload]( [param:Function callback] )

이 값은 [example:webgl_buffergeometry WebGL / Buffergeometry]에서 버퍼가 GPU로 전송된 후에 자유 메모리로 사용됩니다.

-

[method:BufferAttribute set] ( [param:Array value], [param:Integer offset] )

+

[method:this set] ( [param:Array value], [param:Integer offset] )

value -- 복사할 [page:Array] 혹은 [page:TypedArray] 값입니다.
offset -- (생략가능) 복사를 시작할 [page:BufferAttribute.array array] 의 인덱스값입니다.

@@ -170,28 +170,28 @@

[method:BufferAttribute set] ( [param:Array value], [param:Integer offset] ) [page:Array value]가 [page:TypedArray]로 되는 조건에 대해서는 해당 페이지를 참고하세요.

-

[method:BufferAttribute setUsage] ( [param:Usage value] )

+

[method:this setUsage] ( [param:Usage value] )

[page:BufferAttribute.usage usage]를 value로 설정합니다.

-

[method:BufferAttribute setX]( [param:Integer index], [param:Float x] )

+

[method:this setX]( [param:Integer index], [param:Float x] )

x 컴포넌트 값을 설정합니다.

-

[method:BufferAttribute setY]( [param:Integer index], [param:Float y] )

+

[method:this setY]( [param:Integer index], [param:Float y] )

y 컴포넌트 값을 설정합니다.

-

[method:BufferAttribute setZ]( [param:Integer index], [param:Float z] )

+

[method:this setZ]( [param:Integer index], [param:Float z] )

z 컴포넌트 값을 설정합니다.

-

[method:BufferAttribute setW]( [param:Integer index], [param:Float w] )

+

[method:this setW]( [param:Integer index], [param:Float w] )

w 컴포넌트 값을 설정합니다.

-

[method:BufferAttribute setXY]( [param:Integer index], [param:Float x], [param:Float y] )

+

[method:this setXY]( [param:Integer index], [param:Float x], [param:Float y] )

index의 벡터의 x 및 y 컴포넌트를 설정합니다.

-

[method:BufferAttribute setXYZ]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z] )

+

[method:this setXYZ]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z] )

x, y 및 z 컴포넌트를 설정합니다.

-

[method:BufferAttribute setXYZW]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z], [param:Float w] )

+

[method:this setXYZW]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z], [param:Float w] )

x, y, z 및 w 컴포넌트를 설정합니다.

diff --git a/docs/api/ko/core/BufferGeometry.html b/docs/api/ko/core/BufferGeometry.html index aa00065f0c9bad..75eea6c68911f0 100644 --- a/docs/api/ko/core/BufferGeometry.html +++ b/docs/api/ko/core/BufferGeometry.html @@ -160,7 +160,7 @@

메서드

이 클래스에서는 [page:EventDispatcher EventDispatcher] 메서드들이 활용 가능합니다.

-

[method:BufferGeometry setAttribute]( [param:String name], [param:BufferAttribute attribute] )

+

[method:this setAttribute]( [param:String name], [param:BufferAttribute attribute] )

기하학에 대한 속성을 설정합니다. [page:.attributes]의 내부 해시맵은 속성들의 반복 속도 증가를 위해 유지되기 때문에, 속성 프로퍼티 대신 이 메서드를 사용하세요. @@ -175,13 +175,13 @@

[method:undefined addGroup]( [param:Integer start], [param:Integer count], [

[method:this applyMatrix4]( [param:Matrix4 matrix] )

꼭짓점 좌표로 직접 매트릭스 변형을 합니다.

-

[method:BufferGeometry center] ()

+

[method:this center] ()

바운딩 박스를 기준으로 기하학을 중앙정렬합니다.

[method:BufferGeometry clone]()

BufferGeometry의 사본을 만듭니다.

-

[method:BufferGeometry copy]( [param:BufferGeometry bufferGeometry] )

+

[method:this copy]( [param:BufferGeometry bufferGeometry] )

다른 BufferGeometry를 이 BufferGeometry에 복사합니다.

[method:undefined clearGroups]( )

@@ -223,7 +223,7 @@

[method:BufferAttribute getIndex] ()

[method:Boolean hasAttribute]( [param:String name] )

특정 이름의 속성이 존재하면 *true*를 리턴합니다.

-

[method:BufferGeometry lookAt] ( [param:Vector3 vector] )

+

[method:this lookAt] ( [param:Vector3 vector] )

vector - 바라보는 시점의 월드 벡터 입니다.

@@ -243,38 +243,38 @@

[method:undefined normalizeNormals]()

[method:BufferAttribute deleteAttribute]( [param:String name] )

특정 이름의 [page:BufferAttribute attribute]를 전부 삭제합니다.

-

[method:BufferGeometry rotateX] ( [param:Float radians] )

+

[method:this rotateX] ( [param:Float radians] )

X 축의 기하학을 회전합니다. 일반적으로 한 구간에서만 사용되며 루프 구간에서 사용되지 않습니다. 일반적인 리얼타임 메쉬 회전은 [page:Object3D.rotation] 를 사용하세요.

-

[method:BufferGeometry rotateY] ( [param:Float radians] )

+

[method:this rotateY] ( [param:Float radians] )

Y 축의 기하학을 회전합니다. 일반적으로 한 구간에서만 사용되며 루프 구간에서 사용되지 않습니다. 일반적인 리얼타임 메쉬 회전은 [page:Object3D.rotation] 를 사용하세요.

-

[method:BufferGeometry rotateZ] ( [param:Float radians] )

+

[method:this rotateZ] ( [param:Float radians] )

Z 축의 기하학을 회전합니다. 일반적으로 한 구간에서만 사용되며 루프 구간에서 사용되지 않습니다. 일반적인 리얼타임 메쉬 회전은 [page:Object3D.rotation] 를 사용하세요.

-

[method:BufferGeometry scale] ( [param:Float x], [param:Float y], [param:Float z] )

+

[method:this scale] ( [param:Float x], [param:Float y], [param:Float z] )

기하학 데이터를 확대/축소합니다. 일반적으로 한 구간에서만 사용되며 루프 구간에서 사용되지 않습니다. 일반적인 리얼타임 메쉬 확대/축소는 [page:Object3D.scale] 를 사용하세요.

-

[method:BufferGeometry setIndex] ( [param:BufferAttribute index] )

+

[method:this setIndex] ( [param:BufferAttribute index] )

[page:.index] 버퍼를 설정합니다.

[method:undefined setDrawRange] ( [param:Integer start], [param:Integer count] )

[page:.drawRange] 프로퍼티를 설정합니다. 인덱스가 없는 BufferGeometry에서, count는 렌더링할 꼭짓점의 수입니다. 인덱스가 있는 BufferGeometry에서 count는 렌더링할 인덱스의 수입니다.

-

[method:BufferGeometry setFromPoints] ( [param:Array points] )

+

[method:this setFromPoints] ( [param:Array points] )

점 배열로부터 BufferGeometry의 속성을 설정합니다. from an array of points.

[method:Object toJSON]()

@@ -283,7 +283,7 @@

[method:Object toJSON]()

[method:BufferGeometry toNonIndexed]()

인덱스가 있는 BufferGeometry의 인덱스가 없는 버전을 리턴합니다.

-

[method:BufferGeometry translate] ( [param:Float x], [param:Float y], [param:Float z] )

+

[method:this translate] ( [param:Float x], [param:Float y], [param:Float z] )

기하학을 이동합니다. 일반적으로 한 구간에서만 사용되며 루프 구간에서 사용되지 않습니다. 일반적인 리얼타임 메쉬 이동은 [page:Object3D.position] 를 사용하세요. diff --git a/docs/api/ko/core/InterleavedBuffer.html b/docs/api/ko/core/InterleavedBuffer.html index 89d92321c25753..1398b9208bf2cc 100644 --- a/docs/api/ko/core/InterleavedBuffer.html +++ b/docs/api/ko/core/InterleavedBuffer.html @@ -10,7 +10,7 @@

[name]

- "Interleaved"는 서로 다른 타입일 수도 있는 여러 속성들이(예를 들어 위치, 법선, uv, 색상)이 단일 배열 버퍼에 패키징되어있다는 뜻입니다. + "Interleaved"는 서로 다른 타입일 수도 있는 여러 속성들이(예를 들어 위치, 법선, uv, 색상)이 단일 배열 버퍼에 패키징되어있다는 뜻입니다.

인터리브 배열에 대한 설명은 여기: [link:https://blog.tojicode.com/2011/05/interleaved-array-basics.html Interleaved array basics]에서 확인할 수 있습니다.

@@ -75,21 +75,21 @@

[property:Boolean needsUpdate]

[property:Usage usage]

- 최적화 목적의 데이터 저장 패턴의 사용법을 정의합니다. + 최적화 목적의 데이터 저장 패턴의 사용법을 정의합니다. [link:https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/bufferData WebGLRenderingContext.bufferData]()의 *usage* 파라미터에 해당합니다.

메서드

-

[method:InterleavedBuffer copy]( [param:InterleavedBuffer source] )

+

[method:this copy]( [param:InterleavedBuffer source] )

다른 [name]를 이[name]에 복사합니다.

-

[method:InterleavedBuffer copyAt]( [param:Integer index1], [param:InterleavedBuffer attribute], [param:Integer index2] )

+

[method:this copyAt]( [param:Integer index1], [param:InterleavedBuffer attribute], [param:Integer index2] )

속성 [index2]의 데이터를 [page:InterleavedBuffer.array array][index1]에 복사합니다.

-

[method:InterleavedBuffer set]( [param:TypedArray value], [param:Integer offset] )

+

[method:this set]( [param:TypedArray value], [param:Integer offset] )

value - 원본 (타입) 배열.
offset - 원본 배열로부터 값을 작성하기 시작할 타깃 배열의 오프셋. 기본값은 *0*입니다.

@@ -105,10 +105,10 @@

[method:InterleavedBuffer clone]( [param:Object data] )

이 [name]의 사본을 만듭니다.

-

[method:InterleavedBuffer setUsage] ( [param:Usage value] )

+

[method:this setUsage] ( [param:Usage value] )

[page:InterleavedBuffer.usage usage]를 value 로 설정합니다.

-

[method:InterleavedBuffer toJSON]( [param:Object data] )

+

[method:Object toJSON]( [param:Object data] )

data - 이 오브젝트는 인터리브 속성을 가진 기하학의 적절한 시리얼라이징을 위한 공유 배열 버퍼를 가지고 있습니다.

diff --git a/docs/api/ko/extras/core/Curve.html b/docs/api/ko/extras/core/Curve.html index fcd41414177b3e..b8b57983a41f1b 100644 --- a/docs/api/ko/extras/core/Curve.html +++ b/docs/api/ko/extras/core/Curve.html @@ -100,13 +100,13 @@

[method:Object computeFrenetFrames]( [param:Integer segments], [param:Boolea

[method:Curve clone]()

이 인스턴스의 사본을 만듭니다.

-

[method:Curve copy]( [param:Curve source] )

+

[method:this copy]( [param:Curve source] )

다른 [name] 객체를 이 인스턴스에 복사합니다.

[method:Object toJSON]()

이 인스턴스의 JSON 객체 표현을 리턴합니다.

-

[method:Curve fromJSON]( [param:Object json] )

+

[method:this fromJSON]( [param:Object json] )

JSON 객체에서 이 인스턴스로 데이터를 복사합니다.

소스코드

diff --git a/docs/api/zh/animation/AnimationAction.html b/docs/api/zh/animation/AnimationAction.html index 896897e4008a4b..d1fe7dc2f1462c 100644 --- a/docs/api/zh/animation/AnimationAction.html +++ b/docs/api/zh/animation/AnimationAction.html @@ -131,7 +131,7 @@

[property:Boolean zeroSlopeAtStart]

方法

-

[method:AnimationAction crossFadeFrom]( [param:AnimationAction fadeOutAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )

+

[method:this crossFadeFrom]( [param:AnimationAction fadeOutAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )

在传入的时间段内，让此动作淡入([page:.fadeIn fade in]),同时让另一个动作淡出。此方法可链式调用。

@@ -141,7 +141,7 @@

[method:AnimationAction crossFadeFrom]( [param:AnimationAction fadeOutAction

-

[method:AnimationAction crossFadeTo]( [param:AnimationAction fadeInAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )

+

[method:this crossFadeTo]( [param:AnimationAction fadeInAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )

在传入的时间段内, 让此动作淡出（[page:.fadeOut fade out]），同时让另一个动作淡入。此方法可链式调用。

如果warpBoolean值是true, 额外的 [page:.warp warping] (时间比例的渐变)将会被应用。

@@ -149,12 +149,12 @@

[method:AnimationAction crossFadeTo]( [param:AnimationAction fadeInAction], 说明: 与 *fadeIn*/*fadeOut*一样, 淡入淡出动作开始/结束时的权重是1.

-

[method:AnimationAction fadeIn]( [param:Number durationInSeconds] )

+

[method:this fadeIn]( [param:Number durationInSeconds] )

在传入的时间间隔内，逐渐将此动作的权重（[page:.weight weight]）由0升到1。此方法可链式调用。

-

[method:AnimationAction fadeOut]( [param:Number durationInSeconds] )

+

[method:this fadeOut]( [param:Number durationInSeconds] )

在传入的时间间隔内，逐渐将此动作的权重（[page:.weight weight]）由1降至0。此方法可链式调用。

@@ -184,7 +184,7 @@

[method:Object3D getRoot]()

返回执行此动作的根对象

-

[method:AnimationAction halt]( [param:Number durationInSeconds] )

+

[method:this halt]( [param:Number durationInSeconds] )

在传入的时间间隔内，通过从当前值开始逐渐降低时间比例([page:.timeScale timeScale])使动画逐渐减速至0。此方法可链式调用。

@@ -206,7 +206,7 @@

[method:Boolean isScheduled]()

说明: 这并不意味着动画正在执行中 (需要额外判断[page:.isRunning isRunning]值)

-

[method:AnimationAction play]()

+

[method:this play]()

让混合器激活动作。此方法可链式调用。

@@ -215,7 +215,7 @@

[method:AnimationAction play]()

[page:.weight weight]=0, [page:.timeScale timeScale]=0) 也可以阻止动画的开始。

-

[method:AnimationAction reset]()

+

[method:this reset]()

重置动作。此方法可链式调用。

@@ -226,12 +226,12 @@

[method:AnimationAction reset]()

这就表示: 如果你想要这两者, 重置并且停止, 不要调用*reset*; 而应该调用*stop*。

-

[method:AnimationAction setDuration]( [param:Number durationInSeconds] )

+

[method:this setDuration]( [param:Number durationInSeconds] )

设置单此循环的持续时间(通过调整时间比例（[page:.timeScale timeScale]）以及停用所有的变形)。此方法可以链式调用。

-

[method:AnimationAction setEffectiveTimeScale]( [param:Number timeScale] )

+

[method:this setEffectiveTimeScale]( [param:Number timeScale] )

设置时间比例（[page:.timeScale timeScale]）以及停用所有的变形)。 此方法可以链式调用。

@@ -241,7 +241,7 @@

[method:AnimationAction setEffectiveTimeScale]( [param:Number timeScale] ) -

[method:AnimationAction setEffectiveWeight]( [param:Number weight] )

+

[method:this setEffectiveWeight]( [param:Number weight] )

设置权重（[page:.weight weight]）以及停止所有淡入淡出。该方法可以链式调用。

@@ -250,12 +250,12 @@

[method:AnimationAction setEffectiveWeight]( [param:Number weight] )

说明: 如果该方法将权重*weight*值设为0，启用值*enabled*不会被自动改为*false*。

-

[method:AnimationAction setLoop]( [param:Number loopMode], [param:Number repetitions] )

+

[method:this setLoop]( [param:Number loopMode], [param:Number repetitions] )

设置循环（[page:.loop loop mode]）及循环重复次数（[page:.repetitions repetitions]）。改方法可被链式调用。

-

[method:AnimationAction startAt]( [param:Number startTimeInSeconds] )

+

[method:this startAt]( [param:Number startTimeInSeconds] )

定义延时启动的事件 (通常会传入[page:AnimationMixer.time] + deltaTimeInSeconds)。 该方法可以链式调用。

@@ -263,7 +263,7 @@

[method:AnimationAction startAt]( [param:Number startTimeInSeconds] )

说明: 如果 *startAt*方法是和[page:.play play]方法一起链式调用, 或者动画已经在混合器中被激活 (通过先行调用*play*, 同时没有停止或重置)，动画将仅在给定时间开始.

-

[method:AnimationAction stop]()

+

[method:this stop]()

让混合器停止动作。该方法可以被链式调用。

@@ -272,17 +272,17 @@

[method:AnimationAction stop]()

说明: 你可以通过[page:AnimationMixer.stopAllAction mixer.stopAllAction]在一个混合器中一举停止所有处于激活态的动作。

-

[method:AnimationAction stopFading]()

+

[method:this stopFading]()

停止动作中所有预定的淡入淡出（[page:.fadeIn fading]）。该方法可以被链式调用。

-

[method:AnimationAction stopWarping]()

+

[method:this stopWarping]()

停用动作中所有预定的变形[page:.warp warping]。该方法可被链式调用。

-

[method:AnimationAction syncWith]( [param:AnimationAction otherAction] )

+

[method:this syncWith]( [param:AnimationAction otherAction] )

将此动作与传入的其它动作同步。此方法可被链式调用。

@@ -292,7 +292,7 @@

[method:AnimationAction syncWith]( [param:AnimationAction otherAction] )

-

[method:AnimationAction warp]( [param:Number startTimeScale], [param:Number endTimeScale], [param:Number durationInSeconds] )

+

[method:this warp]( [param:Number startTimeScale], [param:Number endTimeScale], [param:Number durationInSeconds] )

在传入的事件间隔内，通过逐渐将时间比例[page:.timeScale timeScale]由*startTimeScale*修改至*endTimeScale*来改变回放速度。该方法可被链式调用。

diff --git a/docs/api/zh/animation/AnimationMixer.html b/docs/api/zh/animation/AnimationMixer.html index 5cd6acbee2f74a..b13ecb397ae8dd 100644 --- a/docs/api/zh/animation/AnimationMixer.html +++ b/docs/api/zh/animation/AnimationMixer.html @@ -40,14 +40,6 @@

[property:Number timeScale]

说明: 将混合器的时间比例设为0, 稍后再设置为1，可以暂停/取消暂停由该混合器控制的所有动作。

-

[method:AnimationMixer setTime]([param:Number timeInSeconds])

-

- 设置全局混合器到一个给定的时间，并相应地更新动画。

- - 当你需要在一个动画里跳转到一个精确的时间，该函数将是十分有用的。输入的参数将会被混合器的[page:.timeScale timeScale]进行缩放。 -

- -

方法

@@ -70,18 +62,25 @@

[method:Object3D getRoot]()

返回混合器的根对象

-

[method:AnimationMixer stopAllAction]()

+

[method:this stopAllAction]()

停用混合器上所有预定的动作

-

[method:AnimationMixer update]([param:Number deltaTimeInSeconds])

+

[method:this update]([param:Number deltaTimeInSeconds])

推进混合器时间并更新动画

通常在渲染循环中完成, 传入按照混合器的时间比例([page:.timeScale timeScale])缩放过的[page:Clock.getDelta clock.getDelta]

+

[method:this setTime]([param:Number timeInSeconds])

+

+ 设置全局混合器到一个给定的时间，并相应地更新动画。

+ + 当你需要在一个动画里跳转到一个精确的时间，该函数将是十分有用的。输入的参数将会被混合器的[page:.timeScale timeScale]进行缩放。 +

+

[method:undefined uncacheClip]([param:AnimationClip clip])

diff --git a/docs/api/zh/audio/Audio.html b/docs/api/zh/audio/Audio.html index 6457b0365a7876..e1c2a2de95e11b 100644 --- a/docs/api/zh/audio/Audio.html +++ b/docs/api/zh/audio/Audio.html @@ -102,12 +102,12 @@

[property:String type]

方法

-

[method:Audio connect]()

+

[method:this connect]()

连接[page:Audio.source]. 在初始化和设置/删除filters时使用.

-

[method:Audio disconnect]()

+

[method:this disconnect]()

断开连接[page:Audio.source]. 在设置/删除filters时使用.

@@ -143,12 +143,12 @@

[method:Float getVolume]( value )

返回音量.

-

[method:Audio play]( delay )

+

[method:this play]( delay )

如果[page:Audio.hasPlaybackControl hasPlaybackControl]是true, 开始播放.

-

[method:Audio pause]()

+

[method:this pause]()

如果[page:Audio.hasPlaybackControl hasPlaybackControl]是true, 暂停播放.

@@ -158,69 +158,69 @@

[method:undefined onEnded]()

播放完成后自动调用.

-

[method:Audio setBuffer]( audioBuffer )

+

[method:this setBuffer]( audioBuffer )

设置[page:Audio.source source]给audioBuffer, 和设置[page:Audio.sourceType sourceType]给'buffer'.
如果[page:Audio.autoplay autoplay]为true, 也开始播放.

-

[method:Audio setFilter]( filter )

+

[method:this setFilter]( filter )

Applies a single filter node to the audio.

-

[method:Audio setFilters]( [param:Array value] )

+

[method:this setFilters]( [param:Array value] )

value - arrays of filters.
Applies an array of filter nodes to the audio.

-

[method:Audio setLoop]( [param:Boolean value] )

+

[method:this setLoop]( [param:Boolean value] )

设置[link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loop source.loop]的值 (是否循环播放).

-

[method:Audio setLoopStart]( [param:Float value] )

+

[method:this setLoopStart]( [param:Float value] )

设置[link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopStart source.loopStart]的值

-

[method:Audio setLoopEnd]( [param:Float value] )

+

[method:this setLoopEnd]( [param:Float value] )

设置[link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopEnd source.loopEnd]的值

-

[method:Audio setMediaElementSource]( mediaElement )

+

[method:this setMediaElementSource]( mediaElement )

应用传入的[link:https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement HTMLMediaElement]类型对象作为音源。
并且设置[page:Audio.hasPlaybackControl hasPlaybackControl]为false。

-

[method:Audio setMediaStreamSource]( mediaStream )

+

[method:this setMediaStreamSource]( mediaStream )

应用传入的[link:https://developer.mozilla.org/en-US/docs/Web/API/MediaStream MediaStream]类型对象作为音源。
并且设置[page:Audio.hasPlaybackControl hasPlaybackControl]为false。

-

[method:Audio setNodeSource]( audioNode )

+

[method:this setNodeSource]( audioNode )

设置[page:Audio.source source]给audioBuffer, 和设置[page:Audio.sourceType sourceType]给 'audioNode'.
并且设置[page:Audio.hasPlaybackControl hasPlaybackControl]为false.

-

[method:Audio setPlaybackRate]( [param:Float value] )

+

[method:this setPlaybackRate]( [param:Float value] )

如果[page:Audio.hasPlaybackControl hasPlaybackControl]是true, 设置[page:Audio.playbackRate playbackRate]（播放速率） 的值.

-

[method:Audio setVolume]( [param:Float value] )

+

[method:this setVolume]( [param:Float value] )

设置音量.

-

[method:Audio stop]()

+

[method:this stop]()

如果[page:Audio.hasPlaybackControl hasPlaybackControl]是true, 停止播放.

diff --git a/docs/api/zh/audio/AudioListener.html b/docs/api/zh/audio/AudioListener.html index d5ac71645fd81b..f3542044d0c30a 100644 --- a/docs/api/zh/audio/AudioListener.html +++ b/docs/api/zh/audio/AudioListener.html @@ -76,7 +76,7 @@

[method:GainNode getInput]()

返回[page:AudioListener.gain gainNode].

-

[method:AudioListener removeFilter]()

+

[method:this removeFilter]()

设置[page:AudioListener.filter filter]属性为*null*.

@@ -86,7 +86,7 @@

[method:AudioNode getFilter]()

返回[page:AudioListener.filter filter]属性的值.

-

[method:AudioListener setFilter]( [param:AudioNode value] )

+

[method:this setFilter]( [param:AudioNode value] )

设置[page:AudioListener.filter filter] 属性的值.

@@ -96,7 +96,7 @@

[method:Float getMasterVolume]()

返回音量.

-

[method:AudioListener setMasterVolume]( [param:Number value] )

+

[method:this setMasterVolume]( [param:Number value] )

设置音量.

diff --git a/docs/api/zh/audio/PositionalAudio.html b/docs/api/zh/audio/PositionalAudio.html index fe1ba3f542ac98..3bd7c2896242be 100644 --- a/docs/api/zh/audio/PositionalAudio.html +++ b/docs/api/zh/audio/PositionalAudio.html @@ -87,7 +87,7 @@

[method:Float getRefDistance]()

返回[link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/refDistance panner.refDistance]的值.

-

[method:PositionalAudio setRefDistance]( [param:Float value] )

+

[method:this setRefDistance]( [param:Float value] )

设置[link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/refDistance panner.refDistance]的值.

@@ -97,7 +97,7 @@

[method:Float getRolloffFactor]()

返回[link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/rolloffFactor panner.rolloffFactor]的值.

-

[method:PositionalAudio setRolloffFactor]( [param:Float value] )

+

[method:this setRolloffFactor]( [param:Float value] )

设置[link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/rolloffFactor panner.rolloffFactor]的值.

@@ -107,7 +107,7 @@

[method:String getDistanceModel]()

返回[link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/distanceModel panner.distanceModel]的值.

-

[method:PositionalAudio setDistanceModel]( [param:String value] )

+

[method:this setDistanceModel]( [param:String value] )

设置[link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/distanceModel panner.distanceModel]的值.

@@ -117,12 +117,12 @@

[method:Float getMaxDistance]()

返回[link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/maxDistance panner.maxDistance]的值.

-

[method:PositionalAudio setMaxDistance]( [param:Float value] )

+

[method:this setMaxDistance]( [param:Float value] )

设置[link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/maxDistance panner.maxDistance]的值.

-

[method:PositionalAudio setDirectionalCone]( [param:Float coneInnerAngle], [param:Float coneOuterAngle], [param:Float coneOuterGain] )

+

[method:this setDirectionalCone]( [param:Float coneInnerAngle], [param:Float coneOuterAngle], [param:Float coneOuterGain] )

这个方法用来把环绕声音转换为定向声音[link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode directional sound].

diff --git a/docs/api/zh/cameras/Camera.html b/docs/api/zh/cameras/Camera.html index c78a650ec723f3..9311a0565684a8 100644 --- a/docs/api/zh/cameras/Camera.html +++ b/docs/api/zh/cameras/Camera.html @@ -62,7 +62,7 @@

[method:Camera clone]( )

-

[method:Camera copy]( [param:Camera source], [param:Boolean recursive] )

+

[method:this copy]( [param:Camera source], [param:Boolean recursive] )

将源摄像机的属性复制到新摄像机中。 diff --git a/docs/api/zh/core/BufferAttribute.html b/docs/api/zh/core/BufferAttribute.html index 5ebcea9232f747..7cdde54f8a995f 100644 --- a/docs/api/zh/core/BufferAttribute.html +++ b/docs/api/zh/core/BufferAttribute.html @@ -111,7 +111,7 @@

[method:this transformDirection]( [param:Matrix4 m] )

[method:BufferAttribute clone]()

返回该 BufferAttribute 的拷贝。

-

[method:BufferAttribute copyArray]( array )

+

[method:this copyArray]( array )

将参数中所给定的普通队列或 TypedArray 拷贝到 [page:BufferAttribute.array array] 中。

拷贝 TypedArray 相关注意事项详见 [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/set TypedArray.set]。

@@ -119,16 +119,16 @@

[method:BufferAttribute copyArray]( array )

[method:this copyAt] ( [param:Integer index1], [param:BufferAttribute bufferAttribute], [param:Integer index2] )

将一个矢量从 bufferAttribute[index2] 拷贝到 [page:BufferAttribute.array array][index1] 中。

-

[method:BufferAttribute copyColorsArray]( [param:Array colors] )

+

[method:this copyColorsArray]( [param:Array colors] )

将一个存储 RGB 颜色值的队列拷贝到 [page:BufferAttribute.array array] 中。

-

[method:BufferAttribute copyVector2sArray]( [param:Array vectors] )

+

[method:this copyVector2sArray]( [param:Array vectors] )

将一个存储 [page:Vector2] 的队列拷贝到 [page:BufferAttribute.array array] 中。

-

[method:BufferAttribute copyVector3sArray]( [param:Array vectors] )

+

[method:this copyVector3sArray]( [param:Array vectors] )

将一个存储 [page:Vector3] 的队列拷贝到 [page:BufferAttribute.array array] 中。

-

[method:BufferAttribute copyVector4sArray]( [param:Array vectors] )

+

[method:this copyVector4sArray]( [param:Array vectors] )

将一个存储 [page:Vector4] 的队列拷贝到 [page:BufferAttribute.array array] 中。

[method:Number getX]( [param:Integer index] )

@@ -148,7 +148,7 @@

[method:this onUpload]( [param:Function callback] )

在 [example:webgl_buffergeometry WebGL / Buffergeometry] 中，该方在缓存数据传递给 GPU 后，用于释放内存。

-

[method:BufferAttribute set] ( [param:Array value], [param:Integer offset] )

+

[method:this set] ( [param:Array value], [param:Integer offset] )

value -- 被拷贝的 [page:Array] 或 [page:TypedArray] 类型的数据。
offset -- (可选) [page:BufferAttribute.array array] 中开始拷贝的位置索引。

@@ -159,28 +159,28 @@

[method:BufferAttribute set] ( [param:Array value], [param:Integer offset] ) 特别的, 对将 [page:Array value] 转为 [page:TypedArray] 的要求详见上述链接。

-

[method:BufferAttribute setUsage] ( [param:Usage value] )

+

[method:this setUsage] ( [param:Usage value] )

Set [page:BufferAttribute.usage usage] to value. See usage [page:BufferAttributeUsage constants] for all possible input values.

-

[method:BufferAttribute setX]( [param:Integer index], [param:Float x] )

+

[method:this setX]( [param:Integer index], [param:Float x] )

设置给定索引的矢量的第一维数据（设置 X 值）。

-

[method:BufferAttribute setY]( [param:Integer index], [param:Float y] )

+

[method:this setY]( [param:Integer index], [param:Float y] )

设置给定索引的矢量的第二维数据（设置 Y 值）。

-

[method:BufferAttribute setZ]( [param:Integer index], [param:Float z] )

+

[method:this setZ]( [param:Integer index], [param:Float z] )

设置给定索引的矢量的第三维数据（设置 Z 值）。

-

[method:BufferAttribute setW]( [param:Integer index], [param:Float w] )

+

[method:this setW]( [param:Integer index], [param:Float w] )

设置给定索引的矢量的第四维数据（设置 W 值）。

-

[method:BufferAttribute setXY]( [param:Integer index], [param:Float x], [param:Float y] )

+

[method:this setXY]( [param:Integer index], [param:Float x], [param:Float y] )

设置给定索引的矢量的第一、二维数据（设置 X 和 Y 值）。

-

[method:BufferAttribute setXYZ]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z] )

+

[method:this setXYZ]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z] )

设置给定索引的矢量的第一、二、三维数据（设置 X、Y 和 Z 值）。

-

[method:BufferAttribute setXYZW]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z], [param:Float w] )

+

[method:this setXYZW]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z], [param:Float w] )

设置给定索引的矢量的第一、二、三、四维数据（设置 X、Y、Z 和 W 值）。

diff --git a/docs/api/zh/core/BufferGeometry.html b/docs/api/zh/core/BufferGeometry.html index 5128ace0fb3a83..567350ce119279 100644 --- a/docs/api/zh/core/BufferGeometry.html +++ b/docs/api/zh/core/BufferGeometry.html @@ -154,7 +154,7 @@

方法

[page:EventDispatcher EventDispatcher] 在该类上可用的所有方法。

-

[method:BufferGeometry setAttribute]( [param:String name], [param:BufferAttribute attribute] )

+

[method:this setAttribute]( [param:String name], [param:BufferAttribute attribute] )

为当前几何体设置一个 attribute 属性。在类的内部，有一个存储 [page:.attributes] 的 hashmap， 通过该 hashmap，遍历 attributes 的速度会更快。而使用该方法，可以向 hashmap 内部增加 attribute。 @@ -170,13 +170,13 @@

[method:undefined addGroup]( [param:Integer start], [param:Integer count], [

[method:this applyMatrix4]( [param:Matrix4 matrix] )

用给定矩阵转换几何体的顶点坐标。

-

[method:BufferGeometry center] ()

+

[method:this center] ()

根据边界矩形将几何体居中。

[method:BufferGeometry clone]()

克隆当前的 BufferGeometry。

-

[method:BufferGeometry copy]( [param:BufferGeometry bufferGeometry] )

+

[method:this copy]( [param:BufferGeometry bufferGeometry] )

将参数指定的 BufferGeometry 的值拷贝到当前 BufferGeometry 中。

[method:undefined clearGroups]( )

@@ -218,7 +218,7 @@

[method:BufferAttribute getIndex] ()

[method:Boolean hasAttribute]( [param:String name] )

Returns *true* if the attribute with the specified name exists.

-

[method:BufferGeometry lookAt] ( [param:Vector3 vector] )

+

[method:this lookAt] ( [param:Vector3 vector] )

vector - 几何体所朝向的世界坐标。

@@ -236,33 +236,33 @@

[method:undefined normalizeNormals]()

[method:BufferAttribute deleteAttribute]( [param:String name] )

删除具有指定名称的 [page:BufferAttribute attribute]。

-

[method:BufferGeometry rotateX] ( [param:Float radians] )

+

[method:this rotateX] ( [param:Float radians] )

在 X 轴上旋转几何体。该操作一般在一次处理中完成，不会循环处理。典型的用法是通过调用 [page:Object3D.rotation] 实时旋转几何体。

-

[method:BufferGeometry rotateY] ( [param:Float radians] )

+

[method:this rotateY] ( [param:Float radians] )

在 Y 轴上旋转几何体。该操作一般在一次处理中完成，不会循环处理。典型的用法是通过调用 [page:Object3D.rotation] 实时旋转几何体。

-

[method:BufferGeometry rotateZ] ( [param:Float radians] )

+

[method:this rotateZ] ( [param:Float radians] )

在 Z 轴上旋转几何体。该操作一般在一次处理中完成，不会循环处理。典型的用法是通过调用 [page:Object3D.rotation] 实时旋转几何体。

-

[method:BufferGeometry scale] ( [param:Float x], [param:Float y], [param:Float z] )

+

[method:this scale] ( [param:Float x], [param:Float y], [param:Float z] )

缩放几何体。该操作一般在一次处理中完成，不会循环处理。典型的用法是通过调用 [page:Object3D.scale] 实时旋转几何体。

-

[method:BufferGeometry setIndex] ( [param:BufferAttribute index] )

+

[method:this setIndex] ( [param:BufferAttribute index] )

设置缓存的 [page:.index]。

[method:undefined setDrawRange] ( [param:Integer start], [param:Integer count] )

设置缓存的 [page:.drawRange]。详见相关属性说明。

-

[method:BufferGeometry setFromPoints] ( [param:Array points] )

+

[method:this setFromPoints] ( [param:Array points] )

通过点队列设置该 BufferGeometry 的 attribute。

[method:Object toJSON]()

@@ -271,7 +271,7 @@

[method:Object toJSON]()

[method:BufferGeometry toNonIndexed]()

返回已索引的 BufferGeometry 的非索引版本。

-

[method:BufferGeometry translate] ( [param:Float x], [param:Float y], [param:Float z] )

+

[method:this translate] ( [param:Float x], [param:Float y], [param:Float z] )

移动几何体。该操作一般在一次处理中完成，不会循环处理。典型的用法是通过调用 [page:Object3D.rotation] 实时旋转几何体。

diff --git a/docs/api/zh/core/InstancedBufferGeometry.html b/docs/api/zh/core/InstancedBufferGeometry.html index 6aa483439cf8b8..161dba54f5d930 100644 --- a/docs/api/zh/core/InstancedBufferGeometry.html +++ b/docs/api/zh/core/InstancedBufferGeometry.html @@ -31,7 +31,7 @@

[property:Number instanceCount]

方法

继承方法详见 [page:BufferGeometry]。

-

[method:InstancedBufferGeometry copy]( [param:InstancedBufferGeometry source] )

+

[method:this copy]( [param:InstancedBufferGeometry source] )

Copies the given [name] to this instance.

源代码

diff --git a/docs/api/zh/core/InterleavedBuffer.html b/docs/api/zh/core/InterleavedBuffer.html index 44fe9277c8e1bd..73bca8585b8e00 100644 --- a/docs/api/zh/core/InterleavedBuffer.html +++ b/docs/api/zh/core/InterleavedBuffer.html @@ -81,15 +81,15 @@

[property:Usage usage]

方法

-

[method:InterleavedBuffer copy]( [param:InterleavedBuffer source] )

+

[method:this copy]( [param:InterleavedBuffer source] )

将参数指定的 [name] 拷贝到当前 [name]。

-

[method:InterleavedBuffer copyAt]( [param:Integer index1], [param:InterleavedBuffer attribute], [param:Integer index2] )

+

[method:this copyAt]( [param:Integer index1], [param:InterleavedBuffer attribute], [param:Integer index2] )

将数据从 attribute[index2] 拷贝到 [page:InterleavedBuffer.array array][index1]。

-

[method:InterleavedBuffer set]( [param:TypedArray value], [param:Integer offset] )

+

[method:this set]( [param:TypedArray value], [param:Integer offset] )

value - 被拷贝的源（类型化）队列。
offset - 源队列中，数据开始拷贝的偏移量。默认值是 *0*.

@@ -104,10 +104,10 @@

[method:InterleavedBuffer clone]( [param:Object data] )

Creates a clone of this [name].

-

[method:InterleavedBuffer setUsage] ( [param:Usage value] )

+

[method:this setUsage] ( [param:Usage value] )

Set [page:InterleavedBuffer.usage usage] to value.

-

[method:InterleavedBuffer toJSON]( [param:Object data] )

+

[method:Object toJSON]( [param:Object data] )

data - This object holds shared array buffers required for properly serializing geometries with interleaved attributes.

diff --git a/docs/api/zh/core/Object3D.html b/docs/api/zh/core/Object3D.html index 819dab041b247b..6f06b69e6326e2 100644 --- a/docs/api/zh/core/Object3D.html +++ b/docs/api/zh/core/Object3D.html @@ -206,7 +206,7 @@

[method:this add]( [param:Object3D object], ... )

[method:undefined applyMatrix4]( [param:Matrix4 matrix] )

对当前物体应用这个变换矩阵，并更新物体的位置、旋转和缩放。

-

[method:Object3D applyQuaternion]( [param:Quaternion quaternion] )

+

[method:this applyQuaternion]( [param:Quaternion quaternion] )

对当前物体应用由四元数所表示的变换。

diff --git a/docs/api/zh/extras/core/Curve.html b/docs/api/zh/extras/core/Curve.html index 012b493cc96fdb..fde1784203afe6 100644 --- a/docs/api/zh/extras/core/Curve.html +++ b/docs/api/zh/extras/core/Curve.html @@ -98,13 +98,13 @@

[method:Object computeFrenetFrames]( [param:Integer segments], [param:Boolea

[method:Curve clone]()

创建此实例的克隆。

-

[method:Curve copy]( [param:Curve source] )

+

[method:this copy]( [param:Curve source] )

将另一个[name]对象复制到此实例。

[method:Object toJSON]()

返回此实例的JSON对象表示形式。

-

[method:Curve fromJSON]( [param:Object json] )

+

[method:this fromJSON]( [param:Object json] )

将给定的JSON数据复制到此实例。

Source

diff --git a/docs/api/zh/helpers/BoxHelper.html b/docs/api/zh/helpers/BoxHelper.html index 69b23a8ba826c5..5198f63687060d 100644 --- a/docs/api/zh/helpers/BoxHelper.html +++ b/docs/api/zh/helpers/BoxHelper.html @@ -61,7 +61,7 @@

[method:undefined update]()

保持一致, 包围目标对象所有子对象. 请查看 [page:Box3.setFromObject].

-

[method:BoxHelper setFromObject]( [param:Object3D object] )

+

[method:this setFromObject]( [param:Object3D object] )

[page:Object3D object] - 用于创建辅助对象的目标 [page:Object3D] 对象.

diff --git a/docs/api/zh/lights/DirectionalLight.html b/docs/api/zh/lights/DirectionalLight.html index 7ecc145a370ca5..eb59785472a5bb 100644 --- a/docs/api/zh/lights/DirectionalLight.html +++ b/docs/api/zh/lights/DirectionalLight.html @@ -110,7 +110,7 @@

方法

公共方法请查看基类 [page:Light Light]。

-

[method:DirectionalLight copy]( [param:DirectionalLight source] )

+

[method:this copy]( [param:DirectionalLight source] )

复制 source 的值到这个平行光源对象。

diff --git a/docs/api/zh/lights/HemisphereLight.html b/docs/api/zh/lights/HemisphereLight.html index a661b9312ed05f..6635edbe987f3d 100644 --- a/docs/api/zh/lights/HemisphereLight.html +++ b/docs/api/zh/lights/HemisphereLight.html @@ -79,7 +79,7 @@

方法（Methods）

公共方法请查看基类 [page:Light Light]。

-

[method:HemisphereLight copy]( [param:HemisphereLight source] )

+

[method:this copy]( [param:HemisphereLight source] )

从[page:Light source]复制 [page:.color color], [page:.intensity intensity] 和 [page:.groundColor groundColor] 的值到当前半球光对象中。 diff --git a/docs/api/zh/lights/Light.html b/docs/api/zh/lights/Light.html index 6ce2bf14f16d4d..2b32d53fadd5d4 100644 --- a/docs/api/zh/lights/Light.html +++ b/docs/api/zh/lights/Light.html @@ -53,9 +53,9 @@

Methods

-

[method:Light copy]( [param:Light source] )

+

[method:this copy]( [param:Light source] )

- 从[page:Light source]复制 [page:.color color], [page:.intensity intensity] + 从[page:Light source]复制 [page:.color color], [page:.intensity intensity] 的值到当前光源对象中。

diff --git a/docs/api/zh/lights/PointLight.html b/docs/api/zh/lights/PointLight.html index ea42ff13925caa..0c0254477715c6 100644 --- a/docs/api/zh/lights/PointLight.html +++ b/docs/api/zh/lights/PointLight.html @@ -94,7 +94,7 @@

方法（Methods）

公共方法请查看基类 [page:Light Light]。

-

[method:PointLight copy]( [param:PointLight source] )

+

[method:this copy]( [param:PointLight source] )

将所有属性的值从源 [page:PointLight source] 复制到此点光源对象。

diff --git a/docs/api/zh/lights/RectAreaLight.html b/docs/api/zh/lights/RectAreaLight.html index 7a9078b34a4a8e..e43721cd04c6bc 100644 --- a/docs/api/zh/lights/RectAreaLight.html +++ b/docs/api/zh/lights/RectAreaLight.html @@ -67,7 +67,7 @@

方法（Methods）

-

[method:RectAreaLight copy]( [param:RectAreaLight source] )

+

[method:this copy]( [param:RectAreaLight source] )

将所有属性的值从源 [page:RectAreaLight source] 复制到此平面光光源对象。

diff --git a/docs/api/zh/lights/SpotLight.html b/docs/api/zh/lights/SpotLight.html index 721f6346047960..84309d02af85d3 100644 --- a/docs/api/zh/lights/SpotLight.html +++ b/docs/api/zh/lights/SpotLight.html @@ -144,7 +144,7 @@

方法（Methods）

公共方法请查看基类 [page:Light Light]。

-

[method:SpotLight copy]( [param:SpotLight source] )

+

[method:this copy]( [param:SpotLight source] )

将所有属性的值从源 [page:SpotLight source] 复制到此聚光灯光源对象。

diff --git a/docs/api/zh/lights/shadows/LightShadow.html b/docs/api/zh/lights/shadows/LightShadow.html index 6efdfe971b9fbc..9490943615e9a4 100644 --- a/docs/api/zh/lights/shadows/LightShadow.html +++ b/docs/api/zh/lights/shadows/LightShadow.html @@ -122,7 +122,7 @@

[method:number getViewportCount]()

Used internally by the renderer to get the number of viewports that need to be rendered for this shadow.

-

[method:LightShadow copy]( [param:LightShadow source] )

+

[method:this copy]( [param:LightShadow source] )

将[page:LightShadow source]中的所有属性的值复制到该Light。

diff --git a/docs/api/zh/loaders/FileLoader.html b/docs/api/zh/loaders/FileLoader.html index c696e9d12e4bf3..1473c416fe5ffe 100644 --- a/docs/api/zh/loaders/FileLoader.html +++ b/docs/api/zh/loaders/FileLoader.html @@ -80,7 +80,7 @@

[property:String withCredentials]

方法

共有方法请参见其基类[page:Loader]。

-

[method:null load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )

+

[method:undefined load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )

[page:String url] — 文件的URL或者路径，也可以为 [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
@@ -92,20 +92,13 @@

[method:null load]( [param:String url], [param:Function onLoad], [param:Func 加载URL并将响应传递给onLoad函数。

-

[method:FileLoader setMimeType]( [param:String mimeType] )

+

[method:this setMimeType]( [param:String mimeType] )

设置正在加载的文件预期类型 [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types mimeType] 。请注意，在许多情况下，这将自动确定，因此默认情况下它是 *undefined* 。

-

[method:FileLoader setRequestHeader]( [param:Object requestHeader] )

-

- [page:Object requestHeader] - key: 要设置header的名称。 value：要设置header的值。

- - 请参考在HTTP 请求中的 [link:https://developer.mozilla.org/en-US/docs/Glossary/Request_header request header]。 -

- -

[method:FileLoader setResponseType]( [param:String responseType] )

+

[method:this setResponseType]( [param:String responseType] )

改变响应的类型，其类型有效值如下:
[page:String text] 或者空 string (默认) - 返回的数据类型为 [page:String string].
@@ -115,13 +108,6 @@

[method:FileLoader setResponseType]( [param:String responseType] )

[page:String json] - 将文件解析为 [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse JSON.parse].

-

[method:FileLoader setWithCredentials]( [param:Boolean value] )

-

- XMLHttpRequest是否使用cookie、授权头或TLS客户端证书等凭据。 请参考 [link:https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials XMLHttpRequest.withCredentials].
- 请注意，当您在本地或从同一域加载文件，则该方法无效。 -

- -

源

diff --git a/docs/api/zh/loaders/ImageBitmapLoader.html b/docs/api/zh/loaders/ImageBitmapLoader.html index c2dcf20cf4d216..f685c40b7c8eb2 100644 --- a/docs/api/zh/loaders/ImageBitmapLoader.html +++ b/docs/api/zh/loaders/ImageBitmapLoader.html @@ -92,7 +92,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param 从URL中进行加载，并返回将包含数据的[page:ImageBitmap image]对象。

-

[method:ImageBitmapLoader setOptions]( [param:Object options] )

+

[method:this setOptions]( [param:Object options] )

设置[link:https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/createImageBitmap createImageBitmap]的选项对象。

diff --git a/docs/api/zh/loaders/ImageLoader.html b/docs/api/zh/loaders/ImageLoader.html index f79f3591ee820e..d8605c19f219e8 100644 --- a/docs/api/zh/loaders/ImageLoader.html +++ b/docs/api/zh/loaders/ImageLoader.html @@ -73,7 +73,7 @@

属性

方法

共有方法请参见其基类[page:Loader]。

-

[method:null load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )

+

[method:HTMLImageElement load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )

[page:String url] — 文件的URL或者路径，也可以为 [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
diff --git a/docs/api/zh/loaders/Loader.html b/docs/api/zh/loaders/Loader.html index 704a0c1d94c23a..6ae72d69eb1902 100644 --- a/docs/api/zh/loaders/Loader.html +++ b/docs/api/zh/loaders/Loader.html @@ -52,7 +52,7 @@

[property:String resourcePath]

[property:Object requestHeader]

[link:https://developer.mozilla.org/en-US/docs/Glossary/Request_header request header] 在 HTTP 请求中使用。 请参考 [page:.setRequestHeader]。 默认为 *undefined*。 -

+

方法

@@ -78,22 +78,22 @@

[method:undefined parse]()

该方法需要被所有具体的加载器来实现。它包含了解析资产到 three.js 实体的逻辑。

-

[method:Loader setCrossOrigin]( [param:String crossOrigin] )

+

[method:this setCrossOrigin]( [param:String crossOrigin] )

[page:String crossOrigin] — crossOrigin字符串用于实现CORS，以从允许CORS的其它域加载url。

-

[method:Loader setPath]( [param:String path] )

+

[method:this setPath]( [param:String path] )

[page:String path] — 设置资产的基本路径。

-

[method:Loader setResourcePath]( [param:String resourcePath] )

+

[method:this setResourcePath]( [param:String resourcePath] )

[page:String resourcePath] — 设置独立资源（如纹理贴图）的基本路径。

-

[method:Loader setRequestHeader]( [param:Object requestHeader] )

+

[method:this setRequestHeader]( [param:Object requestHeader] )

[page:Object requestHeader] - key: 要设置header的名称。 value：要设置header的值。

diff --git a/docs/api/zh/loaders/ObjectLoader.html b/docs/api/zh/loaders/ObjectLoader.html index aec1a217a41c74..0ab05b05cf062d 100644 --- a/docs/api/zh/loaders/ObjectLoader.html +++ b/docs/api/zh/loaders/ObjectLoader.html @@ -94,35 +94,35 @@

[method:Object3D parse]( [param:Object json], [param:Function onLoad] )

-

[method:Object3D parseGeometries]( [param:Object json] )

+

[method:Object parseGeometries]( [param:Object json] )

[page:Object json] — 必选参数，需要被解析的JSON源。

此函数以JSON结构，用[page:.parse]()去解析[page:BufferGeometry geometries]。

-

[method:Object3D parseMaterials]( [param:Object json] )

+

[method:Object parseMaterials]( [param:Object json] )

[page:Object json] — 必选参数，需要被解析的JSON源。

此函数通过[page:.parse()来使用[page:MaterialLoader]，以解析JSON结构中任意材质。

-

[method:Object3D parseAnimations]( [param:Object json] )

+

[method:Object parseAnimations]( [param:Object json] )

[page:Object json] — 必选参数，需要被解析的JSON源。

此函数通过[page:.parse]()来使用[page:AnimationClip.parse]()， 以解析JSON结构中任意动画。

-

[method:Object3D parseImages]( [param:Object json] )

+

[method:Object parseImages]( [param:Object json] )

[page:Object json] — 必选参数，需要被解析的JSON源。

此函数通过[page:.parse]()来使用[page:ImageLoader]， 以解析JSON结构中任意图片。

-

[method:Object3D parseTextures]( [param:Object json] )

+

[method:Object parseTextures]( [param:Object json] )

[page:Object json] — 必选参数，需要被解析的JSON源。

此函数通过[page:.parse]()来解析JSON结构中任意纹理。 diff --git a/docs/api/zh/loaders/managers/LoadingManager.html b/docs/api/zh/loaders/managers/LoadingManager.html index 9092cd531550f8..17006cf07f151f 100644 --- a/docs/api/zh/loaders/managers/LoadingManager.html +++ b/docs/api/zh/loaders/managers/LoadingManager.html @@ -155,7 +155,7 @@

[property:Function onError]

方法

-

[method:LoadingManager addHandler]( [param:Object regex], [param:Loader loader] )

+

[method:this addHandler]( [param:Object regex], [param:Loader loader] )

[page:Object regex] — A regular expression.
[page:Loader loader] — The loader. @@ -175,7 +175,7 @@

[method:Loader getHandler]( [param:String file] )

Can be used to retrieve the registered loader for the given file path.

-

[method:LoadingManager removeHandler]( [param:Object regex] )

+

[method:this removeHandler]( [param:Object regex] )

[page:Object regex] — A regular expression.

diff --git a/docs/api/zh/materials/Material.html b/docs/api/zh/materials/Material.html index 7dbb53897a14d9..1312e7f86460f1 100644 --- a/docs/api/zh/materials/Material.html +++ b/docs/api/zh/materials/Material.html @@ -278,7 +278,7 @@

[page:EventDispatcher EventDispatcher] 方法在此类中可用。

[method:Material clone]( )

返回与此材质具有相同参数的新材质。

-

[method:Material copy]( [param:material material] )

+

[method:this copy]( [param:material material] )

将被传入材质中的参数复制到此材质中。

[method:undefined dispose]()

diff --git a/docs/api/zh/math/Box2.html b/docs/api/zh/math/Box2.html index 9a172ccfcb3060..4780180d0fcb8b 100644 --- a/docs/api/zh/math/Box2.html +++ b/docs/api/zh/math/Box2.html @@ -69,7 +69,7 @@

[method:Boolean containsPoint]( [param:Vector2 point] )

如果指定的点([page:Vector2 point])位于盒子的边界内或边界上，则返回true。

-

[method:Box2 copy]( [param:Box2 box] )

+

[method:this copy]( [param:Box2 box] )

将[page:Box2 box]的[page:.min min] 和 [page:.max max]复制到此盒子中。

@@ -86,19 +86,19 @@

[method:Boolean equals]( [param:Box2 box] )

如果这个盒子和被对比盒子具有相同的上下边界，则返回true。

-

[method:Box2 expandByPoint]( [param:Vector2 point] )

+

[method:this expandByPoint]( [param:Vector2 point] )

[page:Vector2 point] - 应该被盒子包含的点。

扩展盒子的边界来包含该点。

-

[method:Box2 expandByScalar]( [param:Float scalar] )

+

[method:this expandByScalar]( [param:Float scalar] )

[page:Float scalar] - 盒子扩展的距离。

在每个维度上扩展参数scalar所指定的距离，如果为负数，则盒子空间将收缩。

-

[method:Box2 expandByVector]( [param:Vector2 vector] )

+

[method:this expandByVector]( [param:Vector2 vector] )

[page:Vector2 vector] - 按照该向量扩展。

在每个维度中按vector的数值进行扩展。宽度在两个方向上的扩展将由vector的x分量确定， @@ -126,7 +126,7 @@

[method:Vector2 getSize]( [param:Vector2 target] )

返回此盒子的宽度和高度。

-

[method:Box2 intersect]( [param:Box2 box] )

+

[method:this intersect]( [param:Box2 box] )

[page:Box2 box] - 要相交的盒子。

返回两者的相交后的盒子，并将相交后的盒子的上限设置为两者的上限中的较小者，将下限设置为两者的下限中的较大者。 @@ -144,11 +144,11 @@

[method:Boolean isEmpty]()

请注意，一个下上边界相等的的盒子仍然包括一个点，一个两个边界共享的点。

-

[method:Box2 makeEmpty]()

+

[method:this makeEmpty]()

使此盒子为空。

-

[method:Box2 set]( [param:Vector2 min], [param:Vector2 max] )

+

[method:this set]( [param:Vector2 min], [param:Vector2 max] )

[page:Vector2 min] - (必须) 表示该盒子的下边界(x, y)。
[page:Vector2 max] - (必须) 表示该盒子的上边界(x, y)。

@@ -157,7 +157,7 @@

[method:Box2 set]( [param:Vector2 min], [param:Vector2 max] )

请注意，此方法仅复制给定对象的值。

-

[method:Box2 setFromCenterAndSize]( [param:Vector2 center], [param:Vector2 size] )

+

[method:this setFromCenterAndSize]( [param:Vector2 center], [param:Vector2 size] )

[page:Vector2 center] - 盒子所要设置的中心位置。 ([page:Vector2]).
[page:Vector2 size] - 盒子所要设置的x和y尺寸 ([page:Vector2]).

@@ -165,19 +165,19 @@

[method:Box2 setFromCenterAndSize]( [param:Vector2 center], [param:Vector2 s 使盒子的中心点位于[page:Vector2 center]，并设置宽高为[page:Vector2 size]中指定的值。

-

[method:Box2 setFromPoints]( [param:Array points] )

+

[method:this setFromPoints]( [param:Array points] )

[page:Array points] - 点的集合，由这些点确定的空间将被盒子包围。

设置这个盒子的上下边界，来包含所有设置在[page:Array points]参数中的点。

-

[method:Box2 translate]( [param:Vector2 offset] )

+

[method:this translate]( [param:Vector2 offset] )

[page:Vector2 offset] - 偏移方向和距离。

添加 [page:Vector2 offset] 到这个盒子的上下边界，实际上在2D空间移动这个盒子[page:Vector2 offset]个单位。

-

[method:Box2 union]( [param:Box2 box] )

+

[method:this union]( [param:Box2 box] )

[page:Box2 box] - 将要与该盒子联合的盒子

在[page:Box2 box]参数的上边界和该盒子的上边界之间取较大者，而对两者的下边界取较小者，这样获得一个新的较大的联合盒子。 diff --git a/docs/api/zh/math/Color.html b/docs/api/zh/math/Color.html index 88266e6b3b37af..7b133cc7537a26 100644 --- a/docs/api/zh/math/Color.html +++ b/docs/api/zh/math/Color.html @@ -96,46 +96,46 @@

[property:Float b]

方法（Methods）

-

[method:Color add]( [param:Color color] )

+

[method:this add]( [param:Color color] )

将给定颜色的RGB值添加到此颜色的RGB值。

-

[method:Color addColors]( [param:Color color1], [param:Color color2] )

+

[method:this addColors]( [param:Color color1], [param:Color color2] )

将此颜色的RGB值设置为 [page:Color color1] 和 [page:Color color2] 的RGB值之和。

-

[method:Color addScalar]( [param:Number s] )

+

[method:this addScalar]( [param:Number s] )

给现有的RGB值都加上 [page:Number s] 。

[method:Color clone]()

返回一个与当前颜色的 [page:.r r], [page:.g g] 和 [page:.b b] 相同的颜色。

-

[method:Color copy]( [param:Color color] )

+

[method:this copy]( [param:Color color] )

从 [page:Color color] 中拷贝 [page:.r r], [page:.g g] 和 [page:.b b] 值到当前的颜色。

-

[method:Color convertGammaToLinear]( [param:Float gammaFactor] )

+

[method:this convertGammaToLinear]( [param:Float gammaFactor] )

[page:Float gammaFactor] - (可选参数). 默认值 *2.0*.

通过取颜色 [page:.r r], [page:.g g] and [page:.b b] 的 [page:Float gammaFactor] 次方将颜色从伽马空间转换成线性空间。

-

[method:Color convertLinearToGamma]( [param:Float gammaFactor] )

+

[method:this convertLinearToGamma]( [param:Float gammaFactor] )

[page:Float gammaFactor] - (可选参数). 默认值 *2.0*.

通过取颜色 [page:.r r], [page:.g g] and [page:.b b] 的 1/[page:Float gammaFactor] 次方将颜色从线性空间转换成伽马空间。

-

[method:Color convertLinearToSRGB]()

+

[method:this convertLinearToSRGB]()

将此颜色从线性空间转换成sRGB空间。

-

[method:Color convertSRGBToLinear]()

+

[method:this convertSRGBToLinear]()

将此颜色从sRGB空间转换成线性空间。

-

[method:Color copyGammaToLinear]( [param:Color color], [param:Float gammaFactor] )

+

[method:this copyGammaToLinear]( [param:Color color], [param:Float gammaFactor] )

[page:Color color] — 需要拷贝的颜色。
[page:Float gammaFactor] - (可选参数). 默认值为 *2.0*.

@@ -143,7 +143,7 @@

[method:Color copyGammaToLinear]( [param:Color color], [param:Float gammaFac 将传入的 [param:Color color] 从伽马空间转换到线性空间然后复制给当前颜色。

-

[method:Color copyLinearToGamma]( [param:Color color], [param:Float gammaFactor] )

+

[method:this copyLinearToGamma]( [param:Color color], [param:Float gammaFactor] )

[page:Color color] — 需要拷贝的颜色。
[page:Float gammaFactor] - (可选参数). 默认值为 *2.0*.

@@ -151,14 +151,14 @@

[method:Color copyLinearToGamma]( [param:Color color], [param:Float gammaFac 将传入的 [param:Color color] 从线性空间转换到伽马空间然后复制给当前颜色。

-

[method:Color copyLinearToSRGB]( [param:Color color]] )

+

[method:this copyLinearToSRGB]( [param:Color color]] )

[page:Color color] — 需要拷贝的颜色。
将传入的 [param:Color color] 拷贝给当前颜色，然后将当前颜色从线性空间转换到sRGB空间。

-

[method:Color copySRGBToLinear]( [param:Color color] )

+

[method:this copySRGBToLinear]( [param:Color color] )

[page:Color color] — 需要拷贝的颜色。
@@ -168,7 +168,7 @@

[method:Color copySRGBToLinear]( [param:Color color] )

[method:Boolean equals]( [param:Color color] )

将 [param:Color color] 的RGB值与该对象的RGB值进行比较。如果它们都是相同的，返回true，否则返回false。

-

[method:Color fromArray]( [param:Array array], [param:Integer offset] )

+

[method:this fromArray]( [param:Array array], [param:Integer offset] )

[page:Array array] - 格式为 [ [page:Float r], [page:Float g], [page:Float b] ] 的数组 [page:Array]。
[page:Integer offset] - 数组中可选偏移量

@@ -205,7 +205,7 @@

[method:Object getHSL]( [param:Object target] )

[method:String getStyle]()

以CSS样式字符串的形式返回该颜色的值。例如:“rgb(255,0,0)”。

-

[method:Color lerp]( [param:Color color], [param:Float alpha] )

+

[method:this lerp]( [param:Color color], [param:Float alpha] )

[page:Color color] - 用于收敛的颜色。
[page:Float alpha] - 介于0到1的数字。

@@ -223,7 +223,7 @@

[method:this lerpColors]( [param:Color color1], [param:Color color2], [param alpha = 0 时为 [page:Color color1]， alpha = 1 时为 [page:Color color2]。

-

[method:Color lerpHSL]( [param:Color color], [param:Float alpha] )

+

[method:this lerpHSL]( [param:Color color], [param:Float alpha] )

[page:Color color] - 用于收敛的颜色。
[page:Float alpha] - 介于0到1的数字。

@@ -233,20 +233,20 @@

[method:Color lerpHSL]( [param:Color color], [param:Float alpha] )

其中0是当前颜色和1.0是第一个参数的颜色。

-

[method:Color multiply]( [param:Color color] )

+

[method:this multiply]( [param:Color color] )

将此颜色的RGB值乘以给定的 [page:Color color] 的RGB值。

-

[method:Color multiplyScalar]( [param:Number s] )

+

[method:this multiplyScalar]( [param:Number s] )

将此颜色的RGB值乘以给定的[page:Number s]的值。

-

[method:Color offsetHSL]( [param:Float h], [param:Float s], [param:Float l] )

+

[method:this offsetHSL]( [param:Float h], [param:Float s], [param:Float l] )

将给定的 [page:Float h], [page:Float s], 和 [page:Float l]值加到当前颜色值。 内部的机制为：先将该颜色的 [page:.r r], [page:.g g] 和 [page:.b b] 值转换为HSL，然后与传入的[page:Float h], [page:Float s], 和 [page:Float l] 相加，最后再将结果转成RGB值。

-

[method:Color set]( [param:Color_Hex_or_String value] )

+

[method:this set]( [param:Color_Hex_or_String value] )

[page:Color_Hex_or_String value] - 用于设置该颜色的值。

@@ -254,7 +254,7 @@

[method:Color set]( [param:Color_Hex_or_String value] )

根据输入类型，将会委托给 [page:.copy], [page:.setStyle], 或者 [page:.setHex] 函数处理。

-

[method:Color setHex]( [param:Integer hex] )

+

[method:this setHex]( [param:Integer hex] )

[page:Integer hex] — [link:https://en.wikipedia.org/wiki/Web_colors#Hex_triplet hexadecimal triplet] 格式。

@@ -262,7 +262,7 @@

[method:Color setHex]( [param:Integer hex] )

-

[method:Color setHSL]( [param:Float h], [param:Float s], [param:Float l] )

+

[method:this setHSL]( [param:Float h], [param:Float s], [param:Float l] )

[page:Float h] — 色相值处于0到1之间。hue value between 0.0 and 1.0
[page:Float s] — 饱和度值处于0到1之间。
@@ -271,7 +271,7 @@

[method:Color setHSL]( [param:Float h], [param:Float s], [param:Float l] ) < 采用HLS值设置此颜色。

-

[method:Color setRGB]( [param:Float r], [param:Float g], [param:Float b] )

+

[method:this setRGB]( [param:Float r], [param:Float g], [param:Float b] )

[page:Float r] — 红色通道的值在0到1之间。
[page:Float g] — 绿色通道的值在0到1之间。
@@ -280,14 +280,14 @@

[method:Color setRGB]( [param:Float r], [param:Float g], [param:Float b] ) < 采用RGB值设置此颜色。

-

[method:Color setScalar]( [param:Float scalar] )

+

[method:this setScalar]( [param:Float scalar] )

[page:Float scalar] — 处于0到1之间的值

将颜色的RGB值都设为该 [page:Float scalar] 的值。

-

[method:Color setStyle]( [param:String style] )

+

[method:this setStyle]( [param:String style] )

[page:String style] — 颜色css样式的字符串

@@ -306,7 +306,7 @@

[method:Color setStyle]( [param:String style] )

注意，对于X11颜色名称，多个单词(如暗橙色)变成字符串“darkorange”。

-

[method:Color setColorName]( [param:String style] )

+

[method:this setColorName]( [param:String style] )

[page:String style] — 颜色名字的英文单词 ( 具体请查阅 [link:https://en.wikipedia.org/wiki/X11_color_names#Color_name_chart X11 color names] )

@@ -315,7 +315,7 @@

[method:Color setColorName]( [param:String style] )

为了方便使用，颜色名称都可以通过 Color.NAMES 访问，例如：Color.NAMES.aliceblue // returns 0xF0F8FF

-

[method:Color sub]( [param:Color color] )

+

[method:this sub]( [param:Color color] )

从该颜色的RGB分量中减去传入颜色的RGB分量。如果分量结果是负，则该分量为零。

diff --git a/docs/api/zh/math/Cylindrical.html b/docs/api/zh/math/Cylindrical.html index 68b501b451ceb3..bb7942a74d9483 100644 --- a/docs/api/zh/math/Cylindrical.html +++ b/docs/api/zh/math/Cylindrical.html @@ -41,23 +41,23 @@

[method:Cylindrical clone]()

返回一个与当前拥有相同 [page:.radius radius], [page:.theta theta] 和 [page:.y y] 属性的圆柱坐标。

-

[method:Cylindrical copy]( [param:Cylindrical other] )

+

[method:this copy]( [param:Cylindrical other] )

将传入的圆柱坐标对象的 [page:.radius radius], [page:.theta theta] 和 [page:.y y] 属性赋给当前对象。

-

[method:Cylindrical set]( [param:Float radius], [param:Float theta], [param:Float y] )

+

[method:this set]( [param:Float radius], [param:Float theta], [param:Float y] )

设置该对象的 [page:.radius radius], [page:.theta theta] 和 [page:.y y] 属性。

-

[method:Cylindrical setFromVector3]( [param:Vector3 vec3] )

+

[method:this setFromVector3]( [param:Vector3 vec3] )

从 [page:Vector3 Vector3] 中取x,y,z,并调用setFromCartesianCoords来设置圆柱坐标的 [page:.radius radius]、[page:.theta theta] 和 [page:.y y] 的属性值。

-

[method:Cylindrical setFromCartesianCoords]( [param:Float x], [param:Float y], [param:Float z] )

+

[method:this setFromCartesianCoords]( [param:Float x], [param:Float y], [param:Float z] )

使用笛卡尔坐标来设置该圆柱坐标中 [page:.radius radius], [page:.theta theta] 以及 [page:.y y] 的属性值。 diff --git a/docs/api/zh/math/Euler.html b/docs/api/zh/math/Euler.html index e3a4cb4b40ca72..e220f774f39727 100644 --- a/docs/api/zh/math/Euler.html +++ b/docs/api/zh/math/Euler.html @@ -65,7 +65,7 @@

[property:Float z]

方法（Methods）

-

[method:Euler copy]( [param:Euler euler] )

+

[method:this copy]( [param:Euler euler] )

将 [page:Euler euler] 的属性拷贝到当前对象。

[method:Euler clone]()

@@ -74,7 +74,7 @@

[method:Euler clone]()

[method:Boolean equals]( [param:Euler euler] )

检查 [page:Euler euler] 是否与当前对象相同。

-

[method:Euler fromArray]( [param:Array array] )

+

[method:this fromArray]( [param:Array array] )

长度为3或4的一个 [page:Array array] 。array[3] 是一个可选的 [page:.order order] 参数。

@@ -84,14 +84,14 @@

[method:Euler fromArray]( [param:Array array] )

将array[3]设置给欧拉角的 [page:.order order] 。可选。

-

[method:Euler reorder]( [param:String newOrder] )

+

[method:this reorder]( [param:String newOrder] )

通过这个欧拉角创建一个四元数，然后用这个四元数和新顺序设置这个欧拉角。

警告: 这将弃用旋转信息。

-

[method:Euler set]( [param:Float x], [param:Float y], [param:Float z], [param:String order] )

+

[method:this set]( [param:Float x], [param:Float y], [param:Float z], [param:String order] )

[page:.x x] - 用弧度表示x轴旋转量。
[page:.y y] - 用弧度表示y轴旋转量。
@@ -101,7 +101,7 @@

[method:Euler set]( [param:Float x], [param:Float y], [param:Float z], [para 设置该欧拉变换的角度和旋转顺序 [page:.order order]。

-

[method:Euler setFromRotationMatrix]( [param:Matrix4 m], [param:String order])

+

[method:this setFromRotationMatrix]( [param:Matrix4 m], [param:String order])

[page:Matrix4 m] - [page:Matrix4] 矩阵上面的3x3部分是一个纯旋转矩阵[link:https://en.wikipedia.org/wiki/Rotation_matrix rotation matrix] （也就是不发生缩放）
@@ -110,7 +110,7 @@

[method:Euler setFromRotationMatrix]( [param:Matrix4 m], [param:String order 使用基于 [page:.order order] 顺序的纯旋转矩阵来设置当前欧拉角。

-

[method:Euler setFromQuaternion]( [param:Quaternion q], [param:String order] )

+

[method:this setFromQuaternion]( [param:Quaternion q], [param:String order] )

[page:Quaternion q] - 归一化的四元数。
[page:.order order] - (可选参数) 表示旋转顺序的字符串。
@@ -119,7 +119,7 @@

[method:Euler setFromQuaternion]( [param:Quaternion q], [param:String order]

-

[method:Euler setFromVector3]( [param:Vector3 vector], [param:String order] )

+

[method:this setFromVector3]( [param:Vector3 vector], [param:String order] )

[page:Vector3 vector] - [page:Vector3].
[page:.order order] - (可选参数) 表示旋转顺序的字符串。

diff --git a/docs/api/zh/math/Frustum.html b/docs/api/zh/math/Frustum.html index 7ddcf4d843e312..e29c20a70515a7 100644 --- a/docs/api/zh/math/Frustum.html +++ b/docs/api/zh/math/Frustum.html @@ -52,7 +52,7 @@

[method:Boolean containsPoint]( [param:Vector3 point] )

检测该点 [page:Vector3 point] 是否在视锥体内。

-

[method:Frustum copy]( [param:Frustum frustum] )

+

[method:this copy]( [param:Frustum frustum] )

[page:Frustum frustum] - 用于拷贝的视锥体。

diff --git a/docs/api/zh/math/Line3.html b/docs/api/zh/math/Line3.html index 1bdd77c7499e53..30c30da7f89578 100644 --- a/docs/api/zh/math/Line3.html +++ b/docs/api/zh/math/Line3.html @@ -38,14 +38,14 @@

[property:Vector3 end]

方法（Methods）

-

[method:Line3 applyMatrix4]( [param:Matrix4 matrix] )

+

[method:this applyMatrix4]( [param:Matrix4 matrix] )

对此线段应用矩阵变换。

[method:Vector3 at]( [param:Float t], [param:Vector3 target] )

[page:Float t] - 使用值0-1返回沿线段的位置。
[page:Vector3 target] — 计算结果会被拷贝到target。

- + 返回一个线段某一位置的向量，当 [page:Float t] = 0的时候返回起始点，当[page:Float t] = 1的时候返回终点。

@@ -69,7 +69,7 @@

[method:Float closestPointToPointParameter]( [param:Vector3 point], [param:B 返回一个基于点投影到线段上的点的参数。如果 [page:Boolean clampToLine] 为true则返回值将在0到1之间。

-

[method:Line3 copy]( [param:Line3 line] )

+

[method:this copy]( [param:Line3 line] )

拷贝传入线段的起始点 [page:.start start] 和终点 [page:.end end] 向量到当前线段。

[method:Vector3 delta]( [param:Vector3 target] )

@@ -101,7 +101,7 @@

[method:Vector3 getCenter]( [param:Vector3 target] )

返回线段的中心点。

-

[method:Line3 set]( [param:Vector3 start], [param:Vector3 end] )

+

[method:this set]( [param:Vector3 start], [param:Vector3 end] )

[page:Vector3 start] - 设置线段的起点 [page:.start start point]。
[page:Vector3 end] - 设置线段的终点 [page:.end end point]。

diff --git a/docs/api/zh/math/Plane.html b/docs/api/zh/math/Plane.html index 48dfacdfec3bef..fc53f8fe10598b 100644 --- a/docs/api/zh/math/Plane.html +++ b/docs/api/zh/math/Plane.html @@ -32,7 +32,7 @@

[property:Float constant]

方法（Methods）

-

[method:Plane applyMatrix4]( [param:Matrix4 matrix], [param:Matrix3 optionalNormalMatrix] )

+

[method:this applyMatrix4]( [param:Matrix4 matrix], [param:Matrix3 optionalNormalMatrix] )

[page:Matrix4 matrix] - 要应用的四位矩阵（[Page:Matrix4]）。
[page:Matrix3 optionalNormalMatrix] - (可选参数) 预先计算好的上述Matrix4参数的法线矩阵 [Page:Matrix3]。

@@ -54,7 +54,7 @@

[method:Vector3 coplanarPoint]( [param:Vector3 target] )

返回一个共面点，通过原点的法向量在平面上投影算得。

-

[method:Plane copy]( [param:Plane plane] )

+

[method:this copy]( [param:Plane plane] )

拷贝给定平面，将其中的法线 [page:.normal normal]，距离常量 [page:.constant constant]属性拷贝给该对象。

@@ -99,12 +99,12 @@

[method:Boolean intersectsSphere]( [param:Sphere sphere] )

确定该平面是否与给定球体 [page:Sphere] 相交。

-

[method:Plane negate]()

+

[method:this negate]()

将法向量与常量求反（乘以-1）。

-

[method:Plane normalize]()

+

[method:this normalize]()

归一化法向量 [page:.normal normal] ，并相应的调整常量 [page:.constant constant]数值。

@@ -117,7 +117,7 @@

[method:Vector3 projectPoint]( [param:Vector3 point], [param:Vector3 target] 将一个点[page:Vector3 point]投射到该平面上。

-

[method:Plane set]( [param:Vector3 normal], [param:Float constant] )

+

[method:this set]( [param:Vector3 normal], [param:Float constant] )

[page:Vector3 normal] - 单位长度的向量表示平面的法向量。
[page:Float constant] - 原点到平面有符号距离。默认值为 *0*。

@@ -125,7 +125,7 @@

[method:Plane set]( [param:Vector3 normal], [param:Float constant] )

设置平面 [page:.normal normal] 的法线和常量 [page:.constant constant] 属性值。

-

[method:Plane setComponents]( [param:Float x], [param:Float y], [param:Float z], [param:Float w] )

+

[method:this setComponents]( [param:Float x], [param:Float y], [param:Float z], [param:Float w] )

[page:Float x] - 单位长度法向量的x值。
[page:Float y] - 单位长度法向量的y值。
@@ -135,7 +135,7 @@

[method:Plane setComponents]( [param:Float x], [param:Float y], [param:Float 设置定义平面的各个变量。

-

[method:Plane setFromCoplanarPoints]( [param:Vector3 a], [param:Vector3 b], [param:Vector3 c] )

+

[method:this setFromCoplanarPoints]( [param:Vector3 a], [param:Vector3 b], [param:Vector3 c] )

[page:Vector3 a] - 用于确定平面的第一个点。
[page:Vector3 b] - 用于确定平面的第二个点。
@@ -144,7 +144,7 @@

[method:Plane setFromCoplanarPoints]( [param:Vector3 a], [param:Vector3 b], 根据给定的三个点确定平面。如果三个点共线将会抛出错误。通过右手螺旋规则确定（向量叉乘）法向量 [page:.normal normal]。

-

[method:Plane setFromNormalAndCoplanarPoint]( [param:Vector3 normal], [param:Vector3 point] )

+

[method:this setFromNormalAndCoplanarPoint]( [param:Vector3 normal], [param:Vector3 point] )

[page:Vector3 normal] - 平面单位法向量
[page:Vector3 point] - 平面上的点

@@ -152,7 +152,7 @@

[method:Plane setFromNormalAndCoplanarPoint]( [param:Vector3 normal], [param 通过参数提供的法线 normal 和 平面上的一个点 point 来设置该平面。

-

[method:Plane translate]( [param:Vector3 offset] )

+

[method:this translate]( [param:Vector3 offset] )

[page:Vector3 offset] - 平移量

diff --git a/docs/api/zh/math/Quaternion.html b/docs/api/zh/math/Quaternion.html index d690f2ce249c5a..2786d30c01a23a 100644 --- a/docs/api/zh/math/Quaternion.html +++ b/docs/api/zh/math/Quaternion.html @@ -61,13 +61,13 @@

[method:Quaternion clone]()

属性的四元数。

-

[method:Quaternion conjugate]()

+

[method:this conjugate]()

返回该四元数的旋转共轭。 四元数的共轭表示的是，围绕旋转轴在相反方向上的相同旋转。

-

[method:Quaternion copy]( [param:Quaternion q] )

+

[method:this copy]( [param:Quaternion q] )

复制四元数 [page:Quaternion q] 的 [page:.x x]、[page:.y y]、[page:.z z] 和 [page:.w w] 属性到该四元数中。 @@ -86,7 +86,7 @@

[method:Float dot]( [param:Quaternion v] )

计算四元数 [page:Quaternion v] 与当前四元数的[link:https://en.wikipedia.org/wiki/Dot_product dot product]（点积）。

-

[method:Quaternion fromArray]( [param:Array array], [param:Integer offset] )

+

[method:this fromArray]( [param:Array array], [param:Integer offset] )

[page:Array array] - 用于构造四元数的形如(x, y, z, w)的数组。
[page:Integer offset] - （可选）数组的偏移量。（译者注：使用数组中从第offset元素算起的四个元素）

@@ -94,12 +94,12 @@

[method:Quaternion fromArray]( [param:Array array], [param:Integer offset] ) 从一个数组来设置四元数的 [page:.x x]、 [page:.y y]、[page:.z z] 和 [page:.w w] 的属性。

-

[method:Quaternion identity]()

+

[method:this identity]()

设置该四元数为 identity 四元数，即表示“不旋转”的四元数。

-

[method:Quaternion invert]()

+

[method:this invert]()

翻转该四元数 —— 计算 [page:.conjugate conjugate] 。假定该四元数具有单位长度。

@@ -116,25 +116,25 @@

[method:Float lengthSq]()

因为这比 [page:.length length]() 的效率稍高一些。

-

[method:Quaternion normalize]()

+

[method:this normalize]()

[link:https://en.wikipedia.org/wiki/Normalized_vector Normalizes]（归一化）四元数 —— 即计算与该四元数具有相同旋转、但长度为*1*的四元数。

-

[method:Quaternion multiply]( [param:Quaternion q] )

+

[method:this multiply]( [param:Quaternion q] )

将该四元数与[page:Quaternion q]相乘。

-

[method:Quaternion multiplyQuaternions]( [param:Quaternion a], [param:Quaternion b] )

+

[method:this multiplyQuaternions]( [param:Quaternion a], [param:Quaternion b] )

将该四元数设为 [page:Quaternion a] x [page:Quaternion b] 。
改编自 [link:http://www.euclideanspace.com/maths/algebra/realNormedAlgebra/quaternions/code/index.htm here] 所概述的方法。

-

[method:Quaternion premultiply]( [param:Quaternion q] )

+

[method:this premultiply]( [param:Quaternion q] )

使用 [page:Quaternion q] 乘以该四元数。

-

[method:Quaternion rotateTowards]( [param:Quaternion q], [param:Float step] )

+

[method:this rotateTowards]( [param:Quaternion q], [param:Float step] )

[page:Quaternion q] - 目标四元数
[page:Float step] - 以弧度为单位的角度步长

@@ -142,7 +142,7 @@

[method:Quaternion rotateTowards]( [param:Quaternion q], [param:Float step] 将该四元数按照步长 step 向目标 *q* 进行旋转。该方法确保最终的四元数不会超过 *q*。

-

[method:Quaternion slerp]( [param:Quaternion qb], [param:Float t] )

+

[method:this slerp]( [param:Quaternion qb], [param:Float t] )

[page:Quaternion qb] - 另一个四元数旋转
[page:Float t] - 闭区间 [0, 1] 中的插值因子

@@ -159,26 +159,26 @@

[method:Quaternion slerp]( [param:Quaternion qb], [param:Float t] )

[method:this slerpQuaternions]( [param:Quaternion qa], [param:Quaternion qb], [param:Float t] )

在给定的四元数之间执行球面线性插值，并将结果存储在这个四元数中

-

[method:Quaternion set]( [param:Float x], [param:Float y], [param:Float z], [param:Float w] )

+

[method:this set]( [param:Float x], [param:Float y], [param:Float z], [param:Float w] )

设置该四元数的 [page:.x x]、[page:.y y]、[page:.z z]和[page:.w w]属性。

-

[method:Quaternion setFromAxisAngle]( [param:Vector3 axis], [param:Float angle] )

+

[method:this setFromAxisAngle]( [param:Vector3 axis], [param:Float angle] )

从由 [page:Vector3 axis]（轴） 和 [page:Float angle]（角度）所给定的旋转来设置该四元数。
改编自 [link:http://www.euclideanspace.com/maths/geometry/rotations/conversions/angleToQuaternion/index.htm here] 所述的方法。
假定*Axis*已被归一化，*angle*以弧度来表示。

-

[method:Quaternion setFromEuler]( [param:Euler euler] )

+

[method:this setFromEuler]( [param:Euler euler] )

从由 [page:Euler] 角所给定的旋转来设置该四元数。

-

[method:Quaternion setFromRotationMatrix]( [param:Matrix4 m] )

+

[method:this setFromRotationMatrix]( [param:Matrix4 m] )

从[page:Matrix4 m]的旋转分量中来设置该四元数。
改编自 [link:http://www.euclideanspace.com/maths/geometry/rotations/conversions/matrixToQuaternion/index.htm here] 所概述的方法。

-

[method:Quaternion setFromUnitVectors]( [param:Vector3 vFrom], [param:Vector3 vTo] )

+

[method:this setFromUnitVectors]( [param:Vector3 vFrom], [param:Vector3 vTo] )

将该四元数设置为从方向向量 [page:Vector3 vFrom] 旋转到方向向量 [page:Vector3 vTo] 所需的旋转。
改编自方法 [link:http://lolengine.net/blog/2013/09/18/beautiful-maths-quaternion-from-vectors here]。
diff --git a/docs/api/zh/math/Ray.html b/docs/api/zh/math/Ray.html index c821793b695a4a..771bead91b3793 100644 --- a/docs/api/zh/math/Ray.html +++ b/docs/api/zh/math/Ray.html @@ -44,7 +44,7 @@

[property:Vector3 direction]

方法

-

[method:Ray applyMatrix4]( [param:Matrix4 matrix4] )

+

[method:this applyMatrix4]( [param:Matrix4 matrix4] )

[page:Matrix4 matrix4] - 将被用于这个[page:Ray]的[page:Matrix4]。

@@ -72,7 +72,7 @@

[method:Vector3 closestPointToPoint]( [param:Vector3 point], [param:Vector3 沿着[page:Ray]，获得与所传入[page:Vector3]最接近的点。

-

[method:Ray copy]( [param:Ray ray] )

+

[method:this copy]( [param:Ray ray] )

复制所传入Ray的[page:.origin origin]和[page:.direction direction]属性到这个Ray上。

@@ -171,21 +171,21 @@

[method:Boolean intersectsSphere]( [param:Sphere sphere] )

若这一射线与[page:Sphere]相交，则将返回true。

-

[method:Ray lookAt]( [param:Vector3 v] )

+

[method:this lookAt]( [param:Vector3 v] )

[page:Vector3 v] - 将要“直视”的[page:Vector3]

调整光线的方向到世界坐标中该向量所指代的点。

-

[method:Ray recast]( [param:Float t] )

+

[method:this recast]( [param:Float t] )

[page:Float t] - 沿着[page:Ray]进行插值的距离。

将[page:Ray]（射线）的原点沿着其方向移动给定的距离。

-

[method:Ray set]( [param:Vector3 origin], [param:Vector3 direction] )

+

[method:this set]( [param:Vector3 origin], [param:Vector3 direction] )

[page:Vector3 origin] - [page:Ray]（射线）的[page:.origin origin]（原点）。
[page:Vector3 origin] - [page:Ray]（射线）的[page:.direction direction]（方向）。 diff --git a/docs/api/zh/math/Sphere.html b/docs/api/zh/math/Sphere.html index c920b84c46e96f..36934895b0af49 100644 --- a/docs/api/zh/math/Sphere.html +++ b/docs/api/zh/math/Sphere.html @@ -33,7 +33,7 @@

[property:Float radius]

方法

-

[method:Sphere applyMatrix4]( [param:Matrix4 matrix] )

+

[method:this applyMatrix4]( [param:Matrix4 matrix] )

[page:Matrix4 matrix] - 将被应用的[Page:Matrix4]矩阵。

@@ -58,7 +58,7 @@

[method:Boolean containsPoint]( [param:Vector3 point] )

检查球体中是否包含所传入的[page:Vector3 point]点，包括球的表面。

-

[method:Sphere copy]( [param:Sphere sphere] )

+

[method:this copy]( [param:Sphere sphere] )

复制所传入的球的[page:.center center]和[page:.radius radius]到这个球上。

@@ -81,7 +81,7 @@

[method:Boolean isEmpty]()

检查球是否为空(球半径为负值)。半径为 0 的球体仅包含其中心点，并不会被视为空。

-

[method:Sphere makeEmpty]()

+

[method:this makeEmpty]()

将该球修改为空，即中心点 [page:.center center] 为 (0,0,0)，半径 [page:.radius radius] 为 -1。

[method:Boolean equals]( [param:Sphere sphere] )

@@ -117,7 +117,7 @@

[method:Boolean intersectsSphere]( [param:Sphere sphere] )

检测两球之间是否有交集。

-

[method:Sphere set]( [param:Vector3 center], [param:Float radius] )

+

[method:this set]( [param:Vector3 center], [param:Float radius] )

[page:Vector3 center] - 球心位置。
[page:Float radius] - 球的半径。

@@ -126,7 +126,7 @@

[method:Sphere set]( [param:Vector3 center], [param:Float radius] )

请注意此，方法使用复制的方式来设置中心值。

-

[method:Sphere setFromPoints]( [param:Array points], [param:Vector3 optionalCenter] )

+

[method:this setFromPoints]( [param:Array points], [param:Vector3 optionalCenter] )

[page:Array points] - 一个包含有[page:Vector3]位置的[page:Array]。
[page:Vector3 optionalCenter] - 可选， [page:Vector3] 球心位置。

@@ -135,7 +135,7 @@

[method:Sphere setFromPoints]( [param:Array points], [param:Vector3 optional 否则，环绕[page:Array points]的包围盒的轴心将通过计算来得到。

-

[method:Sphere translate]( [param:Vector3 offset] )

+

[method:this translate]( [param:Vector3 offset] )

使用所给定[page:Vector3] offset（偏移量）平移球心。

diff --git a/docs/api/zh/math/Spherical.html b/docs/api/zh/math/Spherical.html index c7d5989b69af7c..945c288df61dd5 100644 --- a/docs/api/zh/math/Spherical.html +++ b/docs/api/zh/math/Spherical.html @@ -43,26 +43,26 @@

[method:Spherical clone]()

[page:.radius radius]、[page:.phi phi]和[page:.theta theta]。

-

[method:Spherical copy]( [param:Spherical s] )

+

[method:this copy]( [param:Spherical s] )

复制所传入的球坐标的[page:.radius radius]、 [page:.phi phi] 和[page:.theta theta]属性到该球坐标中。

-

[method:Spherical makeSafe]()

+

[method:this makeSafe]()

将极角 [page:.phi phi] 的值限制在0.000001 和 π - 0.000001 之间。

-

[method:Spherical set]( [param:Float radius], [param:Float phi], [param:Float theta] )

+

[method:this set]( [param:Float radius], [param:Float phi], [param:Float theta] )

设置球坐标中[page:.radius radius]、[page:.phi phi] 和 [page:.theta theta] 属性的值。

-

[method:Spherical setFromVector3]( [param:Vector3 vec3] )

+

[method:this setFromVector3]( [param:Vector3 vec3] )

从[page:Vector3 Vector3]中设置球坐标的[page:.radius radius]、[page:.phi phi]和[page:.theta theta]值。

-

[method:Spherical setFromCartesianCoords]( [param:Float x], [param:Float y], [param:Float z] )

+

[method:this setFromCartesianCoords]( [param:Float x], [param:Float y], [param:Float z] )

从笛卡尔坐标系中设置球坐标的[page:.radius radius]、[page:.phi phi]和[page:.theta theta]值。

diff --git a/docs/api/zh/math/Triangle.html b/docs/api/zh/math/Triangle.html index 585691122a4d2a..e6f7106e4efc56 100644 --- a/docs/api/zh/math/Triangle.html +++ b/docs/api/zh/math/Triangle.html @@ -66,7 +66,7 @@

[method:Boolean containsPoint]( [param:Vector3 point] )

如果传入的点投影到三角形的平面内，则返回true。

-

[method:Triangle copy]( [param:Triangle triangle] )

+

[method:this copy]( [param:Triangle triangle] )

将传入的三角形的[page:.a a]、[page:.b b]和[page:.c c]属性复制给这一三角形。

@@ -117,13 +117,13 @@

[method:Boolean intersectsBox]( [param:Box3 box] )

判定三角形与传入的[page:Box3 box]是否相交。

-

[method:Triangle set]( [param:Vector3 a], [param:Vector3 b], [param:Vector3 c] ) [param:Triangle this]

+

[method:this set]( [param:Vector3 a], [param:Vector3 b], [param:Vector3 c] ) [param:Triangle this]

将三角形的[page:.a a]、[page:.b b]和[page:.c c]属性设置为所传入的[page:Vector3 vector3]。
请注意，此方法仅复制给定对象的值。

-

[method:Triangle setFromAttributeAndIndices]( [param:BufferAttribute attribute], [param:Integer i0], [param:Integer i1], [param:Integer i2] ) [param:Triangle this]

+

[method:this setFromAttributeAndIndices]( [param:BufferAttribute attribute], [param:Integer i0], [param:Integer i1], [param:Integer i2] ) [param:Triangle this]

attribute - [page:BufferAttribute] of vertex data
i0 - [page:Integer] index
@@ -134,7 +134,7 @@

[method:Triangle setFromAttributeAndIndices]( [param:BufferAttribute attribu

-

[method:Triangle setFromPointsAndIndices]( [param:Array points], [param:Integer i0], [param:Integer i1], [param:Integer i2] ) [param:Triangle this]

+

[method:this setFromPointsAndIndices]( [param:Array points], [param:Integer i0], [param:Integer i1], [param:Integer i2] ) [param:Triangle this]

points - [page:Vector3]数组（[page:Array]）
i0 - 整数（[page:Integer]）索引
diff --git a/docs/api/zh/objects/Line.html b/docs/api/zh/objects/Line.html index b86f9142fabb2d..cda6c7ac56c13c 100644 --- a/docs/api/zh/objects/Line.html +++ b/docs/api/zh/objects/Line.html @@ -71,7 +71,7 @@

[property:Object morphTargetDictionary]

方法

共有方法请参见其基类 [page:Object3D]。

-

[method:Line computeLineDistances]()

+

[method:this computeLineDistances]()

计算[page:LineDashedMaterial]所需的距离的值的数组。 对于几何体中的每一个顶点，这个方法计算出了当前点到线的起始点的累积长度。 diff --git a/docs/api/zh/objects/Sprite.html b/docs/api/zh/objects/Sprite.html index 145b8fe82e25b9..d834266b428af1 100644 --- a/docs/api/zh/objects/Sprite.html +++ b/docs/api/zh/objects/Sprite.html @@ -61,7 +61,7 @@

[method:Sprite clone]()

返回当前Sprite对象的一个克隆及其任何后代。

-

[method:Sprite copy]( [param:Sprite sprite] )

+

[method:this copy]( [param:Sprite sprite] )

将前一个Sprite对象的属性复制给当前的这个对象。

diff --git a/docs/api/zh/renderers/WebGLCubeRenderTarget.html b/docs/api/zh/renderers/WebGLCubeRenderTarget.html index a4d7c2138e7a10..bf5c101f6f0d5d 100644 --- a/docs/api/zh/renderers/WebGLCubeRenderTarget.html +++ b/docs/api/zh/renderers/WebGLCubeRenderTarget.html @@ -53,7 +53,7 @@

方法

继承方法，请参阅[page:WebGLRenderTarget]

-

[method:WebGLCubeRenderTarget fromEquirectangularTexture]( [param:WebGLRenderer renderer], [param:Texture texture] )

+

[method:this fromEquirectangularTexture]( [param:WebGLRenderer renderer], [param:Texture texture] )

[page:WebGLRenderer renderer] — 渲染器。
[page:Texture texture] — equirectangular 纹理。 diff --git a/docs/api/zh/renderers/WebGLRenderTarget.html b/docs/api/zh/renderers/WebGLRenderTarget.html index 36ba4025a51047..072a5efe405acb 100644 --- a/docs/api/zh/renderers/WebGLRenderTarget.html +++ b/docs/api/zh/renderers/WebGLRenderTarget.html @@ -102,7 +102,7 @@

[method:WebGLRenderTarget clone]()

创建一个渲染目标副本

-

[method:WebGLRenderTarget copy]( [param:WebGLRenderTarget source] )

+

[method:this copy]( [param:WebGLRenderTarget source] )

采用传入的渲染目标的设置

diff --git a/docs/api/zh/scenes/Fog.html b/docs/api/zh/scenes/Fog.html index 151d4ba03e11a5..d0bd01ee3fdb0a 100644 --- a/docs/api/zh/scenes/Fog.html +++ b/docs/api/zh/scenes/Fog.html @@ -40,7 +40,7 @@

方法

[method:Fog clone]()

返回一个具有和当前雾参数相同的新的Fog实例。

-

[method:Fog toJSON]()

+

[method:Object toJSON]()

以JSON格式返回Fog的数据。

源代码

diff --git a/docs/api/zh/scenes/FogExp2.html b/docs/api/zh/scenes/FogExp2.html index a653ca1a9eb574..91c5310175adbd 100644 --- a/docs/api/zh/scenes/FogExp2.html +++ b/docs/api/zh/scenes/FogExp2.html @@ -34,7 +34,7 @@

方法

[method:FogExp2 clone]()

返回一个具有和当前雾参数相同的新的FogExp2实例。

-

[method:FogExp2 toJSON]()

+

[method:Object toJSON]()

以JSON格式返回FogExp2的数据。

源代码

diff --git a/docs/api/zh/scenes/Scene.html b/docs/api/zh/scenes/Scene.html index 7daa9d4979689e..92c47176fbb068 100644 --- a/docs/api/zh/scenes/Scene.html +++ b/docs/api/zh/scenes/Scene.html @@ -55,7 +55,7 @@

[property:Material overrideMaterial]

方法

-

[method:JSON toJSON]

+

[method:Object toJSON]

meta -- 包含有元数据的对象，例如场景中的的纹理或图片。 将scene对象转换为 three.js [link:https://github.com/mrdoob/three.js/wiki/JSON-Object-Scene-format-4 JSON Object/Scene format]（three.js JSON 物体/场景格式）。 diff --git a/docs/api/zh/textures/CompressedTexture.html b/docs/api/zh/textures/CompressedTexture.html index 233896c9856c5b..535a250bb2c25f 100644 --- a/docs/api/zh/textures/CompressedTexture.html +++ b/docs/api/zh/textures/CompressedTexture.html @@ -78,7 +78,9 @@

[property:Boolean generateMipmaps]

方法

- +

+ 共有方法请参见其基类[page:Texture Texture]。 +

源代码

diff --git a/docs/examples/en/animations/CCDIKSolver.html b/docs/examples/en/animations/CCDIKSolver.html index 4db38561a89f78..f1c0b46a0930a0 100644 --- a/docs/examples/en/animations/CCDIKSolver.html +++ b/docs/examples/en/animations/CCDIKSolver.html @@ -90,12 +90,12 @@

[method:CCDIKHelper createHelper]()

Return [page:CCDIKHelper]. You can visualize IK bones by adding the helper to scene.

-

[method:CCDIKSolver update]()

+

[method:this update]()

Update IK bones quaternion by solving CCD algorithm.

-

[method:CCDIKSolver updateOne]( [param:Object ikParam] )

+

[method:this updateOne]( [param:Object ikParam] )

Update an IK bone quaternion by solving CCD algorithm.

diff --git a/docs/examples/en/animations/MMDPhysics.html b/docs/examples/en/animations/MMDPhysics.html index 92619524cac71b..1c38598d8111cb 100644 --- a/docs/examples/en/animations/MMDPhysics.html +++ b/docs/examples/en/animations/MMDPhysics.html @@ -76,12 +76,12 @@

[method:MMDPhysicsHelper createHelper]()

Return [page:MMDPhysicsHelper]. You can visualize Rigid bodies by adding the helper to scene.

-

[method:CCDIKSolver reset]()

+

[method:this reset]()

Resets Rigid bodies transform to current bone's.

-

[method:CCDIKSolver setGravity]( [param:Vector3 gravity] )

+

[method:this setGravity]( [param:Vector3 gravity] )

[page:Vector3 gravity] — Direction and volume of gravity.

@@ -89,7 +89,7 @@

[method:CCDIKSolver setGravity]( [param:Vector3 gravity] )

Set gravity.

-

[method:CCDIKSolver update]( [param:Number delta] )

+

[method:this update]( [param:Number delta] )

[page:Number delta] — Time in second.

@@ -97,7 +97,7 @@

[method:CCDIKSolver update]( [param:Number delta] )

Advance Physics calculation and updates bones.

-

[method:CCDIKSolver warmup]( [param:Integer cycles] )

+

[method:this warmup]( [param:Integer cycles] )

[page:Number delta] — Time in second.

diff --git a/docs/examples/en/loaders/MMDLoader.html b/docs/examples/en/loaders/MMDLoader.html index 67fe37d70a2aa6..ef62fd51073df7 100644 --- a/docs/examples/en/loaders/MMDLoader.html +++ b/docs/examples/en/loaders/MMDLoader.html @@ -106,7 +106,7 @@

[method:undefined loadWithAnimation]( [param:String modelUrl], [param:String Begin loading PMD/PMX model file and VMD motion file(s) from urls and fire the callback function with an [page:Object] containing parsed [page:SkinnedMesh] and [page:AnimationClip] fitting to the [page:SkinnedMesh].

-

[method:MMDLoader setAnimationPath]( [param:String animationPath] )

+

[method:this setAnimationPath]( [param:String animationPath] )

[page:String animationPath] — Base path for loading animation data (VMD/VPD files).

diff --git a/docs/examples/en/loaders/MTLLoader.html b/docs/examples/en/loaders/MTLLoader.html index 4e4e4b4f809e40..1528ea0378a3fd 100644 --- a/docs/examples/en/loaders/MTLLoader.html +++ b/docs/examples/en/loaders/MTLLoader.html @@ -43,7 +43,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param Begin loading from url and return the loaded material.

-

[method:MTLLoader setMaterialOptions]( [param:Object options] )

+

[method:this setMaterialOptions]( [param:Object options] )

[page:Object options] — required

-

[method:ConvexHull cleanup]()

+

[method:this cleanup]()

Cleans up internal properties after computing the convex hull.

-

[method:ConvexHull compute]()

+

[method:this compute]()

Starts the execution of the quick hull algorithm.

@@ -106,7 +106,7 @@

[method:Object computeExtremes]()

Computes the extremes values (min/max vectors) which will be used to compute the initial hull.

-

[method:ConvexHull computeHorizon]( [param:Vector3 eyePoint], [param:HalfEdge crossEdge], [param:Face face], [param:Array horizon] )

+

[method:this computeHorizon]( [param:Vector3 eyePoint], [param:HalfEdge crossEdge], [param:Face face], [param:Array horizon] )

[page:Vector3 eyePoint] - The 3D-coordinates of a point.
[page:HalfEdge crossEdge] - The edge used to jump to the current face.
@@ -116,18 +116,18 @@

[method:ConvexHull computeHorizon]( [param:Vector3 eyePoint], [param:HalfEdg Computes a chain of half edges in CCW order called the 'horizon'. For an edge to be part of the horizon it must join a face that can see 'eyePoint' and a face that cannot see 'eyePoint'.

-

[method:ConvexHull computeInitialHull]()

+

[method:this computeInitialHull]()

Computes the initial simplex assigning to its faces all the points that are candidates to form part of the hull.

-

[method:ConvexHull containsPoint]( [param:Vector3 point] )

+

[method:this containsPoint]( [param:Vector3 point] )

[page:Vector3 point] - A point in 3D space.

Returns *true* if the given point is inside this convex hull.

-

[method:ConvexHull deleteFaceVertices]( [param:Face face], [param:Face absorbingFace] )

+

[method:this deleteFaceVertices]( [param:Face face], [param:Face absorbingFace] )

[page:Face face] - The given face.
[page:Face absorbingFace] - An optional face that tries to absorb the vertices of the first face.

@@ -155,7 +155,7 @@

[method:Boolean intersectsRay]( [param:Ray ray] )

Returns *true* if the given ray intersects with this convex hull.

-

[method:ConvexHull makeEmpty]()

+

[method:this makeEmpty]()

Makes this convex hull empty.

@@ -169,7 +169,7 @@

[method:VertexNode nextVertexToAdd]()

-

[method:ConvexHull reindexFaces]()

+

[method:this reindexFaces]()

Removes inactive (e.g. deleted) faces from the internal face list.

@@ -180,7 +180,7 @@

[method:VertexNode removeAllVerticesFromFace]( [param:Face face] )

Removes all the visible vertices that a given face is able to see which are stored in the 'assigned' vertext list.

-

[method:ConvexHull removeVertexFromFace]( [param:VertexNode vertex], [param:Face face] )

+

[method:this removeVertexFromFace]( [param:VertexNode vertex], [param:Face face] )

[page:VertexNode vertex] - The vertex to remove.
[page:Face face] - The target face.

@@ -188,21 +188,21 @@

[method:ConvexHull removeVertexFromFace]( [param:VertexNode vertex], [param: Removes a vertex from the 'assigned' list of vertices and from the given face. It also makes sure that the link from 'face' to the first vertex it sees in 'assigned' is linked correctly after the removal.

-

[method:ConvexHull resolveUnassignedPoints]( [param:Array newFaces] )

+

[method:this resolveUnassignedPoints]( [param:Array newFaces] )

[page:Face newFaces] - An array of new faces.

Reassigns as many vertices as possible from the unassigned list to the new faces.

-

[method:ConvexHull setFromObject]( [param:Object3D object] )

+

[method:this setFromObject]( [param:Object3D object] )

[page:Object3D object] - [page:Object3D] to compute the convex hull of.

Computes the convex hull of an [page:Object3D] (including its children),accounting for the world transforms of both the object and its childrens.

-

[method:ConvexHull setFromPoints]( [param:Array points] )

+

[method:this setFromPoints]( [param:Array points] )

[page:Array points] - Array of [page:Vector3 Vector3s] that the resulting convex hull will contain.

diff --git a/docs/examples/en/math/convexhull/Face.html b/docs/examples/en/math/convexhull/Face.html index aebb773e5e687b..3d95701b837f13 100644 --- a/docs/examples/en/math/convexhull/Face.html +++ b/docs/examples/en/math/convexhull/Face.html @@ -77,7 +77,7 @@

[method:HalfEdge getEdge]( [param:Integer i] )

Returns an edge by the given index.

-

[method:Face compute] ()

+

[method:this compute] ()

Computes all properties of the face.

diff --git a/docs/examples/en/math/convexhull/HalfEdge.html b/docs/examples/en/math/convexhull/HalfEdge.html index 52ac3dbcd3f8fc..a6e51dc75e1da1 100644 --- a/docs/examples/en/math/convexhull/HalfEdge.html +++ b/docs/examples/en/math/convexhull/HalfEdge.html @@ -68,7 +68,7 @@

[method:Float lengthSquared]()

Returns the square of the [link:https://en.wikipedia.org/wiki/Euclidean_distance Euclidean length] (straight-line length) of the edge.

-

[method:HalfEdge setTwin]( [param:HalfEdge edge] )

+

[method:this setTwin]( [param:HalfEdge edge] )

[page:HalfEdge edge] - Any half-edge.

diff --git a/docs/examples/en/math/convexhull/VertexList.html b/docs/examples/en/math/convexhull/VertexList.html index 09b9b0e07abad7..375fd28b901736 100644 --- a/docs/examples/en/math/convexhull/VertexList.html +++ b/docs/examples/en/math/convexhull/VertexList.html @@ -42,10 +42,10 @@

[method:VertexNode first]()

[method:VertexNode last]()

Returns the tail reference.

-

[method:VertexList clear]()

+

[[method:this clear]()

Clears the linked list.

-

[method:VertexList insertBefore]( [param:Vertex target], [param:Vertex vertex] )

+

[[method:this insertBefore]( [param:Vertex target], [param:Vertex vertex] )

[page:Vertex target] - The target vertex. It's assumed that this vertex belongs to the linked list.
[page:Vertex vertex] - The vertex to insert.

@@ -53,7 +53,7 @@

[method:VertexList insertBefore]( [param:Vertex target], [param:Vertex verte Inserts a vertex before a target vertex.

-

[method:VertexList insertAfter]( [param:Vertex target], [param:Vertex vertex] )

+

[[method:this insertAfter]( [param:Vertex target], [param:Vertex vertex] )

[page:Vertex target] - The target vertex. It's assumed that this vertex belongs to the linked list.
[page:Vertex vertex] - The vertex to insert.

@@ -61,28 +61,28 @@

[method:VertexList insertAfter]( [param:Vertex target], [param:Vertex vertex Inserts a vertex after a target vertex.

-

[method:VertexList append]( [param:Vertex vertex] )

+

[[method:this append]( [param:Vertex vertex] )

[page:Vertex vertex] - The vertex to append.

Appends a vertex to the end of the linked list.

-

[method:VertexList appendChain]( [param:Vertex vertex] )

+

[[method:this appendChain]( [param:Vertex vertex] )

[page:Vertex vertex] - The head vertex of a chain of vertices.

Appends a chain of vertices where the given vertex is the head.

-

[method:VertexList remove]( [param:Vertex vertex] )

+

[[method:this remove]( [param:Vertex vertex] )

[page:Vertex vertex] - The vertex to remove.

Removes a vertex from the linked list.

-

[method:VertexList removeSubList]( [param:Vertex a], [param:Vertex b] )

+

[[method:this removeSubList]( [param:Vertex a], [param:Vertex b] )

[page:Vertex a] - The head of the sublist.
[page:Vertex b] - The tail of the sublist.

diff --git a/docs/examples/zh/animations/CCDIKSolver.html b/docs/examples/zh/animations/CCDIKSolver.html index 8cb187179214f5..e2a1d9d00ae79e 100644 --- a/docs/examples/zh/animations/CCDIKSolver.html +++ b/docs/examples/zh/animations/CCDIKSolver.html @@ -90,12 +90,12 @@

[method:CCDIKHelper createHelper]()

Return [page:CCDIKHelper]. You can visualize IK bones by adding the helper to scene.

-

[method:CCDIKSolver update]()

+

[method:this update]()

Update bones quaternion by solving CCD algorithm.

-

[method:CCDIKSolver updateOne]( [param:Object ikParam] )

+

[method:this updateOne]( [param:Object ikParam] )

Update an IK bone quaternion by solving CCD algorithm.

diff --git a/docs/examples/zh/animations/MMDPhysics.html b/docs/examples/zh/animations/MMDPhysics.html index 2e49b5944f1016..dea8db0725ef05 100644 --- a/docs/examples/zh/animations/MMDPhysics.html +++ b/docs/examples/zh/animations/MMDPhysics.html @@ -76,12 +76,12 @@

[method:MMDPhysicsHelper createHelper]()

Return [page:MMDPhysicsHelper]. You can visualize Rigid bodies by adding the helper to scene.

-

[method:CCDIKSolver reset]()

+

[method:this reset]()

Resets Rigid bodies transorm to current bone's.

-

[method:CCDIKSolver setGravity]( [param:Vector3 gravity] )

+

[method:this setGravity]( [param:Vector3 gravity] )

[page:Vector3 gravity] — Direction and volume of gravity.

@@ -89,7 +89,7 @@

[method:CCDIKSolver setGravity]( [param:Vector3 gravity] )

Set gravity.

-

[method:CCDIKSolver update]( [param:Number delta] )

+

[method:this update]( [param:Number delta] )

[page:Number delta] — Time in second.

@@ -97,7 +97,7 @@

[method:CCDIKSolver update]( [param:Number delta] )

Advance Physics calculation and updates bones.

-

[method:CCDIKSolver warmup]( [param:Integer cycles] )

+

[method:this warmup]( [param:Integer cycles] )

[page:Number delta] — Time in second.

diff --git a/docs/examples/zh/loaders/MMDLoader.html b/docs/examples/zh/loaders/MMDLoader.html index bae7c3364681be..a395a5c3be1e56 100644 --- a/docs/examples/zh/loaders/MMDLoader.html +++ b/docs/examples/zh/loaders/MMDLoader.html @@ -106,7 +106,7 @@

[method:undefined loadWithAnimation]( [param:String modelUrl], [param:String 开始从URL中加载PMD/PMX模型文件和VMD动画文件（可能有多个文件），并使用一个[page:Object] —— 包含有已解析的[page:SkinnedMesh]和适应[page:SkinnedMesh]的[page:AnimationClip]，来触发回调函数。

-

[method:MMDLoader setAnimationPath]( [param:String animationPath] )

+

[method:this setAnimationPath]( [param:String animationPath] )

[page:String animationPath] — 用于加载动画数据（VMD/VPD 文件）的基础路径。 Base path for loading animation data (VMD/VPD files).

diff --git a/docs/examples/zh/loaders/MTLLoader.html b/docs/examples/zh/loaders/MTLLoader.html index c5c99d98ffd3e5..44259e09f104e4 100644 --- a/docs/examples/zh/loaders/MTLLoader.html +++ b/docs/examples/zh/loaders/MTLLoader.html @@ -43,7 +43,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param 开始从URL中加载，并返回已加载的材质。

-

[method:MTLLoader setMaterialOptions]( [param:Object options] )

+

[method:this setMaterialOptions]( [param:Object options] )

[page:Object options] — required

-

[method:ConvexHull cleanup]()

+

[method:this cleanup]()

Cleans up internal properties after computing the convex hull.

-

[method:ConvexHull compute]()

+

[method:this compute]()

Starts the execution of the quick hull algorithm.

@@ -106,7 +106,7 @@

[method:Object computeExtremes]()

Computes the extremes values (min/max vectors) which will be used to compute the inital hull.

-

[method:ConvexHull computeHorizon]( [param:Vector3 eyePoint], [param:HalfEdge crossEdge], [param:Face face], [param:Array horizon] )

+

[method:this computeHorizon]( [param:Vector3 eyePoint], [param:HalfEdge crossEdge], [param:Face face], [param:Array horizon] )

[page:Vector3 eyePoint] - The 3D-coordinates of a point.
[page:HalfEdge crossEdge] - The edge used to jump to the current face.
@@ -116,18 +116,18 @@

[method:ConvexHull computeHorizon]( [param:Vector3 eyePoint], [param:HalfEdg Computes a chain of half edges in CCW order called the 'horizon'. For an edge to be part of the horizon it must join a face that can see 'eyePoint' and a face that cannot see 'eyePoint'.

-

[method:ConvexHull computeInitialHull]()

+

[method:this computeInitialHull]()

Computes the initial simplex assigning to its faces all the points that are candidates to form part of the hull.

-

[method:ConvexHull containsPoint]( [param:Vector3 point] )

+

[method:this containsPoint]( [param:Vector3 point] )

[page:Vector3 point] - A point in 3D space.

Returns *true* if the given point is inside this convex hull.

-

[method:ConvexHull deleteFaceVertices]( [param:Face face], [param:Face absorbingFace] )

+

[method:this deleteFaceVertices]( [param:Face face], [param:Face absorbingFace] )

[page:Face face] - The given face.
[page:Face absorbingFace] - An optional face that tries to absorb the vertices of the first face.

@@ -155,7 +155,7 @@

[method:Boolean intersectsRay]( [param:Ray ray] )

Returns *true* if the given ray intersects with this convex hull.

-

[method:ConvexHull makeEmpty]()

+

[method:this makeEmpty]()

Makes this convex hull empty.

@@ -169,7 +169,7 @@

[method:VertexNode nextVertexToAdd]()

-

[method:ConvexHull reindexFaces]()

+

[method:this reindexFaces]()

Removes inactive (e.g. deleted) faces from the internal face list.

@@ -180,7 +180,7 @@

[method:VertexNode removeAllVerticesFromFace]( [param:Face face] )

Removes all the visible vertices that a given face is able to see which are stored in the 'assigned' vertext list.

-

[method:ConvexHull removeVertexFromFace]( [param:VertexNode vertex], [param:Face face] )

+

[method:this removeVertexFromFace]( [param:VertexNode vertex], [param:Face face] )

[page:VertexNode vertex] - The vertex to remove.
[page:Face face] - The target face.

@@ -188,21 +188,21 @@

[method:ConvexHull removeVertexFromFace]( [param:VertexNode vertex], [param: Removes a vertex from the 'assigned' list of vertices and from the given face. It also makes sure that the link from 'face' to the first vertex it sees in 'assigned' is linked correctly after the removal.

-

[method:ConvexHull resolveUnassignedPoints]( [param:Array newFaces] )

+

[method:this resolveUnassignedPoints]( [param:Array newFaces] )

[page:Face newFaces] - An array of new faces.

Reassigns as many vertices as possible from the unassigned list to the new faces.

-

[method:ConvexHull setFromObject]( [param:Object3D object] )

+

[method:this setFromObject]( [param:Object3D object] )

[page:Object3D object] - [page:Object3D] to compute the convex hull of.

Computes the convex hull of an [page:Object3D] (including its children),accounting for the world transforms of both the object and its childrens.

-

[method:ConvexHull setFromPoints]( [param:Array points] )

+

[method:this setFromPoints]( [param:Array points] )

[page:Array points] - Array of [page:Vector3 Vector3s] that the resulting convex hull will contain.

diff --git a/docs/examples/zh/math/convexhull/Face.html b/docs/examples/zh/math/convexhull/Face.html index a58952b4644997..ff88d28edca285 100644 --- a/docs/examples/zh/math/convexhull/Face.html +++ b/docs/examples/zh/math/convexhull/Face.html @@ -77,7 +77,7 @@

[method:HalfEdge getEdge]( [param:Integer i] )

Returns an edge by the given index.

-

[method:Face compute] ()

+

[method:this compute] ()

Computes all properties of the face.

diff --git a/docs/examples/zh/math/convexhull/HalfEdge.html b/docs/examples/zh/math/convexhull/HalfEdge.html index 211ae5241a89dd..21535d50ed0837 100644 --- a/docs/examples/zh/math/convexhull/HalfEdge.html +++ b/docs/examples/zh/math/convexhull/HalfEdge.html @@ -67,7 +67,7 @@

[method:Float lengthSquared]()

Returns the square of the [link:https://en.wikipedia.org/wiki/Euclidean_distance Euclidean length] (straight-line length) of the edge.

-

[method:HalfEdge setTwin]( [param:HalfEdge edge] )

+

[method:this setTwin]( [param:HalfEdge edge] )

[page:HalfEdge edge] - Any half-edge.

diff --git a/docs/examples/zh/math/convexhull/VertexList.html b/docs/examples/zh/math/convexhull/VertexList.html index 1d3c666f0e2886..98b397243e4405 100644 --- a/docs/examples/zh/math/convexhull/VertexList.html +++ b/docs/examples/zh/math/convexhull/VertexList.html @@ -42,10 +42,10 @@

[method:VertexNode first]()

[method:VertexNode last]()

Returns the tail reference.

-

[method:VertexList clear]()

+

[method:this clear]()

Clears the linked list.

-

[method:VertexList insertBefore]( [param:Vertex target], [param:Vertex vertex] )

+

[method:this insertBefore]( [param:Vertex target], [param:Vertex vertex] )

[page:Vertex target] - The target vertex. It's assumed that this vertex belongs to the linked list.
[page:Vertex vertex] - The vertex to insert.

@@ -53,7 +53,7 @@

[method:VertexList insertBefore]( [param:Vertex target], [param:Vertex verte Inserts a vertex before a target vertex.

-

[method:VertexList insertAfter]( [param:Vertex target], [param:Vertex vertex] )

+

[method:this insertAfter]( [param:Vertex target], [param:Vertex vertex] )

[page:Vertex target] - The target vertex. It's assumed that this vertex belongs to the linked list.
[page:Vertex vertex] - The vertex to insert.

@@ -61,28 +61,28 @@

[method:VertexList insertAfter]( [param:Vertex target], [param:Vertex vertex Inserts a vertex after a target vertex.

-

[method:VertexList append]( [param:Vertex vertex] )

+

[method:this append]( [param:Vertex vertex] )

[page:Vertex vertex] - The vertex to append.

Appends a vertex to the end of the linked list.

-

[method:VertexList appendChain]( [param:Vertex vertex] )

+

[method:this appendChain]( [param:Vertex vertex] )

[page:Vertex vertex] - The head vertex of a chain of vertices.

Appends a chain of vertices where the given vertex is the head.

-

[method:VertexList remove]( [param:Vertex vertex] )

+

[method:this remove]( [param:Vertex vertex] )

[page:Vertex vertex] - The vertex to remove.

Removes a vertex from the linked list.

-

[method:VertexList removeSubList]( [param:Vertex a], [param:Vertex b] )

+

[method:this removeSubList]( [param:Vertex a], [param:Vertex b] )

[page:Vertex a] - The head of the sublist.
[page:Vertex b] - The tail of the sublist.