From fe0979f7248df4bc6639a844b5a18210a083be74 Mon Sep 17 00:00:00 2001 From: fand Date: Mon, 6 Jan 2025 19:39:21 +0000 Subject: [PATCH] deploy: ce6ecb9eff71eb4e8fc47d3963d933f421e16fd1 --- .../{docs-Vp-jV-V4.css => docs-DnDp3ZPO.css} | 2 +- .../{index-DXU20IJL.js => index-BxNZGJ7n.js} | 4 +- docs/assets/hierarchy.js | 2 +- docs/assets/highlight.css | 22 +- docs/assets/navigation.js | 2 +- docs/classes/AnimationClip.html | 26 -- docs/classes/ArrayCamera.html | 436 ----------------- docs/classes/Bone.html | 332 ------------- docs/classes/Box2.html | 36 -- docs/classes/Box3.html | 48 -- docs/classes/BufferAttribute.html | 163 ------- docs/classes/BufferGeometry.html | 186 -------- docs/classes/Camera.html | 342 -------------- docs/classes/Color.html | 110 ----- docs/classes/ColorBuffer.html | 6 - docs/classes/CubeTexture.html | 274 ----------- docs/classes/CubicInterpolant.html | 8 - docs/classes/Cylindrical.html | 19 - docs/classes/Data3DTexture.html | 239 ---------- docs/classes/DataArrayTexture.html | 246 ---------- docs/classes/DepthBuffer.html | 10 - docs/classes/DepthTexture.html | 241 ---------- docs/classes/DiscreteInterpolant.html | 8 - docs/classes/Euler.html | 33 -- docs/classes/EventDispatcher.html | 27 -- docs/classes/Fog.html | 37 -- docs/classes/FogExp2.html | 33 -- docs/classes/Frustum.html | 14 - docs/classes/GLBufferAttribute.html | 73 --- docs/classes/Group.html | 334 ------------- .../IndirectStorageBufferAttribute.html | 150 ------ docs/classes/InterleavedBuffer.html | 89 ---- docs/classes/InterleavedBufferAttribute.html | 97 ---- docs/classes/Interpolant.html | 7 - docs/classes/KeyframeTrack.html | 26 -- docs/classes/Layers.html | 39 -- docs/classes/Light.html | 339 -------------- docs/classes/LightShadow.html | 85 ---- docs/classes/Line3.html | 22 - docs/classes/LinearInterpolant.html | 8 - docs/classes/Loader.html | 32 -- docs/classes/LoadingManager.html | 36 -- docs/classes/Material.html | 310 ------------ docs/classes/Matrix3.html | 71 --- docs/classes/Matrix4.html | 92 ---- docs/classes/Mesh.html | 352 -------------- docs/classes/Object3D.html | 328 ------------- docs/classes/PerspectiveCamera.html | 440 ------------------ docs/classes/Plane.html | 32 -- docs/classes/Quaternion.html | 93 ---- docs/classes/Ray.html | 36 -- docs/classes/Raycaster.html | 81 ---- docs/classes/RenderTarget.html | 70 --- docs/classes/Scene.html | 368 --------------- docs/classes/Source.html | 38 -- docs/classes/SourceJSON.html | 4 - docs/classes/Sphere.html | 32 -- docs/classes/Spherical.html | 20 - docs/classes/Sprite.html | 338 -------------- docs/classes/SpriteMaterial.html | 336 ------------- docs/classes/StencilBuffer.html | 9 - docs/classes/Texture.html | 267 ----------- docs/classes/TextureLoader.html | 33 -- docs/classes/Triangle.html | 36 -- docs/classes/VFX.html | 18 +- docs/classes/Vector2.html | 150 ------ docs/classes/Vector3.html | 143 ------ docs/classes/Vector4.html | 118 ----- docs/classes/WebGLCapabilities.html | 20 - docs/classes/WebGLExtensions.html | 5 - docs/classes/WebGLInfo.html | 21 - docs/classes/WebGLObjects.html | 4 - docs/classes/WebGLProgram.html | 19 - docs/classes/WebGLProperties.html | 7 - docs/classes/WebGLRenderList.html | 19 - docs/classes/WebGLRenderLists.html | 4 - docs/classes/WebGLRenderTarget.html | 71 --- docs/classes/WebGLRenderer.html | 230 --------- docs/classes/WebGLShadowMap.html | 21 - docs/classes/WebGLState.html | 24 - docs/classes/WebGLTextures.html | 13 - docs/classes/WebGLUniforms.html | 6 - docs/classes/WebGLUtils.html | 3 - docs/classes/WebXRController.html | 9 - docs/classes/WebXRManager.html | 60 --- docs/classes/XRAnchor.html | 4 - docs/classes/XRBoundedReferenceSpace.html | 30 -- docs/classes/XRCompositionLayer.html | 36 -- docs/classes/XRCubeLayer.html | 37 -- docs/classes/XRCylinderLayer.html | 40 -- docs/classes/XREquirectLayer.html | 41 -- docs/classes/XRFrame.html | 30 -- docs/classes/XRGripSpace.html | 338 -------------- docs/classes/XRHand.html | 50 -- docs/classes/XRHandSpace.html | 336 ------------- docs/classes/XRHitTestResult.html | 4 - docs/classes/XRHitTestSource.html | 3 - docs/classes/XRInputSource.html | 9 - docs/classes/XRInputSourceArray.html | 8 - docs/classes/XRInputSourceEvent.html | 64 --- docs/classes/XRJointPose.html | 7 - docs/classes/XRJointSpace-1.html | 335 ------------- docs/classes/XRJointSpace.html | 18 - docs/classes/XRLayer.html | 17 - docs/classes/XRMesh.html | 7 - docs/classes/XRPlane.html | 7 - docs/classes/XRPose.html | 6 - docs/classes/XRProjectionLayer.html | 41 -- docs/classes/XRQuadLayer.html | 39 -- docs/classes/XRRay.html | 5 - docs/classes/XRReferenceSpace.html | 29 -- docs/classes/XRReferenceSpaceEvent.html | 58 --- docs/classes/XRRenderState.html | 7 - docs/classes/XRRigidTransform.html | 9 - docs/classes/XRSession.html | 83 ---- docs/classes/XRSessionEvent.html | 63 --- docs/classes/XRSpace.html | 17 - docs/classes/XRSubImage.html | 3 - docs/classes/XRTargetRaySpace.html | 338 -------------- .../XRTransientInputHitTestResult.html | 5 - .../XRTransientInputHitTestSource.html | 3 - docs/classes/XRView.html | 7 - docs/classes/XRViewerPose.html | 7 - docs/classes/XRViewport.html | 6 - docs/classes/XRWebGLBinding.html | 11 - docs/classes/XRWebGLLayer.html | 28 -- docs/classes/XRWebGLSubImage.html | 8 - docs/classes/default.html | 149 ------ docs/hierarchy.html | 1 - docs/index.html | 4 +- docs/interfaces/AddEventListenerOptions.html | 5 - docs/interfaces/AnimationClipJSON.html | 6 - docs/interfaces/ArrayBufferView.html | 7 - docs/interfaces/ArrayLike.html | 2 - docs/interfaces/BaseEvent.html | 3 - docs/interfaces/BufferAttributeJSON.html | 7 - docs/interfaces/BufferGeometryJSON.html | 7 - docs/interfaces/CompressedTextureMipmap.html | 4 - docs/interfaces/CurveJSON.html | 4 - docs/interfaces/CurvePathJSON.html | 6 - docs/interfaces/DOMMatrix2DInit.html | 13 - docs/interfaces/DOMMatrixInit.html | 24 - docs/interfaces/DOMPoint.html | 13 - docs/interfaces/DOMPointInit.html | 5 - docs/interfaces/DOMPointReadOnly.html | 13 - docs/interfaces/DOMRectInit.html | 5 - docs/interfaces/DOMRectReadOnly.html | 19 - docs/interfaces/Event.html | 4 - docs/interfaces/EventInit.html | 4 - docs/interfaces/EventListener.html | 1 - docs/interfaces/EventListenerObject.html | 2 - docs/interfaces/EventListenerOptions.html | 2 - docs/interfaces/Face.html | 6 - docs/interfaces/FogExp2JSON.html | 5 - docs/interfaces/FogJSON.html | 6 - docs/interfaces/Generator.html | 5 - docs/interfaces/GeometryGroup.html | 10 - docs/interfaces/HSL.html | 4 - docs/interfaces/IUniform.html | 2 - docs/interfaces/ImageBitmap.html | 11 - docs/interfaces/ImageData.html | 14 - docs/interfaces/ImageDataSettings.html | 2 - docs/interfaces/Intersection.html | 21 - docs/interfaces/IterableIterator.html | 6 - docs/interfaces/Iterator.html | 4 - docs/interfaces/IteratorReturnResult.html | 3 - docs/interfaces/IteratorYieldResult.html | 3 - docs/interfaces/JSONMeta.html | 9 - docs/interfaces/KeyframeTrackJSON.html | 6 - docs/interfaces/LightJSON.html | 12 - docs/interfaces/LightShadowJSON.html | 7 - docs/interfaces/MapIterator.html | 5 - docs/interfaces/MaterialJSON.html | 119 ----- docs/interfaces/MaterialParameters.html | 46 -- docs/interfaces/MeshJSON.html | 3 - docs/interfaces/MeshJSONObject.html | 18 - docs/interfaces/MorphTarget.html | 3 - docs/interfaces/Object3DEventMap.html | 9 - docs/interfaces/Object3DJSON.html | 3 - docs/interfaces/Object3DJSONObject.html | 17 - docs/interfaces/OffscreenCanvas.html | 17 - docs/interfaces/PathJSON.html | 7 - docs/interfaces/PerspectiveCameraJSON.html | 3 - .../PerspectiveCameraJSONObject.html | 26 -- docs/interfaces/PlaneLayout.html | 3 - docs/interfaces/ProgressEvent.html | 63 --- docs/interfaces/ProgressEventInit.html | 7 - docs/interfaces/QuaternionLike.html | 5 - docs/interfaces/RGB.html | 4 - docs/interfaces/RaycasterParameters.html | 7 - docs/interfaces/RenderItem.html | 10 - docs/interfaces/RenderTargetOptions.html | 22 - docs/interfaces/Renderer.html | 4 - docs/interfaces/SceneJSON.html | 3 - docs/interfaces/SceneJSONObject.html | 23 - docs/interfaces/ShapeJSON.html | 9 - docs/interfaces/SkeletonJSON.html | 5 - docs/interfaces/SpriteMaterialParameters.html | 52 --- docs/interfaces/Texture3DImageData.html | 5 - docs/interfaces/TextureImageData.html | 4 - docs/interfaces/TextureJSON.html | 24 - docs/interfaces/Vector2Like.html | 3 - docs/interfaces/Vector3Like.html | 4 - docs/interfaces/Vector4Like.html | 5 - docs/interfaces/VideoColorSpace.html | 12 - docs/interfaces/VideoColorSpaceInit.html | 5 - docs/interfaces/VideoFrame.html | 30 -- docs/interfaces/VideoFrameBufferInit.html | 11 - docs/interfaces/VideoFrameCopyToOptions.html | 5 - docs/interfaces/VideoFrameInit.html | 7 - docs/interfaces/WebGLBuffer.html | 3 - .../WebGLCapabilitiesParameters.html | 7 - docs/interfaces/WebGLDebug.html | 8 - docs/interfaces/WebGLFramebuffer.html | 3 - docs/interfaces/WebGLProgramParameters.html | 132 ------ .../WebGLProgramParametersWithUniforms.html | 133 ------ docs/interfaces/WebGLRendererParameters.html | 29 -- docs/interfaces/WebGLShader.html | 3 - docs/interfaces/WebGLTexture.html | 3 - docs/interfaces/WebXRManagerEventMap.html | 7 - docs/interfaces/WebXRSpaceEventMap.html | 20 - docs/interfaces/XRCPUDepthInformation.html | 7 - .../XRCompositionLayerEventMap.html | 2 - docs/interfaces/XRCubeLayerInit.html | 10 - docs/interfaces/XRCylinderLayerInit.html | 14 - docs/interfaces/XRDOMOverlayState.html | 2 - docs/interfaces/XRDepthInformation.html | 5 - docs/interfaces/XREquirectLayerInit.html | 15 - docs/interfaces/XRHandInputState.html | 2 - docs/interfaces/XRHitResult.html | 2 - docs/interfaces/XRHitTestOptionsInit.html | 4 - .../interfaces/XRInputSourceEventHandler.html | 1 - docs/interfaces/XRInputSourceEventInit.html | 6 - .../interfaces/XRInputSourcesChangeEvent.html | 61 --- .../XRInputSourcesChangeEventHandler.html | 1 - docs/interfaces/XRLayerEvent.html | 56 --- docs/interfaces/XRLayerInit.html | 9 - docs/interfaces/XRProjectionLayerInit.html | 5 - docs/interfaces/XRQuadLayerInit.html | 13 - .../XRReferenceSpaceEventHandler.html | 1 - .../interfaces/XRReferenceSpaceEventInit.html | 6 - docs/interfaces/XRReferenceSpaceEventMap.html | 2 - docs/interfaces/XRRenderStateInit.html | 6 - docs/interfaces/XRSessionEventHandler.html | 1 - docs/interfaces/XRSessionEventInit.html | 5 - docs/interfaces/XRSessionEventMap.html | 11 - .../XRTransientInputHitTestOptionsInit.html | 4 - docs/interfaces/XRWebGLDepthInformation.html | 8 - docs/interfaces/XRWebGLLayerInit.html | 7 - docs/modules.html | 4 +- docs/types/AllowSharedBufferSource.html | 1 - docs/types/AlphaOption.html | 1 - docs/types/AnimationBlendMode.html | 1 - docs/types/AnyMapping.html | 6 - docs/types/AnyPixelFormat.html | 8 - docs/types/ArrayBufferLike.html | 1 - docs/types/AttributeGPUType.html | 1 - docs/types/Blending.html | 1 - docs/types/BlendingDstFactor.html | 1 - docs/types/BlendingEquation.html | 1 - docs/types/BlendingSrcFactor.html | 1 - docs/types/BufferSource.html | 1 - docs/types/BuiltinIteratorReturn.html | 3 - docs/types/CanvasImageSource.html | 1 - docs/types/ColorRepresentation.html | 1 - docs/types/Combine.html | 1 - docs/types/CompressedPixelFormat.html | 3 - docs/types/CoordinateSystem.html | 1 - docs/types/CubeTextureMapping.html | 4 - docs/types/CullFace.html | 1 - docs/types/DOMHighResTimeStamp.html | 1 - docs/types/DepthModes.html | 1 - docs/types/DepthPackingStrategies.html | 1 - docs/types/DepthTexturePixelFormat.html | 6 - docs/types/EulerOrder.html | 1 - docs/types/EulerTuple.html | 1 - docs/types/EventListener-1.html | 1 - .../EventListenerOrEventListenerObject.html | 1 - docs/types/Exclude.html | 2 - docs/types/GLSLVersion.html | 1 - docs/types/HTMLOrSVGImageElement.html | 1 - docs/types/InterpolationModes.html | 1 - docs/types/IteratorResult.html | 1 - docs/types/MagnificationTextureFilter.html | 8 - docs/types/Mapping.html | 4 - docs/types/Matrix3Tuple.html | 1 - docs/types/Matrix4Tuple.html | 1 - docs/types/MinificationTextureFilter.html | 8 - docs/types/NormalBufferAttributes.html | 1 - docs/types/NormalMapTypes.html | 1 - docs/types/NormalOrGLBufferAttributes.html | 1 - docs/types/Omit.html | 2 - docs/types/Partial.html | 2 - docs/types/Pick.html | 2 - docs/types/PixelFormat.html | 7 - docs/types/PixelFormatGPU.html | 63 --- docs/types/PredefinedColorSpace.html | 1 - docs/types/QuaternionTuple.html | 1 - docs/types/Record.html | 2 - docs/types/RectOpts.html | 4 +- docs/types/SerializedImage.html | 1 - docs/types/ShaderPreset.html | 2 +- docs/types/ShadowMapType.html | 1 - docs/types/Side.html | 3 - docs/types/StencilFunc.html | 1 - docs/types/StencilOp.html | 1 - docs/types/TexImageSource.html | 1 - docs/types/TextureComparisonFunction.html | 1 - docs/types/TextureDataType.html | 7 - docs/types/ToneMapping.html | 1 - docs/types/TypedArray.html | 1 - docs/types/Usage.html | 1 - docs/types/VFXElementIntersection.html | 2 +- docs/types/VFXOpts.html | 4 +- docs/types/VFXProps.html | 6 +- docs/types/VFXUniformValue.html | 4 +- docs/types/VFXUniforms.html | 2 +- docs/types/VFXWrap.html | 4 +- docs/types/Vector2Tuple.html | 1 - docs/types/Vector3Tuple.html | 1 - docs/types/Vector4Tuple.html | 1 - docs/types/VideoColorPrimaries.html | 1 - docs/types/VideoMatrixCoefficients.html | 1 - docs/types/VideoPixelFormat.html | 1 - docs/types/VideoTransferCharacteristics.html | 1 - docs/types/WebGLPowerPreference.html | 1 - docs/types/WebXRArrayCamera.html | 1 - docs/types/WebXRCamera.html | 1 - docs/types/Wrapping.html | 4 - docs/types/XRAnchorSet.html | 1 - docs/types/XRControllerEventType.html | 1 - docs/types/XRDOMOverlayType.html | 1 - docs/types/XRDepthDataFormat.html | 1 - docs/types/XRDepthUsage.html | 3 - docs/types/XREnvironmentBlendMode.html | 1 - docs/types/XREye.html | 2 - docs/types/XRFrameRequestCallback.html | 1 - docs/types/XRHandJoint.html | 4 - docs/types/XRHandJoints.html | 1 - docs/types/XRHandedness.html | 2 - docs/types/XRHitTestTrackableType.html | 1 - docs/types/XRInputSourceEventType.html | 2 - docs/types/XRLayerLayout.html | 1 - docs/types/XRLayerQuality.html | 1 - docs/types/XRMeshSet.html | 1 - docs/types/XRPlaneOrientation.html | 1 - docs/types/XRPlaneSet.html | 1 - docs/types/XRReferenceSpaceType.html | 2 - docs/types/XRSessionEventType.html | 1 - docs/types/XRTargetRayMode.html | 2 - docs/types/XRTextureType.html | 1 - docs/types/XRVisibilityState.html | 2 - docs/variables/ACESFilmicToneMapping.html | 1 - docs/variables/AddEquation.html | 1 - docs/variables/AddOperation.html | 1 - .../variables/AdditiveAnimationBlendMode.html | 1 - docs/variables/AdditiveBlending.html | 1 - docs/variables/AgXToneMapping.html | 1 - docs/variables/AlphaFormat.html | 2 - docs/variables/AlwaysCompare.html | 1 - docs/variables/AlwaysDepth.html | 1 - docs/variables/AlwaysStencilFunc.html | 1 - docs/variables/BackSide.html | 1 - docs/variables/BasicDepthPacking.html | 1 - docs/variables/BasicShadowMap.html | 1 - docs/variables/ByteType.html | 1 - docs/variables/CineonToneMapping.html | 1 - docs/variables/ClampToEdgeWrapping.html | 3 - docs/variables/ConstantAlphaFactor.html | 1 - docs/variables/ConstantColorFactor.html | 1 - docs/variables/CubeReflectionMapping.html | 2 - docs/variables/CubeRefractionMapping.html | 1 - docs/variables/CubeUVReflectionMapping.html | 1 - docs/variables/CullFaceBack.html | 1 - docs/variables/CullFaceFront.html | 1 - docs/variables/CullFaceFrontBack.html | 1 - docs/variables/CullFaceNone.html | 1 - docs/variables/CustomBlending.html | 1 - docs/variables/CustomToneMapping.html | 1 - docs/variables/DOMPoint-1.html | 2 - docs/variables/DOMPointReadOnly-1.html | 2 - docs/variables/DOMRectReadOnly-1.html | 2 - docs/variables/DecrementStencilOp.html | 1 - docs/variables/DecrementWrapStencilOp.html | 1 - docs/variables/DepthFormat.html | 3 - docs/variables/DepthStencilFormat.html | 4 - docs/variables/DoubleSide.html | 1 - docs/variables/DstAlphaFactor.html | 1 - docs/variables/DstColorFactor.html | 1 - docs/variables/DynamicCopyUsage.html | 1 - docs/variables/DynamicDrawUsage.html | 1 - docs/variables/DynamicReadUsage.html | 1 - docs/variables/EqualCompare.html | 1 - docs/variables/EqualDepth.html | 1 - docs/variables/EqualStencilFunc.html | 1 - .../EquirectangularReflectionMapping.html | 1 - .../EquirectangularRefractionMapping.html | 1 - docs/variables/FloatType.html | 1 - docs/variables/FrontSide.html | 1 - docs/variables/GLSL1.html | 1 - docs/variables/GLSL3.html | 1 - docs/variables/GreaterCompare.html | 1 - docs/variables/GreaterDepth.html | 1 - docs/variables/GreaterEqualCompare.html | 1 - docs/variables/GreaterEqualDepth.html | 1 - docs/variables/GreaterEqualStencilFunc.html | 1 - docs/variables/GreaterStencilFunc.html | 1 - docs/variables/HalfFloatType.html | 1 - docs/variables/ImageBitmap-1.html | 1 - docs/variables/ImageData-1.html | 1 - docs/variables/IncrementStencilOp.html | 1 - docs/variables/IncrementWrapStencilOp.html | 1 - docs/variables/IntType.html | 1 - docs/variables/InterpolateDiscrete.html | 1 - docs/variables/InterpolateLinear.html | 1 - docs/variables/InterpolateSmooth.html | 1 - docs/variables/InvertStencilOp.html | 1 - docs/variables/KeepStencilOp.html | 1 - docs/variables/LessCompare.html | 1 - docs/variables/LessDepth.html | 1 - docs/variables/LessEqualCompare.html | 1 - docs/variables/LessEqualDepth.html | 1 - docs/variables/LessEqualStencilFunc.html | 1 - docs/variables/LessStencilFunc.html | 1 - docs/variables/LinearFilter.html | 4 - .../variables/LinearMipMapLinearFilter-1.html | 4 - .../LinearMipMapNearestFilter-1.html | 3 - docs/variables/LinearMipmapLinearFilter.html | 4 - docs/variables/LinearMipmapNearestFilter.html | 3 - docs/variables/LinearToneMapping.html | 1 - docs/variables/LuminanceAlphaFormat.html | 3 - docs/variables/LuminanceFormat.html | 4 - docs/variables/MaxEquation.html | 1 - docs/variables/MinEquation.html | 1 - docs/variables/MirroredRepeatWrapping.html | 2 - docs/variables/MixOperation.html | 1 - docs/variables/MultiplyBlending.html | 1 - docs/variables/MultiplyOperation.html | 1 - docs/variables/NearestFilter.html | 2 - .../NearestMipMapLinearFilter-1.html | 4 - .../NearestMipMapNearestFilter-1.html | 3 - docs/variables/NearestMipmapLinearFilter.html | 4 - .../variables/NearestMipmapNearestFilter.html | 3 - docs/variables/NeutralToneMapping.html | 1 - docs/variables/NeverCompare.html | 1 - docs/variables/NeverDepth.html | 1 - docs/variables/NeverStencilFunc.html | 1 - docs/variables/NoBlending.html | 1 - docs/variables/NoToneMapping.html | 1 - docs/variables/NormalAnimationBlendMode.html | 1 - docs/variables/NormalBlending.html | 1 - docs/variables/NotEqualCompare.html | 1 - docs/variables/NotEqualDepth.html | 1 - docs/variables/NotEqualStencilFunc.html | 1 - docs/variables/ObjectSpaceNormalMap.html | 1 - docs/variables/OneFactor.html | 1 - .../OneMinusConstantAlphaFactor.html | 1 - .../OneMinusConstantColorFactor.html | 1 - docs/variables/OneMinusDstAlphaFactor.html | 1 - docs/variables/OneMinusDstColorFactor.html | 1 - docs/variables/OneMinusSrcAlphaFactor.html | 1 - docs/variables/OneMinusSrcColorFactor.html | 1 - docs/variables/PCFShadowMap.html | 1 - docs/variables/PCFSoftShadowMap.html | 1 - docs/variables/ProgressEvent-1.html | 1 - docs/variables/RED_GREEN_RGTC2_Format.html | 1 - docs/variables/RED_RGTC1_Format.html | 1 - docs/variables/RGBADepthPacking.html | 1 - docs/variables/RGBAFormat.html | 2 - docs/variables/RGBAIntegerFormat.html | 3 - docs/variables/RGBA_ASTC_10x10_Format.html | 2 - docs/variables/RGBA_ASTC_10x5_Format.html | 2 - docs/variables/RGBA_ASTC_10x6_Format.html | 2 - docs/variables/RGBA_ASTC_10x8_Format.html | 2 - docs/variables/RGBA_ASTC_12x10_Format.html | 2 - docs/variables/RGBA_ASTC_12x12_Format.html | 2 - docs/variables/RGBA_ASTC_4x4_Format.html | 2 - docs/variables/RGBA_ASTC_5x4_Format.html | 2 - docs/variables/RGBA_ASTC_5x5_Format.html | 2 - docs/variables/RGBA_ASTC_6x5_Format.html | 2 - docs/variables/RGBA_ASTC_6x6_Format.html | 2 - docs/variables/RGBA_ASTC_8x5_Format.html | 2 - docs/variables/RGBA_ASTC_8x6_Format.html | 2 - docs/variables/RGBA_ASTC_8x8_Format.html | 2 - docs/variables/RGBA_BPTC_Format.html | 2 - docs/variables/RGBA_ETC2_EAC_Format.html | 2 - docs/variables/RGBA_PVRTC_2BPPV1_Format.html | 3 - docs/variables/RGBA_PVRTC_4BPPV1_Format.html | 3 - docs/variables/RGBA_S3TC_DXT1_Format.html | 3 - docs/variables/RGBA_S3TC_DXT3_Format.html | 3 - docs/variables/RGBA_S3TC_DXT5_Format.html | 3 - docs/variables/RGBDepthPacking.html | 1 - docs/variables/RGBFormat.html | 1 - docs/variables/RGBIntegerFormat.html | 2 - docs/variables/RGB_BPTC_SIGNED_Format.html | 1 - docs/variables/RGB_BPTC_UNSIGNED_Format.html | 1 - docs/variables/RGB_ETC1_Format.html | 2 - docs/variables/RGB_ETC2_Format.html | 2 - docs/variables/RGB_PVRTC_2BPPV1_Format.html | 3 - docs/variables/RGB_PVRTC_4BPPV1_Format.html | 3 - docs/variables/RGB_S3TC_DXT1_Format.html | 3 - docs/variables/RGDepthPacking.html | 1 - docs/variables/RGFormat.html | 2 - docs/variables/RGIntegerFormat.html | 3 - docs/variables/RedFormat.html | 2 - docs/variables/RedIntegerFormat.html | 3 - docs/variables/ReinhardToneMapping.html | 1 - docs/variables/RepeatWrapping.html | 2 - docs/variables/ReplaceStencilOp.html | 1 - docs/variables/ReverseSubtractEquation.html | 1 - .../SIGNED_RED_GREEN_RGTC2_Format.html | 1 - docs/variables/SIGNED_RED_RGTC1_Format.html | 1 - docs/variables/ShortType.html | 1 - docs/variables/SrcAlphaFactor.html | 1 - docs/variables/SrcAlphaSaturateFactor.html | 1 - docs/variables/SrcColorFactor.html | 1 - docs/variables/StaticCopyUsage.html | 1 - docs/variables/StaticDrawUsage.html | 1 - docs/variables/StaticReadUsage.html | 1 - docs/variables/StreamCopyUsage.html | 1 - docs/variables/StreamDrawUsage.html | 1 - docs/variables/StreamReadUsage.html | 1 - docs/variables/SubtractEquation.html | 1 - docs/variables/SubtractiveBlending.html | 1 - docs/variables/TangentSpaceNormalMap.html | 1 - docs/variables/UVMapping.html | 3 - docs/variables/UnsignedByteType.html | 1 - docs/variables/UnsignedInt248Type.html | 1 - docs/variables/UnsignedInt5999Type.html | 1 - docs/variables/UnsignedIntType.html | 1 - docs/variables/UnsignedShort4444Type.html | 1 - docs/variables/UnsignedShort5551Type.html | 1 - docs/variables/UnsignedShortType.html | 1 - docs/variables/VSMShadowMap.html | 1 - docs/variables/VideoColorSpace-1.html | 1 - docs/variables/VideoFrame-1.html | 1 - docs/variables/WebGLBuffer-1.html | 1 - docs/variables/WebGLCoordinateSystem.html | 1 - docs/variables/WebGLFramebuffer-1.html | 1 - docs/variables/WebGLShader-1.html | 1 - docs/variables/WebGLTexture-1.html | 1 - docs/variables/WebGPUCoordinateSystem.html | 1 - docs/variables/ZeroFactor.html | 1 - docs/variables/ZeroStencilOp.html | 1 - docs/variables/shaders.html | 4 +- index.html | 2 +- 546 files changed, 39 insertions(+), 12966 deletions(-) rename assets/{docs-Vp-jV-V4.css => docs-DnDp3ZPO.css} (85%) rename assets/{index-DXU20IJL.js => index-BxNZGJ7n.js} (96%) delete mode 100644 docs/classes/AnimationClip.html delete mode 100644 docs/classes/ArrayCamera.html delete mode 100644 docs/classes/Bone.html delete mode 100644 docs/classes/Box2.html delete mode 100644 docs/classes/Box3.html delete mode 100644 docs/classes/BufferAttribute.html delete mode 100644 docs/classes/BufferGeometry.html delete mode 100644 docs/classes/Camera.html delete mode 100644 docs/classes/Color.html delete mode 100644 docs/classes/ColorBuffer.html delete mode 100644 docs/classes/CubeTexture.html delete mode 100644 docs/classes/CubicInterpolant.html delete mode 100644 docs/classes/Cylindrical.html delete mode 100644 docs/classes/Data3DTexture.html delete mode 100644 docs/classes/DataArrayTexture.html delete mode 100644 docs/classes/DepthBuffer.html delete mode 100644 docs/classes/DepthTexture.html delete mode 100644 docs/classes/DiscreteInterpolant.html delete mode 100644 docs/classes/Euler.html delete mode 100644 docs/classes/EventDispatcher.html delete mode 100644 docs/classes/Fog.html delete mode 100644 docs/classes/FogExp2.html delete mode 100644 docs/classes/Frustum.html delete mode 100644 docs/classes/GLBufferAttribute.html delete mode 100644 docs/classes/Group.html delete mode 100644 docs/classes/IndirectStorageBufferAttribute.html delete mode 100644 docs/classes/InterleavedBuffer.html delete mode 100644 docs/classes/InterleavedBufferAttribute.html delete mode 100644 docs/classes/Interpolant.html delete mode 100644 docs/classes/KeyframeTrack.html delete mode 100644 docs/classes/Layers.html delete mode 100644 docs/classes/Light.html delete mode 100644 docs/classes/LightShadow.html delete mode 100644 docs/classes/Line3.html delete mode 100644 docs/classes/LinearInterpolant.html delete mode 100644 docs/classes/Loader.html delete mode 100644 docs/classes/LoadingManager.html delete mode 100644 docs/classes/Material.html delete mode 100644 docs/classes/Matrix3.html delete mode 100644 docs/classes/Matrix4.html delete mode 100644 docs/classes/Mesh.html delete mode 100644 docs/classes/Object3D.html delete mode 100644 docs/classes/PerspectiveCamera.html delete mode 100644 docs/classes/Plane.html delete mode 100644 docs/classes/Quaternion.html delete mode 100644 docs/classes/Ray.html delete mode 100644 docs/classes/Raycaster.html delete mode 100644 docs/classes/RenderTarget.html delete mode 100644 docs/classes/Scene.html delete mode 100644 docs/classes/Source.html delete mode 100644 docs/classes/SourceJSON.html delete mode 100644 docs/classes/Sphere.html delete mode 100644 docs/classes/Spherical.html delete mode 100644 docs/classes/Sprite.html delete mode 100644 docs/classes/SpriteMaterial.html delete mode 100644 docs/classes/StencilBuffer.html delete mode 100644 docs/classes/Texture.html delete mode 100644 docs/classes/TextureLoader.html delete mode 100644 docs/classes/Triangle.html delete mode 100644 docs/classes/Vector2.html delete mode 100644 docs/classes/Vector3.html delete mode 100644 docs/classes/Vector4.html delete mode 100644 docs/classes/WebGLCapabilities.html delete mode 100644 docs/classes/WebGLExtensions.html delete mode 100644 docs/classes/WebGLInfo.html delete mode 100644 docs/classes/WebGLObjects.html delete mode 100644 docs/classes/WebGLProgram.html delete mode 100644 docs/classes/WebGLProperties.html delete mode 100644 docs/classes/WebGLRenderList.html delete mode 100644 docs/classes/WebGLRenderLists.html delete mode 100644 docs/classes/WebGLRenderTarget.html delete mode 100644 docs/classes/WebGLRenderer.html delete mode 100644 docs/classes/WebGLShadowMap.html delete mode 100644 docs/classes/WebGLState.html delete mode 100644 docs/classes/WebGLTextures.html delete mode 100644 docs/classes/WebGLUniforms.html delete mode 100644 docs/classes/WebGLUtils.html delete mode 100644 docs/classes/WebXRController.html delete mode 100644 docs/classes/WebXRManager.html delete mode 100644 docs/classes/XRAnchor.html delete mode 100644 docs/classes/XRBoundedReferenceSpace.html delete mode 100644 docs/classes/XRCompositionLayer.html delete mode 100644 docs/classes/XRCubeLayer.html delete mode 100644 docs/classes/XRCylinderLayer.html delete mode 100644 docs/classes/XREquirectLayer.html delete mode 100644 docs/classes/XRFrame.html delete mode 100644 docs/classes/XRGripSpace.html delete mode 100644 docs/classes/XRHand.html delete mode 100644 docs/classes/XRHandSpace.html delete mode 100644 docs/classes/XRHitTestResult.html delete mode 100644 docs/classes/XRHitTestSource.html delete mode 100644 docs/classes/XRInputSource.html delete mode 100644 docs/classes/XRInputSourceArray.html delete mode 100644 docs/classes/XRInputSourceEvent.html delete mode 100644 docs/classes/XRJointPose.html delete mode 100644 docs/classes/XRJointSpace-1.html delete mode 100644 docs/classes/XRJointSpace.html delete mode 100644 docs/classes/XRLayer.html delete mode 100644 docs/classes/XRMesh.html delete mode 100644 docs/classes/XRPlane.html delete mode 100644 docs/classes/XRPose.html delete mode 100644 docs/classes/XRProjectionLayer.html delete mode 100644 docs/classes/XRQuadLayer.html delete mode 100644 docs/classes/XRRay.html delete mode 100644 docs/classes/XRReferenceSpace.html delete mode 100644 docs/classes/XRReferenceSpaceEvent.html delete mode 100644 docs/classes/XRRenderState.html delete mode 100644 docs/classes/XRRigidTransform.html delete mode 100644 docs/classes/XRSession.html delete mode 100644 docs/classes/XRSessionEvent.html delete mode 100644 docs/classes/XRSpace.html delete mode 100644 docs/classes/XRSubImage.html delete mode 100644 docs/classes/XRTargetRaySpace.html delete mode 100644 docs/classes/XRTransientInputHitTestResult.html delete mode 100644 docs/classes/XRTransientInputHitTestSource.html delete mode 100644 docs/classes/XRView.html delete mode 100644 docs/classes/XRViewerPose.html delete mode 100644 docs/classes/XRViewport.html delete mode 100644 docs/classes/XRWebGLBinding.html delete mode 100644 docs/classes/XRWebGLLayer.html delete mode 100644 docs/classes/XRWebGLSubImage.html delete mode 100644 docs/classes/default.html delete mode 100644 docs/hierarchy.html delete mode 100644 docs/interfaces/AddEventListenerOptions.html delete mode 100644 docs/interfaces/AnimationClipJSON.html delete mode 100644 docs/interfaces/ArrayBufferView.html delete mode 100644 docs/interfaces/ArrayLike.html delete mode 100644 docs/interfaces/BaseEvent.html delete mode 100644 docs/interfaces/BufferAttributeJSON.html delete mode 100644 docs/interfaces/BufferGeometryJSON.html delete mode 100644 docs/interfaces/CompressedTextureMipmap.html delete mode 100644 docs/interfaces/CurveJSON.html delete mode 100644 docs/interfaces/CurvePathJSON.html delete mode 100644 docs/interfaces/DOMMatrix2DInit.html delete mode 100644 docs/interfaces/DOMMatrixInit.html delete mode 100644 docs/interfaces/DOMPoint.html delete mode 100644 docs/interfaces/DOMPointInit.html delete mode 100644 docs/interfaces/DOMPointReadOnly.html delete mode 100644 docs/interfaces/DOMRectInit.html delete mode 100644 docs/interfaces/DOMRectReadOnly.html delete mode 100644 docs/interfaces/Event.html delete mode 100644 docs/interfaces/EventInit.html delete mode 100644 docs/interfaces/EventListener.html delete mode 100644 docs/interfaces/EventListenerObject.html delete mode 100644 docs/interfaces/EventListenerOptions.html delete mode 100644 docs/interfaces/Face.html delete mode 100644 docs/interfaces/FogExp2JSON.html delete mode 100644 docs/interfaces/FogJSON.html delete mode 100644 docs/interfaces/Generator.html delete mode 100644 docs/interfaces/GeometryGroup.html delete mode 100644 docs/interfaces/HSL.html delete mode 100644 docs/interfaces/IUniform.html delete mode 100644 docs/interfaces/ImageBitmap.html delete mode 100644 docs/interfaces/ImageData.html delete mode 100644 docs/interfaces/ImageDataSettings.html delete mode 100644 docs/interfaces/Intersection.html delete mode 100644 docs/interfaces/IterableIterator.html delete mode 100644 docs/interfaces/Iterator.html delete mode 100644 docs/interfaces/IteratorReturnResult.html delete mode 100644 docs/interfaces/IteratorYieldResult.html delete mode 100644 docs/interfaces/JSONMeta.html delete mode 100644 docs/interfaces/KeyframeTrackJSON.html delete mode 100644 docs/interfaces/LightJSON.html delete mode 100644 docs/interfaces/LightShadowJSON.html delete mode 100644 docs/interfaces/MapIterator.html delete mode 100644 docs/interfaces/MaterialJSON.html delete mode 100644 docs/interfaces/MaterialParameters.html delete mode 100644 docs/interfaces/MeshJSON.html delete mode 100644 docs/interfaces/MeshJSONObject.html delete mode 100644 docs/interfaces/MorphTarget.html delete mode 100644 docs/interfaces/Object3DEventMap.html delete mode 100644 docs/interfaces/Object3DJSON.html delete mode 100644 docs/interfaces/Object3DJSONObject.html delete mode 100644 docs/interfaces/OffscreenCanvas.html delete mode 100644 docs/interfaces/PathJSON.html delete mode 100644 docs/interfaces/PerspectiveCameraJSON.html delete mode 100644 docs/interfaces/PerspectiveCameraJSONObject.html delete mode 100644 docs/interfaces/PlaneLayout.html delete mode 100644 docs/interfaces/ProgressEvent.html delete mode 100644 docs/interfaces/ProgressEventInit.html delete mode 100644 docs/interfaces/QuaternionLike.html delete mode 100644 docs/interfaces/RGB.html delete mode 100644 docs/interfaces/RaycasterParameters.html delete mode 100644 docs/interfaces/RenderItem.html delete mode 100644 docs/interfaces/RenderTargetOptions.html delete mode 100644 docs/interfaces/Renderer.html delete mode 100644 docs/interfaces/SceneJSON.html delete mode 100644 docs/interfaces/SceneJSONObject.html delete mode 100644 docs/interfaces/ShapeJSON.html delete mode 100644 docs/interfaces/SkeletonJSON.html delete mode 100644 docs/interfaces/SpriteMaterialParameters.html delete mode 100644 docs/interfaces/Texture3DImageData.html delete mode 100644 docs/interfaces/TextureImageData.html delete mode 100644 docs/interfaces/TextureJSON.html delete mode 100644 docs/interfaces/Vector2Like.html delete mode 100644 docs/interfaces/Vector3Like.html delete mode 100644 docs/interfaces/Vector4Like.html delete mode 100644 docs/interfaces/VideoColorSpace.html delete mode 100644 docs/interfaces/VideoColorSpaceInit.html delete mode 100644 docs/interfaces/VideoFrame.html delete mode 100644 docs/interfaces/VideoFrameBufferInit.html delete mode 100644 docs/interfaces/VideoFrameCopyToOptions.html delete mode 100644 docs/interfaces/VideoFrameInit.html delete mode 100644 docs/interfaces/WebGLBuffer.html delete mode 100644 docs/interfaces/WebGLCapabilitiesParameters.html delete mode 100644 docs/interfaces/WebGLDebug.html delete mode 100644 docs/interfaces/WebGLFramebuffer.html delete mode 100644 docs/interfaces/WebGLProgramParameters.html delete mode 100644 docs/interfaces/WebGLProgramParametersWithUniforms.html delete mode 100644 docs/interfaces/WebGLRendererParameters.html delete mode 100644 docs/interfaces/WebGLShader.html delete mode 100644 docs/interfaces/WebGLTexture.html delete mode 100644 docs/interfaces/WebXRManagerEventMap.html delete mode 100644 docs/interfaces/WebXRSpaceEventMap.html delete mode 100644 docs/interfaces/XRCPUDepthInformation.html delete mode 100644 docs/interfaces/XRCompositionLayerEventMap.html delete mode 100644 docs/interfaces/XRCubeLayerInit.html delete mode 100644 docs/interfaces/XRCylinderLayerInit.html delete mode 100644 docs/interfaces/XRDOMOverlayState.html delete mode 100644 docs/interfaces/XRDepthInformation.html delete mode 100644 docs/interfaces/XREquirectLayerInit.html delete mode 100644 docs/interfaces/XRHandInputState.html delete mode 100644 docs/interfaces/XRHitResult.html delete mode 100644 docs/interfaces/XRHitTestOptionsInit.html delete mode 100644 docs/interfaces/XRInputSourceEventHandler.html delete mode 100644 docs/interfaces/XRInputSourceEventInit.html delete mode 100644 docs/interfaces/XRInputSourcesChangeEvent.html delete mode 100644 docs/interfaces/XRInputSourcesChangeEventHandler.html delete mode 100644 docs/interfaces/XRLayerEvent.html delete mode 100644 docs/interfaces/XRLayerInit.html delete mode 100644 docs/interfaces/XRProjectionLayerInit.html delete mode 100644 docs/interfaces/XRQuadLayerInit.html delete mode 100644 docs/interfaces/XRReferenceSpaceEventHandler.html delete mode 100644 docs/interfaces/XRReferenceSpaceEventInit.html delete mode 100644 docs/interfaces/XRReferenceSpaceEventMap.html delete mode 100644 docs/interfaces/XRRenderStateInit.html delete mode 100644 docs/interfaces/XRSessionEventHandler.html delete mode 100644 docs/interfaces/XRSessionEventInit.html delete mode 100644 docs/interfaces/XRSessionEventMap.html delete mode 100644 docs/interfaces/XRTransientInputHitTestOptionsInit.html delete mode 100644 docs/interfaces/XRWebGLDepthInformation.html delete mode 100644 docs/interfaces/XRWebGLLayerInit.html delete mode 100644 docs/types/AllowSharedBufferSource.html delete mode 100644 docs/types/AlphaOption.html delete mode 100644 docs/types/AnimationBlendMode.html delete mode 100644 docs/types/AnyMapping.html delete mode 100644 docs/types/AnyPixelFormat.html delete mode 100644 docs/types/ArrayBufferLike.html delete mode 100644 docs/types/AttributeGPUType.html delete mode 100644 docs/types/Blending.html delete mode 100644 docs/types/BlendingDstFactor.html delete mode 100644 docs/types/BlendingEquation.html delete mode 100644 docs/types/BlendingSrcFactor.html delete mode 100644 docs/types/BufferSource.html delete mode 100644 docs/types/BuiltinIteratorReturn.html delete mode 100644 docs/types/CanvasImageSource.html delete mode 100644 docs/types/ColorRepresentation.html delete mode 100644 docs/types/Combine.html delete mode 100644 docs/types/CompressedPixelFormat.html delete mode 100644 docs/types/CoordinateSystem.html delete mode 100644 docs/types/CubeTextureMapping.html delete mode 100644 docs/types/CullFace.html delete mode 100644 docs/types/DOMHighResTimeStamp.html delete mode 100644 docs/types/DepthModes.html delete mode 100644 docs/types/DepthPackingStrategies.html delete mode 100644 docs/types/DepthTexturePixelFormat.html delete mode 100644 docs/types/EulerOrder.html delete mode 100644 docs/types/EulerTuple.html delete mode 100644 docs/types/EventListener-1.html delete mode 100644 docs/types/EventListenerOrEventListenerObject.html delete mode 100644 docs/types/Exclude.html delete mode 100644 docs/types/GLSLVersion.html delete mode 100644 docs/types/HTMLOrSVGImageElement.html delete mode 100644 docs/types/InterpolationModes.html delete mode 100644 docs/types/IteratorResult.html delete mode 100644 docs/types/MagnificationTextureFilter.html delete mode 100644 docs/types/Mapping.html delete mode 100644 docs/types/Matrix3Tuple.html delete mode 100644 docs/types/Matrix4Tuple.html delete mode 100644 docs/types/MinificationTextureFilter.html delete mode 100644 docs/types/NormalBufferAttributes.html delete mode 100644 docs/types/NormalMapTypes.html delete mode 100644 docs/types/NormalOrGLBufferAttributes.html delete mode 100644 docs/types/Omit.html delete mode 100644 docs/types/Partial.html delete mode 100644 docs/types/Pick.html delete mode 100644 docs/types/PixelFormat.html delete mode 100644 docs/types/PixelFormatGPU.html delete mode 100644 docs/types/PredefinedColorSpace.html delete mode 100644 docs/types/QuaternionTuple.html delete mode 100644 docs/types/Record.html delete mode 100644 docs/types/SerializedImage.html delete mode 100644 docs/types/ShadowMapType.html delete mode 100644 docs/types/Side.html delete mode 100644 docs/types/StencilFunc.html delete mode 100644 docs/types/StencilOp.html delete mode 100644 docs/types/TexImageSource.html delete mode 100644 docs/types/TextureComparisonFunction.html delete mode 100644 docs/types/TextureDataType.html delete mode 100644 docs/types/ToneMapping.html delete mode 100644 docs/types/TypedArray.html delete mode 100644 docs/types/Usage.html delete mode 100644 docs/types/Vector2Tuple.html delete mode 100644 docs/types/Vector3Tuple.html delete mode 100644 docs/types/Vector4Tuple.html delete mode 100644 docs/types/VideoColorPrimaries.html delete mode 100644 docs/types/VideoMatrixCoefficients.html delete mode 100644 docs/types/VideoPixelFormat.html delete mode 100644 docs/types/VideoTransferCharacteristics.html delete mode 100644 docs/types/WebGLPowerPreference.html delete mode 100644 docs/types/WebXRArrayCamera.html delete mode 100644 docs/types/WebXRCamera.html delete mode 100644 docs/types/Wrapping.html delete mode 100644 docs/types/XRAnchorSet.html delete mode 100644 docs/types/XRControllerEventType.html delete mode 100644 docs/types/XRDOMOverlayType.html delete mode 100644 docs/types/XRDepthDataFormat.html delete mode 100644 docs/types/XRDepthUsage.html delete mode 100644 docs/types/XREnvironmentBlendMode.html delete mode 100644 docs/types/XREye.html delete mode 100644 docs/types/XRFrameRequestCallback.html delete mode 100644 docs/types/XRHandJoint.html delete mode 100644 docs/types/XRHandJoints.html delete mode 100644 docs/types/XRHandedness.html delete mode 100644 docs/types/XRHitTestTrackableType.html delete mode 100644 docs/types/XRInputSourceEventType.html delete mode 100644 docs/types/XRLayerLayout.html delete mode 100644 docs/types/XRLayerQuality.html delete mode 100644 docs/types/XRMeshSet.html delete mode 100644 docs/types/XRPlaneOrientation.html delete mode 100644 docs/types/XRPlaneSet.html delete mode 100644 docs/types/XRReferenceSpaceType.html delete mode 100644 docs/types/XRSessionEventType.html delete mode 100644 docs/types/XRTargetRayMode.html delete mode 100644 docs/types/XRTextureType.html delete mode 100644 docs/types/XRVisibilityState.html delete mode 100644 docs/variables/ACESFilmicToneMapping.html delete mode 100644 docs/variables/AddEquation.html delete mode 100644 docs/variables/AddOperation.html delete mode 100644 docs/variables/AdditiveAnimationBlendMode.html delete mode 100644 docs/variables/AdditiveBlending.html delete mode 100644 docs/variables/AgXToneMapping.html delete mode 100644 docs/variables/AlphaFormat.html delete mode 100644 docs/variables/AlwaysCompare.html delete mode 100644 docs/variables/AlwaysDepth.html delete mode 100644 docs/variables/AlwaysStencilFunc.html delete mode 100644 docs/variables/BackSide.html delete mode 100644 docs/variables/BasicDepthPacking.html delete mode 100644 docs/variables/BasicShadowMap.html delete mode 100644 docs/variables/ByteType.html delete mode 100644 docs/variables/CineonToneMapping.html delete mode 100644 docs/variables/ClampToEdgeWrapping.html delete mode 100644 docs/variables/ConstantAlphaFactor.html delete mode 100644 docs/variables/ConstantColorFactor.html delete mode 100644 docs/variables/CubeReflectionMapping.html delete mode 100644 docs/variables/CubeRefractionMapping.html delete mode 100644 docs/variables/CubeUVReflectionMapping.html delete mode 100644 docs/variables/CullFaceBack.html delete mode 100644 docs/variables/CullFaceFront.html delete mode 100644 docs/variables/CullFaceFrontBack.html delete mode 100644 docs/variables/CullFaceNone.html delete mode 100644 docs/variables/CustomBlending.html delete mode 100644 docs/variables/CustomToneMapping.html delete mode 100644 docs/variables/DOMPoint-1.html delete mode 100644 docs/variables/DOMPointReadOnly-1.html delete mode 100644 docs/variables/DOMRectReadOnly-1.html delete mode 100644 docs/variables/DecrementStencilOp.html delete mode 100644 docs/variables/DecrementWrapStencilOp.html delete mode 100644 docs/variables/DepthFormat.html delete mode 100644 docs/variables/DepthStencilFormat.html delete mode 100644 docs/variables/DoubleSide.html delete mode 100644 docs/variables/DstAlphaFactor.html delete mode 100644 docs/variables/DstColorFactor.html delete mode 100644 docs/variables/DynamicCopyUsage.html delete mode 100644 docs/variables/DynamicDrawUsage.html delete mode 100644 docs/variables/DynamicReadUsage.html delete mode 100644 docs/variables/EqualCompare.html delete mode 100644 docs/variables/EqualDepth.html delete mode 100644 docs/variables/EqualStencilFunc.html delete mode 100644 docs/variables/EquirectangularReflectionMapping.html delete mode 100644 docs/variables/EquirectangularRefractionMapping.html delete mode 100644 docs/variables/FloatType.html delete mode 100644 docs/variables/FrontSide.html delete mode 100644 docs/variables/GLSL1.html delete mode 100644 docs/variables/GLSL3.html delete mode 100644 docs/variables/GreaterCompare.html delete mode 100644 docs/variables/GreaterDepth.html delete mode 100644 docs/variables/GreaterEqualCompare.html delete mode 100644 docs/variables/GreaterEqualDepth.html delete mode 100644 docs/variables/GreaterEqualStencilFunc.html delete mode 100644 docs/variables/GreaterStencilFunc.html delete mode 100644 docs/variables/HalfFloatType.html delete mode 100644 docs/variables/ImageBitmap-1.html delete mode 100644 docs/variables/ImageData-1.html delete mode 100644 docs/variables/IncrementStencilOp.html delete mode 100644 docs/variables/IncrementWrapStencilOp.html delete mode 100644 docs/variables/IntType.html delete mode 100644 docs/variables/InterpolateDiscrete.html delete mode 100644 docs/variables/InterpolateLinear.html delete mode 100644 docs/variables/InterpolateSmooth.html delete mode 100644 docs/variables/InvertStencilOp.html delete mode 100644 docs/variables/KeepStencilOp.html delete mode 100644 docs/variables/LessCompare.html delete mode 100644 docs/variables/LessDepth.html delete mode 100644 docs/variables/LessEqualCompare.html delete mode 100644 docs/variables/LessEqualDepth.html delete mode 100644 docs/variables/LessEqualStencilFunc.html delete mode 100644 docs/variables/LessStencilFunc.html delete mode 100644 docs/variables/LinearFilter.html delete mode 100644 docs/variables/LinearMipMapLinearFilter-1.html delete mode 100644 docs/variables/LinearMipMapNearestFilter-1.html delete mode 100644 docs/variables/LinearMipmapLinearFilter.html delete mode 100644 docs/variables/LinearMipmapNearestFilter.html delete mode 100644 docs/variables/LinearToneMapping.html delete mode 100644 docs/variables/LuminanceAlphaFormat.html delete mode 100644 docs/variables/LuminanceFormat.html delete mode 100644 docs/variables/MaxEquation.html delete mode 100644 docs/variables/MinEquation.html delete mode 100644 docs/variables/MirroredRepeatWrapping.html delete mode 100644 docs/variables/MixOperation.html delete mode 100644 docs/variables/MultiplyBlending.html delete mode 100644 docs/variables/MultiplyOperation.html delete mode 100644 docs/variables/NearestFilter.html delete mode 100644 docs/variables/NearestMipMapLinearFilter-1.html delete mode 100644 docs/variables/NearestMipMapNearestFilter-1.html delete mode 100644 docs/variables/NearestMipmapLinearFilter.html delete mode 100644 docs/variables/NearestMipmapNearestFilter.html delete mode 100644 docs/variables/NeutralToneMapping.html delete mode 100644 docs/variables/NeverCompare.html delete mode 100644 docs/variables/NeverDepth.html delete mode 100644 docs/variables/NeverStencilFunc.html delete mode 100644 docs/variables/NoBlending.html delete mode 100644 docs/variables/NoToneMapping.html delete mode 100644 docs/variables/NormalAnimationBlendMode.html delete mode 100644 docs/variables/NormalBlending.html delete mode 100644 docs/variables/NotEqualCompare.html delete mode 100644 docs/variables/NotEqualDepth.html delete mode 100644 docs/variables/NotEqualStencilFunc.html delete mode 100644 docs/variables/ObjectSpaceNormalMap.html delete mode 100644 docs/variables/OneFactor.html delete mode 100644 docs/variables/OneMinusConstantAlphaFactor.html delete mode 100644 docs/variables/OneMinusConstantColorFactor.html delete mode 100644 docs/variables/OneMinusDstAlphaFactor.html delete mode 100644 docs/variables/OneMinusDstColorFactor.html delete mode 100644 docs/variables/OneMinusSrcAlphaFactor.html delete mode 100644 docs/variables/OneMinusSrcColorFactor.html delete mode 100644 docs/variables/PCFShadowMap.html delete mode 100644 docs/variables/PCFSoftShadowMap.html delete mode 100644 docs/variables/ProgressEvent-1.html delete mode 100644 docs/variables/RED_GREEN_RGTC2_Format.html delete mode 100644 docs/variables/RED_RGTC1_Format.html delete mode 100644 docs/variables/RGBADepthPacking.html delete mode 100644 docs/variables/RGBAFormat.html delete mode 100644 docs/variables/RGBAIntegerFormat.html delete mode 100644 docs/variables/RGBA_ASTC_10x10_Format.html delete mode 100644 docs/variables/RGBA_ASTC_10x5_Format.html delete mode 100644 docs/variables/RGBA_ASTC_10x6_Format.html delete mode 100644 docs/variables/RGBA_ASTC_10x8_Format.html delete mode 100644 docs/variables/RGBA_ASTC_12x10_Format.html delete mode 100644 docs/variables/RGBA_ASTC_12x12_Format.html delete mode 100644 docs/variables/RGBA_ASTC_4x4_Format.html delete mode 100644 docs/variables/RGBA_ASTC_5x4_Format.html delete mode 100644 docs/variables/RGBA_ASTC_5x5_Format.html delete mode 100644 docs/variables/RGBA_ASTC_6x5_Format.html delete mode 100644 docs/variables/RGBA_ASTC_6x6_Format.html delete mode 100644 docs/variables/RGBA_ASTC_8x5_Format.html delete mode 100644 docs/variables/RGBA_ASTC_8x6_Format.html delete mode 100644 docs/variables/RGBA_ASTC_8x8_Format.html delete mode 100644 docs/variables/RGBA_BPTC_Format.html delete mode 100644 docs/variables/RGBA_ETC2_EAC_Format.html delete mode 100644 docs/variables/RGBA_PVRTC_2BPPV1_Format.html delete mode 100644 docs/variables/RGBA_PVRTC_4BPPV1_Format.html delete mode 100644 docs/variables/RGBA_S3TC_DXT1_Format.html delete mode 100644 docs/variables/RGBA_S3TC_DXT3_Format.html delete mode 100644 docs/variables/RGBA_S3TC_DXT5_Format.html delete mode 100644 docs/variables/RGBDepthPacking.html delete mode 100644 docs/variables/RGBFormat.html delete mode 100644 docs/variables/RGBIntegerFormat.html delete mode 100644 docs/variables/RGB_BPTC_SIGNED_Format.html delete mode 100644 docs/variables/RGB_BPTC_UNSIGNED_Format.html delete mode 100644 docs/variables/RGB_ETC1_Format.html delete mode 100644 docs/variables/RGB_ETC2_Format.html delete mode 100644 docs/variables/RGB_PVRTC_2BPPV1_Format.html delete mode 100644 docs/variables/RGB_PVRTC_4BPPV1_Format.html delete mode 100644 docs/variables/RGB_S3TC_DXT1_Format.html delete mode 100644 docs/variables/RGDepthPacking.html delete mode 100644 docs/variables/RGFormat.html delete mode 100644 docs/variables/RGIntegerFormat.html delete mode 100644 docs/variables/RedFormat.html delete mode 100644 docs/variables/RedIntegerFormat.html delete mode 100644 docs/variables/ReinhardToneMapping.html delete mode 100644 docs/variables/RepeatWrapping.html delete mode 100644 docs/variables/ReplaceStencilOp.html delete mode 100644 docs/variables/ReverseSubtractEquation.html delete mode 100644 docs/variables/SIGNED_RED_GREEN_RGTC2_Format.html delete mode 100644 docs/variables/SIGNED_RED_RGTC1_Format.html delete mode 100644 docs/variables/ShortType.html delete mode 100644 docs/variables/SrcAlphaFactor.html delete mode 100644 docs/variables/SrcAlphaSaturateFactor.html delete mode 100644 docs/variables/SrcColorFactor.html delete mode 100644 docs/variables/StaticCopyUsage.html delete mode 100644 docs/variables/StaticDrawUsage.html delete mode 100644 docs/variables/StaticReadUsage.html delete mode 100644 docs/variables/StreamCopyUsage.html delete mode 100644 docs/variables/StreamDrawUsage.html delete mode 100644 docs/variables/StreamReadUsage.html delete mode 100644 docs/variables/SubtractEquation.html delete mode 100644 docs/variables/SubtractiveBlending.html delete mode 100644 docs/variables/TangentSpaceNormalMap.html delete mode 100644 docs/variables/UVMapping.html delete mode 100644 docs/variables/UnsignedByteType.html delete mode 100644 docs/variables/UnsignedInt248Type.html delete mode 100644 docs/variables/UnsignedInt5999Type.html delete mode 100644 docs/variables/UnsignedIntType.html delete mode 100644 docs/variables/UnsignedShort4444Type.html delete mode 100644 docs/variables/UnsignedShort5551Type.html delete mode 100644 docs/variables/UnsignedShortType.html delete mode 100644 docs/variables/VSMShadowMap.html delete mode 100644 docs/variables/VideoColorSpace-1.html delete mode 100644 docs/variables/VideoFrame-1.html delete mode 100644 docs/variables/WebGLBuffer-1.html delete mode 100644 docs/variables/WebGLCoordinateSystem.html delete mode 100644 docs/variables/WebGLFramebuffer-1.html delete mode 100644 docs/variables/WebGLShader-1.html delete mode 100644 docs/variables/WebGLTexture-1.html delete mode 100644 docs/variables/WebGPUCoordinateSystem.html delete mode 100644 docs/variables/ZeroFactor.html delete mode 100644 docs/variables/ZeroStencilOp.html diff --git a/assets/docs-Vp-jV-V4.css b/assets/docs-DnDp3ZPO.css similarity index 85% rename from assets/docs-Vp-jV-V4.css rename to assets/docs-DnDp3ZPO.css index 2edbde5..197e847 100644 --- a/assets/docs-Vp-jV-V4.css +++ b/assets/docs-DnDp3ZPO.css @@ -1 +1 @@ -@layer typedoc{:root{--light-color-background: #f2f4f8;--light-color-background-secondary: #eff0f1;--light-color-warning-text: #222;--light-color-background-warning: #e6e600;--light-color-accent: #c5c7c9;--light-color-active-menu-item: var(--light-color-accent);--light-color-text: #222;--light-color-text-aside: #6e6e6e;--light-color-icon-background: var(--light-color-background);--light-color-icon-text: var(--light-color-text);--light-color-comment-tag-text: var(--light-color-text);--light-color-comment-tag: var(--light-color-background);--light-color-link: #1f70c2;--light-color-focus-outline: #3584e4;--light-color-ts-keyword: #056bd6;--light-color-ts-project: #b111c9;--light-color-ts-module: var(--light-color-ts-project);--light-color-ts-namespace: var(--light-color-ts-project);--light-color-ts-enum: #7e6f15;--light-color-ts-enum-member: var(--light-color-ts-enum);--light-color-ts-variable: #4760ec;--light-color-ts-function: #572be7;--light-color-ts-class: #1f70c2;--light-color-ts-interface: #108024;--light-color-ts-constructor: var(--light-color-ts-class);--light-color-ts-property: #9f5f30;--light-color-ts-method: #be3989;--light-color-ts-reference: #ff4d82;--light-color-ts-call-signature: var(--light-color-ts-method);--light-color-ts-index-signature: var(--light-color-ts-property);--light-color-ts-constructor-signature: var( --light-color-ts-constructor );--light-color-ts-parameter: var(--light-color-ts-variable);--light-color-ts-type-parameter: #a55c0e;--light-color-ts-accessor: #c73c3c;--light-color-ts-get-signature: var(--light-color-ts-accessor);--light-color-ts-set-signature: var(--light-color-ts-accessor);--light-color-ts-type-alias: #d51270;--light-color-document: #000000;--light-color-alert-note: #0969d9;--light-color-alert-tip: #1a7f37;--light-color-alert-important: #8250df;--light-color-alert-warning: #9a6700;--light-color-alert-caution: #cf222e;--light-external-icon: url("data:image/svg+xml;utf8,");--light-color-scheme: light;--dark-color-background: #2b2e33;--dark-color-background-secondary: #1e2024;--dark-color-background-warning: #bebe00;--dark-color-warning-text: #222;--dark-color-accent: #9096a2;--dark-color-active-menu-item: #5d5d6a;--dark-color-text: #f5f5f5;--dark-color-text-aside: #dddddd;--dark-color-icon-background: var(--dark-color-background-secondary);--dark-color-icon-text: var(--dark-color-text);--dark-color-comment-tag-text: var(--dark-color-text);--dark-color-comment-tag: var(--dark-color-background);--dark-color-link: #00aff4;--dark-color-focus-outline: #4c97f2;--dark-color-ts-keyword: #3399ff;--dark-color-ts-project: #e358ff;--dark-color-ts-module: var(--dark-color-ts-project);--dark-color-ts-namespace: var(--dark-color-ts-project);--dark-color-ts-enum: #f4d93e;--dark-color-ts-enum-member: var(--dark-color-ts-enum);--dark-color-ts-variable: #798dff;--dark-color-ts-function: #a280ff;--dark-color-ts-class: #8ac4ff;--dark-color-ts-interface: #6cff87;--dark-color-ts-constructor: var(--dark-color-ts-class);--dark-color-ts-property: #ff984d;--dark-color-ts-method: #ff4db8;--dark-color-ts-reference: #ff4d82;--dark-color-ts-call-signature: var(--dark-color-ts-method);--dark-color-ts-index-signature: var(--dark-color-ts-property);--dark-color-ts-constructor-signature: var(--dark-color-ts-constructor);--dark-color-ts-parameter: var(--dark-color-ts-variable);--dark-color-ts-type-parameter: #e07d13;--dark-color-ts-accessor: #ff6060;--dark-color-ts-get-signature: var(--dark-color-ts-accessor);--dark-color-ts-set-signature: var(--dark-color-ts-accessor);--dark-color-ts-type-alias: #ff6492;--dark-color-document: #ffffff;--dark-color-alert-note: #0969d9;--dark-color-alert-tip: #1a7f37;--dark-color-alert-important: #8250df;--dark-color-alert-warning: #9a6700;--dark-color-alert-caution: #cf222e;--dark-external-icon: url("data:image/svg+xml;utf8,");--dark-color-scheme: dark}@media (prefers-color-scheme: light){:root{--color-background: var(--light-color-background);--color-background-secondary: var( --light-color-background-secondary );--color-background-warning: var(--light-color-background-warning);--color-warning-text: var(--light-color-warning-text);--color-accent: var(--light-color-accent);--color-active-menu-item: var(--light-color-active-menu-item);--color-text: var(--light-color-text);--color-text-aside: var(--light-color-text-aside);--color-icon-background: var(--light-color-icon-background);--color-icon-text: var(--light-color-icon-text);--color-comment-tag-text: var(--light-color-text);--color-comment-tag: var(--light-color-background);--color-link: var(--light-color-link);--color-focus-outline: var(--light-color-focus-outline);--color-ts-keyword: var(--light-color-ts-keyword);--color-ts-project: var(--light-color-ts-project);--color-ts-module: var(--light-color-ts-module);--color-ts-namespace: var(--light-color-ts-namespace);--color-ts-enum: var(--light-color-ts-enum);--color-ts-enum-member: var(--light-color-ts-enum-member);--color-ts-variable: var(--light-color-ts-variable);--color-ts-function: var(--light-color-ts-function);--color-ts-class: var(--light-color-ts-class);--color-ts-interface: var(--light-color-ts-interface);--color-ts-constructor: var(--light-color-ts-constructor);--color-ts-property: var(--light-color-ts-property);--color-ts-method: var(--light-color-ts-method);--color-ts-reference: var(--light-color-ts-reference);--color-ts-call-signature: var(--light-color-ts-call-signature);--color-ts-index-signature: var(--light-color-ts-index-signature);--color-ts-constructor-signature: var( --light-color-ts-constructor-signature );--color-ts-parameter: var(--light-color-ts-parameter);--color-ts-type-parameter: var(--light-color-ts-type-parameter);--color-ts-accessor: var(--light-color-ts-accessor);--color-ts-get-signature: var(--light-color-ts-get-signature);--color-ts-set-signature: var(--light-color-ts-set-signature);--color-ts-type-alias: var(--light-color-ts-type-alias);--color-document: var(--light-color-document);--color-alert-note: var(--light-color-alert-note);--color-alert-tip: var(--light-color-alert-tip);--color-alert-important: var(--light-color-alert-important);--color-alert-warning: var(--light-color-alert-warning);--color-alert-caution: var(--light-color-alert-caution);--external-icon: var(--light-external-icon);--color-scheme: var(--light-color-scheme)}}@media (prefers-color-scheme: dark){:root{--color-background: var(--dark-color-background);--color-background-secondary: var( --dark-color-background-secondary );--color-background-warning: var(--dark-color-background-warning);--color-warning-text: var(--dark-color-warning-text);--color-accent: var(--dark-color-accent);--color-active-menu-item: var(--dark-color-active-menu-item);--color-text: var(--dark-color-text);--color-text-aside: var(--dark-color-text-aside);--color-icon-background: var(--dark-color-icon-background);--color-icon-text: var(--dark-color-icon-text);--color-comment-tag-text: var(--dark-color-text);--color-comment-tag: var(--dark-color-background);--color-link: var(--dark-color-link);--color-focus-outline: var(--dark-color-focus-outline);--color-ts-keyword: var(--dark-color-ts-keyword);--color-ts-project: var(--dark-color-ts-project);--color-ts-module: var(--dark-color-ts-module);--color-ts-namespace: var(--dark-color-ts-namespace);--color-ts-enum: var(--dark-color-ts-enum);--color-ts-enum-member: var(--dark-color-ts-enum-member);--color-ts-variable: var(--dark-color-ts-variable);--color-ts-function: var(--dark-color-ts-function);--color-ts-class: var(--dark-color-ts-class);--color-ts-interface: var(--dark-color-ts-interface);--color-ts-constructor: var(--dark-color-ts-constructor);--color-ts-property: var(--dark-color-ts-property);--color-ts-method: var(--dark-color-ts-method);--color-ts-reference: var(--dark-color-ts-reference);--color-ts-call-signature: var(--dark-color-ts-call-signature);--color-ts-index-signature: var(--dark-color-ts-index-signature);--color-ts-constructor-signature: var( --dark-color-ts-constructor-signature );--color-ts-parameter: var(--dark-color-ts-parameter);--color-ts-type-parameter: var(--dark-color-ts-type-parameter);--color-ts-accessor: var(--dark-color-ts-accessor);--color-ts-get-signature: var(--dark-color-ts-get-signature);--color-ts-set-signature: var(--dark-color-ts-set-signature);--color-ts-type-alias: var(--dark-color-ts-type-alias);--color-document: var(--dark-color-document);--color-alert-note: var(--dark-color-alert-note);--color-alert-tip: var(--dark-color-alert-tip);--color-alert-important: var(--dark-color-alert-important);--color-alert-warning: var(--dark-color-alert-warning);--color-alert-caution: var(--dark-color-alert-caution);--external-icon: var(--dark-external-icon);--color-scheme: var(--dark-color-scheme)}}html{color-scheme:var(--color-scheme)}body{margin:0}:root[data-theme=light]{--color-background: var(--light-color-background);--color-background-secondary: var(--light-color-background-secondary);--color-background-warning: var(--light-color-background-warning);--color-warning-text: var(--light-color-warning-text);--color-icon-background: var(--light-color-icon-background);--color-accent: var(--light-color-accent);--color-active-menu-item: var(--light-color-active-menu-item);--color-text: var(--light-color-text);--color-text-aside: var(--light-color-text-aside);--color-icon-text: var(--light-color-icon-text);--color-comment-tag-text: var(--light-color-text);--color-comment-tag: var(--light-color-background);--color-link: var(--light-color-link);--color-focus-outline: var(--light-color-focus-outline);--color-ts-keyword: var(--light-color-ts-keyword);--color-ts-project: var(--light-color-ts-project);--color-ts-module: var(--light-color-ts-module);--color-ts-namespace: var(--light-color-ts-namespace);--color-ts-enum: var(--light-color-ts-enum);--color-ts-enum-member: var(--light-color-ts-enum-member);--color-ts-variable: var(--light-color-ts-variable);--color-ts-function: var(--light-color-ts-function);--color-ts-class: var(--light-color-ts-class);--color-ts-interface: var(--light-color-ts-interface);--color-ts-constructor: var(--light-color-ts-constructor);--color-ts-property: var(--light-color-ts-property);--color-ts-method: var(--light-color-ts-method);--color-ts-reference: var(--light-color-ts-reference);--color-ts-call-signature: var(--light-color-ts-call-signature);--color-ts-index-signature: var(--light-color-ts-index-signature);--color-ts-constructor-signature: var( --light-color-ts-constructor-signature );--color-ts-parameter: var(--light-color-ts-parameter);--color-ts-type-parameter: var(--light-color-ts-type-parameter);--color-ts-accessor: var(--light-color-ts-accessor);--color-ts-get-signature: var(--light-color-ts-get-signature);--color-ts-set-signature: var(--light-color-ts-set-signature);--color-ts-type-alias: var(--light-color-ts-type-alias);--color-document: var(--light-color-document);--color-note: var(--light-color-note);--color-tip: var(--light-color-tip);--color-important: var(--light-color-important);--color-warning: var(--light-color-warning);--color-caution: var(--light-color-caution);--external-icon: var(--light-external-icon);--color-scheme: var(--light-color-scheme)}:root[data-theme=dark]{--color-background: var(--dark-color-background);--color-background-secondary: var(--dark-color-background-secondary);--color-background-warning: var(--dark-color-background-warning);--color-warning-text: var(--dark-color-warning-text);--color-icon-background: var(--dark-color-icon-background);--color-accent: var(--dark-color-accent);--color-active-menu-item: var(--dark-color-active-menu-item);--color-text: var(--dark-color-text);--color-text-aside: var(--dark-color-text-aside);--color-icon-text: var(--dark-color-icon-text);--color-comment-tag-text: var(--dark-color-text);--color-comment-tag: var(--dark-color-background);--color-link: var(--dark-color-link);--color-focus-outline: var(--dark-color-focus-outline);--color-ts-keyword: var(--dark-color-ts-keyword);--color-ts-project: var(--dark-color-ts-project);--color-ts-module: var(--dark-color-ts-module);--color-ts-namespace: var(--dark-color-ts-namespace);--color-ts-enum: var(--dark-color-ts-enum);--color-ts-enum-member: var(--dark-color-ts-enum-member);--color-ts-variable: var(--dark-color-ts-variable);--color-ts-function: var(--dark-color-ts-function);--color-ts-class: var(--dark-color-ts-class);--color-ts-interface: var(--dark-color-ts-interface);--color-ts-constructor: var(--dark-color-ts-constructor);--color-ts-property: var(--dark-color-ts-property);--color-ts-method: var(--dark-color-ts-method);--color-ts-reference: var(--dark-color-ts-reference);--color-ts-call-signature: var(--dark-color-ts-call-signature);--color-ts-index-signature: var(--dark-color-ts-index-signature);--color-ts-constructor-signature: var( --dark-color-ts-constructor-signature );--color-ts-parameter: var(--dark-color-ts-parameter);--color-ts-type-parameter: var(--dark-color-ts-type-parameter);--color-ts-accessor: var(--dark-color-ts-accessor);--color-ts-get-signature: var(--dark-color-ts-get-signature);--color-ts-set-signature: var(--dark-color-ts-set-signature);--color-ts-type-alias: var(--dark-color-ts-type-alias);--color-document: var(--dark-color-document);--color-note: var(--dark-color-note);--color-tip: var(--dark-color-tip);--color-important: var(--dark-color-important);--color-warning: var(--dark-color-warning);--color-caution: var(--dark-color-caution);--external-icon: var(--dark-external-icon);--color-scheme: var(--dark-color-scheme)}*:focus-visible,.tsd-accordion-summary:focus-visible svg{outline:2px solid var(--color-focus-outline)}.always-visible,.always-visible .tsd-signatures{display:inherit!important}h1,h2,h3,h4,h5,h6{line-height:1.2}h1{font-size:1.875rem;margin:.67rem 0}h2{font-size:1.5rem;margin:.83rem 0}h3{font-size:1.25rem;margin:1rem 0}h4{font-size:1.05rem;margin:1.33rem 0}h5{font-size:1rem;margin:1.5rem 0}h6{font-size:.875rem;margin:2.33rem 0}dl,menu,ol,ul{margin:1em 0}dd{margin:0 0 0 34px}.container{max-width:1700px;padding:0 2rem}footer{border-top:1px solid var(--color-accent);padding-top:1rem;padding-bottom:1rem;max-height:3.5rem}footer>p{margin:0 1em}.container-main{margin:0 auto;min-height:calc(100vh - 97px - 4rem)}@keyframes fade-in{0%{opacity:0}to{opacity:1}}@keyframes fade-out{0%{opacity:1;visibility:visible}to{opacity:0}}@keyframes fade-in-delayed{0%{opacity:0}33%{opacity:0}to{opacity:1}}@keyframes fade-out-delayed{0%{opacity:1;visibility:visible}66%{opacity:0}to{opacity:0}}@keyframes pop-in-from-right{0%{transform:translate(100%)}to{transform:translate(0)}}@keyframes pop-out-to-right{0%{transform:translate(0);visibility:visible}to{transform:translate(100%)}}body{background:var(--color-background);font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Noto Sans,Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji";font-size:16px;color:var(--color-text)}a{color:var(--color-link);text-decoration:none}a:hover{text-decoration:underline}a.external[target=_blank]{background-image:var(--external-icon);background-position:top 3px right;background-repeat:no-repeat;padding-right:13px}a.tsd-anchor-link{color:var(--color-text)}code,pre{font-family:Menlo,Monaco,Consolas,Courier New,monospace;padding:.2em;margin:0;font-size:.875rem;border-radius:.8em}pre{position:relative;white-space:pre-wrap;word-wrap:break-word;padding:10px;border:1px solid var(--color-accent);margin-bottom:8px}pre code{padding:0;font-size:100%}pre>button{position:absolute;top:10px;right:10px;opacity:0;transition:opacity .1s;box-sizing:border-box}pre:hover>button,pre>button.visible{opacity:1}blockquote{margin:1em 0;padding-left:1em;border-left:4px solid gray}.tsd-typography{line-height:1.333em}.tsd-typography ul{list-style:square;padding:0 0 0 20px;margin:0}.tsd-typography .tsd-index-panel h3,.tsd-index-panel .tsd-typography h3,.tsd-typography h4,.tsd-typography h5,.tsd-typography h6{font-size:1em}.tsd-typography h5,.tsd-typography h6{font-weight:400}.tsd-typography p,.tsd-typography ul,.tsd-typography ol{margin:1em 0}.tsd-typography table{border-collapse:collapse;border:none}.tsd-typography td,.tsd-typography th{padding:6px 13px;border:1px solid var(--color-accent)}.tsd-typography thead,.tsd-typography tr:nth-child(2n){background-color:var(--color-background-secondary)}.tsd-alert{padding:8px 16px;margin-bottom:16px;border-left:.25em solid var(--alert-color)}.tsd-alert blockquote>:last-child,.tsd-alert>:last-child{margin-bottom:0}.tsd-alert-title{color:var(--alert-color);display:inline-flex;align-items:center}.tsd-alert-title span{margin-left:4px}.tsd-alert-note{--alert-color: var(--color-alert-note)}.tsd-alert-tip{--alert-color: var(--color-alert-tip)}.tsd-alert-important{--alert-color: var(--color-alert-important)}.tsd-alert-warning{--alert-color: var(--color-alert-warning)}.tsd-alert-caution{--alert-color: var(--color-alert-caution)}.tsd-breadcrumb{margin:0;padding:0;color:var(--color-text-aside)}.tsd-breadcrumb a{color:var(--color-text-aside);text-decoration:none}.tsd-breadcrumb a:hover{text-decoration:underline}.tsd-breadcrumb li{display:inline}.tsd-breadcrumb li:after{content:" / "}.tsd-comment-tags{display:flex;flex-direction:column}dl.tsd-comment-tag-group{display:flex;align-items:center;overflow:hidden;margin:.5em 0}dl.tsd-comment-tag-group dt{display:flex;margin-right:.5em;font-size:.875em;font-weight:400}dl.tsd-comment-tag-group dd{margin:0}code.tsd-tag{padding:.25em .4em;border:.1em solid var(--color-accent);margin-right:.25em;font-size:70%}h1 code.tsd-tag:first-of-type{margin-left:.25em}dl.tsd-comment-tag-group dd:before,dl.tsd-comment-tag-group dd:after{content:" "}dl.tsd-comment-tag-group dd pre,dl.tsd-comment-tag-group dd:after{clear:both}dl.tsd-comment-tag-group p{margin:0}.tsd-panel.tsd-comment .lead{font-size:1.1em;line-height:1.333em;margin-bottom:2em}.tsd-panel.tsd-comment .lead:last-child{margin-bottom:0}.tsd-filter-visibility h4{font-size:1rem;padding-top:.75rem;padding-bottom:.5rem;margin:0}.tsd-filter-item:not(:last-child){margin-bottom:.5rem}.tsd-filter-input{display:flex;width:-moz-fit-content;width:fit-content;align-items:center;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;cursor:pointer}.tsd-filter-input input[type=checkbox]{cursor:pointer;position:absolute;width:1.5em;height:1.5em;opacity:0}.tsd-filter-input input[type=checkbox]:disabled{pointer-events:none}.tsd-filter-input svg{cursor:pointer;width:1.5em;height:1.5em;margin-right:.5em;border-radius:.33em;opacity:.99}.tsd-filter-input input[type=checkbox]:focus-visible+svg{outline:2px solid var(--color-focus-outline)}.tsd-checkbox-background{fill:var(--color-accent)}input[type=checkbox]:checked~svg .tsd-checkbox-checkmark{stroke:var(--color-text)}.tsd-filter-input input:disabled~svg>.tsd-checkbox-background{fill:var(--color-background);stroke:var(--color-accent);stroke-width:.25rem}.tsd-filter-input input:disabled~svg>.tsd-checkbox-checkmark{stroke:var(--color-accent)}.settings-label{font-weight:700;text-transform:uppercase;display:inline-block}.tsd-filter-visibility .settings-label{margin:.75rem 0 .5rem}.tsd-theme-toggle .settings-label{margin:.75rem .75rem 0 0}.tsd-hierarchy h4 label:hover span{text-decoration:underline}.tsd-hierarchy{list-style:square;margin:0}.tsd-hierarchy-target{font-weight:700}.tsd-hierarchy-toggle{color:var(--color-link);cursor:pointer}.tsd-full-hierarchy:not(:last-child){margin-bottom:1em;padding-bottom:1em;border-bottom:1px solid var(--color-accent)}.tsd-full-hierarchy,.tsd-full-hierarchy ul{list-style:none;margin:0;padding:0}.tsd-full-hierarchy ul{padding-left:1.5rem}.tsd-full-hierarchy a{padding:.25rem 0!important;font-size:1rem;display:inline-flex;align-items:center;color:var(--color-text)}.tsd-full-hierarchy svg[data-dropdown]{cursor:pointer}.tsd-full-hierarchy svg[data-dropdown=false]{transform:rotate(-90deg)}.tsd-full-hierarchy svg[data-dropdown=false]~ul{display:none}.tsd-panel-group.tsd-index-group{margin-bottom:0}.tsd-index-panel .tsd-index-list{list-style:none;line-height:1.333em;margin:0;padding:.25rem 0 0;overflow:hidden;display:grid;grid-template-columns:repeat(3,1fr);column-gap:1rem;grid-template-rows:auto}@media (max-width: 1024px){.tsd-index-panel .tsd-index-list{grid-template-columns:repeat(2,1fr)}}@media (max-width: 768px){.tsd-index-panel .tsd-index-list{grid-template-columns:repeat(1,1fr)}}.tsd-index-panel .tsd-index-list li{-webkit-page-break-inside:avoid;-moz-page-break-inside:avoid;-ms-page-break-inside:avoid;-o-page-break-inside:avoid;page-break-inside:avoid}.tsd-flag{display:inline-block;padding:.25em .4em;border-radius:4px;color:var(--color-comment-tag-text);background-color:var(--color-comment-tag);text-indent:0;font-size:75%;line-height:1;font-weight:400}.tsd-anchor{position:relative;top:-100px}.tsd-member{position:relative}.tsd-member .tsd-anchor+h3{display:flex;align-items:center;margin-top:0;margin-bottom:0;border-bottom:none}.tsd-navigation.settings{margin:1rem 0}.tsd-navigation>a,.tsd-navigation .tsd-accordion-summary{width:calc(100% - .25rem);display:flex;align-items:center}.tsd-navigation a,.tsd-navigation summary>span,.tsd-page-navigation a{display:flex;width:calc(100% - .25rem);align-items:center;padding:.25rem;color:var(--color-text);text-decoration:none;box-sizing:border-box}.tsd-navigation a.current,.tsd-page-navigation a.current{background:var(--color-active-menu-item)}.tsd-navigation a:hover,.tsd-page-navigation a:hover{text-decoration:underline}.tsd-navigation ul,.tsd-page-navigation ul{margin-top:0;margin-bottom:0;padding:0;list-style:none}.tsd-navigation li,.tsd-page-navigation li{padding:0;max-width:100%}.tsd-navigation .tsd-nav-link{display:none}.tsd-nested-navigation{margin-left:3rem}.tsd-nested-navigation>li>details{margin-left:-1.5rem}.tsd-small-nested-navigation{margin-left:1.5rem}.tsd-small-nested-navigation>li>details{margin-left:-1.5rem}.tsd-page-navigation-section{margin-left:10px}.tsd-page-navigation-section>summary{padding:.25rem}.tsd-page-navigation-section>div{margin-left:20px}.tsd-page-navigation ul{padding-left:1.75rem}#tsd-sidebar-links a{margin-top:0;margin-bottom:.5rem;line-height:1.25rem}#tsd-sidebar-links a:last-of-type{margin-bottom:0}a.tsd-index-link{padding:.25rem 0!important;font-size:1rem;line-height:1.25rem;display:inline-flex;align-items:center;color:var(--color-text)}.tsd-accordion-summary{list-style-type:none;outline:none}.tsd-accordion-summary::-webkit-details-marker{display:none}.tsd-accordion-summary,.tsd-accordion-summary a{-moz-user-select:none;-webkit-user-select:none;-ms-user-select:none;user-select:none;cursor:pointer}.tsd-accordion-summary a{width:calc(100% - 1.5rem)}.tsd-accordion-summary>*{margin-top:0;margin-bottom:0;padding-top:0;padding-bottom:0}.tsd-accordion .tsd-accordion-summary>svg{margin-left:.25rem;vertical-align:text-top}.tsd-accordion:not([open])>.tsd-accordion-summary>svg:first-child,.tsd-accordion:not([open])>.tsd-accordion-summary>h1>svg:first-child,.tsd-accordion:not([open])>.tsd-accordion-summary>h2>svg:first-child,.tsd-accordion:not([open])>.tsd-accordion-summary>h3>svg:first-child,.tsd-accordion:not([open])>.tsd-accordion-summary>h4>svg:first-child{transform:rotate(-90deg)}.tsd-index-content>:not(:first-child){margin-top:.75rem}.tsd-index-heading{margin-top:1.5rem;margin-bottom:.75rem}.tsd-no-select{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.tsd-kind-icon{margin-right:.5rem;width:1.25rem;height:1.25rem;min-width:1.25rem;min-height:1.25rem}.tsd-signature>.tsd-kind-icon{margin-right:.8rem}.tsd-panel{margin-bottom:2.5rem}.tsd-panel.tsd-member{margin-bottom:4rem}.tsd-panel:empty{display:none}.tsd-panel>h1,.tsd-panel>h2,.tsd-panel>h3{margin:1.5rem -1.5rem .75rem;padding:0 1.5rem .75rem}.tsd-panel>h1.tsd-before-signature,.tsd-panel>h2.tsd-before-signature,.tsd-panel>h3.tsd-before-signature{margin-bottom:0;border-bottom:none}.tsd-panel-group,.tsd-panel-group.tsd-index-group{margin:2rem 0}.tsd-panel-group.tsd-index-group details{margin:2rem 0}.tsd-panel-group>.tsd-accordion-summary{margin-bottom:1rem}#tsd-search{transition:background-color .2s}#tsd-search .title{position:relative;z-index:2}#tsd-search .field{position:absolute;left:0;top:0;right:2.5rem;height:100%}#tsd-search .field input{box-sizing:border-box;position:relative;top:-50px;z-index:1;width:100%;padding:0 10px;opacity:0;outline:0;border:0;background:transparent;color:var(--color-text)}#tsd-search .field label{position:absolute;overflow:hidden;right:-40px}#tsd-search .field input,#tsd-search .title,#tsd-toolbar-links a{transition:opacity .2s}#tsd-search .results{position:absolute;visibility:hidden;top:40px;width:100%;margin:0;padding:0;list-style:none;box-shadow:0 0 4px #00000040}#tsd-search .results li{background-color:var(--color-background);line-height:initial;padding:4px}#tsd-search .results li:nth-child(2n){background-color:var(--color-background-secondary)}#tsd-search .results li.state{display:none}#tsd-search .results li.current:not(.no-results),#tsd-search .results li:hover:not(.no-results){background-color:var(--color-accent)}#tsd-search .results a{display:flex;align-items:center;padding:.25rem;box-sizing:border-box}#tsd-search .results a:before{top:10px}#tsd-search .results span.parent{color:var(--color-text-aside);font-weight:400}#tsd-search.has-focus{background-color:var(--color-accent)}#tsd-search.has-focus .field input{top:0;opacity:1}#tsd-search.has-focus .title,#tsd-search.has-focus #tsd-toolbar-links a{z-index:0;opacity:0}#tsd-search.has-focus .results{visibility:visible}#tsd-search.loading .results li.state.loading,#tsd-search.failure .results li.state.failure{display:block}#tsd-toolbar-links{position:absolute;top:0;right:2rem;height:100%;display:flex;align-items:center;justify-content:flex-end}#tsd-toolbar-links a{margin-left:1.5rem}#tsd-toolbar-links a:hover{text-decoration:underline}.tsd-signature{margin:0 0 1rem;padding:1rem .5rem;border:1px solid var(--color-accent);font-family:Menlo,Monaco,Consolas,Courier New,monospace;font-size:14px;overflow-x:auto}.tsd-signature-keyword{color:var(--color-ts-keyword);font-weight:400}.tsd-signature-symbol{color:var(--color-text-aside);font-weight:400}.tsd-signature-type{font-style:italic;font-weight:400}.tsd-signatures{padding:0;margin:0 0 1em;list-style-type:none}.tsd-signatures .tsd-signature{margin:0;border-color:var(--color-accent);border-width:1px 0;transition:background-color .1s}.tsd-signatures .tsd-index-signature:not(:last-child){margin-bottom:1em}.tsd-signatures .tsd-index-signature .tsd-signature,.tsd-description .tsd-signatures .tsd-signature{border-width:1px}ul.tsd-parameter-list,ul.tsd-type-parameter-list{list-style:square;margin:0;padding-left:20px}ul.tsd-parameter-list>li.tsd-parameter-signature,ul.tsd-type-parameter-list>li.tsd-parameter-signature{list-style:none;margin-left:-20px}ul.tsd-parameter-list h5,ul.tsd-type-parameter-list h5{font-size:16px;margin:1em 0 .5em}.tsd-sources{margin-top:1rem;font-size:.875em}.tsd-sources a{color:var(--color-text-aside);text-decoration:underline}.tsd-sources ul{list-style:none;padding:0}.tsd-page-toolbar{position:sticky;z-index:1;top:0;left:0;width:100%;color:var(--color-text);background:var(--color-background-secondary);border-bottom:1px var(--color-accent) solid;transition:transform .3s ease-in-out}.tsd-page-toolbar a{color:var(--color-text);text-decoration:none}.tsd-page-toolbar a.title{font-weight:700}.tsd-page-toolbar a.title:hover{text-decoration:underline}.tsd-page-toolbar .tsd-toolbar-contents{display:flex;justify-content:space-between;height:2.5rem;margin:0 auto}.tsd-page-toolbar .table-cell{position:relative;white-space:nowrap;line-height:40px}.tsd-page-toolbar .table-cell:first-child{width:100%}.tsd-page-toolbar .tsd-toolbar-icon{box-sizing:border-box;line-height:0;padding:12px 0}.tsd-widget{display:inline-block;overflow:hidden;opacity:.8;height:40px;transition:opacity .1s,background-color .2s;vertical-align:bottom;cursor:pointer}.tsd-widget:hover{opacity:.9}.tsd-widget.active{opacity:1;background-color:var(--color-accent)}.tsd-widget.no-caption{width:40px}.tsd-widget.no-caption:before{margin:0}.tsd-widget.options,.tsd-widget.menu{display:none}input[type=checkbox]+.tsd-widget:before{background-position:-120px 0}input[type=checkbox]:checked+.tsd-widget:before{background-position:-160px 0}img{max-width:100%}.tsd-member-summary-name{display:inline-flex;align-items:center;padding:.25rem;text-decoration:none}.tsd-anchor-icon{display:inline-flex;align-items:center;margin-left:.5rem;color:var(--color-text)}.tsd-anchor-icon svg{width:1em;height:1em;visibility:hidden}.tsd-member-summary-name:hover>.tsd-anchor-icon svg,.tsd-anchor-link:hover>.tsd-anchor-icon svg{visibility:visible}.deprecated{text-decoration:line-through!important}.warning{padding:1rem;color:var(--color-warning-text);background:var(--color-background-warning)}.tsd-kind-project{color:var(--color-ts-project)}.tsd-kind-module{color:var(--color-ts-module)}.tsd-kind-namespace{color:var(--color-ts-namespace)}.tsd-kind-enum{color:var(--color-ts-enum)}.tsd-kind-enum-member{color:var(--color-ts-enum-member)}.tsd-kind-variable{color:var(--color-ts-variable)}.tsd-kind-function{color:var(--color-ts-function)}.tsd-kind-class{color:var(--color-ts-class)}.tsd-kind-interface{color:var(--color-ts-interface)}.tsd-kind-constructor{color:var(--color-ts-constructor)}.tsd-kind-property{color:var(--color-ts-property)}.tsd-kind-method{color:var(--color-ts-method)}.tsd-kind-reference{color:var(--color-ts-reference)}.tsd-kind-call-signature{color:var(--color-ts-call-signature)}.tsd-kind-index-signature{color:var(--color-ts-index-signature)}.tsd-kind-constructor-signature{color:var(--color-ts-constructor-signature)}.tsd-kind-parameter{color:var(--color-ts-parameter)}.tsd-kind-type-parameter{color:var(--color-ts-type-parameter)}.tsd-kind-accessor{color:var(--color-ts-accessor)}.tsd-kind-get-signature{color:var(--color-ts-get-signature)}.tsd-kind-set-signature{color:var(--color-ts-set-signature)}.tsd-kind-type-alias{color:var(--color-ts-type-alias)}.tsd-kind-icon~span{color:var(--color-text)}*{scrollbar-width:thin;scrollbar-color:var(--color-accent) var(--color-icon-background)}*::-webkit-scrollbar{width:.75rem}*::-webkit-scrollbar-track{background:var(--color-icon-background)}*::-webkit-scrollbar-thumb{background-color:var(--color-accent);border-radius:999rem;border:.25rem solid var(--color-icon-background)}@media (max-width: 769px){.tsd-widget.options,.tsd-widget.menu{display:inline-block}.container-main{display:flex}html .col-content{float:none;max-width:100%;width:100%}html .col-sidebar{position:fixed!important;overflow-y:auto;-webkit-overflow-scrolling:touch;z-index:1024;top:0!important;bottom:0!important;left:auto!important;right:0!important;padding:1.5rem 1.5rem 0 0;width:75vw;visibility:hidden;background-color:var(--color-background);transform:translate(100%)}html .col-sidebar>*:last-child{padding-bottom:20px}html .overlay{content:"";display:block;position:fixed;z-index:1023;top:0;left:0;right:0;bottom:0;background-color:#000000bf;visibility:hidden}.to-has-menu .overlay{animation:fade-in .4s}.to-has-menu .col-sidebar{animation:pop-in-from-right .4s}.from-has-menu .overlay{animation:fade-out .4s}.from-has-menu .col-sidebar{animation:pop-out-to-right .4s}.has-menu body{overflow:hidden}.has-menu .overlay{visibility:visible}.has-menu .col-sidebar{visibility:visible;transform:translate(0);display:flex;flex-direction:column;gap:1.5rem;max-height:100vh;padding:1rem 2rem}.has-menu .tsd-navigation{max-height:100%}#tsd-toolbar-links{display:none}.tsd-navigation .tsd-nav-link{display:flex}}@media (min-width: 770px){.container-main{display:grid;grid-template-columns:minmax(0,1fr) minmax(0,2fr);grid-template-areas:"sidebar content";margin:2rem auto}.col-sidebar{grid-area:sidebar}.col-content{grid-area:content;padding:0 1rem}}@media (min-width: 770px) and (max-width: 1399px){.col-sidebar{max-height:calc(100vh - 2rem - 42px);overflow:auto;position:sticky;top:42px;padding-top:1rem}.site-menu{margin-top:1rem}}@media (min-width: 1200px){.container-main{grid-template-columns:minmax(0,1fr) minmax(0,2.5fr) minmax(0,20rem);grid-template-areas:"sidebar content toc"}.col-sidebar{display:contents}.page-menu{grid-area:toc;padding-left:1rem}.site-menu{grid-area:sidebar}.site-menu{margin-top:1rem}.page-menu,.site-menu{max-height:calc(100vh - 2rem - 42px);overflow:auto;position:sticky;top:42px}}}:root{--light-hl-0: #001080;--dark-hl-0: #9CDCFE;--light-hl-1: #000000;--dark-hl-1: #D4D4D4;--light-hl-2: #AF00DB;--dark-hl-2: #C586C0;--light-hl-3: #A31515;--dark-hl-3: #CE9178;--light-hl-4: #0000FF;--dark-hl-4: #569CD6;--light-hl-5: #0070C1;--dark-hl-5: #4FC1FF;--light-hl-6: #795E26;--dark-hl-6: #DCDCAA;--light-hl-7: #000000;--dark-hl-7: #C8C8C8;--light-hl-8: #098658;--dark-hl-8: #B5CEA8;--light-hl-9: #008000;--dark-hl-9: #6A9955;--light-hl-10: #267F99;--dark-hl-10: #4EC9B0;--light-code-background: #FFFFFF;--dark-code-background: #1E1E1E}@media (prefers-color-scheme: light){:root{--hl-0: var(--light-hl-0);--hl-1: var(--light-hl-1);--hl-2: var(--light-hl-2);--hl-3: var(--light-hl-3);--hl-4: var(--light-hl-4);--hl-5: var(--light-hl-5);--hl-6: var(--light-hl-6);--hl-7: var(--light-hl-7);--hl-8: var(--light-hl-8);--hl-9: var(--light-hl-9);--hl-10: var(--light-hl-10);--code-background: var(--light-code-background)}}@media (prefers-color-scheme: dark){:root{--hl-0: var(--dark-hl-0);--hl-1: var(--dark-hl-1);--hl-2: var(--dark-hl-2);--hl-3: var(--dark-hl-3);--hl-4: var(--dark-hl-4);--hl-5: var(--dark-hl-5);--hl-6: var(--dark-hl-6);--hl-7: var(--dark-hl-7);--hl-8: var(--dark-hl-8);--hl-9: var(--dark-hl-9);--hl-10: var(--dark-hl-10);--code-background: var(--dark-code-background)}}:root[data-theme=light]{--hl-0: var(--light-hl-0);--hl-1: var(--light-hl-1);--hl-2: var(--light-hl-2);--hl-3: var(--light-hl-3);--hl-4: var(--light-hl-4);--hl-5: var(--light-hl-5);--hl-6: var(--light-hl-6);--hl-7: var(--light-hl-7);--hl-8: var(--light-hl-8);--hl-9: var(--light-hl-9);--hl-10: var(--light-hl-10);--code-background: var(--light-code-background)}:root[data-theme=dark]{--hl-0: var(--dark-hl-0);--hl-1: var(--dark-hl-1);--hl-2: var(--dark-hl-2);--hl-3: var(--dark-hl-3);--hl-4: var(--dark-hl-4);--hl-5: var(--dark-hl-5);--hl-6: var(--dark-hl-6);--hl-7: var(--dark-hl-7);--hl-8: var(--dark-hl-8);--hl-9: var(--dark-hl-9);--hl-10: var(--dark-hl-10);--code-background: var(--dark-code-background)}.hl-0{color:var(--hl-0)}.hl-1{color:var(--hl-1)}.hl-2{color:var(--hl-2)}.hl-3{color:var(--hl-3)}.hl-4{color:var(--hl-4)}.hl-5{color:var(--hl-5)}.hl-6{color:var(--hl-6)}.hl-7{color:var(--hl-7)}.hl-8{color:var(--hl-8)}.hl-9{color:var(--hl-9)}.hl-10{color:var(--hl-10)}pre,code{background:var(--code-background)}html,body{overflow-x:hidden}:root{--hl-0: var(--dark-hl-0) !important;--hl-1: var(--dark-hl-1) !important;--hl-2: var(--dark-hl-2) !important;--hl-3: var(--dark-hl-3) !important;--hl-4: var(--dark-hl-4) !important;--hl-5: var(--dark-hl-5) !important;--code-background: var(--dark-code-background) !important}:root{--color-background: var(--dark-color-background) !important;--color-background-secondary: var( --dark-color-background-secondary ) !important;--color-background-warning: var(--dark-color-background-warning) !important;--color-warning-text: var(--dark-color-warning-text) !important;--color-icon-background: var(--dark-color-icon-background) !important;--color-accent: var(--dark-color-accent) !important;--color-active-menu-item: var(--dark-color-active-menu-item) !important;--color-text: var(--dark-color-text) !important;--color-text-aside: var(--dark-color-text-aside) !important;--color-link: var(--dark-color-link) !important;--color-focus-outline: var(--dark-color-focus-outline) !important;--color-ts-keyword: var(--dark-color-ts-keyword) !important;--color-ts-module: var(--dark-color-ts-module) !important;--color-ts-namespace: var(--dark-color-ts-namespace) !important;--color-ts-enum: var(--dark-color-ts-enum) !important;--color-ts-enum-member: var(--dark-color-ts-enum-member) !important;--color-ts-variable: var(--dark-color-ts-variable) !important;--color-ts-function: var(--dark-color-ts-function) !important;--color-ts-class: var(--dark-color-ts-class) !important;--color-ts-interface: var(--dark-color-ts-interface) !important;--color-ts-constructor: var(--dark-color-ts-constructor) !important;--color-ts-property: var(--dark-color-ts-property) !important;--color-ts-method: var(--dark-color-ts-method) !important;--color-ts-call-signature: var(--dark-color-ts-call-signature) !important;--color-ts-index-signature: var(--dark-color-ts-index-signature) !important;--color-ts-constructor-signature: var( --dark-color-ts-constructor-signature ) !important;--color-ts-parameter: var(--dark-color-ts-parameter) !important;--color-ts-type-parameter: var(--dark-color-ts-type-parameter) !important;--color-ts-accessor: var(--dark-color-ts-accessor) !important;--color-ts-get-signature: var(--dark-color-ts-get-signature) !important;--color-ts-set-signature: var(--dark-color-ts-set-signature) !important;--color-ts-type-alias: var(--dark-color-ts-type-alias) !important;--color-document: var(--dark-color-document) !important;--external-icon: var(--dark-external-icon) !important;--color-scheme: var(--dark-color-scheme) !important}.tsd-typography,.tsd-signature{line-height:1.5!important}.container-main{grid-template-columns:minmax(0,1fr) minmax(0,3fr);grid-template-areas:"sidebar content"}.page-menu{display:none!important}.container{padding:0 1rem!important}.tsd-page-toolbar{background:transparent;border:none;padding-top:1rem;padding-bottom:1rem}@media (min-width: 770px){.tsd-page-toolbar{padding-bottom:0}}#tsd-toolbar-links{right:1rem}#tsd-toolbar-links a{margin-left:1rem!important}.title{color:transparent!important}.title:after{display:block;position:absolute;left:0;top:0;content:"VFX-JS API docs";color:var(--color-text);line-height:1}.tsd-page-title>h2{margin-top:0}h1:not(.tsd-page-title h1){margin-top:0}li.tsd-parameter{margin-bottom:3rem}li.tsd-parameter>h5{margin-bottom:1rem 0}.tsd-type-declaration>h4{margin:2rem 0} +@layer typedoc{:root{--light-color-background: #f2f4f8;--light-color-background-secondary: #eff0f1;--light-color-warning-text: #222;--light-color-background-warning: #e6e600;--light-color-accent: #c5c7c9;--light-color-active-menu-item: var(--light-color-accent);--light-color-text: #222;--light-color-text-aside: #6e6e6e;--light-color-icon-background: var(--light-color-background);--light-color-icon-text: var(--light-color-text);--light-color-comment-tag-text: var(--light-color-text);--light-color-comment-tag: var(--light-color-background);--light-color-link: #1f70c2;--light-color-focus-outline: #3584e4;--light-color-ts-keyword: #056bd6;--light-color-ts-project: #b111c9;--light-color-ts-module: var(--light-color-ts-project);--light-color-ts-namespace: var(--light-color-ts-project);--light-color-ts-enum: #7e6f15;--light-color-ts-enum-member: var(--light-color-ts-enum);--light-color-ts-variable: #4760ec;--light-color-ts-function: #572be7;--light-color-ts-class: #1f70c2;--light-color-ts-interface: #108024;--light-color-ts-constructor: var(--light-color-ts-class);--light-color-ts-property: #9f5f30;--light-color-ts-method: #be3989;--light-color-ts-reference: #ff4d82;--light-color-ts-call-signature: var(--light-color-ts-method);--light-color-ts-index-signature: var(--light-color-ts-property);--light-color-ts-constructor-signature: var( --light-color-ts-constructor );--light-color-ts-parameter: var(--light-color-ts-variable);--light-color-ts-type-parameter: #a55c0e;--light-color-ts-accessor: #c73c3c;--light-color-ts-get-signature: var(--light-color-ts-accessor);--light-color-ts-set-signature: var(--light-color-ts-accessor);--light-color-ts-type-alias: #d51270;--light-color-document: #000000;--light-color-alert-note: #0969d9;--light-color-alert-tip: #1a7f37;--light-color-alert-important: #8250df;--light-color-alert-warning: #9a6700;--light-color-alert-caution: #cf222e;--light-external-icon: url("data:image/svg+xml;utf8,");--light-color-scheme: light;--dark-color-background: #2b2e33;--dark-color-background-secondary: #1e2024;--dark-color-background-warning: #bebe00;--dark-color-warning-text: #222;--dark-color-accent: #9096a2;--dark-color-active-menu-item: #5d5d6a;--dark-color-text: #f5f5f5;--dark-color-text-aside: #dddddd;--dark-color-icon-background: var(--dark-color-background-secondary);--dark-color-icon-text: var(--dark-color-text);--dark-color-comment-tag-text: var(--dark-color-text);--dark-color-comment-tag: var(--dark-color-background);--dark-color-link: #00aff4;--dark-color-focus-outline: #4c97f2;--dark-color-ts-keyword: #3399ff;--dark-color-ts-project: #e358ff;--dark-color-ts-module: var(--dark-color-ts-project);--dark-color-ts-namespace: var(--dark-color-ts-project);--dark-color-ts-enum: #f4d93e;--dark-color-ts-enum-member: var(--dark-color-ts-enum);--dark-color-ts-variable: #798dff;--dark-color-ts-function: #a280ff;--dark-color-ts-class: #8ac4ff;--dark-color-ts-interface: #6cff87;--dark-color-ts-constructor: var(--dark-color-ts-class);--dark-color-ts-property: #ff984d;--dark-color-ts-method: #ff4db8;--dark-color-ts-reference: #ff4d82;--dark-color-ts-call-signature: var(--dark-color-ts-method);--dark-color-ts-index-signature: var(--dark-color-ts-property);--dark-color-ts-constructor-signature: var(--dark-color-ts-constructor);--dark-color-ts-parameter: var(--dark-color-ts-variable);--dark-color-ts-type-parameter: #e07d13;--dark-color-ts-accessor: #ff6060;--dark-color-ts-get-signature: var(--dark-color-ts-accessor);--dark-color-ts-set-signature: var(--dark-color-ts-accessor);--dark-color-ts-type-alias: #ff6492;--dark-color-document: #ffffff;--dark-color-alert-note: #0969d9;--dark-color-alert-tip: #1a7f37;--dark-color-alert-important: #8250df;--dark-color-alert-warning: #9a6700;--dark-color-alert-caution: #cf222e;--dark-external-icon: url("data:image/svg+xml;utf8,");--dark-color-scheme: dark}@media (prefers-color-scheme: light){:root{--color-background: var(--light-color-background);--color-background-secondary: var( --light-color-background-secondary );--color-background-warning: var(--light-color-background-warning);--color-warning-text: var(--light-color-warning-text);--color-accent: var(--light-color-accent);--color-active-menu-item: var(--light-color-active-menu-item);--color-text: var(--light-color-text);--color-text-aside: var(--light-color-text-aside);--color-icon-background: var(--light-color-icon-background);--color-icon-text: var(--light-color-icon-text);--color-comment-tag-text: var(--light-color-text);--color-comment-tag: var(--light-color-background);--color-link: var(--light-color-link);--color-focus-outline: var(--light-color-focus-outline);--color-ts-keyword: var(--light-color-ts-keyword);--color-ts-project: var(--light-color-ts-project);--color-ts-module: var(--light-color-ts-module);--color-ts-namespace: var(--light-color-ts-namespace);--color-ts-enum: var(--light-color-ts-enum);--color-ts-enum-member: var(--light-color-ts-enum-member);--color-ts-variable: var(--light-color-ts-variable);--color-ts-function: var(--light-color-ts-function);--color-ts-class: var(--light-color-ts-class);--color-ts-interface: var(--light-color-ts-interface);--color-ts-constructor: var(--light-color-ts-constructor);--color-ts-property: var(--light-color-ts-property);--color-ts-method: var(--light-color-ts-method);--color-ts-reference: var(--light-color-ts-reference);--color-ts-call-signature: var(--light-color-ts-call-signature);--color-ts-index-signature: var(--light-color-ts-index-signature);--color-ts-constructor-signature: var( --light-color-ts-constructor-signature );--color-ts-parameter: var(--light-color-ts-parameter);--color-ts-type-parameter: var(--light-color-ts-type-parameter);--color-ts-accessor: var(--light-color-ts-accessor);--color-ts-get-signature: var(--light-color-ts-get-signature);--color-ts-set-signature: var(--light-color-ts-set-signature);--color-ts-type-alias: var(--light-color-ts-type-alias);--color-document: var(--light-color-document);--color-alert-note: var(--light-color-alert-note);--color-alert-tip: var(--light-color-alert-tip);--color-alert-important: var(--light-color-alert-important);--color-alert-warning: var(--light-color-alert-warning);--color-alert-caution: var(--light-color-alert-caution);--external-icon: var(--light-external-icon);--color-scheme: var(--light-color-scheme)}}@media (prefers-color-scheme: dark){:root{--color-background: var(--dark-color-background);--color-background-secondary: var( --dark-color-background-secondary );--color-background-warning: var(--dark-color-background-warning);--color-warning-text: var(--dark-color-warning-text);--color-accent: var(--dark-color-accent);--color-active-menu-item: var(--dark-color-active-menu-item);--color-text: var(--dark-color-text);--color-text-aside: var(--dark-color-text-aside);--color-icon-background: var(--dark-color-icon-background);--color-icon-text: var(--dark-color-icon-text);--color-comment-tag-text: var(--dark-color-text);--color-comment-tag: var(--dark-color-background);--color-link: var(--dark-color-link);--color-focus-outline: var(--dark-color-focus-outline);--color-ts-keyword: var(--dark-color-ts-keyword);--color-ts-project: var(--dark-color-ts-project);--color-ts-module: var(--dark-color-ts-module);--color-ts-namespace: var(--dark-color-ts-namespace);--color-ts-enum: var(--dark-color-ts-enum);--color-ts-enum-member: var(--dark-color-ts-enum-member);--color-ts-variable: var(--dark-color-ts-variable);--color-ts-function: var(--dark-color-ts-function);--color-ts-class: var(--dark-color-ts-class);--color-ts-interface: var(--dark-color-ts-interface);--color-ts-constructor: var(--dark-color-ts-constructor);--color-ts-property: var(--dark-color-ts-property);--color-ts-method: var(--dark-color-ts-method);--color-ts-reference: var(--dark-color-ts-reference);--color-ts-call-signature: var(--dark-color-ts-call-signature);--color-ts-index-signature: var(--dark-color-ts-index-signature);--color-ts-constructor-signature: var( --dark-color-ts-constructor-signature );--color-ts-parameter: var(--dark-color-ts-parameter);--color-ts-type-parameter: var(--dark-color-ts-type-parameter);--color-ts-accessor: var(--dark-color-ts-accessor);--color-ts-get-signature: var(--dark-color-ts-get-signature);--color-ts-set-signature: var(--dark-color-ts-set-signature);--color-ts-type-alias: var(--dark-color-ts-type-alias);--color-document: var(--dark-color-document);--color-alert-note: var(--dark-color-alert-note);--color-alert-tip: var(--dark-color-alert-tip);--color-alert-important: var(--dark-color-alert-important);--color-alert-warning: var(--dark-color-alert-warning);--color-alert-caution: var(--dark-color-alert-caution);--external-icon: var(--dark-external-icon);--color-scheme: var(--dark-color-scheme)}}html{color-scheme:var(--color-scheme)}body{margin:0}:root[data-theme=light]{--color-background: var(--light-color-background);--color-background-secondary: var(--light-color-background-secondary);--color-background-warning: var(--light-color-background-warning);--color-warning-text: var(--light-color-warning-text);--color-icon-background: var(--light-color-icon-background);--color-accent: var(--light-color-accent);--color-active-menu-item: var(--light-color-active-menu-item);--color-text: var(--light-color-text);--color-text-aside: var(--light-color-text-aside);--color-icon-text: var(--light-color-icon-text);--color-comment-tag-text: var(--light-color-text);--color-comment-tag: var(--light-color-background);--color-link: var(--light-color-link);--color-focus-outline: var(--light-color-focus-outline);--color-ts-keyword: var(--light-color-ts-keyword);--color-ts-project: var(--light-color-ts-project);--color-ts-module: var(--light-color-ts-module);--color-ts-namespace: var(--light-color-ts-namespace);--color-ts-enum: var(--light-color-ts-enum);--color-ts-enum-member: var(--light-color-ts-enum-member);--color-ts-variable: var(--light-color-ts-variable);--color-ts-function: var(--light-color-ts-function);--color-ts-class: var(--light-color-ts-class);--color-ts-interface: var(--light-color-ts-interface);--color-ts-constructor: var(--light-color-ts-constructor);--color-ts-property: var(--light-color-ts-property);--color-ts-method: var(--light-color-ts-method);--color-ts-reference: var(--light-color-ts-reference);--color-ts-call-signature: var(--light-color-ts-call-signature);--color-ts-index-signature: var(--light-color-ts-index-signature);--color-ts-constructor-signature: var( --light-color-ts-constructor-signature );--color-ts-parameter: var(--light-color-ts-parameter);--color-ts-type-parameter: var(--light-color-ts-type-parameter);--color-ts-accessor: var(--light-color-ts-accessor);--color-ts-get-signature: var(--light-color-ts-get-signature);--color-ts-set-signature: var(--light-color-ts-set-signature);--color-ts-type-alias: var(--light-color-ts-type-alias);--color-document: var(--light-color-document);--color-note: var(--light-color-note);--color-tip: var(--light-color-tip);--color-important: var(--light-color-important);--color-warning: var(--light-color-warning);--color-caution: var(--light-color-caution);--external-icon: var(--light-external-icon);--color-scheme: var(--light-color-scheme)}:root[data-theme=dark]{--color-background: var(--dark-color-background);--color-background-secondary: var(--dark-color-background-secondary);--color-background-warning: var(--dark-color-background-warning);--color-warning-text: var(--dark-color-warning-text);--color-icon-background: var(--dark-color-icon-background);--color-accent: var(--dark-color-accent);--color-active-menu-item: var(--dark-color-active-menu-item);--color-text: var(--dark-color-text);--color-text-aside: var(--dark-color-text-aside);--color-icon-text: var(--dark-color-icon-text);--color-comment-tag-text: var(--dark-color-text);--color-comment-tag: var(--dark-color-background);--color-link: var(--dark-color-link);--color-focus-outline: var(--dark-color-focus-outline);--color-ts-keyword: var(--dark-color-ts-keyword);--color-ts-project: var(--dark-color-ts-project);--color-ts-module: var(--dark-color-ts-module);--color-ts-namespace: var(--dark-color-ts-namespace);--color-ts-enum: var(--dark-color-ts-enum);--color-ts-enum-member: var(--dark-color-ts-enum-member);--color-ts-variable: var(--dark-color-ts-variable);--color-ts-function: var(--dark-color-ts-function);--color-ts-class: var(--dark-color-ts-class);--color-ts-interface: var(--dark-color-ts-interface);--color-ts-constructor: var(--dark-color-ts-constructor);--color-ts-property: var(--dark-color-ts-property);--color-ts-method: var(--dark-color-ts-method);--color-ts-reference: var(--dark-color-ts-reference);--color-ts-call-signature: var(--dark-color-ts-call-signature);--color-ts-index-signature: var(--dark-color-ts-index-signature);--color-ts-constructor-signature: var( --dark-color-ts-constructor-signature );--color-ts-parameter: var(--dark-color-ts-parameter);--color-ts-type-parameter: var(--dark-color-ts-type-parameter);--color-ts-accessor: var(--dark-color-ts-accessor);--color-ts-get-signature: var(--dark-color-ts-get-signature);--color-ts-set-signature: var(--dark-color-ts-set-signature);--color-ts-type-alias: var(--dark-color-ts-type-alias);--color-document: var(--dark-color-document);--color-note: var(--dark-color-note);--color-tip: var(--dark-color-tip);--color-important: var(--dark-color-important);--color-warning: var(--dark-color-warning);--color-caution: var(--dark-color-caution);--external-icon: var(--dark-external-icon);--color-scheme: var(--dark-color-scheme)}*:focus-visible,.tsd-accordion-summary:focus-visible svg{outline:2px solid var(--color-focus-outline)}.always-visible,.always-visible .tsd-signatures{display:inherit!important}h1,h2,h3,h4,h5,h6{line-height:1.2}h1{font-size:1.875rem;margin:.67rem 0}h2{font-size:1.5rem;margin:.83rem 0}h3{font-size:1.25rem;margin:1rem 0}h4{font-size:1.05rem;margin:1.33rem 0}h5{font-size:1rem;margin:1.5rem 0}h6{font-size:.875rem;margin:2.33rem 0}dl,menu,ol,ul{margin:1em 0}dd{margin:0 0 0 34px}.container{max-width:1700px;padding:0 2rem}footer{border-top:1px solid var(--color-accent);padding-top:1rem;padding-bottom:1rem;max-height:3.5rem}footer>p{margin:0 1em}.container-main{margin:0 auto;min-height:calc(100vh - 97px - 4rem)}@keyframes fade-in{0%{opacity:0}to{opacity:1}}@keyframes fade-out{0%{opacity:1;visibility:visible}to{opacity:0}}@keyframes fade-in-delayed{0%{opacity:0}33%{opacity:0}to{opacity:1}}@keyframes fade-out-delayed{0%{opacity:1;visibility:visible}66%{opacity:0}to{opacity:0}}@keyframes pop-in-from-right{0%{transform:translate(100%)}to{transform:translate(0)}}@keyframes pop-out-to-right{0%{transform:translate(0);visibility:visible}to{transform:translate(100%)}}body{background:var(--color-background);font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Noto Sans,Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji";font-size:16px;color:var(--color-text)}a{color:var(--color-link);text-decoration:none}a:hover{text-decoration:underline}a.external[target=_blank]{background-image:var(--external-icon);background-position:top 3px right;background-repeat:no-repeat;padding-right:13px}a.tsd-anchor-link{color:var(--color-text)}code,pre{font-family:Menlo,Monaco,Consolas,Courier New,monospace;padding:.2em;margin:0;font-size:.875rem;border-radius:.8em}pre{position:relative;white-space:pre-wrap;word-wrap:break-word;padding:10px;border:1px solid var(--color-accent);margin-bottom:8px}pre code{padding:0;font-size:100%}pre>button{position:absolute;top:10px;right:10px;opacity:0;transition:opacity .1s;box-sizing:border-box}pre:hover>button,pre>button.visible{opacity:1}blockquote{margin:1em 0;padding-left:1em;border-left:4px solid gray}.tsd-typography{line-height:1.333em}.tsd-typography ul{list-style:square;padding:0 0 0 20px;margin:0}.tsd-typography .tsd-index-panel h3,.tsd-index-panel .tsd-typography h3,.tsd-typography h4,.tsd-typography h5,.tsd-typography h6{font-size:1em}.tsd-typography h5,.tsd-typography h6{font-weight:400}.tsd-typography p,.tsd-typography ul,.tsd-typography ol{margin:1em 0}.tsd-typography table{border-collapse:collapse;border:none}.tsd-typography td,.tsd-typography th{padding:6px 13px;border:1px solid var(--color-accent)}.tsd-typography thead,.tsd-typography tr:nth-child(2n){background-color:var(--color-background-secondary)}.tsd-alert{padding:8px 16px;margin-bottom:16px;border-left:.25em solid var(--alert-color)}.tsd-alert blockquote>:last-child,.tsd-alert>:last-child{margin-bottom:0}.tsd-alert-title{color:var(--alert-color);display:inline-flex;align-items:center}.tsd-alert-title span{margin-left:4px}.tsd-alert-note{--alert-color: var(--color-alert-note)}.tsd-alert-tip{--alert-color: var(--color-alert-tip)}.tsd-alert-important{--alert-color: var(--color-alert-important)}.tsd-alert-warning{--alert-color: var(--color-alert-warning)}.tsd-alert-caution{--alert-color: var(--color-alert-caution)}.tsd-breadcrumb{margin:0;padding:0;color:var(--color-text-aside)}.tsd-breadcrumb a{color:var(--color-text-aside);text-decoration:none}.tsd-breadcrumb a:hover{text-decoration:underline}.tsd-breadcrumb li{display:inline}.tsd-breadcrumb li:after{content:" / "}.tsd-comment-tags{display:flex;flex-direction:column}dl.tsd-comment-tag-group{display:flex;align-items:center;overflow:hidden;margin:.5em 0}dl.tsd-comment-tag-group dt{display:flex;margin-right:.5em;font-size:.875em;font-weight:400}dl.tsd-comment-tag-group dd{margin:0}code.tsd-tag{padding:.25em .4em;border:.1em solid var(--color-accent);margin-right:.25em;font-size:70%}h1 code.tsd-tag:first-of-type{margin-left:.25em}dl.tsd-comment-tag-group dd:before,dl.tsd-comment-tag-group dd:after{content:" "}dl.tsd-comment-tag-group dd pre,dl.tsd-comment-tag-group dd:after{clear:both}dl.tsd-comment-tag-group p{margin:0}.tsd-panel.tsd-comment .lead{font-size:1.1em;line-height:1.333em;margin-bottom:2em}.tsd-panel.tsd-comment .lead:last-child{margin-bottom:0}.tsd-filter-visibility h4{font-size:1rem;padding-top:.75rem;padding-bottom:.5rem;margin:0}.tsd-filter-item:not(:last-child){margin-bottom:.5rem}.tsd-filter-input{display:flex;width:-moz-fit-content;width:fit-content;align-items:center;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;cursor:pointer}.tsd-filter-input input[type=checkbox]{cursor:pointer;position:absolute;width:1.5em;height:1.5em;opacity:0}.tsd-filter-input input[type=checkbox]:disabled{pointer-events:none}.tsd-filter-input svg{cursor:pointer;width:1.5em;height:1.5em;margin-right:.5em;border-radius:.33em;opacity:.99}.tsd-filter-input input[type=checkbox]:focus-visible+svg{outline:2px solid var(--color-focus-outline)}.tsd-checkbox-background{fill:var(--color-accent)}input[type=checkbox]:checked~svg .tsd-checkbox-checkmark{stroke:var(--color-text)}.tsd-filter-input input:disabled~svg>.tsd-checkbox-background{fill:var(--color-background);stroke:var(--color-accent);stroke-width:.25rem}.tsd-filter-input input:disabled~svg>.tsd-checkbox-checkmark{stroke:var(--color-accent)}.settings-label{font-weight:700;text-transform:uppercase;display:inline-block}.tsd-filter-visibility .settings-label{margin:.75rem 0 .5rem}.tsd-theme-toggle .settings-label{margin:.75rem .75rem 0 0}.tsd-hierarchy h4 label:hover span{text-decoration:underline}.tsd-hierarchy{list-style:square;margin:0}.tsd-hierarchy-target{font-weight:700}.tsd-hierarchy-toggle{color:var(--color-link);cursor:pointer}.tsd-full-hierarchy:not(:last-child){margin-bottom:1em;padding-bottom:1em;border-bottom:1px solid var(--color-accent)}.tsd-full-hierarchy,.tsd-full-hierarchy ul{list-style:none;margin:0;padding:0}.tsd-full-hierarchy ul{padding-left:1.5rem}.tsd-full-hierarchy a{padding:.25rem 0!important;font-size:1rem;display:inline-flex;align-items:center;color:var(--color-text)}.tsd-full-hierarchy svg[data-dropdown]{cursor:pointer}.tsd-full-hierarchy svg[data-dropdown=false]{transform:rotate(-90deg)}.tsd-full-hierarchy svg[data-dropdown=false]~ul{display:none}.tsd-panel-group.tsd-index-group{margin-bottom:0}.tsd-index-panel .tsd-index-list{list-style:none;line-height:1.333em;margin:0;padding:.25rem 0 0;overflow:hidden;display:grid;grid-template-columns:repeat(3,1fr);column-gap:1rem;grid-template-rows:auto}@media (max-width: 1024px){.tsd-index-panel .tsd-index-list{grid-template-columns:repeat(2,1fr)}}@media (max-width: 768px){.tsd-index-panel .tsd-index-list{grid-template-columns:repeat(1,1fr)}}.tsd-index-panel .tsd-index-list li{-webkit-page-break-inside:avoid;-moz-page-break-inside:avoid;-ms-page-break-inside:avoid;-o-page-break-inside:avoid;page-break-inside:avoid}.tsd-flag{display:inline-block;padding:.25em .4em;border-radius:4px;color:var(--color-comment-tag-text);background-color:var(--color-comment-tag);text-indent:0;font-size:75%;line-height:1;font-weight:400}.tsd-anchor{position:relative;top:-100px}.tsd-member{position:relative}.tsd-member .tsd-anchor+h3{display:flex;align-items:center;margin-top:0;margin-bottom:0;border-bottom:none}.tsd-navigation.settings{margin:1rem 0}.tsd-navigation>a,.tsd-navigation .tsd-accordion-summary{width:calc(100% - .25rem);display:flex;align-items:center}.tsd-navigation a,.tsd-navigation summary>span,.tsd-page-navigation a{display:flex;width:calc(100% - .25rem);align-items:center;padding:.25rem;color:var(--color-text);text-decoration:none;box-sizing:border-box}.tsd-navigation a.current,.tsd-page-navigation a.current{background:var(--color-active-menu-item)}.tsd-navigation a:hover,.tsd-page-navigation a:hover{text-decoration:underline}.tsd-navigation ul,.tsd-page-navigation ul{margin-top:0;margin-bottom:0;padding:0;list-style:none}.tsd-navigation li,.tsd-page-navigation li{padding:0;max-width:100%}.tsd-navigation .tsd-nav-link{display:none}.tsd-nested-navigation{margin-left:3rem}.tsd-nested-navigation>li>details{margin-left:-1.5rem}.tsd-small-nested-navigation{margin-left:1.5rem}.tsd-small-nested-navigation>li>details{margin-left:-1.5rem}.tsd-page-navigation-section{margin-left:10px}.tsd-page-navigation-section>summary{padding:.25rem}.tsd-page-navigation-section>div{margin-left:20px}.tsd-page-navigation ul{padding-left:1.75rem}#tsd-sidebar-links a{margin-top:0;margin-bottom:.5rem;line-height:1.25rem}#tsd-sidebar-links a:last-of-type{margin-bottom:0}a.tsd-index-link{padding:.25rem 0!important;font-size:1rem;line-height:1.25rem;display:inline-flex;align-items:center;color:var(--color-text)}.tsd-accordion-summary{list-style-type:none;outline:none}.tsd-accordion-summary::-webkit-details-marker{display:none}.tsd-accordion-summary,.tsd-accordion-summary a{-moz-user-select:none;-webkit-user-select:none;-ms-user-select:none;user-select:none;cursor:pointer}.tsd-accordion-summary a{width:calc(100% - 1.5rem)}.tsd-accordion-summary>*{margin-top:0;margin-bottom:0;padding-top:0;padding-bottom:0}.tsd-accordion .tsd-accordion-summary>svg{margin-left:.25rem;vertical-align:text-top}.tsd-accordion:not([open])>.tsd-accordion-summary>svg:first-child,.tsd-accordion:not([open])>.tsd-accordion-summary>h1>svg:first-child,.tsd-accordion:not([open])>.tsd-accordion-summary>h2>svg:first-child,.tsd-accordion:not([open])>.tsd-accordion-summary>h3>svg:first-child,.tsd-accordion:not([open])>.tsd-accordion-summary>h4>svg:first-child{transform:rotate(-90deg)}.tsd-index-content>:not(:first-child){margin-top:.75rem}.tsd-index-heading{margin-top:1.5rem;margin-bottom:.75rem}.tsd-no-select{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.tsd-kind-icon{margin-right:.5rem;width:1.25rem;height:1.25rem;min-width:1.25rem;min-height:1.25rem}.tsd-signature>.tsd-kind-icon{margin-right:.8rem}.tsd-panel{margin-bottom:2.5rem}.tsd-panel.tsd-member{margin-bottom:4rem}.tsd-panel:empty{display:none}.tsd-panel>h1,.tsd-panel>h2,.tsd-panel>h3{margin:1.5rem -1.5rem .75rem;padding:0 1.5rem .75rem}.tsd-panel>h1.tsd-before-signature,.tsd-panel>h2.tsd-before-signature,.tsd-panel>h3.tsd-before-signature{margin-bottom:0;border-bottom:none}.tsd-panel-group,.tsd-panel-group.tsd-index-group{margin:2rem 0}.tsd-panel-group.tsd-index-group details{margin:2rem 0}.tsd-panel-group>.tsd-accordion-summary{margin-bottom:1rem}#tsd-search{transition:background-color .2s}#tsd-search .title{position:relative;z-index:2}#tsd-search .field{position:absolute;left:0;top:0;right:2.5rem;height:100%}#tsd-search .field input{box-sizing:border-box;position:relative;top:-50px;z-index:1;width:100%;padding:0 10px;opacity:0;outline:0;border:0;background:transparent;color:var(--color-text)}#tsd-search .field label{position:absolute;overflow:hidden;right:-40px}#tsd-search .field input,#tsd-search .title,#tsd-toolbar-links a{transition:opacity .2s}#tsd-search .results{position:absolute;visibility:hidden;top:40px;width:100%;margin:0;padding:0;list-style:none;box-shadow:0 0 4px #00000040}#tsd-search .results li{background-color:var(--color-background);line-height:initial;padding:4px}#tsd-search .results li:nth-child(2n){background-color:var(--color-background-secondary)}#tsd-search .results li.state{display:none}#tsd-search .results li.current:not(.no-results),#tsd-search .results li:hover:not(.no-results){background-color:var(--color-accent)}#tsd-search .results a{display:flex;align-items:center;padding:.25rem;box-sizing:border-box}#tsd-search .results a:before{top:10px}#tsd-search .results span.parent{color:var(--color-text-aside);font-weight:400}#tsd-search.has-focus{background-color:var(--color-accent)}#tsd-search.has-focus .field input{top:0;opacity:1}#tsd-search.has-focus .title,#tsd-search.has-focus #tsd-toolbar-links a{z-index:0;opacity:0}#tsd-search.has-focus .results{visibility:visible}#tsd-search.loading .results li.state.loading,#tsd-search.failure .results li.state.failure{display:block}#tsd-toolbar-links{position:absolute;top:0;right:2rem;height:100%;display:flex;align-items:center;justify-content:flex-end}#tsd-toolbar-links a{margin-left:1.5rem}#tsd-toolbar-links a:hover{text-decoration:underline}.tsd-signature{margin:0 0 1rem;padding:1rem .5rem;border:1px solid var(--color-accent);font-family:Menlo,Monaco,Consolas,Courier New,monospace;font-size:14px;overflow-x:auto}.tsd-signature-keyword{color:var(--color-ts-keyword);font-weight:400}.tsd-signature-symbol{color:var(--color-text-aside);font-weight:400}.tsd-signature-type{font-style:italic;font-weight:400}.tsd-signatures{padding:0;margin:0 0 1em;list-style-type:none}.tsd-signatures .tsd-signature{margin:0;border-color:var(--color-accent);border-width:1px 0;transition:background-color .1s}.tsd-signatures .tsd-index-signature:not(:last-child){margin-bottom:1em}.tsd-signatures .tsd-index-signature .tsd-signature,.tsd-description .tsd-signatures .tsd-signature{border-width:1px}ul.tsd-parameter-list,ul.tsd-type-parameter-list{list-style:square;margin:0;padding-left:20px}ul.tsd-parameter-list>li.tsd-parameter-signature,ul.tsd-type-parameter-list>li.tsd-parameter-signature{list-style:none;margin-left:-20px}ul.tsd-parameter-list h5,ul.tsd-type-parameter-list h5{font-size:16px;margin:1em 0 .5em}.tsd-sources{margin-top:1rem;font-size:.875em}.tsd-sources a{color:var(--color-text-aside);text-decoration:underline}.tsd-sources ul{list-style:none;padding:0}.tsd-page-toolbar{position:sticky;z-index:1;top:0;left:0;width:100%;color:var(--color-text);background:var(--color-background-secondary);border-bottom:1px var(--color-accent) solid;transition:transform .3s ease-in-out}.tsd-page-toolbar a{color:var(--color-text);text-decoration:none}.tsd-page-toolbar a.title{font-weight:700}.tsd-page-toolbar a.title:hover{text-decoration:underline}.tsd-page-toolbar .tsd-toolbar-contents{display:flex;justify-content:space-between;height:2.5rem;margin:0 auto}.tsd-page-toolbar .table-cell{position:relative;white-space:nowrap;line-height:40px}.tsd-page-toolbar .table-cell:first-child{width:100%}.tsd-page-toolbar .tsd-toolbar-icon{box-sizing:border-box;line-height:0;padding:12px 0}.tsd-widget{display:inline-block;overflow:hidden;opacity:.8;height:40px;transition:opacity .1s,background-color .2s;vertical-align:bottom;cursor:pointer}.tsd-widget:hover{opacity:.9}.tsd-widget.active{opacity:1;background-color:var(--color-accent)}.tsd-widget.no-caption{width:40px}.tsd-widget.no-caption:before{margin:0}.tsd-widget.options,.tsd-widget.menu{display:none}input[type=checkbox]+.tsd-widget:before{background-position:-120px 0}input[type=checkbox]:checked+.tsd-widget:before{background-position:-160px 0}img{max-width:100%}.tsd-member-summary-name{display:inline-flex;align-items:center;padding:.25rem;text-decoration:none}.tsd-anchor-icon{display:inline-flex;align-items:center;margin-left:.5rem;color:var(--color-text)}.tsd-anchor-icon svg{width:1em;height:1em;visibility:hidden}.tsd-member-summary-name:hover>.tsd-anchor-icon svg,.tsd-anchor-link:hover>.tsd-anchor-icon svg{visibility:visible}.deprecated{text-decoration:line-through!important}.warning{padding:1rem;color:var(--color-warning-text);background:var(--color-background-warning)}.tsd-kind-project{color:var(--color-ts-project)}.tsd-kind-module{color:var(--color-ts-module)}.tsd-kind-namespace{color:var(--color-ts-namespace)}.tsd-kind-enum{color:var(--color-ts-enum)}.tsd-kind-enum-member{color:var(--color-ts-enum-member)}.tsd-kind-variable{color:var(--color-ts-variable)}.tsd-kind-function{color:var(--color-ts-function)}.tsd-kind-class{color:var(--color-ts-class)}.tsd-kind-interface{color:var(--color-ts-interface)}.tsd-kind-constructor{color:var(--color-ts-constructor)}.tsd-kind-property{color:var(--color-ts-property)}.tsd-kind-method{color:var(--color-ts-method)}.tsd-kind-reference{color:var(--color-ts-reference)}.tsd-kind-call-signature{color:var(--color-ts-call-signature)}.tsd-kind-index-signature{color:var(--color-ts-index-signature)}.tsd-kind-constructor-signature{color:var(--color-ts-constructor-signature)}.tsd-kind-parameter{color:var(--color-ts-parameter)}.tsd-kind-type-parameter{color:var(--color-ts-type-parameter)}.tsd-kind-accessor{color:var(--color-ts-accessor)}.tsd-kind-get-signature{color:var(--color-ts-get-signature)}.tsd-kind-set-signature{color:var(--color-ts-set-signature)}.tsd-kind-type-alias{color:var(--color-ts-type-alias)}.tsd-kind-icon~span{color:var(--color-text)}*{scrollbar-width:thin;scrollbar-color:var(--color-accent) var(--color-icon-background)}*::-webkit-scrollbar{width:.75rem}*::-webkit-scrollbar-track{background:var(--color-icon-background)}*::-webkit-scrollbar-thumb{background-color:var(--color-accent);border-radius:999rem;border:.25rem solid var(--color-icon-background)}@media (max-width: 769px){.tsd-widget.options,.tsd-widget.menu{display:inline-block}.container-main{display:flex}html .col-content{float:none;max-width:100%;width:100%}html .col-sidebar{position:fixed!important;overflow-y:auto;-webkit-overflow-scrolling:touch;z-index:1024;top:0!important;bottom:0!important;left:auto!important;right:0!important;padding:1.5rem 1.5rem 0 0;width:75vw;visibility:hidden;background-color:var(--color-background);transform:translate(100%)}html .col-sidebar>*:last-child{padding-bottom:20px}html .overlay{content:"";display:block;position:fixed;z-index:1023;top:0;left:0;right:0;bottom:0;background-color:#000000bf;visibility:hidden}.to-has-menu .overlay{animation:fade-in .4s}.to-has-menu .col-sidebar{animation:pop-in-from-right .4s}.from-has-menu .overlay{animation:fade-out .4s}.from-has-menu .col-sidebar{animation:pop-out-to-right .4s}.has-menu body{overflow:hidden}.has-menu .overlay{visibility:visible}.has-menu .col-sidebar{visibility:visible;transform:translate(0);display:flex;flex-direction:column;gap:1.5rem;max-height:100vh;padding:1rem 2rem}.has-menu .tsd-navigation{max-height:100%}#tsd-toolbar-links{display:none}.tsd-navigation .tsd-nav-link{display:flex}}@media (min-width: 770px){.container-main{display:grid;grid-template-columns:minmax(0,1fr) minmax(0,2fr);grid-template-areas:"sidebar content";margin:2rem auto}.col-sidebar{grid-area:sidebar}.col-content{grid-area:content;padding:0 1rem}}@media (min-width: 770px) and (max-width: 1399px){.col-sidebar{max-height:calc(100vh - 2rem - 42px);overflow:auto;position:sticky;top:42px;padding-top:1rem}.site-menu{margin-top:1rem}}@media (min-width: 1200px){.container-main{grid-template-columns:minmax(0,1fr) minmax(0,2.5fr) minmax(0,20rem);grid-template-areas:"sidebar content toc"}.col-sidebar{display:contents}.page-menu{grid-area:toc;padding-left:1rem}.site-menu{grid-area:sidebar}.site-menu{margin-top:1rem}.page-menu,.site-menu{max-height:calc(100vh - 2rem - 42px);overflow:auto;position:sticky;top:42px}}}:root{--light-hl-0: #001080;--dark-hl-0: #9CDCFE;--light-hl-1: #000000;--dark-hl-1: #D4D4D4;--light-hl-2: #AF00DB;--dark-hl-2: #C586C0;--light-hl-3: #A31515;--dark-hl-3: #CE9178;--light-hl-4: #0000FF;--dark-hl-4: #569CD6;--light-hl-5: #0070C1;--dark-hl-5: #4FC1FF;--light-hl-6: #795E26;--dark-hl-6: #DCDCAA;--light-hl-7: #098658;--dark-hl-7: #B5CEA8;--light-hl-8: #008000;--dark-hl-8: #6A9955;--light-code-background: #FFFFFF;--dark-code-background: #1E1E1E}@media (prefers-color-scheme: light){:root{--hl-0: var(--light-hl-0);--hl-1: var(--light-hl-1);--hl-2: var(--light-hl-2);--hl-3: var(--light-hl-3);--hl-4: var(--light-hl-4);--hl-5: var(--light-hl-5);--hl-6: var(--light-hl-6);--hl-7: var(--light-hl-7);--hl-8: var(--light-hl-8);--code-background: var(--light-code-background)}}@media (prefers-color-scheme: dark){:root{--hl-0: var(--dark-hl-0);--hl-1: var(--dark-hl-1);--hl-2: var(--dark-hl-2);--hl-3: var(--dark-hl-3);--hl-4: var(--dark-hl-4);--hl-5: var(--dark-hl-5);--hl-6: var(--dark-hl-6);--hl-7: var(--dark-hl-7);--hl-8: var(--dark-hl-8);--code-background: var(--dark-code-background)}}:root[data-theme=light]{--hl-0: var(--light-hl-0);--hl-1: var(--light-hl-1);--hl-2: var(--light-hl-2);--hl-3: var(--light-hl-3);--hl-4: var(--light-hl-4);--hl-5: var(--light-hl-5);--hl-6: var(--light-hl-6);--hl-7: var(--light-hl-7);--hl-8: var(--light-hl-8);--code-background: var(--light-code-background)}:root[data-theme=dark]{--hl-0: var(--dark-hl-0);--hl-1: var(--dark-hl-1);--hl-2: var(--dark-hl-2);--hl-3: var(--dark-hl-3);--hl-4: var(--dark-hl-4);--hl-5: var(--dark-hl-5);--hl-6: var(--dark-hl-6);--hl-7: var(--dark-hl-7);--hl-8: var(--dark-hl-8);--code-background: var(--dark-code-background)}.hl-0{color:var(--hl-0)}.hl-1{color:var(--hl-1)}.hl-2{color:var(--hl-2)}.hl-3{color:var(--hl-3)}.hl-4{color:var(--hl-4)}.hl-5{color:var(--hl-5)}.hl-6{color:var(--hl-6)}.hl-7{color:var(--hl-7)}.hl-8{color:var(--hl-8)}pre,code{background:var(--code-background)}html,body{overflow-x:hidden}:root{--hl-0: var(--dark-hl-0) !important;--hl-1: var(--dark-hl-1) !important;--hl-2: var(--dark-hl-2) !important;--hl-3: var(--dark-hl-3) !important;--hl-4: var(--dark-hl-4) !important;--hl-5: var(--dark-hl-5) !important;--code-background: var(--dark-code-background) !important}:root{--color-background: var(--dark-color-background) !important;--color-background-secondary: var( --dark-color-background-secondary ) !important;--color-background-warning: var(--dark-color-background-warning) !important;--color-warning-text: var(--dark-color-warning-text) !important;--color-icon-background: var(--dark-color-icon-background) !important;--color-accent: var(--dark-color-accent) !important;--color-active-menu-item: var(--dark-color-active-menu-item) !important;--color-text: var(--dark-color-text) !important;--color-text-aside: var(--dark-color-text-aside) !important;--color-link: var(--dark-color-link) !important;--color-focus-outline: var(--dark-color-focus-outline) !important;--color-ts-keyword: var(--dark-color-ts-keyword) !important;--color-ts-module: var(--dark-color-ts-module) !important;--color-ts-namespace: var(--dark-color-ts-namespace) !important;--color-ts-enum: var(--dark-color-ts-enum) !important;--color-ts-enum-member: var(--dark-color-ts-enum-member) !important;--color-ts-variable: var(--dark-color-ts-variable) !important;--color-ts-function: var(--dark-color-ts-function) !important;--color-ts-class: var(--dark-color-ts-class) !important;--color-ts-interface: var(--dark-color-ts-interface) !important;--color-ts-constructor: var(--dark-color-ts-constructor) !important;--color-ts-property: var(--dark-color-ts-property) !important;--color-ts-method: var(--dark-color-ts-method) !important;--color-ts-call-signature: var(--dark-color-ts-call-signature) !important;--color-ts-index-signature: var(--dark-color-ts-index-signature) !important;--color-ts-constructor-signature: var( --dark-color-ts-constructor-signature ) !important;--color-ts-parameter: var(--dark-color-ts-parameter) !important;--color-ts-type-parameter: var(--dark-color-ts-type-parameter) !important;--color-ts-accessor: var(--dark-color-ts-accessor) !important;--color-ts-get-signature: var(--dark-color-ts-get-signature) !important;--color-ts-set-signature: var(--dark-color-ts-set-signature) !important;--color-ts-type-alias: var(--dark-color-ts-type-alias) !important;--color-document: var(--dark-color-document) !important;--external-icon: var(--dark-external-icon) !important;--color-scheme: var(--dark-color-scheme) !important}.tsd-typography,.tsd-signature{line-height:1.5!important}.container-main{grid-template-columns:minmax(0,1fr) minmax(0,3fr);grid-template-areas:"sidebar content"}.page-menu{display:none!important}.container{padding:0 1rem!important}.tsd-page-toolbar{background:transparent;border:none;padding-top:1rem;padding-bottom:1rem}@media (min-width: 770px){.tsd-page-toolbar{padding-bottom:0}}#tsd-toolbar-links{right:1rem}#tsd-toolbar-links a{margin-left:1rem!important}.title{color:transparent!important}.title:after{display:block;position:absolute;left:0;top:0;content:"VFX-JS API docs";color:var(--color-text);line-height:1}.tsd-page-title>h2{margin-top:0}h1:not(.tsd-page-title h1){margin-top:0}li.tsd-parameter{margin-bottom:3rem}li.tsd-parameter>h5{margin-bottom:1rem 0}.tsd-type-declaration>h4{margin:2rem 0} diff --git a/assets/index-DXU20IJL.js b/assets/index-BxNZGJ7n.js similarity index 96% rename from assets/index-DXU20IJL.js rename to assets/index-BxNZGJ7n.js index da25719..3a95cc4 100644 --- a/assets/index-DXU20IJL.js +++ b/assets/index-BxNZGJ7n.js @@ -3824,7 +3824,7 @@ void main() { } -}`;class Up{constructor(){this.texture=null,this.mesh=null,this.depthNear=0,this.depthFar=0}init(e,t,n){if(this.texture===null){const r=new ht,s=e.properties.get(r);s.__webglTexture=t.texture,(t.depthNear!==n.depthNear||t.depthFar!==n.depthFar)&&(this.depthNear=t.depthNear,this.depthFar=t.depthFar),this.texture=r}}getMesh(e){if(this.texture!==null&&this.mesh===null){const t=e.cameras[0].viewport,n=new hn({vertexShader:Dp,fragmentShader:Lp,uniforms:{depthColor:{value:this.texture},depthWidth:{value:t.z},depthHeight:{value:t.w}}});this.mesh=new jt(new Bi(20,20),n)}return this.mesh}reset(){this.texture=null,this.mesh=null}getDepthTexture(){return this.texture}}class Ip extends xi{constructor(e,t){super();const n=this;let r=null,s=1,o=null,a="local-floor",l=1,c=null,u=null,d=null,h=null,m=null,x=null;const T=new Up,p=t.getContextAttributes();let f=null,M=null;const _=[],v=[],R=new qe;let w=null;const b=new Wt;b.viewport=new st;const P=new Wt;P.viewport=new st;const E=[b,P],y=new eu;let C=null,H=null;this.cameraAutoUpdate=!0,this.enabled=!1,this.isPresenting=!1,this.getController=function(k){let ee=_[k];return ee===void 0&&(ee=new us,_[k]=ee),ee.getTargetRaySpace()},this.getControllerGrip=function(k){let ee=_[k];return ee===void 0&&(ee=new us,_[k]=ee),ee.getGripSpace()},this.getHand=function(k){let ee=_[k];return ee===void 0&&(ee=new us,_[k]=ee),ee.getHandSpace()};function z(k){const ee=v.indexOf(k.inputSource);if(ee===-1)return;const fe=_[ee];fe!==void 0&&(fe.update(k.inputSource,k.frame,c||o),fe.dispatchEvent({type:k.type,data:k.inputSource}))}function W(){r.removeEventListener("select",z),r.removeEventListener("selectstart",z),r.removeEventListener("selectend",z),r.removeEventListener("squeeze",z),r.removeEventListener("squeezestart",z),r.removeEventListener("squeezeend",z),r.removeEventListener("end",W),r.removeEventListener("inputsourceschange",q);for(let k=0;k<_.length;k++){const ee=v[k];ee!==null&&(v[k]=null,_[k].disconnect(ee))}C=null,H=null,T.reset(),e.setRenderTarget(f),m=null,h=null,d=null,r=null,M=null,Ye.stop(),n.isPresenting=!1,e.setPixelRatio(w),e.setSize(R.width,R.height,!1),n.dispatchEvent({type:"sessionend"})}this.setFramebufferScaleFactor=function(k){s=k,n.isPresenting===!0&&console.warn("THREE.WebXRManager: Cannot change framebuffer scale while presenting.")},this.setReferenceSpaceType=function(k){a=k,n.isPresenting===!0&&console.warn("THREE.WebXRManager: Cannot change reference space type while presenting.")},this.getReferenceSpace=function(){return c||o},this.setReferenceSpace=function(k){c=k},this.getBaseLayer=function(){return h!==null?h:m},this.getBinding=function(){return d},this.getFrame=function(){return x},this.getSession=function(){return r},this.setSession=async function(k){if(r=k,r!==null){if(f=e.getRenderTarget(),r.addEventListener("select",z),r.addEventListener("selectstart",z),r.addEventListener("selectend",z),r.addEventListener("squeeze",z),r.addEventListener("squeezestart",z),r.addEventListener("squeezeend",z),r.addEventListener("end",W),r.addEventListener("inputsourceschange",q),p.xrCompatible!==!0&&await t.makeXRCompatible(),w=e.getPixelRatio(),e.getSize(R),r.enabledFeatures!==void 0&&r.enabledFeatures.includes("layers")){let fe=null,ne=null,Se=null;p.depth&&(Se=p.stencil?t.DEPTH24_STENCIL8:t.DEPTH_COMPONENT24,fe=p.stencil?gi:ui,ne=p.stencil?mi:Vn);const Ae={colorFormat:t.RGBA8,depthFormat:Se,scaleFactor:s};d=new XRWebGLBinding(r,t),h=d.createProjectionLayer(Ae),r.updateRenderState({layers:[h]}),e.setPixelRatio(1),e.setSize(h.textureWidth,h.textureHeight,!1),M=new Hn(h.textureWidth,h.textureHeight,{format:Nt,type:fn,depthTexture:new nl(h.textureWidth,h.textureHeight,ne,void 0,void 0,void 0,void 0,void 0,void 0,fe),stencilBuffer:p.stencil,colorSpace:e.outputColorSpace,samples:p.antialias?4:0,resolveDepthBuffer:h.ignoreDepthValues===!1})}else{const fe={antialias:p.antialias,alpha:!0,depth:p.depth,stencil:p.stencil,framebufferScaleFactor:s};m=new XRWebGLLayer(r,t,fe),r.updateRenderState({baseLayer:m}),e.setPixelRatio(1),e.setSize(m.framebufferWidth,m.framebufferHeight,!1),M=new Hn(m.framebufferWidth,m.framebufferHeight,{format:Nt,type:fn,colorSpace:e.outputColorSpace,stencilBuffer:p.stencil})}M.isXRRenderTarget=!0,this.setFoveation(l),c=null,o=await r.requestReferenceSpace(a),Ye.setContext(r),Ye.start(),n.isPresenting=!0,n.dispatchEvent({type:"sessionstart"})}},this.getEnvironmentBlendMode=function(){if(r!==null)return r.environmentBlendMode},this.getDepthTexture=function(){return T.getDepthTexture()};function q(k){for(let ee=0;ee=0&&(v[ne]=null,_[ne].disconnect(fe))}for(let ee=0;ee=v.length){v.push(fe),ne=Ae;break}else if(v[Ae]===null){v[Ae]=fe,ne=Ae;break}if(ne===-1)break}const Se=_[ne];Se&&Se.connect(fe)}}const X=new V,Z=new V;function N(k,ee,fe){X.setFromMatrixPosition(ee.matrixWorld),Z.setFromMatrixPosition(fe.matrixWorld);const ne=X.distanceTo(Z),Se=ee.projectionMatrix.elements,Ae=fe.projectionMatrix.elements,Pe=Se[14]/(Se[10]-1),Ke=Se[14]/(Se[10]+1),Fe=(Se[9]+1)/Se[5],Qe=(Se[9]-1)/Se[5],D=(Se[8]-1)/Se[0],Ct=(Ae[8]+1)/Ae[0],Oe=Pe*D,Be=Pe*Ct,Me=ne/(-D+Ct),et=Me*-D;if(ee.matrixWorld.decompose(k.position,k.quaternion,k.scale),k.translateX(et),k.translateZ(Me),k.matrixWorld.compose(k.position,k.quaternion,k.scale),k.matrixWorldInverse.copy(k.matrixWorld).invert(),Se[10]===-1)k.projectionMatrix.copy(ee.projectionMatrix),k.projectionMatrixInverse.copy(ee.projectionMatrixInverse);else{const xe=Pe+Me,A=Ke+Me,g=Oe-et,F=Be+(ne-et),$=Fe*Ke/A*xe,j=Qe*Ke/A*xe;k.projectionMatrix.makePerspective(g,F,$,j,xe,A),k.projectionMatrixInverse.copy(k.projectionMatrix).invert()}}function te(k,ee){ee===null?k.matrixWorld.copy(k.matrix):k.matrixWorld.multiplyMatrices(ee.matrixWorld,k.matrix),k.matrixWorldInverse.copy(k.matrixWorld).invert()}this.updateCamera=function(k){if(r===null)return;let ee=k.near,fe=k.far;T.texture!==null&&(T.depthNear>0&&(ee=T.depthNear),T.depthFar>0&&(fe=T.depthFar)),y.near=P.near=b.near=ee,y.far=P.far=b.far=fe,(C!==y.near||H!==y.far)&&(r.updateRenderState({depthNear:y.near,depthFar:y.far}),C=y.near,H=y.far),b.layers.mask=k.layers.mask|2,P.layers.mask=k.layers.mask|4,y.layers.mask=b.layers.mask|P.layers.mask;const ne=k.parent,Se=y.cameras;te(y,ne);for(let Ae=0;Ae0&&(p.alphaTest.value=f.alphaTest);const M=e.get(f),_=M.envMap,v=M.envMapRotation;_&&(p.envMap.value=_,Un.copy(v),Un.x*=-1,Un.y*=-1,Un.z*=-1,_.isCubeTexture&&_.isRenderTargetTexture===!1&&(Un.y*=-1,Un.z*=-1),p.envMapRotation.value.setFromMatrix4(Fp.makeRotationFromEuler(Un)),p.flipEnvMap.value=_.isCubeTexture&&_.isRenderTargetTexture===!1?-1:1,p.reflectivity.value=f.reflectivity,p.ior.value=f.ior,p.refractionRatio.value=f.refractionRatio),f.lightMap&&(p.lightMap.value=f.lightMap,p.lightMapIntensity.value=f.lightMapIntensity,t(f.lightMap,p.lightMapTransform)),f.aoMap&&(p.aoMap.value=f.aoMap,p.aoMapIntensity.value=f.aoMapIntensity,t(f.aoMap,p.aoMapTransform))}function o(p,f){p.diffuse.value.copy(f.color),p.opacity.value=f.opacity,f.map&&(p.map.value=f.map,t(f.map,p.mapTransform))}function a(p,f){p.dashSize.value=f.dashSize,p.totalSize.value=f.dashSize+f.gapSize,p.scale.value=f.scale}function l(p,f,M,_){p.diffuse.value.copy(f.color),p.opacity.value=f.opacity,p.size.value=f.size*M,p.scale.value=_*.5,f.map&&(p.map.value=f.map,t(f.map,p.uvTransform)),f.alphaMap&&(p.alphaMap.value=f.alphaMap,t(f.alphaMap,p.alphaMapTransform)),f.alphaTest>0&&(p.alphaTest.value=f.alphaTest)}function c(p,f){p.diffuse.value.copy(f.color),p.opacity.value=f.opacity,p.rotation.value=f.rotation,f.map&&(p.map.value=f.map,t(f.map,p.mapTransform)),f.alphaMap&&(p.alphaMap.value=f.alphaMap,t(f.alphaMap,p.alphaMapTransform)),f.alphaTest>0&&(p.alphaTest.value=f.alphaTest)}function u(p,f){p.specular.value.copy(f.specular),p.shininess.value=Math.max(f.shininess,1e-4)}function d(p,f){f.gradientMap&&(p.gradientMap.value=f.gradientMap)}function h(p,f){p.metalness.value=f.metalness,f.metalnessMap&&(p.metalnessMap.value=f.metalnessMap,t(f.metalnessMap,p.metalnessMapTransform)),p.roughness.value=f.roughness,f.roughnessMap&&(p.roughnessMap.value=f.roughnessMap,t(f.roughnessMap,p.roughnessMapTransform)),f.envMap&&(p.envMapIntensity.value=f.envMapIntensity)}function m(p,f,M){p.ior.value=f.ior,f.sheen>0&&(p.sheenColor.value.copy(f.sheenColor).multiplyScalar(f.sheen),p.sheenRoughness.value=f.sheenRoughness,f.sheenColorMap&&(p.sheenColorMap.value=f.sheenColorMap,t(f.sheenColorMap,p.sheenColorMapTransform)),f.sheenRoughnessMap&&(p.sheenRoughnessMap.value=f.sheenRoughnessMap,t(f.sheenRoughnessMap,p.sheenRoughnessMapTransform))),f.clearcoat>0&&(p.clearcoat.value=f.clearcoat,p.clearcoatRoughness.value=f.clearcoatRoughness,f.clearcoatMap&&(p.clearcoatMap.value=f.clearcoatMap,t(f.clearcoatMap,p.clearcoatMapTransform)),f.clearcoatRoughnessMap&&(p.clearcoatRoughnessMap.value=f.clearcoatRoughnessMap,t(f.clearcoatRoughnessMap,p.clearcoatRoughnessMapTransform)),f.clearcoatNormalMap&&(p.clearcoatNormalMap.value=f.clearcoatNormalMap,t(f.clearcoatNormalMap,p.clearcoatNormalMapTransform),p.clearcoatNormalScale.value.copy(f.clearcoatNormalScale),f.side===Tt&&p.clearcoatNormalScale.value.negate())),f.dispersion>0&&(p.dispersion.value=f.dispersion),f.iridescence>0&&(p.iridescence.value=f.iridescence,p.iridescenceIOR.value=f.iridescenceIOR,p.iridescenceThicknessMinimum.value=f.iridescenceThicknessRange[0],p.iridescenceThicknessMaximum.value=f.iridescenceThicknessRange[1],f.iridescenceMap&&(p.iridescenceMap.value=f.iridescenceMap,t(f.iridescenceMap,p.iridescenceMapTransform)),f.iridescenceThicknessMap&&(p.iridescenceThicknessMap.value=f.iridescenceThicknessMap,t(f.iridescenceThicknessMap,p.iridescenceThicknessMapTransform))),f.transmission>0&&(p.transmission.value=f.transmission,p.transmissionSamplerMap.value=M.texture,p.transmissionSamplerSize.value.set(M.width,M.height),f.transmissionMap&&(p.transmissionMap.value=f.transmissionMap,t(f.transmissionMap,p.transmissionMapTransform)),p.thickness.value=f.thickness,f.thicknessMap&&(p.thicknessMap.value=f.thicknessMap,t(f.thicknessMap,p.thicknessMapTransform)),p.attenuationDistance.value=f.attenuationDistance,p.attenuationColor.value.copy(f.attenuationColor)),f.anisotropy>0&&(p.anisotropyVector.value.set(f.anisotropy*Math.cos(f.anisotropyRotation),f.anisotropy*Math.sin(f.anisotropyRotation)),f.anisotropyMap&&(p.anisotropyMap.value=f.anisotropyMap,t(f.anisotropyMap,p.anisotropyMapTransform))),p.specularIntensity.value=f.specularIntensity,p.specularColor.value.copy(f.specularColor),f.specularColorMap&&(p.specularColorMap.value=f.specularColorMap,t(f.specularColorMap,p.specularColorMapTransform)),f.specularIntensityMap&&(p.specularIntensityMap.value=f.specularIntensityMap,t(f.specularIntensityMap,p.specularIntensityMapTransform))}function x(p,f){f.matcap&&(p.matcap.value=f.matcap)}function T(p,f){const M=e.get(f).light;p.referencePosition.value.setFromMatrixPosition(M.matrixWorld),p.nearDistance.value=M.shadow.camera.near,p.farDistance.value=M.shadow.camera.far}return{refreshFogUniforms:n,refreshMaterialUniforms:r}}function Op(i,e,t,n){let r={},s={},o=[];const a=i.getParameter(i.MAX_UNIFORM_BUFFER_BINDINGS);function l(M,_){const v=_.program;n.uniformBlockBinding(M,v)}function c(M,_){let v=r[M.id];v===void 0&&(x(M),v=u(M),r[M.id]=v,M.addEventListener("dispose",p));const R=_.program;n.updateUBOMapping(M,R);const w=e.render.frame;s[M.id]!==w&&(h(M),s[M.id]=w)}function u(M){const _=d();M.__bindingPointIndex=_;const v=i.createBuffer(),R=M.__size,w=M.usage;return i.bindBuffer(i.UNIFORM_BUFFER,v),i.bufferData(i.UNIFORM_BUFFER,R,w),i.bindBuffer(i.UNIFORM_BUFFER,null),i.bindBufferBase(i.UNIFORM_BUFFER,_,v),v}function d(){for(let M=0;M0&&(v+=R-w),M.__size=v,M.__cache={},this}function T(M){const _={boundary:0,storage:0};return typeof M=="number"||typeof M=="boolean"?(_.boundary=4,_.storage=4):M.isVector2?(_.boundary=8,_.storage=8):M.isVector3||M.isColor?(_.boundary=16,_.storage=12):M.isVector4?(_.boundary=16,_.storage=16):M.isMatrix3?(_.boundary=48,_.storage=48):M.isMatrix4?(_.boundary=64,_.storage=64):M.isTexture?console.warn("THREE.WebGLRenderer: Texture samplers can not be part of an uniforms group."):console.warn("THREE.WebGLRenderer: Unsupported uniform value type.",M),_}function p(M){const _=M.target;_.removeEventListener("dispose",p);const v=o.indexOf(_.__bindingPointIndex);o.splice(v,1),i.deleteBuffer(r[_.id]),delete r[_.id],delete s[_.id]}function f(){for(const M in r)i.deleteBuffer(r[M]);o=[],r={},s={}}return{bind:l,update:c,dispose:f}}class Bp{constructor(e={}){const{canvas:t=_c(),context:n=null,depth:r=!0,stencil:s=!1,alpha:o=!1,antialias:a=!1,premultipliedAlpha:l=!0,preserveDrawingBuffer:c=!1,powerPreference:u="default",failIfMajorPerformanceCaveat:d=!1,reverseDepthBuffer:h=!1}=e;this.isWebGLRenderer=!0;let m;if(n!==null){if(typeof WebGLRenderingContext<"u"&&n instanceof WebGLRenderingContext)throw new Error("THREE.WebGLRenderer: WebGL 1 is not supported since r163.");m=n.getContextAttributes().alpha}else m=o;const x=new Uint32Array(4),T=new Int32Array(4);let p=null,f=null;const M=[],_=[];this.domElement=t,this.debug={checkShaderErrors:!0,onShaderError:null},this.autoClear=!0,this.autoClearColor=!0,this.autoClearDepth=!0,this.autoClearStencil=!0,this.sortObjects=!0,this.clippingPlanes=[],this.localClippingEnabled=!1,this._outputColorSpace=It,this.toneMapping=En,this.toneMappingExposure=1;const v=this;let R=!1,w=0,b=0,P=null,E=-1,y=null;const C=new st,H=new st;let z=null;const W=new je(0);let q=0,X=t.width,Z=t.height,N=1,te=null,ae=null;const _e=new st(0,0,X,Z),Te=new st(0,0,X,Z);let Ye=!1;const k=new tl;let ee=!1,fe=!1;this.transmissionResolutionScale=1;const ne=new lt,Se=new lt,Ae=new V,Pe=new st,Ke={background:null,fog:null,environment:null,overrideMaterial:null,isScene:!0};let Fe=!1;function Qe(){return P===null?N:1}let D=n;function Ct(S,U){return t.getContext(S,U)}try{const S={alpha:!0,depth:r,stencil:s,antialias:a,premultipliedAlpha:l,preserveDrawingBuffer:c,powerPreference:u,failIfMajorPerformanceCaveat:d};if("setAttribute"in t&&t.setAttribute("data-engine",`three.js r${ta}`),t.addEventListener("webglcontextlost",K,!1),t.addEventListener("webglcontextrestored",ce,!1),t.addEventListener("webglcontextcreationerror",le,!1),D===null){const U="webgl2";if(D=Ct(U,S),D===null)throw Ct(U)?new Error("Error creating WebGL context with your selected attributes."):new Error("Error creating WebGL context.")}}catch(S){throw console.error("THREE.WebGLRenderer: "+S.message),S}let Oe,Be,Me,et,xe,A,g,F,$,j,Y,ve,oe,de,Ve,Q,pe,be,we,me,ze,Ue,Je,L;function re(){Oe=new Yd(D),Oe.init(),Ue=new Cp(D,Oe),Be=new Hd(D,Oe,e,Ue),Me=new wp(D,Oe),Be.reverseDepthBuffer&&h&&Me.buffers.depth.setReversed(!0),et=new Zd(D),xe=new pp,A=new Rp(D,Oe,Me,xe,Be,Ue,et),g=new kd(v),F=new qd(v),$=new nu(D),Je=new zd(D,$),j=new $d(D,$,et,Je),Y=new Jd(D,j,$,et),we=new jd(D,Be,A),Q=new Gd(xe),ve=new hp(v,g,F,Oe,Be,Je,Q),oe=new Np(v,xe),de=new gp,Ve=new yp(Oe),be=new Bd(v,g,F,Me,Y,m,l),pe=new bp(v,Y,Be),L=new Op(D,et,Be,Me),me=new Vd(D,Oe,et),ze=new Kd(D,Oe,et),et.programs=ve.programs,v.capabilities=Be,v.extensions=Oe,v.properties=xe,v.renderLists=de,v.shadowMap=pe,v.state=Me,v.info=et}re();const G=new Ip(v,D);this.xr=G,this.getContext=function(){return D},this.getContextAttributes=function(){return D.getContextAttributes()},this.forceContextLoss=function(){const S=Oe.get("WEBGL_lose_context");S&&S.loseContext()},this.forceContextRestore=function(){const S=Oe.get("WEBGL_lose_context");S&&S.restoreContext()},this.getPixelRatio=function(){return N},this.setPixelRatio=function(S){S!==void 0&&(N=S,this.setSize(X,Z,!1))},this.getSize=function(S){return S.set(X,Z)},this.setSize=function(S,U,O=!0){if(G.isPresenting){console.warn("THREE.WebGLRenderer: Can't change size while VR device is presenting.");return}X=S,Z=U,t.width=Math.floor(S*N),t.height=Math.floor(U*N),O===!0&&(t.style.width=S+"px",t.style.height=U+"px"),this.setViewport(0,0,S,U)},this.getDrawingBufferSize=function(S){return S.set(X*N,Z*N).floor()},this.setDrawingBufferSize=function(S,U,O){X=S,Z=U,N=O,t.width=Math.floor(S*O),t.height=Math.floor(U*O),this.setViewport(0,0,S,U)},this.getCurrentViewport=function(S){return S.copy(C)},this.getViewport=function(S){return S.copy(_e)},this.setViewport=function(S,U,O,B){S.isVector4?_e.set(S.x,S.y,S.z,S.w):_e.set(S,U,O,B),Me.viewport(C.copy(_e).multiplyScalar(N).round())},this.getScissor=function(S){return S.copy(Te)},this.setScissor=function(S,U,O,B){S.isVector4?Te.set(S.x,S.y,S.z,S.w):Te.set(S,U,O,B),Me.scissor(H.copy(Te).multiplyScalar(N).round())},this.getScissorTest=function(){return Ye},this.setScissorTest=function(S){Me.setScissorTest(Ye=S)},this.setOpaqueSort=function(S){te=S},this.setTransparentSort=function(S){ae=S},this.getClearColor=function(S){return S.copy(be.getClearColor())},this.setClearColor=function(){be.setClearColor.apply(be,arguments)},this.getClearAlpha=function(){return be.getClearAlpha()},this.setClearAlpha=function(){be.setClearAlpha.apply(be,arguments)},this.clear=function(S=!0,U=!0,O=!0){let B=0;if(S){let I=!1;if(P!==null){const J=P.texture.format;I=J===oa||J===aa||J===sa}if(I){const J=P.texture.type,se=J===fn||J===Vn||J===Di||J===mi||J===ia||J===ra,ue=be.getClearColor(),ge=be.getClearAlpha(),Re=ue.r,Ce=ue.g,ye=ue.b;se?(x[0]=Re,x[1]=Ce,x[2]=ye,x[3]=ge,D.clearBufferuiv(D.COLOR,0,x)):(T[0]=Re,T[1]=Ce,T[2]=ye,T[3]=ge,D.clearBufferiv(D.COLOR,0,T))}else B|=D.COLOR_BUFFER_BIT}U&&(B|=D.DEPTH_BUFFER_BIT),O&&(B|=D.STENCIL_BUFFER_BIT,this.state.buffers.stencil.setMask(4294967295)),D.clear(B)},this.clearColor=function(){this.clear(!0,!1,!1)},this.clearDepth=function(){this.clear(!1,!0,!1)},this.clearStencil=function(){this.clear(!1,!1,!0)},this.dispose=function(){t.removeEventListener("webglcontextlost",K,!1),t.removeEventListener("webglcontextrestored",ce,!1),t.removeEventListener("webglcontextcreationerror",le,!1),be.dispose(),de.dispose(),Ve.dispose(),xe.dispose(),g.dispose(),F.dispose(),Y.dispose(),Je.dispose(),L.dispose(),ve.dispose(),G.dispose(),G.removeEventListener("sessionstart",pa),G.removeEventListener("sessionend",ma),An.stop()};function K(S){S.preventDefault(),console.log("THREE.WebGLRenderer: Context Lost."),R=!0}function ce(){console.log("THREE.WebGLRenderer: Context Restored."),R=!1;const S=et.autoReset,U=pe.enabled,O=pe.autoUpdate,B=pe.needsUpdate,I=pe.type;re(),et.autoReset=S,pe.enabled=U,pe.autoUpdate=O,pe.needsUpdate=B,pe.type=I}function le(S){console.error("THREE.WebGLRenderer: A WebGL context could not be created. Reason: ",S.statusMessage)}function De(S){const U=S.target;U.removeEventListener("dispose",De),it(U)}function it(S){mt(S),xe.remove(S)}function mt(S){const U=xe.get(S).programs;U!==void 0&&(U.forEach(function(O){ve.releaseProgram(O)}),S.isShaderMaterial&&ve.releaseShaderCache(S))}this.renderBufferDirect=function(S,U,O,B,I,J){U===null&&(U=Ke);const se=I.isMesh&&I.matrixWorld.determinant()<0,ue=Ml(S,U,O,B,I);Me.setMaterial(B,se);let ge=O.index,Re=1;if(B.wireframe===!0){if(ge=j.getWireframeAttribute(O),ge===void 0)return;Re=2}const Ce=O.drawRange,ye=O.attributes.position;let He=Ce.start*Re,We=(Ce.start+Ce.count)*Re;J!==null&&(He=Math.max(He,J.start*Re),We=Math.min(We,(J.start+J.count)*Re)),ge!==null?(He=Math.max(He,0),We=Math.min(We,ge.count)):ye!=null&&(He=Math.max(He,0),We=Math.min(We,ye.count));const at=We-He;if(at<0||at===1/0)return;Je.setup(I,B,ue,O,ge);let rt,Ge=me;if(ge!==null&&(rt=$.get(ge),Ge=ze,Ge.setIndex(rt)),I.isMesh)B.wireframe===!0?(Me.setLineWidth(B.wireframeLinewidth*Qe()),Ge.setMode(D.LINES)):Ge.setMode(D.TRIANGLES);else if(I.isLine){let Ee=B.linewidth;Ee===void 0&&(Ee=1),Me.setLineWidth(Ee*Qe()),I.isLineSegments?Ge.setMode(D.LINES):I.isLineLoop?Ge.setMode(D.LINE_LOOP):Ge.setMode(D.LINE_STRIP)}else I.isPoints?Ge.setMode(D.POINTS):I.isSprite&&Ge.setMode(D.TRIANGLES);if(I.isBatchedMesh)if(I._multiDrawInstances!==null)Ge.renderMultiDrawInstances(I._multiDrawStarts,I._multiDrawCounts,I._multiDrawCount,I._multiDrawInstances);else if(Oe.get("WEBGL_multi_draw"))Ge.renderMultiDraw(I._multiDrawStarts,I._multiDrawCounts,I._multiDrawCount);else{const Ee=I._multiDrawStarts,pt=I._multiDrawCounts,Xe=I._multiDrawCount,Bt=ge?$.get(ge).bytesPerElement:1,kn=xe.get(B).currentProgram.getUniforms();for(let bt=0;bt{function J(){if(B.forEach(function(se){xe.get(se).currentProgram.isReady()&&B.delete(se)}),B.size===0){I(S);return}setTimeout(J,10)}Oe.get("KHR_parallel_shader_compile")!==null?J():setTimeout(J,10)})};let Ot=null;function Qt(S){Ot&&Ot(S)}function pa(){An.stop()}function ma(){An.start()}const An=new rl;An.setAnimationLoop(Qt),typeof self<"u"&&An.setContext(self),this.setAnimationLoop=function(S){Ot=S,G.setAnimationLoop(S),S===null?An.stop():An.start()},G.addEventListener("sessionstart",pa),G.addEventListener("sessionend",ma),this.render=function(S,U){if(U!==void 0&&U.isCamera!==!0){console.error("THREE.WebGLRenderer.render: camera is not an instance of THREE.Camera.");return}if(R===!0)return;if(S.matrixWorldAutoUpdate===!0&&S.updateMatrixWorld(),U.parent===null&&U.matrixWorldAutoUpdate===!0&&U.updateMatrixWorld(),G.enabled===!0&&G.isPresenting===!0&&(G.cameraAutoUpdate===!0&&G.updateCamera(U),U=G.getCamera()),S.isScene===!0&&S.onBeforeRender(v,S,U,P),f=Ve.get(S,_.length),f.init(U),_.push(f),Se.multiplyMatrices(U.projectionMatrix,U.matrixWorldInverse),k.setFromProjectionMatrix(Se),fe=this.localClippingEnabled,ee=Q.init(this.clippingPlanes,fe),p=de.get(S,M.length),p.init(),M.push(p),G.enabled===!0&&G.isPresenting===!0){const J=v.xr.getDepthSensingMesh();J!==null&&Ur(J,U,-1/0,v.sortObjects)}Ur(S,U,0,v.sortObjects),p.finish(),v.sortObjects===!0&&p.sort(te,ae),Fe=G.enabled===!1||G.isPresenting===!1||G.hasDepthSensing()===!1,Fe&&be.addToRenderList(p,S),this.info.render.frame++,ee===!0&&Q.beginShadows();const O=f.state.shadowsArray;pe.render(O,S,U),ee===!0&&Q.endShadows(),this.info.autoReset===!0&&this.info.reset();const B=p.opaque,I=p.transmissive;if(f.setupLights(),U.isArrayCamera){const J=U.cameras;if(I.length>0)for(let se=0,ue=J.length;se0&&_a(B,I,S,U),Fe&&be.render(S),ga(p,S,U);P!==null&&b===0&&(A.updateMultisampleRenderTarget(P),A.updateRenderTargetMipmap(P)),S.isScene===!0&&S.onAfterRender(v,S,U),Je.resetDefaultState(),E=-1,y=null,_.pop(),_.length>0?(f=_[_.length-1],ee===!0&&Q.setGlobalState(v.clippingPlanes,f.state.camera)):f=null,M.pop(),M.length>0?p=M[M.length-1]:p=null};function Ur(S,U,O,B){if(S.visible===!1)return;if(S.layers.test(U.layers)){if(S.isGroup)O=S.renderOrder;else if(S.isLOD)S.autoUpdate===!0&&S.update(U);else if(S.isLight)f.pushLight(S),S.castShadow&&f.pushShadow(S);else if(S.isSprite){if(!S.frustumCulled||k.intersectsSprite(S)){B&&Pe.setFromMatrixPosition(S.matrixWorld).applyMatrix4(Se);const se=Y.update(S),ue=S.material;ue.visible&&p.push(S,se,ue,O,Pe.z,null)}}else if((S.isMesh||S.isLine||S.isPoints)&&(!S.frustumCulled||k.intersectsObject(S))){const se=Y.update(S),ue=S.material;if(B&&(S.boundingSphere!==void 0?(S.boundingSphere===null&&S.computeBoundingSphere(),Pe.copy(S.boundingSphere.center)):(se.boundingSphere===null&&se.computeBoundingSphere(),Pe.copy(se.boundingSphere.center)),Pe.applyMatrix4(S.matrixWorld).applyMatrix4(Se)),Array.isArray(ue)){const ge=se.groups;for(let Re=0,Ce=ge.length;Re0&&Vi(I,U,O),J.length>0&&Vi(J,U,O),se.length>0&&Vi(se,U,O),Me.buffers.depth.setTest(!0),Me.buffers.depth.setMask(!0),Me.buffers.color.setMask(!0),Me.setPolygonOffset(!1)}function _a(S,U,O,B){if((O.isScene===!0?O.overrideMaterial:null)!==null)return;f.state.transmissionRenderTarget[B.id]===void 0&&(f.state.transmissionRenderTarget[B.id]=new Hn(1,1,{generateMipmaps:!0,type:Oe.has("EXT_color_buffer_half_float")||Oe.has("EXT_color_buffer_float")?Ui:fn,minFilter:Bn,samples:4,stencilBuffer:s,resolveDepthBuffer:!1,resolveStencilBuffer:!1,colorSpace:ke.workingColorSpace}));const J=f.state.transmissionRenderTarget[B.id],se=B.viewport||C;J.setSize(se.z*v.transmissionResolutionScale,se.w*v.transmissionResolutionScale);const ue=v.getRenderTarget();v.setRenderTarget(J),v.getClearColor(W),q=v.getClearAlpha(),q<1&&v.setClearColor(16777215,.5),v.clear(),Fe&&be.render(O);const ge=v.toneMapping;v.toneMapping=En;const Re=B.viewport;if(B.viewport!==void 0&&(B.viewport=void 0),f.setupLightsView(B),ee===!0&&Q.setGlobalState(v.clippingPlanes,B),Vi(S,O,B),A.updateMultisampleRenderTarget(J),A.updateRenderTargetMipmap(J),Oe.has("WEBGL_multisampled_render_to_texture")===!1){let Ce=!1;for(let ye=0,He=U.length;ye0),ye=!!O.morphAttributes.position,He=!!O.morphAttributes.normal,We=!!O.morphAttributes.color;let at=En;B.toneMapped&&(P===null||P.isXRRenderTarget===!0)&&(at=v.toneMapping);const rt=O.morphAttributes.position||O.morphAttributes.normal||O.morphAttributes.color,Ge=rt!==void 0?rt.length:0,Ee=xe.get(B),pt=f.state.lights;if(ee===!0&&(fe===!0||S!==y)){const xt=S===y&&B.id===E;Q.setState(B,S,xt)}let Xe=!1;B.version===Ee.__version?(Ee.needsLights&&Ee.lightsStateVersion!==pt.state.version||Ee.outputColorSpace!==ue||I.isBatchedMesh&&Ee.batching===!1||!I.isBatchedMesh&&Ee.batching===!0||I.isBatchedMesh&&Ee.batchingColor===!0&&I.colorTexture===null||I.isBatchedMesh&&Ee.batchingColor===!1&&I.colorTexture!==null||I.isInstancedMesh&&Ee.instancing===!1||!I.isInstancedMesh&&Ee.instancing===!0||I.isSkinnedMesh&&Ee.skinning===!1||!I.isSkinnedMesh&&Ee.skinning===!0||I.isInstancedMesh&&Ee.instancingColor===!0&&I.instanceColor===null||I.isInstancedMesh&&Ee.instancingColor===!1&&I.instanceColor!==null||I.isInstancedMesh&&Ee.instancingMorph===!0&&I.morphTexture===null||I.isInstancedMesh&&Ee.instancingMorph===!1&&I.morphTexture!==null||Ee.envMap!==ge||B.fog===!0&&Ee.fog!==J||Ee.numClippingPlanes!==void 0&&(Ee.numClippingPlanes!==Q.numPlanes||Ee.numIntersection!==Q.numIntersection)||Ee.vertexAlphas!==Re||Ee.vertexTangents!==Ce||Ee.morphTargets!==ye||Ee.morphNormals!==He||Ee.morphColors!==We||Ee.toneMapping!==at||Ee.morphTargetsCount!==Ge)&&(Xe=!0):(Xe=!0,Ee.__version=B.version);let Bt=Ee.currentProgram;Xe===!0&&(Bt=Hi(B,U,I));let kn=!1,bt=!1,Si=!1;const tt=Bt.getUniforms(),Pt=Ee.uniforms;if(Me.useProgram(Bt.program)&&(kn=!0,bt=!0,Si=!0),B.id!==E&&(E=B.id,bt=!0),kn||y!==S){Me.buffers.depth.getReversed()?(ne.copy(S.projectionMatrix),xc(ne),Mc(ne),tt.setValue(D,"projectionMatrix",ne)):tt.setValue(D,"projectionMatrix",S.projectionMatrix),tt.setValue(D,"viewMatrix",S.matrixWorldInverse);const St=tt.map.cameraPosition;St!==void 0&&St.setValue(D,Ae.setFromMatrixPosition(S.matrixWorld)),Be.logarithmicDepthBuffer&&tt.setValue(D,"logDepthBufFC",2/(Math.log(S.far+1)/Math.LN2)),(B.isMeshPhongMaterial||B.isMeshToonMaterial||B.isMeshLambertMaterial||B.isMeshBasicMaterial||B.isMeshStandardMaterial||B.isShaderMaterial)&&tt.setValue(D,"isOrthographic",S.isOrthographicCamera===!0),y!==S&&(y=S,bt=!0,Si=!0)}if(I.isSkinnedMesh){tt.setOptional(D,I,"bindMatrix"),tt.setOptional(D,I,"bindMatrixInverse");const xt=I.skeleton;xt&&(xt.boneTexture===null&&xt.computeBoneTexture(),tt.setValue(D,"boneTexture",xt.boneTexture,A))}I.isBatchedMesh&&(tt.setOptional(D,I,"batchingTexture"),tt.setValue(D,"batchingTexture",I._matricesTexture,A),tt.setOptional(D,I,"batchingIdTexture"),tt.setValue(D,"batchingIdTexture",I._indirectTexture,A),tt.setOptional(D,I,"batchingColorTexture"),I._colorsTexture!==null&&tt.setValue(D,"batchingColorTexture",I._colorsTexture,A));const Dt=O.morphAttributes;if((Dt.position!==void 0||Dt.normal!==void 0||Dt.color!==void 0)&&we.update(I,O,Bt),(bt||Ee.receiveShadow!==I.receiveShadow)&&(Ee.receiveShadow=I.receiveShadow,tt.setValue(D,"receiveShadow",I.receiveShadow)),B.isMeshGouraudMaterial&&B.envMap!==null&&(Pt.envMap.value=ge,Pt.flipEnvMap.value=ge.isCubeTexture&&ge.isRenderTargetTexture===!1?-1:1),B.isMeshStandardMaterial&&B.envMap===null&&U.environment!==null&&(Pt.envMapIntensity.value=U.environmentIntensity),bt&&(tt.setValue(D,"toneMappingExposure",v.toneMappingExposure),Ee.needsLights&&Sl(Pt,Si),J&&B.fog===!0&&oe.refreshFogUniforms(Pt,J),oe.refreshMaterialUniforms(Pt,B,N,Z,f.state.transmissionRenderTarget[S.id]),vr.upload(D,xa(Ee),Pt,A)),B.isShaderMaterial&&B.uniformsNeedUpdate===!0&&(vr.upload(D,xa(Ee),Pt,A),B.uniformsNeedUpdate=!1),B.isSpriteMaterial&&tt.setValue(D,"center",I.center),tt.setValue(D,"modelViewMatrix",I.modelViewMatrix),tt.setValue(D,"normalMatrix",I.normalMatrix),tt.setValue(D,"modelMatrix",I.matrixWorld),B.isShaderMaterial||B.isRawShaderMaterial){const xt=B.uniformsGroups;for(let St=0,Ir=xt.length;St0&&A.useMultisampledRTT(S)===!1?I=xe.get(S).__webglMultisampledFramebuffer:Array.isArray(Ce)?I=Ce[O]:I=Ce,C.copy(S.viewport),H.copy(S.scissor),z=S.scissorTest}else C.copy(_e).multiplyScalar(N).floor(),H.copy(Te).multiplyScalar(N).floor(),z=Ye;if(O!==0&&(I=El),Me.bindFramebuffer(D.FRAMEBUFFER,I)&&B&&Me.drawBuffers(S,I),Me.viewport(C),Me.scissor(H),Me.setScissorTest(z),J){const ge=xe.get(S.texture);D.framebufferTexture2D(D.FRAMEBUFFER,D.COLOR_ATTACHMENT0,D.TEXTURE_CUBE_MAP_POSITIVE_X+U,ge.__webglTexture,O)}else if(se){const ge=xe.get(S.texture),Re=U;D.framebufferTextureLayer(D.FRAMEBUFFER,D.COLOR_ATTACHMENT0,ge.__webglTexture,O,Re)}else if(S!==null&&O!==0){const ge=xe.get(S.texture);D.framebufferTexture2D(D.FRAMEBUFFER,D.COLOR_ATTACHMENT0,D.TEXTURE_2D,ge.__webglTexture,O)}E=-1},this.readRenderTargetPixels=function(S,U,O,B,I,J,se){if(!(S&&S.isWebGLRenderTarget)){console.error("THREE.WebGLRenderer.readRenderTargetPixels: renderTarget is not THREE.WebGLRenderTarget.");return}let ue=xe.get(S).__webglFramebuffer;if(S.isWebGLCubeRenderTarget&&se!==void 0&&(ue=ue[se]),ue){Me.bindFramebuffer(D.FRAMEBUFFER,ue);try{const ge=S.texture,Re=ge.format,Ce=ge.type;if(!Be.textureFormatReadable(Re)){console.error("THREE.WebGLRenderer.readRenderTargetPixels: renderTarget is not in RGBA or implementation defined format.");return}if(!Be.textureTypeReadable(Ce)){console.error("THREE.WebGLRenderer.readRenderTargetPixels: renderTarget is not in UnsignedByteType or implementation defined type.");return}U>=0&&U<=S.width-B&&O>=0&&O<=S.height-I&&D.readPixels(U,O,B,I,Ue.convert(Re),Ue.convert(Ce),J)}finally{const ge=P!==null?xe.get(P).__webglFramebuffer:null;Me.bindFramebuffer(D.FRAMEBUFFER,ge)}}},this.readRenderTargetPixelsAsync=async function(S,U,O,B,I,J,se){if(!(S&&S.isWebGLRenderTarget))throw new Error("THREE.WebGLRenderer.readRenderTargetPixels: renderTarget is not THREE.WebGLRenderTarget.");let ue=xe.get(S).__webglFramebuffer;if(S.isWebGLCubeRenderTarget&&se!==void 0&&(ue=ue[se]),ue){const ge=S.texture,Re=ge.format,Ce=ge.type;if(!Be.textureFormatReadable(Re))throw new Error("THREE.WebGLRenderer.readRenderTargetPixelsAsync: renderTarget is not in RGBA or implementation defined format.");if(!Be.textureTypeReadable(Ce))throw new Error("THREE.WebGLRenderer.readRenderTargetPixelsAsync: renderTarget is not in UnsignedByteType or implementation defined type.");if(U>=0&&U<=S.width-B&&O>=0&&O<=S.height-I){Me.bindFramebuffer(D.FRAMEBUFFER,ue);const ye=D.createBuffer();D.bindBuffer(D.PIXEL_PACK_BUFFER,ye),D.bufferData(D.PIXEL_PACK_BUFFER,J.byteLength,D.STREAM_READ),D.readPixels(U,O,B,I,Ue.convert(Re),Ue.convert(Ce),0);const He=P!==null?xe.get(P).__webglFramebuffer:null;Me.bindFramebuffer(D.FRAMEBUFFER,He);const We=D.fenceSync(D.SYNC_GPU_COMMANDS_COMPLETE,0);return D.flush(),await vc(D,We,4),D.bindBuffer(D.PIXEL_PACK_BUFFER,ye),D.getBufferSubData(D.PIXEL_PACK_BUFFER,0,J),D.deleteBuffer(ye),D.deleteSync(We),J}else throw new Error("THREE.WebGLRenderer.readRenderTargetPixelsAsync: requested read bounds are out of range.")}},this.copyFramebufferToTexture=function(S,U=null,O=0){S.isTexture!==!0&&(si("WebGLRenderer: copyFramebufferToTexture function signature has changed."),U=arguments[0]||null,S=arguments[1]);const B=Math.pow(2,-O),I=Math.floor(S.image.width*B),J=Math.floor(S.image.height*B),se=U!==null?U.x:0,ue=U!==null?U.y:0;A.setTexture2D(S,0),D.copyTexSubImage2D(D.TEXTURE_2D,O,0,0,se,ue,I,J),Me.unbindTexture()};const Tl=D.createFramebuffer(),bl=D.createFramebuffer();this.copyTextureToTexture=function(S,U,O=null,B=null,I=0,J=null){S.isTexture!==!0&&(si("WebGLRenderer: copyTextureToTexture function signature has changed."),B=arguments[0]||null,S=arguments[1],U=arguments[2],J=arguments[3]||0,O=null),J===null&&(I!==0?(si("WebGLRenderer: copyTextureToTexture function signature has changed to support src and dst mipmap levels."),J=I,I=0):J=0);let se,ue,ge,Re,Ce,ye,He,We,at;const rt=S.isCompressedTexture?S.mipmaps[J]:S.image;if(O!==null)se=O.max.x-O.min.x,ue=O.max.y-O.min.y,ge=O.isBox3?O.max.z-O.min.z:1,Re=O.min.x,Ce=O.min.y,ye=O.isBox3?O.min.z:0;else{const Dt=Math.pow(2,-I);se=Math.floor(rt.width*Dt),ue=Math.floor(rt.height*Dt),S.isDataArrayTexture?ge=rt.depth:S.isData3DTexture?ge=Math.floor(rt.depth*Dt):ge=1,Re=0,Ce=0,ye=0}B!==null?(He=B.x,We=B.y,at=B.z):(He=0,We=0,at=0);const Ge=Ue.convert(U.format),Ee=Ue.convert(U.type);let pt;U.isData3DTexture?(A.setTexture3D(U,0),pt=D.TEXTURE_3D):U.isDataArrayTexture||U.isCompressedArrayTexture?(A.setTexture2DArray(U,0),pt=D.TEXTURE_2D_ARRAY):(A.setTexture2D(U,0),pt=D.TEXTURE_2D),D.pixelStorei(D.UNPACK_FLIP_Y_WEBGL,U.flipY),D.pixelStorei(D.UNPACK_PREMULTIPLY_ALPHA_WEBGL,U.premultiplyAlpha),D.pixelStorei(D.UNPACK_ALIGNMENT,U.unpackAlignment);const Xe=D.getParameter(D.UNPACK_ROW_LENGTH),Bt=D.getParameter(D.UNPACK_IMAGE_HEIGHT),kn=D.getParameter(D.UNPACK_SKIP_PIXELS),bt=D.getParameter(D.UNPACK_SKIP_ROWS),Si=D.getParameter(D.UNPACK_SKIP_IMAGES);D.pixelStorei(D.UNPACK_ROW_LENGTH,rt.width),D.pixelStorei(D.UNPACK_IMAGE_HEIGHT,rt.height),D.pixelStorei(D.UNPACK_SKIP_PIXELS,Re),D.pixelStorei(D.UNPACK_SKIP_ROWS,Ce),D.pixelStorei(D.UNPACK_SKIP_IMAGES,ye);const tt=S.isDataArrayTexture||S.isData3DTexture,Pt=U.isDataArrayTexture||U.isData3DTexture;if(S.isDepthTexture){const Dt=xe.get(S),xt=xe.get(U),St=xe.get(Dt.__renderTarget),Ir=xe.get(xt.__renderTarget);Me.bindFramebuffer(D.READ_FRAMEBUFFER,St.__webglFramebuffer),Me.bindFramebuffer(D.DRAW_FRAMEBUFFER,Ir.__webglFramebuffer);for(let wn=0;wn{const e=document.implementation.createHTMLDocument("test"),t=e.createRange();t.selectNodeContents(e.documentElement),t.deleteContents();const n=document.createElement("head");return e.documentElement.appendChild(n),e.documentElement.appendChild(t.createContextualFragment(i)),e.documentElement.setAttribute("xmlns",e.documentElement.namespaceURI),new XMLSerializer().serializeToString(e).replace(//,"")};function Vp(i){return i.cloneNode(!0)}function cl(i,e,t){return fa(this,void 0,void 0,function*(){const n=i.getBoundingClientRect(),r=window.devicePixelRatio,s=n.width*r,o=n.height*r,a=t&&t.width===s&&t.height===o?t:new OffscreenCanvas(s,o),l=Vp(i);yield ul(i,l),l.style.setProperty("opacity",e.toString()),l.style.setProperty("margin","0px");const c=l.outerHTML,u=zp(c),d=`${u}`;return new Promise((h,m)=>{const x=new Image;x.onload=()=>{const T=a.getContext("2d");if(T===null)return m();T.clearRect(0,0,s,o),T.scale(r,r),T.drawImage(x,0,0,s,o),T.setTransform(1,0,0,1,0,0),h(a)},x.src=`data:image/svg+xml;charset=utf-8,${encodeURIComponent(d)}`})})}function ul(i,e){return fa(this,void 0,void 0,function*(){const t=window.getComputedStyle(i);Array.from(t).forEach(n=>{e.style.setProperty(n,t.getPropertyValue(n),t.getPropertyPriority(n))}),e.tagName==="INPUT"?e.setAttribute("value",e.value):e.tagName==="TEXTAREA"?e.innerHTML=e.value:e.tagName==="IMG"&&(e.src=yield Hp(i.src));for(let n=0;nt.blob());return new Promise(t=>{const n=new FileReader;n.onload=function(){t(this.result)},n.readAsDataURL(e)})})}const Gp=` +}`;class Up{constructor(){this.texture=null,this.mesh=null,this.depthNear=0,this.depthFar=0}init(e,t,n){if(this.texture===null){const r=new ht,s=e.properties.get(r);s.__webglTexture=t.texture,(t.depthNear!==n.depthNear||t.depthFar!==n.depthFar)&&(this.depthNear=t.depthNear,this.depthFar=t.depthFar),this.texture=r}}getMesh(e){if(this.texture!==null&&this.mesh===null){const t=e.cameras[0].viewport,n=new hn({vertexShader:Dp,fragmentShader:Lp,uniforms:{depthColor:{value:this.texture},depthWidth:{value:t.z},depthHeight:{value:t.w}}});this.mesh=new jt(new Bi(20,20),n)}return this.mesh}reset(){this.texture=null,this.mesh=null}getDepthTexture(){return this.texture}}class Ip extends xi{constructor(e,t){super();const n=this;let r=null,s=1,o=null,a="local-floor",l=1,c=null,u=null,d=null,h=null,m=null,x=null;const T=new Up,p=t.getContextAttributes();let f=null,M=null;const _=[],v=[],R=new qe;let w=null;const b=new Wt;b.viewport=new st;const P=new Wt;P.viewport=new st;const E=[b,P],y=new eu;let C=null,H=null;this.cameraAutoUpdate=!0,this.enabled=!1,this.isPresenting=!1,this.getController=function(k){let ee=_[k];return ee===void 0&&(ee=new us,_[k]=ee),ee.getTargetRaySpace()},this.getControllerGrip=function(k){let ee=_[k];return ee===void 0&&(ee=new us,_[k]=ee),ee.getGripSpace()},this.getHand=function(k){let ee=_[k];return ee===void 0&&(ee=new us,_[k]=ee),ee.getHandSpace()};function z(k){const ee=v.indexOf(k.inputSource);if(ee===-1)return;const fe=_[ee];fe!==void 0&&(fe.update(k.inputSource,k.frame,c||o),fe.dispatchEvent({type:k.type,data:k.inputSource}))}function W(){r.removeEventListener("select",z),r.removeEventListener("selectstart",z),r.removeEventListener("selectend",z),r.removeEventListener("squeeze",z),r.removeEventListener("squeezestart",z),r.removeEventListener("squeezeend",z),r.removeEventListener("end",W),r.removeEventListener("inputsourceschange",q);for(let k=0;k<_.length;k++){const ee=v[k];ee!==null&&(v[k]=null,_[k].disconnect(ee))}C=null,H=null,T.reset(),e.setRenderTarget(f),m=null,h=null,d=null,r=null,M=null,Ye.stop(),n.isPresenting=!1,e.setPixelRatio(w),e.setSize(R.width,R.height,!1),n.dispatchEvent({type:"sessionend"})}this.setFramebufferScaleFactor=function(k){s=k,n.isPresenting===!0&&console.warn("THREE.WebXRManager: Cannot change framebuffer scale while presenting.")},this.setReferenceSpaceType=function(k){a=k,n.isPresenting===!0&&console.warn("THREE.WebXRManager: Cannot change reference space type while presenting.")},this.getReferenceSpace=function(){return c||o},this.setReferenceSpace=function(k){c=k},this.getBaseLayer=function(){return h!==null?h:m},this.getBinding=function(){return d},this.getFrame=function(){return x},this.getSession=function(){return r},this.setSession=async function(k){if(r=k,r!==null){if(f=e.getRenderTarget(),r.addEventListener("select",z),r.addEventListener("selectstart",z),r.addEventListener("selectend",z),r.addEventListener("squeeze",z),r.addEventListener("squeezestart",z),r.addEventListener("squeezeend",z),r.addEventListener("end",W),r.addEventListener("inputsourceschange",q),p.xrCompatible!==!0&&await t.makeXRCompatible(),w=e.getPixelRatio(),e.getSize(R),r.enabledFeatures!==void 0&&r.enabledFeatures.includes("layers")){let fe=null,ne=null,Se=null;p.depth&&(Se=p.stencil?t.DEPTH24_STENCIL8:t.DEPTH_COMPONENT24,fe=p.stencil?gi:ui,ne=p.stencil?mi:Vn);const Ae={colorFormat:t.RGBA8,depthFormat:Se,scaleFactor:s};d=new XRWebGLBinding(r,t),h=d.createProjectionLayer(Ae),r.updateRenderState({layers:[h]}),e.setPixelRatio(1),e.setSize(h.textureWidth,h.textureHeight,!1),M=new Hn(h.textureWidth,h.textureHeight,{format:Nt,type:fn,depthTexture:new nl(h.textureWidth,h.textureHeight,ne,void 0,void 0,void 0,void 0,void 0,void 0,fe),stencilBuffer:p.stencil,colorSpace:e.outputColorSpace,samples:p.antialias?4:0,resolveDepthBuffer:h.ignoreDepthValues===!1})}else{const fe={antialias:p.antialias,alpha:!0,depth:p.depth,stencil:p.stencil,framebufferScaleFactor:s};m=new XRWebGLLayer(r,t,fe),r.updateRenderState({baseLayer:m}),e.setPixelRatio(1),e.setSize(m.framebufferWidth,m.framebufferHeight,!1),M=new Hn(m.framebufferWidth,m.framebufferHeight,{format:Nt,type:fn,colorSpace:e.outputColorSpace,stencilBuffer:p.stencil})}M.isXRRenderTarget=!0,this.setFoveation(l),c=null,o=await r.requestReferenceSpace(a),Ye.setContext(r),Ye.start(),n.isPresenting=!0,n.dispatchEvent({type:"sessionstart"})}},this.getEnvironmentBlendMode=function(){if(r!==null)return r.environmentBlendMode},this.getDepthTexture=function(){return T.getDepthTexture()};function q(k){for(let ee=0;ee=0&&(v[ne]=null,_[ne].disconnect(fe))}for(let ee=0;ee=v.length){v.push(fe),ne=Ae;break}else if(v[Ae]===null){v[Ae]=fe,ne=Ae;break}if(ne===-1)break}const Se=_[ne];Se&&Se.connect(fe)}}const X=new V,Z=new V;function N(k,ee,fe){X.setFromMatrixPosition(ee.matrixWorld),Z.setFromMatrixPosition(fe.matrixWorld);const ne=X.distanceTo(Z),Se=ee.projectionMatrix.elements,Ae=fe.projectionMatrix.elements,Pe=Se[14]/(Se[10]-1),Ke=Se[14]/(Se[10]+1),Fe=(Se[9]+1)/Se[5],Qe=(Se[9]-1)/Se[5],D=(Se[8]-1)/Se[0],Ct=(Ae[8]+1)/Ae[0],Oe=Pe*D,Be=Pe*Ct,Me=ne/(-D+Ct),et=Me*-D;if(ee.matrixWorld.decompose(k.position,k.quaternion,k.scale),k.translateX(et),k.translateZ(Me),k.matrixWorld.compose(k.position,k.quaternion,k.scale),k.matrixWorldInverse.copy(k.matrixWorld).invert(),Se[10]===-1)k.projectionMatrix.copy(ee.projectionMatrix),k.projectionMatrixInverse.copy(ee.projectionMatrixInverse);else{const xe=Pe+Me,A=Ke+Me,g=Oe-et,F=Be+(ne-et),$=Fe*Ke/A*xe,j=Qe*Ke/A*xe;k.projectionMatrix.makePerspective(g,F,$,j,xe,A),k.projectionMatrixInverse.copy(k.projectionMatrix).invert()}}function te(k,ee){ee===null?k.matrixWorld.copy(k.matrix):k.matrixWorld.multiplyMatrices(ee.matrixWorld,k.matrix),k.matrixWorldInverse.copy(k.matrixWorld).invert()}this.updateCamera=function(k){if(r===null)return;let ee=k.near,fe=k.far;T.texture!==null&&(T.depthNear>0&&(ee=T.depthNear),T.depthFar>0&&(fe=T.depthFar)),y.near=P.near=b.near=ee,y.far=P.far=b.far=fe,(C!==y.near||H!==y.far)&&(r.updateRenderState({depthNear:y.near,depthFar:y.far}),C=y.near,H=y.far),b.layers.mask=k.layers.mask|2,P.layers.mask=k.layers.mask|4,y.layers.mask=b.layers.mask|P.layers.mask;const ne=k.parent,Se=y.cameras;te(y,ne);for(let Ae=0;Ae0&&(p.alphaTest.value=f.alphaTest);const M=e.get(f),_=M.envMap,v=M.envMapRotation;_&&(p.envMap.value=_,Un.copy(v),Un.x*=-1,Un.y*=-1,Un.z*=-1,_.isCubeTexture&&_.isRenderTargetTexture===!1&&(Un.y*=-1,Un.z*=-1),p.envMapRotation.value.setFromMatrix4(Fp.makeRotationFromEuler(Un)),p.flipEnvMap.value=_.isCubeTexture&&_.isRenderTargetTexture===!1?-1:1,p.reflectivity.value=f.reflectivity,p.ior.value=f.ior,p.refractionRatio.value=f.refractionRatio),f.lightMap&&(p.lightMap.value=f.lightMap,p.lightMapIntensity.value=f.lightMapIntensity,t(f.lightMap,p.lightMapTransform)),f.aoMap&&(p.aoMap.value=f.aoMap,p.aoMapIntensity.value=f.aoMapIntensity,t(f.aoMap,p.aoMapTransform))}function o(p,f){p.diffuse.value.copy(f.color),p.opacity.value=f.opacity,f.map&&(p.map.value=f.map,t(f.map,p.mapTransform))}function a(p,f){p.dashSize.value=f.dashSize,p.totalSize.value=f.dashSize+f.gapSize,p.scale.value=f.scale}function l(p,f,M,_){p.diffuse.value.copy(f.color),p.opacity.value=f.opacity,p.size.value=f.size*M,p.scale.value=_*.5,f.map&&(p.map.value=f.map,t(f.map,p.uvTransform)),f.alphaMap&&(p.alphaMap.value=f.alphaMap,t(f.alphaMap,p.alphaMapTransform)),f.alphaTest>0&&(p.alphaTest.value=f.alphaTest)}function c(p,f){p.diffuse.value.copy(f.color),p.opacity.value=f.opacity,p.rotation.value=f.rotation,f.map&&(p.map.value=f.map,t(f.map,p.mapTransform)),f.alphaMap&&(p.alphaMap.value=f.alphaMap,t(f.alphaMap,p.alphaMapTransform)),f.alphaTest>0&&(p.alphaTest.value=f.alphaTest)}function u(p,f){p.specular.value.copy(f.specular),p.shininess.value=Math.max(f.shininess,1e-4)}function d(p,f){f.gradientMap&&(p.gradientMap.value=f.gradientMap)}function h(p,f){p.metalness.value=f.metalness,f.metalnessMap&&(p.metalnessMap.value=f.metalnessMap,t(f.metalnessMap,p.metalnessMapTransform)),p.roughness.value=f.roughness,f.roughnessMap&&(p.roughnessMap.value=f.roughnessMap,t(f.roughnessMap,p.roughnessMapTransform)),f.envMap&&(p.envMapIntensity.value=f.envMapIntensity)}function m(p,f,M){p.ior.value=f.ior,f.sheen>0&&(p.sheenColor.value.copy(f.sheenColor).multiplyScalar(f.sheen),p.sheenRoughness.value=f.sheenRoughness,f.sheenColorMap&&(p.sheenColorMap.value=f.sheenColorMap,t(f.sheenColorMap,p.sheenColorMapTransform)),f.sheenRoughnessMap&&(p.sheenRoughnessMap.value=f.sheenRoughnessMap,t(f.sheenRoughnessMap,p.sheenRoughnessMapTransform))),f.clearcoat>0&&(p.clearcoat.value=f.clearcoat,p.clearcoatRoughness.value=f.clearcoatRoughness,f.clearcoatMap&&(p.clearcoatMap.value=f.clearcoatMap,t(f.clearcoatMap,p.clearcoatMapTransform)),f.clearcoatRoughnessMap&&(p.clearcoatRoughnessMap.value=f.clearcoatRoughnessMap,t(f.clearcoatRoughnessMap,p.clearcoatRoughnessMapTransform)),f.clearcoatNormalMap&&(p.clearcoatNormalMap.value=f.clearcoatNormalMap,t(f.clearcoatNormalMap,p.clearcoatNormalMapTransform),p.clearcoatNormalScale.value.copy(f.clearcoatNormalScale),f.side===Tt&&p.clearcoatNormalScale.value.negate())),f.dispersion>0&&(p.dispersion.value=f.dispersion),f.iridescence>0&&(p.iridescence.value=f.iridescence,p.iridescenceIOR.value=f.iridescenceIOR,p.iridescenceThicknessMinimum.value=f.iridescenceThicknessRange[0],p.iridescenceThicknessMaximum.value=f.iridescenceThicknessRange[1],f.iridescenceMap&&(p.iridescenceMap.value=f.iridescenceMap,t(f.iridescenceMap,p.iridescenceMapTransform)),f.iridescenceThicknessMap&&(p.iridescenceThicknessMap.value=f.iridescenceThicknessMap,t(f.iridescenceThicknessMap,p.iridescenceThicknessMapTransform))),f.transmission>0&&(p.transmission.value=f.transmission,p.transmissionSamplerMap.value=M.texture,p.transmissionSamplerSize.value.set(M.width,M.height),f.transmissionMap&&(p.transmissionMap.value=f.transmissionMap,t(f.transmissionMap,p.transmissionMapTransform)),p.thickness.value=f.thickness,f.thicknessMap&&(p.thicknessMap.value=f.thicknessMap,t(f.thicknessMap,p.thicknessMapTransform)),p.attenuationDistance.value=f.attenuationDistance,p.attenuationColor.value.copy(f.attenuationColor)),f.anisotropy>0&&(p.anisotropyVector.value.set(f.anisotropy*Math.cos(f.anisotropyRotation),f.anisotropy*Math.sin(f.anisotropyRotation)),f.anisotropyMap&&(p.anisotropyMap.value=f.anisotropyMap,t(f.anisotropyMap,p.anisotropyMapTransform))),p.specularIntensity.value=f.specularIntensity,p.specularColor.value.copy(f.specularColor),f.specularColorMap&&(p.specularColorMap.value=f.specularColorMap,t(f.specularColorMap,p.specularColorMapTransform)),f.specularIntensityMap&&(p.specularIntensityMap.value=f.specularIntensityMap,t(f.specularIntensityMap,p.specularIntensityMapTransform))}function x(p,f){f.matcap&&(p.matcap.value=f.matcap)}function T(p,f){const M=e.get(f).light;p.referencePosition.value.setFromMatrixPosition(M.matrixWorld),p.nearDistance.value=M.shadow.camera.near,p.farDistance.value=M.shadow.camera.far}return{refreshFogUniforms:n,refreshMaterialUniforms:r}}function Op(i,e,t,n){let r={},s={},o=[];const a=i.getParameter(i.MAX_UNIFORM_BUFFER_BINDINGS);function l(M,_){const v=_.program;n.uniformBlockBinding(M,v)}function c(M,_){let v=r[M.id];v===void 0&&(x(M),v=u(M),r[M.id]=v,M.addEventListener("dispose",p));const R=_.program;n.updateUBOMapping(M,R);const w=e.render.frame;s[M.id]!==w&&(h(M),s[M.id]=w)}function u(M){const _=d();M.__bindingPointIndex=_;const v=i.createBuffer(),R=M.__size,w=M.usage;return i.bindBuffer(i.UNIFORM_BUFFER,v),i.bufferData(i.UNIFORM_BUFFER,R,w),i.bindBuffer(i.UNIFORM_BUFFER,null),i.bindBufferBase(i.UNIFORM_BUFFER,_,v),v}function d(){for(let M=0;M0&&(v+=R-w),M.__size=v,M.__cache={},this}function T(M){const _={boundary:0,storage:0};return typeof M=="number"||typeof M=="boolean"?(_.boundary=4,_.storage=4):M.isVector2?(_.boundary=8,_.storage=8):M.isVector3||M.isColor?(_.boundary=16,_.storage=12):M.isVector4?(_.boundary=16,_.storage=16):M.isMatrix3?(_.boundary=48,_.storage=48):M.isMatrix4?(_.boundary=64,_.storage=64):M.isTexture?console.warn("THREE.WebGLRenderer: Texture samplers can not be part of an uniforms group."):console.warn("THREE.WebGLRenderer: Unsupported uniform value type.",M),_}function p(M){const _=M.target;_.removeEventListener("dispose",p);const v=o.indexOf(_.__bindingPointIndex);o.splice(v,1),i.deleteBuffer(r[_.id]),delete r[_.id],delete s[_.id]}function f(){for(const M in r)i.deleteBuffer(r[M]);o=[],r={},s={}}return{bind:l,update:c,dispose:f}}class Bp{constructor(e={}){const{canvas:t=_c(),context:n=null,depth:r=!0,stencil:s=!1,alpha:o=!1,antialias:a=!1,premultipliedAlpha:l=!0,preserveDrawingBuffer:c=!1,powerPreference:u="default",failIfMajorPerformanceCaveat:d=!1,reverseDepthBuffer:h=!1}=e;this.isWebGLRenderer=!0;let m;if(n!==null){if(typeof WebGLRenderingContext<"u"&&n instanceof WebGLRenderingContext)throw new Error("THREE.WebGLRenderer: WebGL 1 is not supported since r163.");m=n.getContextAttributes().alpha}else m=o;const x=new Uint32Array(4),T=new Int32Array(4);let p=null,f=null;const M=[],_=[];this.domElement=t,this.debug={checkShaderErrors:!0,onShaderError:null},this.autoClear=!0,this.autoClearColor=!0,this.autoClearDepth=!0,this.autoClearStencil=!0,this.sortObjects=!0,this.clippingPlanes=[],this.localClippingEnabled=!1,this._outputColorSpace=It,this.toneMapping=En,this.toneMappingExposure=1;const v=this;let R=!1,w=0,b=0,P=null,E=-1,y=null;const C=new st,H=new st;let z=null;const W=new je(0);let q=0,X=t.width,Z=t.height,N=1,te=null,ae=null;const _e=new st(0,0,X,Z),Te=new st(0,0,X,Z);let Ye=!1;const k=new tl;let ee=!1,fe=!1;this.transmissionResolutionScale=1;const ne=new lt,Se=new lt,Ae=new V,Pe=new st,Ke={background:null,fog:null,environment:null,overrideMaterial:null,isScene:!0};let Fe=!1;function Qe(){return P===null?N:1}let D=n;function Ct(S,U){return t.getContext(S,U)}try{const S={alpha:!0,depth:r,stencil:s,antialias:a,premultipliedAlpha:l,preserveDrawingBuffer:c,powerPreference:u,failIfMajorPerformanceCaveat:d};if("setAttribute"in t&&t.setAttribute("data-engine",`three.js r${ta}`),t.addEventListener("webglcontextlost",K,!1),t.addEventListener("webglcontextrestored",ce,!1),t.addEventListener("webglcontextcreationerror",le,!1),D===null){const U="webgl2";if(D=Ct(U,S),D===null)throw Ct(U)?new Error("Error creating WebGL context with your selected attributes."):new Error("Error creating WebGL context.")}}catch(S){throw console.error("THREE.WebGLRenderer: "+S.message),S}let Oe,Be,Me,et,xe,A,g,F,$,j,Y,ve,oe,de,Ve,Q,pe,be,we,me,ze,Ue,Je,L;function re(){Oe=new Yd(D),Oe.init(),Ue=new Cp(D,Oe),Be=new Hd(D,Oe,e,Ue),Me=new wp(D,Oe),Be.reverseDepthBuffer&&h&&Me.buffers.depth.setReversed(!0),et=new Zd(D),xe=new pp,A=new Rp(D,Oe,Me,xe,Be,Ue,et),g=new kd(v),F=new qd(v),$=new nu(D),Je=new zd(D,$),j=new $d(D,$,et,Je),Y=new Jd(D,j,$,et),we=new jd(D,Be,A),Q=new Gd(xe),ve=new hp(v,g,F,Oe,Be,Je,Q),oe=new Np(v,xe),de=new gp,Ve=new yp(Oe),be=new Bd(v,g,F,Me,Y,m,l),pe=new bp(v,Y,Be),L=new Op(D,et,Be,Me),me=new Vd(D,Oe,et),ze=new Kd(D,Oe,et),et.programs=ve.programs,v.capabilities=Be,v.extensions=Oe,v.properties=xe,v.renderLists=de,v.shadowMap=pe,v.state=Me,v.info=et}re();const G=new Ip(v,D);this.xr=G,this.getContext=function(){return D},this.getContextAttributes=function(){return D.getContextAttributes()},this.forceContextLoss=function(){const S=Oe.get("WEBGL_lose_context");S&&S.loseContext()},this.forceContextRestore=function(){const S=Oe.get("WEBGL_lose_context");S&&S.restoreContext()},this.getPixelRatio=function(){return N},this.setPixelRatio=function(S){S!==void 0&&(N=S,this.setSize(X,Z,!1))},this.getSize=function(S){return S.set(X,Z)},this.setSize=function(S,U,O=!0){if(G.isPresenting){console.warn("THREE.WebGLRenderer: Can't change size while VR device is presenting.");return}X=S,Z=U,t.width=Math.floor(S*N),t.height=Math.floor(U*N),O===!0&&(t.style.width=S+"px",t.style.height=U+"px"),this.setViewport(0,0,S,U)},this.getDrawingBufferSize=function(S){return S.set(X*N,Z*N).floor()},this.setDrawingBufferSize=function(S,U,O){X=S,Z=U,N=O,t.width=Math.floor(S*O),t.height=Math.floor(U*O),this.setViewport(0,0,S,U)},this.getCurrentViewport=function(S){return S.copy(C)},this.getViewport=function(S){return S.copy(_e)},this.setViewport=function(S,U,O,B){S.isVector4?_e.set(S.x,S.y,S.z,S.w):_e.set(S,U,O,B),Me.viewport(C.copy(_e).multiplyScalar(N).round())},this.getScissor=function(S){return S.copy(Te)},this.setScissor=function(S,U,O,B){S.isVector4?Te.set(S.x,S.y,S.z,S.w):Te.set(S,U,O,B),Me.scissor(H.copy(Te).multiplyScalar(N).round())},this.getScissorTest=function(){return Ye},this.setScissorTest=function(S){Me.setScissorTest(Ye=S)},this.setOpaqueSort=function(S){te=S},this.setTransparentSort=function(S){ae=S},this.getClearColor=function(S){return S.copy(be.getClearColor())},this.setClearColor=function(){be.setClearColor.apply(be,arguments)},this.getClearAlpha=function(){return be.getClearAlpha()},this.setClearAlpha=function(){be.setClearAlpha.apply(be,arguments)},this.clear=function(S=!0,U=!0,O=!0){let B=0;if(S){let I=!1;if(P!==null){const J=P.texture.format;I=J===oa||J===aa||J===sa}if(I){const J=P.texture.type,se=J===fn||J===Vn||J===Di||J===mi||J===ia||J===ra,ue=be.getClearColor(),ge=be.getClearAlpha(),Re=ue.r,Ce=ue.g,ye=ue.b;se?(x[0]=Re,x[1]=Ce,x[2]=ye,x[3]=ge,D.clearBufferuiv(D.COLOR,0,x)):(T[0]=Re,T[1]=Ce,T[2]=ye,T[3]=ge,D.clearBufferiv(D.COLOR,0,T))}else B|=D.COLOR_BUFFER_BIT}U&&(B|=D.DEPTH_BUFFER_BIT),O&&(B|=D.STENCIL_BUFFER_BIT,this.state.buffers.stencil.setMask(4294967295)),D.clear(B)},this.clearColor=function(){this.clear(!0,!1,!1)},this.clearDepth=function(){this.clear(!1,!0,!1)},this.clearStencil=function(){this.clear(!1,!1,!0)},this.dispose=function(){t.removeEventListener("webglcontextlost",K,!1),t.removeEventListener("webglcontextrestored",ce,!1),t.removeEventListener("webglcontextcreationerror",le,!1),be.dispose(),de.dispose(),Ve.dispose(),xe.dispose(),g.dispose(),F.dispose(),Y.dispose(),Je.dispose(),L.dispose(),ve.dispose(),G.dispose(),G.removeEventListener("sessionstart",pa),G.removeEventListener("sessionend",ma),An.stop()};function K(S){S.preventDefault(),console.log("THREE.WebGLRenderer: Context Lost."),R=!0}function ce(){console.log("THREE.WebGLRenderer: Context Restored."),R=!1;const S=et.autoReset,U=pe.enabled,O=pe.autoUpdate,B=pe.needsUpdate,I=pe.type;re(),et.autoReset=S,pe.enabled=U,pe.autoUpdate=O,pe.needsUpdate=B,pe.type=I}function le(S){console.error("THREE.WebGLRenderer: A WebGL context could not be created. Reason: ",S.statusMessage)}function De(S){const U=S.target;U.removeEventListener("dispose",De),it(U)}function it(S){mt(S),xe.remove(S)}function mt(S){const U=xe.get(S).programs;U!==void 0&&(U.forEach(function(O){ve.releaseProgram(O)}),S.isShaderMaterial&&ve.releaseShaderCache(S))}this.renderBufferDirect=function(S,U,O,B,I,J){U===null&&(U=Ke);const se=I.isMesh&&I.matrixWorld.determinant()<0,ue=Ml(S,U,O,B,I);Me.setMaterial(B,se);let ge=O.index,Re=1;if(B.wireframe===!0){if(ge=j.getWireframeAttribute(O),ge===void 0)return;Re=2}const Ce=O.drawRange,ye=O.attributes.position;let He=Ce.start*Re,We=(Ce.start+Ce.count)*Re;J!==null&&(He=Math.max(He,J.start*Re),We=Math.min(We,(J.start+J.count)*Re)),ge!==null?(He=Math.max(He,0),We=Math.min(We,ge.count)):ye!=null&&(He=Math.max(He,0),We=Math.min(We,ye.count));const at=We-He;if(at<0||at===1/0)return;Je.setup(I,B,ue,O,ge);let rt,Ge=me;if(ge!==null&&(rt=$.get(ge),Ge=ze,Ge.setIndex(rt)),I.isMesh)B.wireframe===!0?(Me.setLineWidth(B.wireframeLinewidth*Qe()),Ge.setMode(D.LINES)):Ge.setMode(D.TRIANGLES);else if(I.isLine){let Ee=B.linewidth;Ee===void 0&&(Ee=1),Me.setLineWidth(Ee*Qe()),I.isLineSegments?Ge.setMode(D.LINES):I.isLineLoop?Ge.setMode(D.LINE_LOOP):Ge.setMode(D.LINE_STRIP)}else I.isPoints?Ge.setMode(D.POINTS):I.isSprite&&Ge.setMode(D.TRIANGLES);if(I.isBatchedMesh)if(I._multiDrawInstances!==null)Ge.renderMultiDrawInstances(I._multiDrawStarts,I._multiDrawCounts,I._multiDrawCount,I._multiDrawInstances);else if(Oe.get("WEBGL_multi_draw"))Ge.renderMultiDraw(I._multiDrawStarts,I._multiDrawCounts,I._multiDrawCount);else{const Ee=I._multiDrawStarts,pt=I._multiDrawCounts,Xe=I._multiDrawCount,Bt=ge?$.get(ge).bytesPerElement:1,kn=xe.get(B).currentProgram.getUniforms();for(let bt=0;bt{function J(){if(B.forEach(function(se){xe.get(se).currentProgram.isReady()&&B.delete(se)}),B.size===0){I(S);return}setTimeout(J,10)}Oe.get("KHR_parallel_shader_compile")!==null?J():setTimeout(J,10)})};let Ot=null;function Qt(S){Ot&&Ot(S)}function pa(){An.stop()}function ma(){An.start()}const An=new rl;An.setAnimationLoop(Qt),typeof self<"u"&&An.setContext(self),this.setAnimationLoop=function(S){Ot=S,G.setAnimationLoop(S),S===null?An.stop():An.start()},G.addEventListener("sessionstart",pa),G.addEventListener("sessionend",ma),this.render=function(S,U){if(U!==void 0&&U.isCamera!==!0){console.error("THREE.WebGLRenderer.render: camera is not an instance of THREE.Camera.");return}if(R===!0)return;if(S.matrixWorldAutoUpdate===!0&&S.updateMatrixWorld(),U.parent===null&&U.matrixWorldAutoUpdate===!0&&U.updateMatrixWorld(),G.enabled===!0&&G.isPresenting===!0&&(G.cameraAutoUpdate===!0&&G.updateCamera(U),U=G.getCamera()),S.isScene===!0&&S.onBeforeRender(v,S,U,P),f=Ve.get(S,_.length),f.init(U),_.push(f),Se.multiplyMatrices(U.projectionMatrix,U.matrixWorldInverse),k.setFromProjectionMatrix(Se),fe=this.localClippingEnabled,ee=Q.init(this.clippingPlanes,fe),p=de.get(S,M.length),p.init(),M.push(p),G.enabled===!0&&G.isPresenting===!0){const J=v.xr.getDepthSensingMesh();J!==null&&Ur(J,U,-1/0,v.sortObjects)}Ur(S,U,0,v.sortObjects),p.finish(),v.sortObjects===!0&&p.sort(te,ae),Fe=G.enabled===!1||G.isPresenting===!1||G.hasDepthSensing()===!1,Fe&&be.addToRenderList(p,S),this.info.render.frame++,ee===!0&&Q.beginShadows();const O=f.state.shadowsArray;pe.render(O,S,U),ee===!0&&Q.endShadows(),this.info.autoReset===!0&&this.info.reset();const B=p.opaque,I=p.transmissive;if(f.setupLights(),U.isArrayCamera){const J=U.cameras;if(I.length>0)for(let se=0,ue=J.length;se0&&_a(B,I,S,U),Fe&&be.render(S),ga(p,S,U);P!==null&&b===0&&(A.updateMultisampleRenderTarget(P),A.updateRenderTargetMipmap(P)),S.isScene===!0&&S.onAfterRender(v,S,U),Je.resetDefaultState(),E=-1,y=null,_.pop(),_.length>0?(f=_[_.length-1],ee===!0&&Q.setGlobalState(v.clippingPlanes,f.state.camera)):f=null,M.pop(),M.length>0?p=M[M.length-1]:p=null};function Ur(S,U,O,B){if(S.visible===!1)return;if(S.layers.test(U.layers)){if(S.isGroup)O=S.renderOrder;else if(S.isLOD)S.autoUpdate===!0&&S.update(U);else if(S.isLight)f.pushLight(S),S.castShadow&&f.pushShadow(S);else if(S.isSprite){if(!S.frustumCulled||k.intersectsSprite(S)){B&&Pe.setFromMatrixPosition(S.matrixWorld).applyMatrix4(Se);const se=Y.update(S),ue=S.material;ue.visible&&p.push(S,se,ue,O,Pe.z,null)}}else if((S.isMesh||S.isLine||S.isPoints)&&(!S.frustumCulled||k.intersectsObject(S))){const se=Y.update(S),ue=S.material;if(B&&(S.boundingSphere!==void 0?(S.boundingSphere===null&&S.computeBoundingSphere(),Pe.copy(S.boundingSphere.center)):(se.boundingSphere===null&&se.computeBoundingSphere(),Pe.copy(se.boundingSphere.center)),Pe.applyMatrix4(S.matrixWorld).applyMatrix4(Se)),Array.isArray(ue)){const ge=se.groups;for(let Re=0,Ce=ge.length;Re0&&Vi(I,U,O),J.length>0&&Vi(J,U,O),se.length>0&&Vi(se,U,O),Me.buffers.depth.setTest(!0),Me.buffers.depth.setMask(!0),Me.buffers.color.setMask(!0),Me.setPolygonOffset(!1)}function _a(S,U,O,B){if((O.isScene===!0?O.overrideMaterial:null)!==null)return;f.state.transmissionRenderTarget[B.id]===void 0&&(f.state.transmissionRenderTarget[B.id]=new Hn(1,1,{generateMipmaps:!0,type:Oe.has("EXT_color_buffer_half_float")||Oe.has("EXT_color_buffer_float")?Ui:fn,minFilter:Bn,samples:4,stencilBuffer:s,resolveDepthBuffer:!1,resolveStencilBuffer:!1,colorSpace:ke.workingColorSpace}));const J=f.state.transmissionRenderTarget[B.id],se=B.viewport||C;J.setSize(se.z*v.transmissionResolutionScale,se.w*v.transmissionResolutionScale);const ue=v.getRenderTarget();v.setRenderTarget(J),v.getClearColor(W),q=v.getClearAlpha(),q<1&&v.setClearColor(16777215,.5),v.clear(),Fe&&be.render(O);const ge=v.toneMapping;v.toneMapping=En;const Re=B.viewport;if(B.viewport!==void 0&&(B.viewport=void 0),f.setupLightsView(B),ee===!0&&Q.setGlobalState(v.clippingPlanes,B),Vi(S,O,B),A.updateMultisampleRenderTarget(J),A.updateRenderTargetMipmap(J),Oe.has("WEBGL_multisampled_render_to_texture")===!1){let Ce=!1;for(let ye=0,He=U.length;ye0),ye=!!O.morphAttributes.position,He=!!O.morphAttributes.normal,We=!!O.morphAttributes.color;let at=En;B.toneMapped&&(P===null||P.isXRRenderTarget===!0)&&(at=v.toneMapping);const rt=O.morphAttributes.position||O.morphAttributes.normal||O.morphAttributes.color,Ge=rt!==void 0?rt.length:0,Ee=xe.get(B),pt=f.state.lights;if(ee===!0&&(fe===!0||S!==y)){const xt=S===y&&B.id===E;Q.setState(B,S,xt)}let Xe=!1;B.version===Ee.__version?(Ee.needsLights&&Ee.lightsStateVersion!==pt.state.version||Ee.outputColorSpace!==ue||I.isBatchedMesh&&Ee.batching===!1||!I.isBatchedMesh&&Ee.batching===!0||I.isBatchedMesh&&Ee.batchingColor===!0&&I.colorTexture===null||I.isBatchedMesh&&Ee.batchingColor===!1&&I.colorTexture!==null||I.isInstancedMesh&&Ee.instancing===!1||!I.isInstancedMesh&&Ee.instancing===!0||I.isSkinnedMesh&&Ee.skinning===!1||!I.isSkinnedMesh&&Ee.skinning===!0||I.isInstancedMesh&&Ee.instancingColor===!0&&I.instanceColor===null||I.isInstancedMesh&&Ee.instancingColor===!1&&I.instanceColor!==null||I.isInstancedMesh&&Ee.instancingMorph===!0&&I.morphTexture===null||I.isInstancedMesh&&Ee.instancingMorph===!1&&I.morphTexture!==null||Ee.envMap!==ge||B.fog===!0&&Ee.fog!==J||Ee.numClippingPlanes!==void 0&&(Ee.numClippingPlanes!==Q.numPlanes||Ee.numIntersection!==Q.numIntersection)||Ee.vertexAlphas!==Re||Ee.vertexTangents!==Ce||Ee.morphTargets!==ye||Ee.morphNormals!==He||Ee.morphColors!==We||Ee.toneMapping!==at||Ee.morphTargetsCount!==Ge)&&(Xe=!0):(Xe=!0,Ee.__version=B.version);let Bt=Ee.currentProgram;Xe===!0&&(Bt=Hi(B,U,I));let kn=!1,bt=!1,Si=!1;const tt=Bt.getUniforms(),Pt=Ee.uniforms;if(Me.useProgram(Bt.program)&&(kn=!0,bt=!0,Si=!0),B.id!==E&&(E=B.id,bt=!0),kn||y!==S){Me.buffers.depth.getReversed()?(ne.copy(S.projectionMatrix),xc(ne),Mc(ne),tt.setValue(D,"projectionMatrix",ne)):tt.setValue(D,"projectionMatrix",S.projectionMatrix),tt.setValue(D,"viewMatrix",S.matrixWorldInverse);const St=tt.map.cameraPosition;St!==void 0&&St.setValue(D,Ae.setFromMatrixPosition(S.matrixWorld)),Be.logarithmicDepthBuffer&&tt.setValue(D,"logDepthBufFC",2/(Math.log(S.far+1)/Math.LN2)),(B.isMeshPhongMaterial||B.isMeshToonMaterial||B.isMeshLambertMaterial||B.isMeshBasicMaterial||B.isMeshStandardMaterial||B.isShaderMaterial)&&tt.setValue(D,"isOrthographic",S.isOrthographicCamera===!0),y!==S&&(y=S,bt=!0,Si=!0)}if(I.isSkinnedMesh){tt.setOptional(D,I,"bindMatrix"),tt.setOptional(D,I,"bindMatrixInverse");const xt=I.skeleton;xt&&(xt.boneTexture===null&&xt.computeBoneTexture(),tt.setValue(D,"boneTexture",xt.boneTexture,A))}I.isBatchedMesh&&(tt.setOptional(D,I,"batchingTexture"),tt.setValue(D,"batchingTexture",I._matricesTexture,A),tt.setOptional(D,I,"batchingIdTexture"),tt.setValue(D,"batchingIdTexture",I._indirectTexture,A),tt.setOptional(D,I,"batchingColorTexture"),I._colorsTexture!==null&&tt.setValue(D,"batchingColorTexture",I._colorsTexture,A));const Dt=O.morphAttributes;if((Dt.position!==void 0||Dt.normal!==void 0||Dt.color!==void 0)&&we.update(I,O,Bt),(bt||Ee.receiveShadow!==I.receiveShadow)&&(Ee.receiveShadow=I.receiveShadow,tt.setValue(D,"receiveShadow",I.receiveShadow)),B.isMeshGouraudMaterial&&B.envMap!==null&&(Pt.envMap.value=ge,Pt.flipEnvMap.value=ge.isCubeTexture&&ge.isRenderTargetTexture===!1?-1:1),B.isMeshStandardMaterial&&B.envMap===null&&U.environment!==null&&(Pt.envMapIntensity.value=U.environmentIntensity),bt&&(tt.setValue(D,"toneMappingExposure",v.toneMappingExposure),Ee.needsLights&&Sl(Pt,Si),J&&B.fog===!0&&oe.refreshFogUniforms(Pt,J),oe.refreshMaterialUniforms(Pt,B,N,Z,f.state.transmissionRenderTarget[S.id]),vr.upload(D,xa(Ee),Pt,A)),B.isShaderMaterial&&B.uniformsNeedUpdate===!0&&(vr.upload(D,xa(Ee),Pt,A),B.uniformsNeedUpdate=!1),B.isSpriteMaterial&&tt.setValue(D,"center",I.center),tt.setValue(D,"modelViewMatrix",I.modelViewMatrix),tt.setValue(D,"normalMatrix",I.normalMatrix),tt.setValue(D,"modelMatrix",I.matrixWorld),B.isShaderMaterial||B.isRawShaderMaterial){const xt=B.uniformsGroups;for(let St=0,Ir=xt.length;St0&&A.useMultisampledRTT(S)===!1?I=xe.get(S).__webglMultisampledFramebuffer:Array.isArray(Ce)?I=Ce[O]:I=Ce,C.copy(S.viewport),H.copy(S.scissor),z=S.scissorTest}else C.copy(_e).multiplyScalar(N).floor(),H.copy(Te).multiplyScalar(N).floor(),z=Ye;if(O!==0&&(I=El),Me.bindFramebuffer(D.FRAMEBUFFER,I)&&B&&Me.drawBuffers(S,I),Me.viewport(C),Me.scissor(H),Me.setScissorTest(z),J){const ge=xe.get(S.texture);D.framebufferTexture2D(D.FRAMEBUFFER,D.COLOR_ATTACHMENT0,D.TEXTURE_CUBE_MAP_POSITIVE_X+U,ge.__webglTexture,O)}else if(se){const ge=xe.get(S.texture),Re=U;D.framebufferTextureLayer(D.FRAMEBUFFER,D.COLOR_ATTACHMENT0,ge.__webglTexture,O,Re)}else if(S!==null&&O!==0){const ge=xe.get(S.texture);D.framebufferTexture2D(D.FRAMEBUFFER,D.COLOR_ATTACHMENT0,D.TEXTURE_2D,ge.__webglTexture,O)}E=-1},this.readRenderTargetPixels=function(S,U,O,B,I,J,se){if(!(S&&S.isWebGLRenderTarget)){console.error("THREE.WebGLRenderer.readRenderTargetPixels: renderTarget is not THREE.WebGLRenderTarget.");return}let ue=xe.get(S).__webglFramebuffer;if(S.isWebGLCubeRenderTarget&&se!==void 0&&(ue=ue[se]),ue){Me.bindFramebuffer(D.FRAMEBUFFER,ue);try{const ge=S.texture,Re=ge.format,Ce=ge.type;if(!Be.textureFormatReadable(Re)){console.error("THREE.WebGLRenderer.readRenderTargetPixels: renderTarget is not in RGBA or implementation defined format.");return}if(!Be.textureTypeReadable(Ce)){console.error("THREE.WebGLRenderer.readRenderTargetPixels: renderTarget is not in UnsignedByteType or implementation defined type.");return}U>=0&&U<=S.width-B&&O>=0&&O<=S.height-I&&D.readPixels(U,O,B,I,Ue.convert(Re),Ue.convert(Ce),J)}finally{const ge=P!==null?xe.get(P).__webglFramebuffer:null;Me.bindFramebuffer(D.FRAMEBUFFER,ge)}}},this.readRenderTargetPixelsAsync=async function(S,U,O,B,I,J,se){if(!(S&&S.isWebGLRenderTarget))throw new Error("THREE.WebGLRenderer.readRenderTargetPixels: renderTarget is not THREE.WebGLRenderTarget.");let ue=xe.get(S).__webglFramebuffer;if(S.isWebGLCubeRenderTarget&&se!==void 0&&(ue=ue[se]),ue){const ge=S.texture,Re=ge.format,Ce=ge.type;if(!Be.textureFormatReadable(Re))throw new Error("THREE.WebGLRenderer.readRenderTargetPixelsAsync: renderTarget is not in RGBA or implementation defined format.");if(!Be.textureTypeReadable(Ce))throw new Error("THREE.WebGLRenderer.readRenderTargetPixelsAsync: renderTarget is not in UnsignedByteType or implementation defined type.");if(U>=0&&U<=S.width-B&&O>=0&&O<=S.height-I){Me.bindFramebuffer(D.FRAMEBUFFER,ue);const ye=D.createBuffer();D.bindBuffer(D.PIXEL_PACK_BUFFER,ye),D.bufferData(D.PIXEL_PACK_BUFFER,J.byteLength,D.STREAM_READ),D.readPixels(U,O,B,I,Ue.convert(Re),Ue.convert(Ce),0);const He=P!==null?xe.get(P).__webglFramebuffer:null;Me.bindFramebuffer(D.FRAMEBUFFER,He);const We=D.fenceSync(D.SYNC_GPU_COMMANDS_COMPLETE,0);return D.flush(),await vc(D,We,4),D.bindBuffer(D.PIXEL_PACK_BUFFER,ye),D.getBufferSubData(D.PIXEL_PACK_BUFFER,0,J),D.deleteBuffer(ye),D.deleteSync(We),J}else throw new Error("THREE.WebGLRenderer.readRenderTargetPixelsAsync: requested read bounds are out of range.")}},this.copyFramebufferToTexture=function(S,U=null,O=0){S.isTexture!==!0&&(si("WebGLRenderer: copyFramebufferToTexture function signature has changed."),U=arguments[0]||null,S=arguments[1]);const B=Math.pow(2,-O),I=Math.floor(S.image.width*B),J=Math.floor(S.image.height*B),se=U!==null?U.x:0,ue=U!==null?U.y:0;A.setTexture2D(S,0),D.copyTexSubImage2D(D.TEXTURE_2D,O,0,0,se,ue,I,J),Me.unbindTexture()};const Tl=D.createFramebuffer(),bl=D.createFramebuffer();this.copyTextureToTexture=function(S,U,O=null,B=null,I=0,J=null){S.isTexture!==!0&&(si("WebGLRenderer: copyTextureToTexture function signature has changed."),B=arguments[0]||null,S=arguments[1],U=arguments[2],J=arguments[3]||0,O=null),J===null&&(I!==0?(si("WebGLRenderer: copyTextureToTexture function signature has changed to support src and dst mipmap levels."),J=I,I=0):J=0);let se,ue,ge,Re,Ce,ye,He,We,at;const rt=S.isCompressedTexture?S.mipmaps[J]:S.image;if(O!==null)se=O.max.x-O.min.x,ue=O.max.y-O.min.y,ge=O.isBox3?O.max.z-O.min.z:1,Re=O.min.x,Ce=O.min.y,ye=O.isBox3?O.min.z:0;else{const Dt=Math.pow(2,-I);se=Math.floor(rt.width*Dt),ue=Math.floor(rt.height*Dt),S.isDataArrayTexture?ge=rt.depth:S.isData3DTexture?ge=Math.floor(rt.depth*Dt):ge=1,Re=0,Ce=0,ye=0}B!==null?(He=B.x,We=B.y,at=B.z):(He=0,We=0,at=0);const Ge=Ue.convert(U.format),Ee=Ue.convert(U.type);let pt;U.isData3DTexture?(A.setTexture3D(U,0),pt=D.TEXTURE_3D):U.isDataArrayTexture||U.isCompressedArrayTexture?(A.setTexture2DArray(U,0),pt=D.TEXTURE_2D_ARRAY):(A.setTexture2D(U,0),pt=D.TEXTURE_2D),D.pixelStorei(D.UNPACK_FLIP_Y_WEBGL,U.flipY),D.pixelStorei(D.UNPACK_PREMULTIPLY_ALPHA_WEBGL,U.premultiplyAlpha),D.pixelStorei(D.UNPACK_ALIGNMENT,U.unpackAlignment);const Xe=D.getParameter(D.UNPACK_ROW_LENGTH),Bt=D.getParameter(D.UNPACK_IMAGE_HEIGHT),kn=D.getParameter(D.UNPACK_SKIP_PIXELS),bt=D.getParameter(D.UNPACK_SKIP_ROWS),Si=D.getParameter(D.UNPACK_SKIP_IMAGES);D.pixelStorei(D.UNPACK_ROW_LENGTH,rt.width),D.pixelStorei(D.UNPACK_IMAGE_HEIGHT,rt.height),D.pixelStorei(D.UNPACK_SKIP_PIXELS,Re),D.pixelStorei(D.UNPACK_SKIP_ROWS,Ce),D.pixelStorei(D.UNPACK_SKIP_IMAGES,ye);const tt=S.isDataArrayTexture||S.isData3DTexture,Pt=U.isDataArrayTexture||U.isData3DTexture;if(S.isDepthTexture){const Dt=xe.get(S),xt=xe.get(U),St=xe.get(Dt.__renderTarget),Ir=xe.get(xt.__renderTarget);Me.bindFramebuffer(D.READ_FRAMEBUFFER,St.__webglFramebuffer),Me.bindFramebuffer(D.DRAW_FRAMEBUFFER,Ir.__webglFramebuffer);for(let wn=0;wn=0;t--)i.push(!!(e&1<=this.raw.frames.length)return null;var t=this.raw.frames[i];if(t.image){var n=t.image.descriptor.width*t.image.descriptor.height,r=o(t.image.data.minCodeSize,t.image.data.blocks,n);t.image.descriptor.lct.interlaced&&(r=a(r,t.image.descriptor.width));var s={pixels:r,dims:{top:t.image.descriptor.top,left:t.image.descriptor.left,width:t.image.descriptor.width,height:t.image.descriptor.height}};return t.image.descriptor.lct&&t.image.descriptor.lct.exists?s.colorTable=t.image.lct:s.colorTable=this.raw.gct,t.gce&&(s.delay=(t.gce.delay||10)*10,s.disposalType=t.gce.extras.disposal,t.gce.extras.transparentColorGiven&&(s.transparentIndex=t.gce.transparentColorIndex)),e&&(s.patch=l(s)),s}return null;function o(c,u,d){var h=4096,m=-1,x=d,T,p,f,M,_,v,R,w,b,P,E,y,C,H,z,W,q=new Array(d),X=new Array(h),Z=new Array(h),N=new Array(h+1);for(y=c,p=1<>=M,w-=M,b>T||b==_)break;if(b==p){M=y+1,f=(1<p;)N[H++]=Z[b],b=X[b];C=Z[b]&255,N[H++]=C,Ta.arrayBuffer()).then(a=>new da(a)),r=n.decompressFrames(!0,void 0,void 0),s=n.raw.lsd.width,o=n.raw.lsd.height;return new ha(r,s,o,t)})}constructor(e,t,n,r){this.frames=[],this.index=0,this.playTime=0,this.frames=e,this.canvas=document.createElement("canvas"),this.ctx=this.canvas.getContext("2d"),this.pixelRatio=r,this.canvas.width=t,this.canvas.height=n,this.startTime=Date.now()}getCanvas(){return this.canvas}update(){const t=Date.now()-this.startTime;for(;this.playTimeJs(this,void 0,void 0,function*(){if(typeof window<"u"){for(const n of he(this,Ut,"f"))if(n.type==="text"&&n.isInViewport){const r=n.element.getBoundingClientRect();(r.width!==n.width||r.height!==n.height)&&(yield he(this,$t,"m",yr).call(this,n),n.width=r.width,n.height=r.height)}for(const n of he(this,Ut,"f"))if(n.type==="text"&&!n.isInViewport){const r=n.element.getBoundingClientRect();(r.width!==n.width||r.height!==n.height)&&(yield he(this,$t,"m",yr).call(this,n),n.width=r.width,n.height=r.height)}}})),Sr.set(this,n=>{typeof window<"u"&&(Yt(this,xr,n.clientX,"f"),Yt(this,Mr,window.innerHeight-n.clientY,"f"))}),Er.set(this,()=>{var n;const r=Date.now()/1e3;he(this,kt,"f").clear(),he(this,$t,"m",dl).call(this);for(const s of he(this,Ut,"f")){const o=s.element.getBoundingClientRect(),a=ur(o,s.overflow),l=s.isFullScreen||ea(he(this,Ft,"f"),a),c=ur(he(this,Ft,"f"),s.intersection.rootMargin),u=So(c,o),d=s.isFullScreen||bo(c,o,u,s.intersection.threshold);if(!s.isInLogicalViewport&&d&&(s.enterTime=r,s.leaveTime=1/0),s.isInLogicalViewport&&!d&&(s.leaveTime=r),s.isInViewport=l,s.isInLogicalViewport=d,!(!l||r-s.leaveTime>s.release)){s.uniforms.time.value=r-s.startTime,s.uniforms.enterTime.value=r-s.enterTime,s.uniforms.leaveTime.value=r-s.leaveTime,s.uniforms.resolution.value.x=o.width*he(this,Gt,"f"),s.uniforms.resolution.value.y=o.height*he(this,Gt,"f"),s.uniforms.offset.value.x=o.left*he(this,Gt,"f"),s.uniforms.offset.value.y=(window.innerHeight-o.top-o.height)*he(this,Gt,"f"),s.uniforms.mouse.value.x=he(this,xr,"f")*he(this,Gt,"f"),s.uniforms.mouse.value.y=he(this,Mr,"f")*he(this,Gt,"f"),s.uniforms.intersection.value=u;for(const[h,m]of Object.entries(s.uniformGenerators))s.uniforms[h].value=m();(n=To.get(s.element))===null||n===void 0||n.update(),(s.type==="video"||s.isGif)&&(s.uniforms.src.value.needsUpdate=!0),s.isFullScreen?he(this,kt,"f").setViewport(0,0,window.innerWidth,window.innerHeight):he(this,kt,"f").setViewport(o.left-s.overflow.left,window.innerHeight-(o.top+o.height)-s.overflow.bottom,o.width+(s.overflow.left+s.overflow.right),o.height+(s.overflow.top+s.overflow.bottom)),he(this,ai,"f").lookAt(s.scene.position);try{he(this,kt,"f").render(s.scene,he(this,ai,"f"))}catch(h){console.error(h)}}}this.isPlaying()&&Yt(this,Mn,requestAnimationFrame(he(this,Er,"f")),"f")}),Yt(this,Pi,e,"f"),Yt(this,kt,new Bp({canvas:e,alpha:!0}),"f"),he(this,kt,"f").autoClear=!1,he(this,kt,"f").setClearAlpha(0),typeof window<"u"&&(Yt(this,Gt,t||window.devicePixelRatio,"f"),window.addEventListener("resize",he(this,Ci,"f")),window.addEventListener("mousemove",he(this,Sr,"f"))),he(this,Ci,"f").call(this),Yt(this,ai,new il(-1,1,1,-1,.1,10),"f"),he(this,ai,"f").position.set(0,0,1)}destroy(){this.stop(),typeof window<"u"&&(window.removeEventListener("resize",he(this,Ci,"f")),window.removeEventListener("mousemove",he(this,Sr,"f")))}addElement(e){return Js(this,arguments,void 0,function*(t,n={}){var r,s;const o=he(this,$t,"m",hl).call(this,n.shader||"uvGradient"),a=he(this,$t,"m",pl).call(this,n.glslVersion,o),l=t.getBoundingClientRect(),[c,u]=em(n.overflow),d=ur(l,u),h=tm(n.intersection),m=c||ea(he(this,Ft,"f"),d),x=ur(he(this,Ft,"f"),h.rootMargin),T=So(he(this,Ft,"f"),l),p=c||bo(x,l,T,h.threshold),f=t.style.opacity===""?1:parseFloat(t.style.opacity);let M,_,v=!1;if(t instanceof HTMLImageElement)if(_="img",v=!!t.src.match(/\.gif/i),v){const W=yield ha.create(t.src,he(this,Gt,"f"));To.set(t,W),M=new ht(W.getCanvas())}else M=he(this,Qs,"f").load(t.src);else if(t instanceof HTMLVideoElement)M=new Yc(t),_="video";else if(t instanceof HTMLCanvasElement)M=new _r(t),_="canvas";else{const W=yield cl(t,f);M=new _r(W),_="text"}const[R,w]=nm(n.wrap);if(M.wrapS=R,M.wrapT=w,M.minFilter=Et,M.magFilter=Et,M.format=Nt,M.needsUpdate=!0,n.overlay!==!0)if(typeof n.overlay=="number")t.style.setProperty("opacity",n.overlay.toString());else{const W=_==="video"?"0.0001":"0";t.style.setProperty("opacity",W.toString())}const b={src:{value:M},resolution:{value:new qe},offset:{value:new qe},time:{value:0},enterTime:{value:-1},leaveTime:{value:-1},mouse:{value:new qe},intersection:{value:T}},P={};if(n.uniforms!==void 0){const W=Object.keys(n.uniforms);for(const q of W){const X=n.uniforms[q];typeof X=="function"?(b[q]={value:X()},P[q]=X):b[q]={value:X}}}const E=new Wc,y=new Bi(2,2),C=new hn({vertexShader:Gp,fragmentShader:o,transparent:!0,uniforms:b,glslVersion:a});E.add(new jt(y,C));const H=Date.now()/1e3,z={type:_,element:t,isInViewport:m,isInLogicalViewport:p,width:l.width,height:l.height,scene:E,uniforms:b,uniformGenerators:P,startTime:H,enterTime:p?H:-1/0,leaveTime:p?1/0:-1/0,release:(r=n.release)!==null&&r!==void 0?r:1/0,isGif:v,isFullScreen:c,overflow:u,intersection:h,originalOpacity:f,zIndex:(s=n.zIndex)!==null&&s!==void 0?s:0};he(this,Ut,"f").push(z),he(this,Ut,"f").sort((W,q)=>W.zIndex-q.zIndex)})}removeElement(e){const t=he(this,Ut,"f").findIndex(n=>n.element===e);if(t!==-1){const n=he(this,Ut,"f").splice(t,1)[0];e.style.setProperty("opacity",n.originalOpacity.toString())}}updateTextElement(e){const t=he(this,Ut,"f").findIndex(n=>n.element===e);return t!==-1?he(this,$t,"m",yr).call(this,he(this,Ut,"f")[t]):Promise.resolve()}updateCanvasElement(e){const t=he(this,Ut,"f").find(n=>n.element===e);if(t){const n=t.uniforms.src.value,r=new _r(e);r.wrapS=n.wrapS,r.wrapT=n.wrapT,t.uniforms.src.value=r,n.dispose()}}isPlaying(){return he(this,Mn,"f")!==void 0}play(){this.isPlaying()||Yt(this,Mn,requestAnimationFrame(he(this,Er,"f")),"f")}stop(){he(this,Mn,"f")!==void 0&&(cancelAnimationFrame(he(this,Mn,"f")),Yt(this,Mn,void 0,"f"))}}Pi=new WeakMap,kt=new WeakMap,ai=new WeakMap,Mn=new WeakMap,Gt=new WeakMap,Ut=new WeakMap,Qs=new WeakMap,Ft=new WeakMap,xr=new WeakMap,Mr=new WeakMap,Ri=new WeakMap,Ci=new WeakMap,Sr=new WeakMap,Er=new WeakMap,$t=new WeakSet,dl=function(){if(typeof window<"u"){const e=window.innerWidth,t=window.innerHeight;(e!==he(this,$t,"m",yo).call(this)||t!==he(this,$t,"m",Eo).call(this))&&(he(this,Pi,"f").width=e,he(this,Pi,"f").height=t,he(this,kt,"f").setSize(e,t),he(this,kt,"f").setPixelRatio(he(this,Gt,"f")),Yt(this,Ft,{top:0,left:0,right:e,bottom:t},"f"))}},yo=function(){return he(this,Ft,"f").right-he(this,Ft,"f").left},Eo=function(){return he(this,Ft,"f").bottom-he(this,Ft,"f").top},yr=function(e){return Js(this,void 0,void 0,function*(){if(!he(this,Ri,"f").get(e.element)){he(this,Ri,"f").set(e.element,!0);try{const t=e.uniforms.src.value,n=t.image,r=yield cl(e.element,e.originalOpacity,n);if(r.width===0||r.width===0)throw"omg";const s=new _r(r);s.wrapS=t.wrapS,s.wrapT=t.wrapT,e.uniforms.src.value=s,t.dispose()}catch(t){console.error(t)}he(this,Ri,"f").set(e.element,!1)}})},hl=function(e){return e in xo?xo[e]:e},pl=function(e,t){if(e)return e;if(t.includes("out vec4"))return"300 es";if(t.includes("gl_FragColor"))return"100";throw`VFX-JS error: Cannot detect GLSL version of the shader. + `};var fa=function(i,e,t,n){function r(s){return s instanceof t?s:new t(function(o){o(s)})}return new(t||(t=Promise))(function(s,o){function a(u){try{c(n.next(u))}catch(d){o(d)}}function l(u){try{c(n.throw(u))}catch(d){o(d)}}function c(u){u.done?s(u.value):r(u.value).then(a,l)}c((n=n.apply(i,e||[])).next())})};const Vp=i=>{const e=document.implementation.createHTMLDocument("test"),t=e.createRange();t.selectNodeContents(e.documentElement),t.deleteContents();const n=document.createElement("head");return e.documentElement.appendChild(n),e.documentElement.appendChild(t.createContextualFragment(i)),e.documentElement.setAttribute("xmlns",e.documentElement.namespaceURI),new XMLSerializer().serializeToString(e).replace(//,"")};function Hp(i){return i.cloneNode(!0)}function cl(i,e,t){return fa(this,void 0,void 0,function*(){const n=i.getBoundingClientRect(),r=window.devicePixelRatio,s=n.width*r,o=n.height*r,a=t&&t.width===s&&t.height===o?t:new OffscreenCanvas(s,o),l=Hp(i);yield ul(i,l),l.style.setProperty("opacity",e.toString()),l.style.setProperty("margin","0px");const c=l.outerHTML,u=Vp(c),d=`${u}`;return new Promise((h,m)=>{const x=new Image;x.onload=()=>{const T=a.getContext("2d");if(T===null)return m();T.clearRect(0,0,s,o),T.scale(r,r),T.drawImage(x,0,0,s,o),T.setTransform(1,0,0,1,0,0),h(a)},x.src=`data:image/svg+xml;charset=utf-8,${encodeURIComponent(d)}`})})}function ul(i,e){return fa(this,void 0,void 0,function*(){const t=window.getComputedStyle(i);for(const n of Array.from(t))e.style.setProperty(n,t.getPropertyValue(n),t.getPropertyPriority(n));e.tagName==="INPUT"?e.setAttribute("value",e.value):e.tagName==="TEXTAREA"?e.innerHTML=e.value:e.tagName==="IMG"&&(e.src=yield Gp(i.src));for(let n=0;nt.blob());return new Promise(t=>{const n=new FileReader;n.onload=function(){t(this.result)},n.readAsDataURL(e)})})}function bn(i){this.data=i,this.pos=0}bn.prototype.readByte=function(){return this.data[this.pos++]};bn.prototype.peekByte=function(){return this.data[this.pos]};bn.prototype.readBytes=function(i){return this.data.subarray(this.pos,this.pos+=i)};bn.prototype.peekBytes=function(i){return this.data.subarray(this.pos,this.pos+i)};bn.prototype.readString=function(i){for(var e="",t=0;t=0;t--)i.push(!!(e&1<=this.raw.frames.length)return null;var t=this.raw.frames[i];if(t.image){var n=t.image.descriptor.width*t.image.descriptor.height,r=o(t.image.data.minCodeSize,t.image.data.blocks,n);t.image.descriptor.lct.interlaced&&(r=a(r,t.image.descriptor.width));var s={pixels:r,dims:{top:t.image.descriptor.top,left:t.image.descriptor.left,width:t.image.descriptor.width,height:t.image.descriptor.height}};return t.image.descriptor.lct&&t.image.descriptor.lct.exists?s.colorTable=t.image.lct:s.colorTable=this.raw.gct,t.gce&&(s.delay=(t.gce.delay||10)*10,s.disposalType=t.gce.extras.disposal,t.gce.extras.transparentColorGiven&&(s.transparentIndex=t.gce.transparentColorIndex)),e&&(s.patch=l(s)),s}return null;function o(c,u,d){var h=4096,m=-1,x=d,T,p,f,M,_,v,R,w,b,P,E,y,C,H,z,W,q=new Array(d),X=new Array(h),Z=new Array(h),N=new Array(h+1);for(y=c,p=1<>=M,w-=M,b>T||b==_)break;if(b==p){M=y+1,f=(1<p;)N[H++]=Z[b],b=X[b];C=Z[b]&255,N[H++]=C,Ta.arrayBuffer()).then(a=>new da(a)),r=n.decompressFrames(!0,void 0,void 0),{width:s,height:o}=n.raw.lsd;return new ha(r,s,o,t)})}constructor(e,t,n,r){this.frames=[],this.index=0,this.playTime=0,this.frames=e,this.canvas=document.createElement("canvas"),this.ctx=this.canvas.getContext("2d"),this.pixelRatio=r,this.canvas.width=t,this.canvas.height=n,this.startTime=Date.now()}getCanvas(){return this.canvas}update(){const t=Date.now()-this.startTime;for(;this.playTimeJs(this,void 0,void 0,function*(){if(typeof window<"u"){for(const n of he(this,Ut,"f"))if(n.type==="text"&&n.isInViewport){const r=n.element.getBoundingClientRect();(r.width!==n.width||r.height!==n.height)&&(yield he(this,$t,"m",yr).call(this,n),n.width=r.width,n.height=r.height)}for(const n of he(this,Ut,"f"))if(n.type==="text"&&!n.isInViewport){const r=n.element.getBoundingClientRect();(r.width!==n.width||r.height!==n.height)&&(yield he(this,$t,"m",yr).call(this,n),n.width=r.width,n.height=r.height)}}})),Sr.set(this,n=>{typeof window<"u"&&(Yt(this,xr,n.clientX,"f"),Yt(this,Mr,window.innerHeight-n.clientY,"f"))}),Er.set(this,()=>{var n;const r=Date.now()/1e3;he(this,kt,"f").clear(),he(this,$t,"m",dl).call(this);for(const s of he(this,Ut,"f")){const o=s.element.getBoundingClientRect(),a=ur(o,s.overflow),l=s.isFullScreen||ea(he(this,Ft,"f"),a),c=ur(he(this,Ft,"f"),s.intersection.rootMargin),u=So(c,o),d=s.isFullScreen||bo(c,o,u,s.intersection.threshold);if(!s.isInLogicalViewport&&d&&(s.enterTime=r,s.leaveTime=Number.POSITIVE_INFINITY),s.isInLogicalViewport&&!d&&(s.leaveTime=r),s.isInViewport=l,s.isInLogicalViewport=d,!(!l||r-s.leaveTime>s.release)){s.uniforms.time.value=r-s.startTime,s.uniforms.enterTime.value=r-s.enterTime,s.uniforms.leaveTime.value=r-s.leaveTime,s.uniforms.resolution.value.x=o.width*he(this,Gt,"f"),s.uniforms.resolution.value.y=o.height*he(this,Gt,"f"),s.uniforms.offset.value.x=o.left*he(this,Gt,"f"),s.uniforms.offset.value.y=(window.innerHeight-o.top-o.height)*he(this,Gt,"f"),s.uniforms.mouse.value.x=he(this,xr,"f")*he(this,Gt,"f"),s.uniforms.mouse.value.y=he(this,Mr,"f")*he(this,Gt,"f"),s.uniforms.intersection.value=u;for(const[h,m]of Object.entries(s.uniformGenerators))s.uniforms[h].value=m();(n=To.get(s.element))===null||n===void 0||n.update(),(s.type==="video"||s.isGif)&&(s.uniforms.src.value.needsUpdate=!0),s.isFullScreen?he(this,kt,"f").setViewport(0,0,window.innerWidth,window.innerHeight):he(this,kt,"f").setViewport(o.left-s.overflow.left,window.innerHeight-(o.top+o.height)-s.overflow.bottom,o.width+(s.overflow.left+s.overflow.right),o.height+(s.overflow.top+s.overflow.bottom)),he(this,ai,"f").lookAt(s.scene.position);try{he(this,kt,"f").render(s.scene,he(this,ai,"f"))}catch(h){console.error(h)}}}this.isPlaying()&&Yt(this,Mn,requestAnimationFrame(he(this,Er,"f")),"f")}),Yt(this,Pi,e,"f"),Yt(this,kt,new Bp({canvas:e,alpha:!0}),"f"),he(this,kt,"f").autoClear=!1,he(this,kt,"f").setClearAlpha(0),typeof window<"u"&&(Yt(this,Gt,t||window.devicePixelRatio,"f"),window.addEventListener("resize",he(this,Ci,"f")),window.addEventListener("mousemove",he(this,Sr,"f"))),he(this,Ci,"f").call(this),Yt(this,ai,new il(-1,1,1,-1,.1,10),"f"),he(this,ai,"f").position.set(0,0,1)}destroy(){this.stop(),typeof window<"u"&&(window.removeEventListener("resize",he(this,Ci,"f")),window.removeEventListener("mousemove",he(this,Sr,"f")))}addElement(e){return Js(this,arguments,void 0,function*(t,n={}){var r,s;const o=he(this,$t,"m",hl).call(this,n.shader||"uvGradient"),a=he(this,$t,"m",pl).call(this,n.glslVersion,o),l=t.getBoundingClientRect(),[c,u]=em(n.overflow),d=ur(l,u),h=tm(n.intersection),m=c||ea(he(this,Ft,"f"),d),x=ur(he(this,Ft,"f"),h.rootMargin),T=So(he(this,Ft,"f"),l),p=c||bo(x,l,T,h.threshold),f=t.style.opacity===""?1:Number.parseFloat(t.style.opacity);let M,_,v=!1;if(t instanceof HTMLImageElement)if(_="img",v=!!t.src.match(/\.gif/i),v){const W=yield ha.create(t.src,he(this,Gt,"f"));To.set(t,W),M=new ht(W.getCanvas())}else M=he(this,Qs,"f").load(t.src);else if(t instanceof HTMLVideoElement)M=new Yc(t),_="video";else if(t instanceof HTMLCanvasElement)M=new _r(t),_="canvas";else{const W=yield cl(t,f);M=new _r(W),_="text"}const[R,w]=nm(n.wrap);if(M.wrapS=R,M.wrapT=w,M.minFilter=Et,M.magFilter=Et,M.format=Nt,M.needsUpdate=!0,n.overlay!==!0)if(typeof n.overlay=="number")t.style.setProperty("opacity",n.overlay.toString());else{const W=_==="video"?"0.0001":"0";t.style.setProperty("opacity",W.toString())}const b={src:{value:M},resolution:{value:new qe},offset:{value:new qe},time:{value:0},enterTime:{value:-1},leaveTime:{value:-1},mouse:{value:new qe},intersection:{value:T}},P={};if(n.uniforms!==void 0){const W=Object.keys(n.uniforms);for(const q of W){const X=n.uniforms[q];typeof X=="function"?(b[q]={value:X()},P[q]=X):b[q]={value:X}}}const E=new Wc,y=new Bi(2,2),C=new hn({vertexShader:zp,fragmentShader:o,transparent:!0,uniforms:b,glslVersion:a});E.add(new jt(y,C));const H=Date.now()/1e3,z={type:_,element:t,isInViewport:m,isInLogicalViewport:p,width:l.width,height:l.height,scene:E,uniforms:b,uniformGenerators:P,startTime:H,enterTime:p?H:Number.NEGATIVE_INFINITY,leaveTime:p?Number.POSITIVE_INFINITY:Number.NEGATIVE_INFINITY,release:(r=n.release)!==null&&r!==void 0?r:Number.POSITIVE_INFINITY,isGif:v,isFullScreen:c,overflow:u,intersection:h,originalOpacity:f,zIndex:(s=n.zIndex)!==null&&s!==void 0?s:0};he(this,Ut,"f").push(z),he(this,Ut,"f").sort((W,q)=>W.zIndex-q.zIndex)})}removeElement(e){const t=he(this,Ut,"f").findIndex(n=>n.element===e);if(t!==-1){const n=he(this,Ut,"f").splice(t,1)[0];e.style.setProperty("opacity",n.originalOpacity.toString())}}updateTextElement(e){const t=he(this,Ut,"f").findIndex(n=>n.element===e);return t!==-1?he(this,$t,"m",yr).call(this,he(this,Ut,"f")[t]):Promise.resolve()}updateCanvasElement(e){const t=he(this,Ut,"f").find(n=>n.element===e);if(t){const n=t.uniforms.src.value,r=new _r(e);r.wrapS=n.wrapS,r.wrapT=n.wrapT,t.uniforms.src.value=r,n.dispose()}}isPlaying(){return he(this,Mn,"f")!==void 0}play(){this.isPlaying()||Yt(this,Mn,requestAnimationFrame(he(this,Er,"f")),"f")}stop(){he(this,Mn,"f")!==void 0&&(cancelAnimationFrame(he(this,Mn,"f")),Yt(this,Mn,void 0,"f"))}}Pi=new WeakMap,kt=new WeakMap,ai=new WeakMap,Mn=new WeakMap,Gt=new WeakMap,Ut=new WeakMap,Qs=new WeakMap,Ft=new WeakMap,xr=new WeakMap,Mr=new WeakMap,Ri=new WeakMap,Ci=new WeakMap,Sr=new WeakMap,Er=new WeakMap,$t=new WeakSet,dl=function(){if(typeof window<"u"){const e=window.innerWidth,t=window.innerHeight;(e!==he(this,$t,"m",yo).call(this)||t!==he(this,$t,"m",Eo).call(this))&&(he(this,Pi,"f").width=e,he(this,Pi,"f").height=t,he(this,kt,"f").setSize(e,t),he(this,kt,"f").setPixelRatio(he(this,Gt,"f")),Yt(this,Ft,{top:0,left:0,right:e,bottom:t},"f"))}},yo=function(){return he(this,Ft,"f").right-he(this,Ft,"f").left},Eo=function(){return he(this,Ft,"f").bottom-he(this,Ft,"f").top},yr=function(e){return Js(this,void 0,void 0,function*(){if(!he(this,Ri,"f").get(e.element)){he(this,Ri,"f").set(e.element,!0);try{const t=e.uniforms.src.value,n=t.image,r=yield cl(e.element,e.originalOpacity,n);if(r.width===0||r.width===0)throw"omg";const s=new _r(r);s.wrapS=t.wrapS,s.wrapT=t.wrapT,e.uniforms.src.value=s,t.dispose()}catch(t){console.error(t)}he(this,Ri,"f").set(e.element,!1)}})},hl=function(e){return e in xo?xo[e]:e},pl=function(e,t){if(e)return e;if(t.includes("out vec4"))return"300 es";if(t.includes("gl_FragColor"))return"100";throw`VFX-JS error: Cannot detect GLSL version of the shader. Original shader: ${t}`};function ea(i,e){return e.left<=i.right&&e.right>=i.left&&e.top<=i.bottom&&e.bottom>=i.top}function bo(i,e,t,n){return n===0?ea(i,e):t>=n}function em(i){return i===!0?[!0,Mo]:i===void 0?[!1,Mo]:[!1,fl(i)]}function tm(i){var e,t;const n=(e=i==null?void 0:i.threshold)!==null&&e!==void 0?e:0,r=fl((t=i==null?void 0:i.rootMargin)!==null&&t!==void 0?t:0);return{threshold:n,rootMargin:r}}function fs(i){return i==="repeat"?br:i==="mirror"?Ar:Zt}function nm(i){if(!i)return[Zt,Zt];if(Array.isArray(i))return[fs(i[0]),fs(i[1])];{const e=fs(i);return[e,e]}}var im=function(i,e,t,n){function r(s){return s instanceof t?s:new t(function(o){o(s)})}return new(t||(t=Promise))(function(s,o){function a(u){try{c(n.next(u))}catch(d){o(d)}}function l(u){try{c(n.throw(u))}catch(d){o(d)}}function c(u){u.done?s(u.value):r(u.value).then(a,l)}c((n=n.apply(i,e||[])).next())})},Ao=function(i,e,t,n,r){if(n==="m")throw new TypeError("Private method is not writable");if(n==="a"&&!r)throw new TypeError("Private accessor was defined without a setter");if(typeof e=="function"?i!==e||!r:!e.has(i))throw new TypeError("Cannot write private member to an object whose class did not declare it");return n==="a"?r.call(i,t):r?r.value=t:e.set(i,t),t},dt=function(i,e,t,n){if(t==="a"&&!n)throw new TypeError("Private accessor was defined without a getter");if(typeof e=="function"?i!==e||!n:!e.has(i))throw new TypeError("Cannot read private member from an object whose class did not declare it");return t==="m"?n:t==="a"?n.call(i):n?n.value:e.get(i)},oi,vt,Tr,ml,gl,_l,vl;const rm={position:"fixed",top:0,left:0,width:"100vw",height:"100vh","z-index":9999,"pointer-events":"none"};class sm{constructor(e={}){oi.add(this),vt.set(this,void 0),Tr.set(this,void 0);const t=document.createElement("canvas");for(const[n,r]of Object.entries(rm))t.style.setProperty(n,r.toString());e.zIndex!==void 0&&t.style.setProperty("z-index",e.zIndex.toString()),document.body.appendChild(t),Ao(this,Tr,t,"f"),Ao(this,vt,new Qp(t,e.pixelRatio),"f"),dt(this,vt,"f").play()}add(e,t){e instanceof HTMLImageElement?dt(this,oi,"m",ml).call(this,e,t):e instanceof HTMLVideoElement?dt(this,oi,"m",gl).call(this,e,t):e instanceof HTMLCanvasElement?dt(this,oi,"m",_l).call(this,e,t):dt(this,oi,"m",vl).call(this,e,t)}remove(e){dt(this,vt,"f").removeElement(e)}update(e){return im(this,void 0,void 0,function*(){if(e instanceof HTMLCanvasElement){dt(this,vt,"f").updateCanvasElement(e);return}else return dt(this,vt,"f").updateTextElement(e)})}play(){dt(this,vt,"f").play()}stop(){dt(this,vt,"f").stop()}destroy(){dt(this,vt,"f").destroy(),dt(this,Tr,"f").remove()}}vt=new WeakMap,Tr=new WeakMap,oi=new WeakSet,ml=function(e,t){e.complete?dt(this,vt,"f").addElement(e,t):e.addEventListener("load",()=>{dt(this,vt,"f").addElement(e,t)},{once:!0})},gl=function(e,t){e.readyState>=3?dt(this,vt,"f").addElement(e,t):e.addEventListener("canplay",()=>{dt(this,vt,"f").addElement(e,t)},{once:!0})},_l=function(e,t){dt(this,vt,"f").addElement(e,t)},vl=function(e,t){dt(this,vt,"f").addElement(e,t)};var wo=typeof globalThis<"u"?globalThis:typeof window<"u"?window:typeof global<"u"?global:typeof self<"u"?self:{};function am(i){return i&&i.__esModule&&Object.prototype.hasOwnProperty.call(i,"default")?i.default:i}var ds={exports:{}},Ro;function om(){return Ro||(Ro=1,function(i){var e=typeof window<"u"?window:typeof WorkerGlobalScope<"u"&&self instanceof WorkerGlobalScope?self:{};/** diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index a837d93..fb85f0a 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJydWk1v2zgQ/S86s1tSFL9ya+MimyLZZJ0WDbDogbGZWLu27KXoYoMi/31ByU5JSZaGubSG/UZvOBzOvKHyM7Pbrauzs784EwwRTGSOCGGUIIIpVohh3HytMJJF3nwsFOICY1TkkiNRKI6KnAn/D0aSKowEoYhgLCQqikIiJbm348w/k1P/GxfqO8qseVybhSu3VZ2d/cwIFf6/Sm9MdpZ9Mw8XV3NTLY01NkPZP2W1zM5ILlG2t+vsLFusdV2b+n0E/G3lNusMtT9mZ5mrl++85bv2ixeUURmynOuNsXrs8S1i4rkoW6zK9dKaykcSE/b9BWWc0YDpi/nP7a252url+Hoi4PR6BAlZegHLGT8SlJUz9lEvTP1+Mlyv2HhphAq/MpEXp3bqVlu9Mc7YesKFE1YAj15QRjBTsQf382td6afJVHnFTUeWCIWHl/lF2yfjgEnZggF0kod0dwtTmTGKBjD92JxgEjz24/7x0dgLs90YZ5/Hnh8jAUQ5C4mutTO21OsxiiMm5XQRQpXySZhTIQO+m4e/zcLR2RjfEZPCR6VAfmsQVYyhguc54pRQJJTAiPiC2TjDCe8fdsAxT3KFCIFoLjHiijIksGi4/dcB90w7TWcADyIgoHDmEndoPlirn4FMIRZAphgLyC7sdr8bY2gAKbFkmFLEcq4QY02Ho6wpbb6LDWTV57ubPyYKWghNraui7a+KIuVbqWK8ODgjBpz59MNU7lrvgA4d4alOSSZx64UMc3u6g4FaV9wyGW2YikJ2K+653umHcl260tRpzWXYMnlr8nYreJ6HQSifVqMNoAFM57mXV8Fjm62alfVOu8VqPMgdaFIJxUwh3xeQr9nIF1LkCxjismiUiz8cgVf387aHzfXz3a4N0Em3ulhACHKuIrILW+4APK8wAAWLonw//11XSwDFK2yawou+gOLW2Hrnte0PMy0xe+CUzVQ5bwqXb0ph+zX1arT1mnoFWBUTrCcePjhny4e9Gw1eB5q0IkGaauCHjID80hmr3XZK2h5hydIW87bo+kPQU9TTii9B7MW8QjVV1rf0sL2anVtBWmuAAwwLONJM5/sHA+AIYJB5RPVkLKB7vuJgA4AgKiwal9WytGbh7tzW6ieTkKfjloDlUtabWm/t9snqza+e8610q69V+bi1G1DnGn0AMECF4gNqHNxB+wbJB4qwVlIJVZC+Nqazy41+Ml4aTrjSNwCGQIkwEz9ux+cp//v0fkvKwxN0t9I7UHofcTDX/TXKCRXafk7Qou3n1N1TnElEsFAcESwp9xspCxJqoCZLTV03SuSyKqec6uGBsSjyMBYflsvmAVdl7Uxl7M2uvUAa5z5hBfagJ9LS6N/IHcvxIsftLijaVaKADHzFAdfMZOfy437eSCHg8NE3APKK6H7ufv7nXi+v9LOxgAzroIGMsoj15/nzuvS9HM7aswAyKxLL7E//7ptmBGfuWUCZRWfN+weTsN4QDWNUuOARY9PoGvVyWfm+pv2hmGQetAJ6QHIZr/n2azL/gA2QPR7le5IfcIIHbaDsPGRv7mKm55IANt0Y/Z1FZ/4ArOkIAy6DMzmkLUE9sYMGMsbX60vzqPfr0TngAEkZAbyY9ZXdvyiZ1JJv0o/Jlx6H27DmLU5fuyUqtxTdFruhCnJwQ4b1albWC2ucufRmu+1aV6NbMgAHXMdjglXUZyujLZCxBwbx5SqezcoFkK6LBbEV8QAFIoJzdGZrLBVqIoqadbabSkQ4F9xqB6kYR1iyfKJcHmhlHsXZ/oAo+Fdc+sWCUscFR6oeqptT9HJHMRL/Mpf616+EiuazOASBRsk9u7m+3ZaVmxu9vKnWzxMedeHpo2GuDgc7Hp/v55/9cwFXc79w7wgk3XnnRhMudlKEThx+IQXy6hJ5oYe85mrXzKMXZffzZBXyBgkSD3e44MjroYM/UeduLtAe1iblvi2AQ1/g8o4CvTN1XW6rJtnHtz5EplUhQQ47IEhMflnt9u5uu7cLU5+vdPVkYj9ObcQJO2gMRHRHM6jvQNJmxBLqiqR8QL2B2GMwlFAp1a3CwA4QYdOrMRFt6fGNIBSTO1uOXxW2CECxITnjcXG91s6W/wHKTYQFhtIX04FaDqzhUBLK41coc/NorKkW5teQDyqnJ+zAboj8ZNkA8XcN4MTyVMmAkw8ZgR2IDkybjJA/soiRkPRllAylbz5LSeAW/QZlwHh7PFmkDOJVgMehU2aQoL+8/A+rYbOD" \ No newline at end of file +window.hierarchyData = "eJyrVirKzy8pVrKKjtVRKkpNy0lNLsnMzytWsqqurQUAmx4Kpg==" \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index dcf7fb6..a387162 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -13,14 +13,10 @@ --dark-hl-5: #4FC1FF; --light-hl-6: #795E26; --dark-hl-6: #DCDCAA; - --light-hl-7: #000000; - --dark-hl-7: #C8C8C8; - --light-hl-8: #098658; - --dark-hl-8: #B5CEA8; - --light-hl-9: #008000; - --dark-hl-9: #6A9955; - --light-hl-10: #267F99; - --dark-hl-10: #4EC9B0; + --light-hl-7: #098658; + --dark-hl-7: #B5CEA8; + --light-hl-8: #008000; + --dark-hl-8: #6A9955; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -35,8 +31,6 @@ --hl-6: var(--light-hl-6); --hl-7: var(--light-hl-7); --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); --code-background: var(--light-code-background); } } @@ -50,8 +44,6 @@ --hl-6: var(--dark-hl-6); --hl-7: var(--dark-hl-7); --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); --code-background: var(--dark-code-background); } } @@ -65,8 +57,6 @@ --hl-6: var(--light-hl-6); --hl-7: var(--light-hl-7); --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); --code-background: var(--light-code-background); } @@ -80,8 +70,6 @@ --hl-6: var(--dark-hl-6); --hl-7: var(--dark-hl-7); --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); --code-background: var(--dark-code-background); } @@ -94,6 +82,4 @@ .hl-6 { color: var(--hl-6); } .hl-7 { color: var(--hl-7); } .hl-8 { color: var(--hl-8); } -.hl-9 { color: var(--hl-9); } -.hl-10 { color: var(--hl-10); } pre, code { background: var(--code-background); } diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 20014c3..8794ad4 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJy1Xdty4ziS/Rc/d890+VJb3W+WbKs8Y5fVkuyumYmNCliCJWxRpBoEXdZuzL9PgFcATAB0JvfNwXOchwBxSSQS0L/+70TxN3Xy28nTzdeTn04OTO1OfjtZJyzPef7Xp5uvf9mpfXLy08l3kW5Ofvtw+unfP7X/8wd/nt0teLrhksv+f1twz85PFe/ktxOVb34W+c/8TXGZsuTEUJiyPZesb7p6jrO54m+qkPwuYxvorS0YpzBPWMr7lsvHOItlVV6/KZ7mIktzT113BILKbfqSeexriGB5uWOb7Mc9O3jMtzhBY8oO7FkkQgnuqyWTQlCay+zAZUCnIxBUqu5zJ3LlkzEYlG+jmAKabIehbX9d3LOUbT0DRIvi7D/xtcrkKTByVQDF6rnP6jlyLMuSDKiE8jG5hayY3HIVbCIVBae0XHNoRCsf4yxOipcXLmc823Mlj33TNo7TuGeKS8GSvvUGwdl9eP4fvlZnV327DUKambxzErKmszegg+inaHtnoL0zSm8DTNYAzuoVU+zsylujFoxXuJSSHYMiJgOnc8eOXAKjf/Uc3TOkeANGuBrAWb0uEmiYLx/jLP5e6I6aiiztm+0wSh0A7a4GcFYvU7FnSmTpNBGAo2PBOIWZzArAcvkYZ3HBjmuWK+jbtRCy7XqcbIp3rf9XpFuvV2HjNA9vK9ne795pFDmfHnYcGjGq58h6ESkHWnP5mFAL1ZTm8z5rFPvG2x3gs5SPR/GZoy4zwZOrHBSPP1eByHmFH9TOZ90AkS1P8XQtEp99C0bOAq88VVciPzC13oHzgU3AqXxdVP7sgh2XB7YG+pLLwOrMpDh4JVoQa/0zSzde6y2Itb7gL1zydM29EjYDq1N2q9IhgTQ6FGt/LjM9zogs9Yo4FFJJJiLVU4i3LDWO1biRbA9+jBLAWl3yPAcdpRZCRrO4zA+6Zl+5LxzXoyA9Mp7vAHeM5zvKGvNSKSmeCyi84RBwKrep4jLh7JVvooJ+LtJzCy7+6ev+crrxr28MFGf/JgM62U2G7Fk32fb67QAsdmsAOdsXz9xbBQaIbT0bIflaLVUm2ZYPaEEhPtInyAoJzQ7Vc2QsQwqWbhMomFEjBM9ZrKGgTgshv/MxEenGY9sAsVETKICmn+Ls/Z0fX/RssZJs/b1v2ILRq0JwPUhpY39bPnzxtTONEbz+x1S8ZHLvW6g0MGGlUu1PeNYrFYj2b+AdoxpAewQ+p4/mU4qt2KwkS3NdoaBPaTGwOl5Pj+TfPQkOfMLqOcXmIZPADNxhWNvTbH/IchF0fV0OVuv3gm28Ii2ILkk5hHLpL4ZJwKpc/1mU86NXxSKgy1I8c385GpC0BlkWz7d7tgX7r0VAjzlZDg85WY62qVs7lz7LHYq1f5mud9AmWoOgV+FCrXiufI6QQyCqLHheJOBgYRHQcRE98Aqeqtv0UKhoyQL0Ud/AX+oAHfsGf8tEqrzTX4eS7PuaeQtirZf1UH2CcvsIEnE5+AiRHnI92/8WjFWYZEW64Zt4KAokossFVxvafy0r2Rf/MMCRYggDQgfI3aO76BKzR8EpbfgLA3t8DSAjEiJfS654WR2HLGEpoACQ8HsqTAa1ehR0lEGsg0Iug9DSfBJk66VjUsdDfCuxBkbGeGSRqwJYdtTACGNuZLglZEJNs1TJLAF3yR3C//fM9/OHcfYUys2c+MZCSUOvYwOuMNULhmPO1XNiJN5bNSY+Qnv16rgcSnRFicQbWtEYNponBTQFVc8pe2q+7TTKe/rzyWycEss3hwahh+MXtm5D+e6wcHrx8b3b4lzOmQ4MKiunyFDycAnCV/y52Pq1Shhnvpyv8mrXDxQwCTgJHZW854qB5hsQZ7pJFrSDooZ5k0CTKLu/lXkNyDQknNSE5e5IZGi0KPJD1+Fb+CPXIM50mcfD89z/7haD0A/MxPMhnRDmIxvCy4t2iXk6Zekrg0UdDqGkOhjuGcgMnCBQbpQ/OyslV8Ug4aTKZV21FrLDxoaSw0GXqU2ED3ZViIiTrBPk78R3DioZOKHyvOZbFDkeKC6ZyuCP34CUijmPVMw5/t27vFWvhk3ByXxe3oG2Py/vcAYXswnsmswmOIMznga+Yosi39bIfXg4KPvUVM+xsng4wfIshHcqb1FsVVXnIJzcX6u6DAZyBreOXHiL0qcRBvI6i7ab3v4QatffynWH9uC/4V6ncd4jM3OfRpPzVrNJwEnobUHtt/BNHXK5F4e9Z2LxcHHCtQlv0QycMkafRcboM/zgWb/h2VUZW9DnOEIFMWjIxpDJw87N4jLbQocjJ2Pz2IH3u/RYyKG3OTMQ6UoADyd4Y0W7DIWb3gbC4NF8xw6B0bxBkca/84SrLPXbNwj0tWX1d3SFWf2Nk/MvngiLJmvddZuKAaszzUL2kM2mtKBPBWjPI+QzeLiEqhuiOp5kmbDkbXwtSnG8bhWHF+sdTFgqdSHl4ELJouHkqqBhFUi190gNMZeElQJC5tpw4lnkhv5hxFfwVbGPjJXuTgl4+7pLwkqVBvxjlknASrg5WZGq9NGx8s5piECNAkysaJsiFpCzOOjKNTPFAmI9HlbQShoLCPZ46BI2OWSh0pkcUq8rE/n17R6y8v9Cnc/loks4fxwoCzDxw1ubzhKoWIeFFTO3+cLjOMDEihp7fvl0x9LtkHkk/E8jvMr73mEMcbNK/cOuw0L7CFXOWu2UBVpWn4iVBJPm4i8Q+zdCDbgJfm7BoYy+4QJXD/cPr1wm7BjywxwWct3hnmbzusogExkC4PnOHwuqQUpcr83migT2LB5yPZ5tvSI1hjasz3GFjDc4MYgbWDM7nDGDn+8IeCL3TXScaiKULwxo4AQBb7yMGCZ7EhueOYdnzahfC5OCfoNCfsSSWMezvM25x0KOZ0z5h5YGRIaYC/nqH1BalBAZ8c5lxHiPFU2Jx1vGiO34hxSAR4jsVEfRwvGdjoMTunq4n+tcwgVnm4c0OYJKLokm5W0JJoEUEQj4TcR1lpn46h/kwYPE73CRhi2nxllLlZvszwmP78QbpJEXNe9bzYzoDAa6coBPcwwDmjaFllHxD8GTTcCVB3g0wQVXhUwHKJpEQi90z1e4nRA6XPFu72fJlRLpFnboeiyqN+Qdt2wKVaaqmQFiHRE94i/4Ojq3mBxC2coLm5yMebdYHYdaidPscFxloX0eDxc5fOnz43fsmBWe4arDCR5g0MO0GOgGUV3KF/IBOgbNzwj6GCPuqwQDkCB7jFhYQNWljRX3C0hCVNKYEWogDT7KWBEeBm0esdGfXsWbfcXBpiIdgl6cgSOjKtbpiEi4w0dGfrWbrw8H8/ZCdTxUF9vrx47NX379rw8Xp/Z/61u8oX8vn8f+v8pznkuem4k9lQ0TG/Ae/Zy49lU8eW89K7r9Q5XRPB/wFn9IM3DUvoF+PEA9kxtAO5Mb8H+Hft+6+E8sKbi/dko49o6rLOX37HCw7n6rLBkQ/m3LYWHBdaYdT5WzSKt0AAper75RbsH/LHiupixJnq3bgipJmIVXXR0PfOMcXK8rsUXw1ttfCdDGoE7VgoTvVCSJnVRWf5z6OaUFZHIjUqb48phbOTLN57dxvJInwFXJWKB7FPSd/e864fty6obOYrXdEGDFemMV+M5+lKNk7RC5liEOvjRz8caTmzIw4goZEKFnVAEevfaDWq8D43UmCXcusKwEmud0y9d/FuDw5eJ0paVc37C15ZvYUi2BrnWVq7BWS6CMybZ3DzUEiENRvE5fhcxS3QHLktxnG0ATYuFVyww88NaMtudaOGEMqo4qrYpD0ncADIyqcB5QOCcqfNEjS/Ige3dv9Lw1P5OqPkx5PNUyEK0bWU+pQwh+QnWT9U2RrnteQgeR7T/0/OEWINgW/f6pnxHq+uH+s9juFjxfiT1fKrbvvTdAwet5vGiyB73ib2X41L2po51ADZQwdkn49ZvnlHrZpuJFrMvJsZ7vb0Si+i6an0lQF0PFfUS89mV69DSKDiFZDzhvNjqKfzibPwZcxNn8kTrbnAVmmzPibFON4XAfMjFKOy9/RwYsg4kR1jf6V2Ue5AZY3LQI0Tr49h2Ct96d7wUlHJj6FeCWZGKUflcfGfP6lX3GSGvaBxlMrwAWuuB/EMreHf23TyLWBbdhiv9e7tIs+zHEDiGMaUwq606bejCrHlPeWmfwlhdO9fw7E6MolFkZ7u5WI2GAZI3fC5YI1Ytn2ShphXaEFmRHUquprkQFm00LUezrtAPQeg1QbD+JXJR3n7jpvo2GQ6BolauNx9y6YKyR6TCygg7rwO5Jj4DXetiLnnn9jLiODyzhqat3sOKJNd6uTmfzRyi+4uJ4pS45xc5fqXRslLhSrv3wgJvroZHjlfpwGpMiz1K9ZIbCfl4iJQbf/rKGZ93QZ+DVZnfLuycuc6BsBkSJ+++fRdrfUKgeE1vGnK2/60CokkzxrfDEU3osaryo3mbxxIkalFRn9Z0UgTYPkgj9ubkBVTdeMDbVZxDiPOUet/hfvnHut6xDPjZM9iAfpPBtO/YZVM+Pb1Keezy/ChvFtwy4lhT79bgCB+cNkFSG6vRVmd2vs2RhMYhF8kXaI1Kwno1TYiX9nWb9jLD6e1snRX+BWT8mvKnkG/4iUr6BUgHrNwc4hJGtvGAvEMjsEQi+UJJkP5Y7Jpt7w2FFD40QxdJ5UIGB28VJvbX5oUd4Y8uCKTrd9cxlIAHuQACJomlm5cGCLoOi5ibkwYoQC6/6eXV/9yCXT7OyvdeJAq4oSKL0isOOVZm1/Z7QQsTWX4XYphl/eRFrPbH2s7dgGlG3HKLmUuyZBJxBgELUq37qicvpjkm21ol7uRJrWNjDpcSyRaJEap8S6Ae1ARJeMy9z94wCvjIp9OSc/7WGbNtnp9Z0A14425mwCG5yztngVXv/GtZOwoCRAl8yMFmuk7AIKInqlxUiMj0SSmrBRbpjchMRA2goualIeZZGxHoklNTl9Hp5I5K9WEfkQCKudEWusn2sdC4JV7rt11ixLAauqfNCSZbE2nuPhe+44PXGTu81OMguPGG5WLcZk5CQzUCJzKc3QQkTRwtkLyoqYnJQQk/L+6CIiSP7TZVd+sX6qVCzy3Q4SWBiJQH3BSa99N93CtzIDJ7aLAJdIlaQloTviv6EXac/hjN33yE5fxyq2WfiBlHt8LqLNGME7WDc3Dqb+I23INb0ZdD2JcH4XbEXKUvX3K/gUGgykc8A8VCCZTDYr2PAePNNhl1YxWIh/bZN4Ps3INa0DvVuuQwqWBxkIw41YZLheAFmY7z/ZIDOZBShyyFKl3SpxzQX25RvJkflhGU7JZeD88ECAiTDy10mlc9yC5IqJyjRI6Gkbt0IVCdwC4Wd3lmCgHmHgpK5STLmFWhBlOnPLHkJmrcI9M98fn5+PuhTN0S65MXFxYdBkg2R2hROzz8NaA01iyp28euvvw5Qa2jIGE3/IJAZoIGPAw02Xp4GCAqYDJxrutkIfZVKSMbl4IbL4lnpeGREC6Ch5O6LRIlDcgxpuRxCLCYkYzOwX6l/Hsz6QPBxsHd+m5CGy0G6fK/6cOIQPQ8V1xhEGpIyYJx59hY038G4ryPX5YpkyVShM0vcA3TGNwKZKNF/cpn5hToUZfwhDRSiBbGVVe68BCvJYGDf/16kRR4Xg5mkZhD//OOULCIGM3EL2lxFxGwGqWRxMZiJLVmkgdgMaskGtsYRRKdZmiuWxhQBGqmMA2UDdFJpIy0HoI1S2oENdiz5L3rqLeNH8DZMgyJjoT/YMfdaN2BcsI/nfuMtiDatJ/IkaL9joETCAkTjM8n1uaewRo9EkYqp4AW+ZCpcDouA7wfgKWenN3iPO7+jZUV0HAq+bUV0XA6tpwwo1CiCdWuKyPVZpJYXaxl9GrnTDivgKLLVQBwR7JHQaw3gsL+93PAc+h8o8XfOD0EJi4Bc2x4StuZBFZeDDNmuZZmcF5Tqs5CbTUPE+ixayfQ1AMNKZzFpJYyKwkxkSV+5jH1Ai4KLj+vtefuuCyM+3oDI3Jb1d5/lBsN9j6x4TrjPdIfi4sNPgQSjFsTOruUvU7F0WyRMLvhLUt3CFVCM/c9IL1IGVN/5Ivb/4Bo59FsYRgPvYGR+FfBDEo55DSKNQ7+FYeQitSjS/IIfOFP9e1CsycJg4NatCdsfVtn1ZstDSgANGWeVMpN8Ey8bzER66UzyXLnXrJguukEg5Mn6FUycUobqJ6GHFghgE8Xv3yXusrF5zmZpYjXtJdNLPlzaISPLXZkY+Mm9ZJr0kA/uJY9Q7mEda6SvbRZksPA437raqA1d5eJu6sYudXnn9u4waT8b58l5f8LG8OccDuU0Ru/nX5wE0hpHSuhbMMT6SrIfzoUKxgaMTcFV2jFl+4iOy0GWR3K2j5THohCqTX/eSLW1FEq1BXVcDqHaIuWxKIRq079PEam2lkKptqCOyyFUW6Q8FgUfsq0uyYAHVwNHhzYD9g0YH6IN2DdxWmg2UgiyUB2LDMjYDFIoNvTFbQo5BBsvEFmuiqoGhCwCMmvpmQ+KUIBEimQ8FgES0ZKPT4PLCVDxzoj7K1iOLzKhnCvTF+Z8AFugBtAmz3wmz0gpeA8HfSbYlxzlkpCBh7ewioFj/eiggIkjw6m5WJu3CMFxVYeEzvKPKbkcrNAAnRFk4ipkkZX+lcNUldeStNcvQVogEZcFUt6eGVeEeNj1GvyrcNZyzaRQQqvQVTBOfLWjYIOss8m35dlq+u3q6+rDt+CZlh4P3beGKvaJdMmzoZJno0leDJW8IEp+mz8tVtNv55P5/Cn2MQEqUfZ0uOzpGLKX7yguyKUKDykwyEVX9PVqGqtgg0KROY3LnJKrsTRyfTmNVaHDwwteLnUbeDuPCTo8ouDFQMGL8QSjQ47DIwp+HCj4cTzBjwMFP44j+GlgCT+NVcJPA0v4abwSfhoo+GkcwQ+/DKxTg0iXHFarBpEuOaxeDSJd8sMvQzVbJlX0dLDo6aiikZkKYOJFJ/NVdLIyOOgJuLSxvJ19ub6KzMN9Jk308ctwWYeLE76++raYRdwah4MLr1evOkTPQ0WXb7a4vv5Smgq2VZBJLesw7eA/INP3miuK+ZXI15IrcBEL0Khy1WZ0RKwiUaWW+yyDU+t7JNL2cGhb+F3r/v/+D8RmQZw=" \ No newline at end of file +window.navigationData = "eJyNkUELgkAQhf/LnCXTiMp7QqekyITosOmE0rouu1MU4X8PLUljQ6/vzfd4M3N4AuGdwIPQj8ACySgFD2LOtEZth340SinnYMElEwl4jjsvrTazlqS/HD3km6rkLumOFzNn6nbpQBXShNd6H79NWYIqUKiRfjPa3oAeO5GdC5WbqjRWX8oGYzIdo9EHtNgrJg0NKnn4DiHjV/y/R20PSFtyzFHQShAqjTFlhTCEGqb6snX9mdaZbkxl7MRR2x+rmzBxy+MLOITdbg==" \ No newline at end of file diff --git a/docs/classes/AnimationClip.html b/docs/classes/AnimationClip.html deleted file mode 100644 index 72a5008..0000000 --- a/docs/classes/AnimationClip.html +++ /dev/null @@ -1,26 +0,0 @@ -AnimationClip | VFX-JS

Class AnimationClip

Constructors

constructor -

Properties

name -tracks -blendMode -duration -uuid -results -

Methods

CreateFromMorphTargetSequence -findByName -CreateClipsFromMorphTargetSequences -parse -parseAnimation -toJSON -resetDuration -trim -validate -optimize -clone -toJSON -

Constructors

constructor

Properties

name

name: string

tracks

tracks: KeyframeTrack[]

blendMode

blendMode: AnimationBlendMode

Default

THREE.NormalAnimationBlendMode
-
- -

duration

duration: number

Default

-1
-
- -

uuid

uuid: string

results

results: any[]

Methods

StaticCreateFromMorphTargetSequence

  • CreateFromMorphTargetSequence(
        name: string,
        morphTargetSequence: MorphTarget[],
        fps: number,
        noLoop: boolean,
    ): AnimationClip

  • Parameters

    • name: string
    • morphTargetSequence: MorphTarget[]
    • fps: number
    • noLoop: boolean

    Returns AnimationClip

StaticfindByName

StaticCreateClipsFromMorphTargetSequences

  • CreateClipsFromMorphTargetSequences(
        morphTargets: MorphTarget[],
        fps: number,
        noLoop: boolean,
    ): AnimationClip[]

  • Parameters

    Returns AnimationClip[]

Staticparse

StaticparseAnimation

StatictoJSON

resetDuration

trim

validate

  • validate(): boolean

  • Returns boolean

optimize

clone

  • clone(): this

  • Returns this

toJSON

  • toJSON(clip: AnimationClip): any

  • Parameters

    Returns any

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/ArrayCamera.html b/docs/classes/ArrayCamera.html deleted file mode 100644 index b5c98be..0000000 --- a/docs/classes/ArrayCamera.html +++ /dev/null @@ -1,436 +0,0 @@ -ArrayCamera | VFX-JS

Class ArrayCamera

ArrayCamera can be used in order to efficiently render a scene with a predefined set of cameras

-

Remarks

This is an important performance aspect for rendering VR scenes.
-An instance of ArrayCamera always has an array of sub cameras
-It's mandatory to define for each sub camera the viewport property which determines the part of the viewport that is rendered with this camera.

-

See

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_UP -DEFAULT_MATRIX_AUTO_UPDATE -DEFAULT_MATRIX_WORLD_AUTO_UPDATE -isArrayCamera -cameras -isPerspectiveCamera -type -zoom -fov -aspect -near -far -focus -view -filmGauge -filmOffset -isCamera -layers -matrixWorldInverse -projectionMatrix -projectionMatrixInverse -coordinateSystem -viewport? -isObject3D -id -uuid -name -parent -children -up -position -rotation -quaternion -scale -modelViewMatrix -normalMatrix -matrix -matrixWorld -matrixAutoUpdate -matrixWorldAutoUpdate -matrixWorldNeedsUpdate -visible -castShadow -receiveShadow -frustumCulled -renderOrder -animations -userData -customDepthMaterial? -customDistanceMaterial? -

Methods

getFocalLength -setFocalLength -getEffectiveFOV -getFilmWidth -getFilmHeight -getViewBounds -getViewSize -setViewOffset -clearViewOffset -updateProjectionMatrix -setLens -toJSON -getWorldDirection -onBeforeShadow -onAfterShadow -onBeforeRender -onAfterRender -applyMatrix4 -applyQuaternion -setRotationFromAxisAngle -setRotationFromEuler -setRotationFromMatrix -setRotationFromQuaternion -rotateOnAxis -rotateOnWorldAxis -rotateX -rotateY -rotateZ -translateOnAxis -translateX -translateY -translateZ -localToWorld -worldToLocal -lookAt -add -remove -removeFromParent -clear -attach -getObjectById -getObjectByName -getObjectByProperty -getObjectsByProperty -getWorldPosition -getWorldQuaternion -getWorldScale -raycast -traverse -traverseVisible -traverseAncestors -updateMatrix -updateMatrixWorld -updateWorldMatrix -clone -copy -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

StaticDEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight,
-THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

-

Default Value

new THREE.Vector3( 0, 1, 0)

-

StaticDEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

StaticDEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

ReadonlyisArrayCamera

isArrayCamera: true

Read-only flag to check if a given object is of type ArrayCamera.

-

Remarks

This is a constant value

-

Default Value

true

-

cameras

cameras: PerspectiveCamera[]

An array of cameras.

-

Default Value

[]

-

ReadonlyisPerspectiveCamera

isPerspectiveCamera: true

Read-only flag to check if a given object is of type Camera.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlytype

type: string

Default Value

PerspectiveCamera

-

zoom

zoom: number

Gets or sets the zoom factor of the camera.

-

Default Value

1

-

fov

fov: number

Camera frustum vertical field of view, from bottom to top of view, in degrees.

-

Remarks

Expects a Float

-

Default Value

50

-

aspect

aspect: number

Camera frustum aspect ratio, usually the canvas width / canvas height.

-

Remarks

Expects a Float

-

Default Value

1, (square canvas).

-

near

near: number

Camera frustum near plane.

-

Remarks

The valid range is greater than 0 and less than the current value of the .far plane.

-

Default Value

0.1

-

far

far: number

Camera frustum far plane.

-

Remarks

Must be greater than the current value of .near plane.

-

Default Value

2000

-

focus

focus: number

Object distance used for stereoscopy and depth-of-field effects.

-

Remarks

This parameter does not influence the projection matrix unless a THREE.StereoCamera | StereoCamera is being used.

-

Default Value

10

-

view

view:
    | null
    | {
        enabled: boolean;
        fullWidth: number;
        fullHeight: number;
        offsetX: number;
        offsetY: number;
        width: number;
        height: number;
    }

Frustum window specification or null.
-This is set using the .setViewOffset method and cleared using .clearViewOffset.

-

Default Value

null

-

filmGauge

filmGauge: number

Film size used for the larger axis.
-This parameter does not influence the projection matrix unless .filmOffset is set to a nonzero value.

-

Remarks

Expects a Float

-

Default Value

35, millimeters.

-

filmOffset

filmOffset: number

Horizontal off-center offset in the same unit as .filmGauge.

-

Remarks

Expects a Float

-

Default Value

0

-

ReadonlyisCamera

isCamera: true

Read-only flag to check if a given object is of type Camera.

-

Remarks

This is a constant value

-

Default Value

true

-

layers

layers: Layers

The THREE.Layers | layers that the Camera is a member of.

-

Remarks

Objects must share at least one layer with the Camera to be n when the camera's viewpoint is rendered.

-

Default Value

new THREE.Layers()

-

matrixWorldInverse

matrixWorldInverse: Matrix4

This is the inverse of matrixWorld.

-

Remarks

MatrixWorld contains the Matrix which has the world transform of the Camera .

-

Default Value

THREE.Matrix4 | new THREE.Matrix4()

-

projectionMatrix

projectionMatrix: Matrix4

This is the matrix which contains the projection.

-

Default Value

THREE.Matrix4 | new THREE.Matrix4()

-

projectionMatrixInverse

projectionMatrixInverse: Matrix4

This is the inverse of projectionMatrix.

-

Default Value

THREE.Matrix4 | new THREE.Matrix4()

-

coordinateSystem

coordinateSystem: CoordinateSystem

Optionalviewport

viewport?: Vector4

ReadonlyisObject3D

isObject3D: true

Flag to check if a given object is of type Object3D.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Object3D instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
-Expects a Integer

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

parent

parent: null | Object3D

Object's parent in the scene graph.

-

Remarks

An object can have at most one parent.

-

Default Value

null

-

children

children: Object3D[]

Array with object's children.

-

See

THREE.Object3DGroup | Group for info on manually grouping objects.

-

Default Value

[]

-

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

-

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

-

Readonlyposition

position: Vector3

Object's local position.

-

Default Value

new THREE.Vector3() - that is (0, 0, 0).

-

Readonlyrotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

-

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

-

Readonlyquaternion

quaternion: Quaternion

Object's local rotation as a THREE.Quaternion | Quaternion.

-

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

-

Readonlyscale

scale: Vector3

The object's local scale.

-

Default Value

new THREE.Vector3( 1, 1, 1 )

-

ReadonlymodelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

-

ReadonlynormalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

-

matrix

matrix: Matrix4

The local transform matrix.

-

Default Value

new THREE.Matrix4()

-

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

-

Remarks

If the Object3D has no parent, then it's identical to the local transform THREE.Object3D.matrix | .matrix.

-

Default Value

new THREE.Matrix4()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and
-scale every frame and also recalculates the matrixWorld property.

-

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

-

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates.
-When it isn't, then you have to maintain all matrices in the object and its children yourself.

-

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

-

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

-

Default Value

false

-

visible

visible: boolean

Object gets rendered if true.

-

Default Value

true

-

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

-

Default Value

false

-

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

-

Default Value

false

-

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object.
-If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

-

Default Value

true

-

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph
-objects to be overridden although opaque and transparent objects remain sorted independently.

-

Remarks

When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.
-Sorting is from lowest to highest renderOrder.

-

Default Value

0

-

animations

animations: AnimationClip[]

Array with object's animation clips.

-

Default Value

[]

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the Object3D.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default

{}

-

OptionalcustomDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

-

Remarks

Can only be used in context of meshes.
-When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight,
-if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

-

Default Value

undefined

-

OptionalcustomDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

-

Default Value

undefined

-

Methods

getFocalLength

  • getFocalLength(): number

  • Returns the focal length of the current .fov | fov in respect to .filmGauge.

    -

    Returns number

setFocalLength

  • setFocalLength(focalLength: number): void

  • Sets the FOV by focal length in respect to the current .filmGauge.

    -

    Parameters

    • focalLength: number

      Expects a Float

      -

    Returns void

    Remarks

    By default, the focal length is specified for a 35mm (full frame) camera.

    -

getEffectiveFOV

  • getEffectiveFOV(): number

  • Returns the current vertical field of view angle in degrees considering .zoom.

    -

    Returns number

getFilmWidth

  • getFilmWidth(): number

  • Returns the width of the image on the film

    -

    Returns number

    Remarks

    If .aspect. is greater than or equal to one (landscape format), the result equals .filmGauge.

    -

getFilmHeight

  • getFilmHeight(): number

  • Returns the height of the image on the film

    -

    Returns number

    Remarks

    If .aspect. is less than or equal to one (portrait format), the result equals .filmGauge.

    -

getViewBounds

  • getViewBounds(distance: number, minTarget: Vector2, maxTarget: Vector2): void

  • Computes the 2D bounds of the camera's viewable rectangle at a given distance along the viewing direction.
    -Sets minTarget and maxTarget to the coordinates of the lower-left and upper-right corners of the view rectangle.

    -

    Parameters

    Returns void

getViewSize

  • getViewSize(distance: number, target: Vector2): Vector2

  • Computes the width and height of the camera's viewable rectangle at a given distance along the viewing direction.
    -Copies the result into the target Vector2, where x is width and y is height.

    -

    Parameters

    Returns Vector2

setViewOffset

  • setViewOffset(
        fullWidth: number,
        fullHeight: number,
        x: number,
        y: number,
        width: number,
        height: number,
    ): void

  • Sets an offset in a larger frustum.

    -

    Parameters

    • fullWidth: number

      Full width of multiview setup Expects a Float.

      -
    • fullHeight: number

      Full height of multiview setup Expects a Float.

      -
    • x: number

      Horizontal offset of subcamera Expects a Float.

      -
    • y: number

      Vertical offset of subcamera Expects a Float.

      -
    • width: number

      Width of subcamera Expects a Float.

      -
    • height: number

      Height of subcamera Expects a Float.

      -

    Returns void

    Remarks

    This is useful for multi-window or multi-monitor/multi-machine setups.

    -

    For example, if you have 3x2 monitors and each monitor is 1920x1080 and
    -the monitors are in grid like this

    -
    ┌───┬───┬───┐
    │ A │ B │ C │
    ├───┼───┼───┤
    │ D │ E │ F │
    └───┴───┴───┘
-
    - -

    then for each monitor you would call it like this

    -
      const w = 1920;
      const h = 1080;
      const fullWidth = w * 3;
      const fullHeight = h * 2;

      // Monitor - A
      camera.setViewOffset( fullWidth, fullHeight, w * 0, h * 0, w, h );
      // Monitor - B
      camera.setViewOffset( fullWidth, fullHeight, w * 1, h * 0, w, h );
      // Monitor - C
      camera.setViewOffset( fullWidth, fullHeight, w * 2, h * 0, w, h );
      // Monitor - D
      camera.setViewOffset( fullWidth, fullHeight, w * 0, h * 1, w, h );
      // Monitor - E
      camera.setViewOffset( fullWidth, fullHeight, w * 1, h * 1, w, h );
      // Monitor - F
      camera.setViewOffset( fullWidth, fullHeight, w * 2, h * 1, w, h );
-
    - -

    Note there is no reason monitors have to be the same size or in a grid.

    -

clearViewOffset

updateProjectionMatrix

  • updateProjectionMatrix(): void

  • Updates the camera projection matrix

    -

    Returns void

    Remarks

    Must be called after any change of parameters.

    -

setLens

  • setLens(focalLength: number, frameHeight?: number): void

  • Parameters

    • focalLength: number
    • OptionalframeHeight: number

    Returns void

    Deprecated

    Use .setFocalLength() and .filmGauge instead.

    -

toJSON

getWorldDirection

  • getWorldDirection(target: Vector3): Vector3

  • Returns a THREE.Vector3 | Vector3 representing the world space direction in which the Camera is looking.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

    Remarks

    Note: A Camera looks down its local, negative z-axis.

    -

onBeforeShadow

  • onBeforeShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterShadow

  • onAfterShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onBeforeRender

  • onBeforeRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterRender

  • onAfterRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

applyMatrix4

  • applyMatrix4(matrix: Matrix4): void

  • Applies the matrix transform to the object and updates the object's position, rotation and scale.

    -

    Parameters

    Returns void

applyQuaternion

  • applyQuaternion(quaternion: Quaternion): this

  • Applies the rotation represented by the quaternion to the object.

    -

    Parameters

    Returns this

setRotationFromAxisAngle

  • setRotationFromAxisAngle(axis: Vector3, angle: number): void

  • Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      Angle in radians. Expects a Float

      -

    Returns void

setRotationFromEuler

setRotationFromMatrix

  • setRotationFromMatrix(m: Matrix4): void

  • Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

    -

    Parameters

    • m: Matrix4

      Rotate the quaternion by the rotation component of the matrix.

      -

    Returns void

    Remarks

    Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

    -

setRotationFromQuaternion

rotateOnAxis

  • rotateOnAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in object space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

rotateOnWorldAxis

  • rotateOnWorldAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in world space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in world space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized
    -Method Assumes no rotated parent.

    -

rotateX

  • rotateX(angle: number): this

  • Rotates the object around x axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateY

  • rotateY(angle: number): this

  • Rotates the object around y axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateZ

  • rotateZ(angle: number): this

  • Rotates the object around z axis in local space.

    -

    Parameters

    • angle: number

    Returns this

translateOnAxis

  • translateOnAxis(axis: Vector3, distance: number): this

  • Translate an object by distance along an axis in object space

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • distance: number

      The distance to translate. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

translateX

  • translateX(distance: number): this

  • Translates object along x axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateY

  • translateY(distance: number): this

  • Translates object along y axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateZ

  • translateZ(distance: number): this

  • Translates object along z axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

localToWorld

  • localToWorld(vector: Vector3): Vector3

  • Converts the vector from this object's local space to world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in this object's local space.

      -

    Returns Vector3

worldToLocal

  • worldToLocal(vector: Vector3): Vector3

  • Converts the vector from world space to this object's local space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space.

      -

    Returns Vector3

lookAt

  • lookAt(vector: Vector3): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space to look at.

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -
  • lookAt(x: number, y: number, z: number): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -

add

  • add(...object: Object3D[]): this

  • Adds another Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be added
    -Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.

    -

    See

      -
    • attach
      • -
    • THREE.Group | Group for info on manually grouping objects.
      • -
    -

remove

  • remove(...object: Object3D[]): this

  • Removes a Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be removed.

    -

    See

    THREE.Group | Group for info on manually grouping objects.

    -

removeFromParent

  • removeFromParent(): this

  • Removes this object from its current parent.

    -

    Returns this

clear

  • clear(): this

  • Removes all child objects.

    -

    Returns this

attach

  • attach(object: Object3D): this

  • Adds a Object3D as a child of this, while maintaining the object's world transform.

    -

    Parameters

    Returns this

    Remarks

    Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

    -

    See

    add

    -

getObjectById

  • getObjectById(id: number): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    -

    Parameters

    • id: number

      Unique number of the object instance. Expects a Integer

      -

    Returns undefined | Object3D

    Remarks

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    -

    See

    id

    -

getObjectByName

  • getObjectByName(name: string): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

    -

    Parameters

    • name: string

      String to match to the children's Object3D.name property.

      -

    Returns undefined | Object3D

    Remarks

    Note that for most objects the name is an empty string by default
    -You will have to set it manually to make use of this method.

    -

getObjectByProperty

  • getObjectByProperty(name: string, value: any): undefined | Object3D

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      the property name to search for.

      -
    • value: any

      value of the given property.

      -

    Returns undefined | Object3D

getObjectsByProperty

  • getObjectsByProperty(
        name: string,
        value: any,
        optionalTarget?: Object3D[],
    ): Object3D[]

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      The property name to search for.

      -
    • value: any

      Value of the given property.

      -
    • OptionaloptionalTarget: Object3D[]

      target to set the result. Otherwise a new Array is instantiated. If set, you must clear
      -this array prior to each call (i.e., array.length = 0;).

      -

    Returns Object3D[]

getWorldPosition

  • getWorldPosition(target: Vector3): Vector3

  • Returns a vector representing the position of the object in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldQuaternion

getWorldScale

  • getWorldScale(target: Vector3): Vector3

  • Returns a vector of the scaling factors applied to the object for each axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

raycast

  • raycast(raycaster: Raycaster, intersects: Intersection[]): void

  • Abstract (empty) method to get intersections between a casted ray and this object

    -

    Parameters

    Returns void

    Remarks

    Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

    -

    See

    THREE.Raycaster | Raycaster

    -

    Default Value

    () => {}

    -

traverse

  • traverse(callback: (object: Object3D) => any): void

  • Executes the callback on this object and all descendants.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseVisible

  • traverseVisible(callback: (object: Object3D) => any): void

  • Like traverse, but the callback will only be executed for visible objects

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Descendants of invisible objects are not traversed.
    -Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseAncestors

  • traverseAncestors(callback: (object: Object3D) => any): void

  • Executes the callback on all ancestors.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

updateMatrix

  • updateMatrix(): void

  • Updates local transform.

    -

    Returns void

updateMatrixWorld

  • updateMatrixWorld(force?: boolean): void

  • Updates the global transform of the object.
    -And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

    -

    Parameters

    • Optionalforce: boolean

      A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame.
      -Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

      -

    Returns void

updateWorldMatrix

  • updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void

  • Updates the global transform of the object.

    -

    Parameters

    • updateParents: boolean

      Recursively updates global transform of ancestors.

      -
    • updateChildren: boolean

      Recursively updates global transform of descendants.

      -

    Returns void

clone

  • clone(recursive?: boolean): this

  • Returns a clone of this object and optionally all descendants.

    -

    Parameters

    • Optionalrecursive: boolean

      If true, descendants of the object are also cloned. Default true

      -

    Returns this

copy

  • copy(object: Object3D, recursive?: boolean): this

  • Copies the given object into this object.

    -

    Parameters

    • object: Object3D
    • Optionalrecursive: boolean

      If set to true, descendants of the object are copied next to the existing ones. If set to
      -false, descendants are left unchanged. Default is true.

      -

    Returns this

    Remarks

    Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

    -

addEventListener

hasEventListener

removeEventListener

dispatchEvent

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Bone.html b/docs/classes/Bone.html deleted file mode 100644 index 3902ba2..0000000 --- a/docs/classes/Bone.html +++ /dev/null @@ -1,332 +0,0 @@ -Bone | VFX-JS

Class Bone<TEventMap>

A Bone which is part of a THREE.Skeleton | Skeleton

-

Remarks

The skeleton in turn is used by the THREE.SkinnedMesh | SkinnedMesh
-Bones are almost identical to a blank THREE.Object3D | Object3D.

-

Example

const root = new THREE.Bone();
const child = new THREE.Bone();
root.add(child);
child.position.y = 5;
-
- -

See

-

Type Parameters

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_UP -DEFAULT_MATRIX_AUTO_UPDATE -DEFAULT_MATRIX_WORLD_AUTO_UPDATE -isBone -type -isObject3D -id -uuid -name -parent -children -up -position -rotation -quaternion -scale -modelViewMatrix -normalMatrix -matrix -matrixWorld -matrixAutoUpdate -matrixWorldAutoUpdate -matrixWorldNeedsUpdate -layers -visible -castShadow -receiveShadow -frustumCulled -renderOrder -animations -userData -customDepthMaterial? -customDistanceMaterial? -

Methods

onBeforeShadow -onAfterShadow -onBeforeRender -onAfterRender -applyMatrix4 -applyQuaternion -setRotationFromAxisAngle -setRotationFromEuler -setRotationFromMatrix -setRotationFromQuaternion -rotateOnAxis -rotateOnWorldAxis -rotateX -rotateY -rotateZ -translateOnAxis -translateX -translateY -translateZ -localToWorld -worldToLocal -lookAt -add -remove -removeFromParent -clear -attach -getObjectById -getObjectByName -getObjectByProperty -getObjectsByProperty -getWorldPosition -getWorldQuaternion -getWorldScale -getWorldDirection -raycast -traverse -traverseVisible -traverseAncestors -updateMatrix -updateMatrixWorld -updateWorldMatrix -toJSON -clone -copy -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

StaticDEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight,
-THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

-

Default Value

new THREE.Vector3( 0, 1, 0)

-

StaticDEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

StaticDEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

ReadonlyisBone

isBone: true

Read-only flag to check if a given object is of type Bone.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlytype

type: string

Default Value

Bone

-

ReadonlyisObject3D

isObject3D: true

Flag to check if a given object is of type Object3D.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Object3D instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
-Expects a Integer

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

parent

parent: null | Object3D

Object's parent in the scene graph.

-

Remarks

An object can have at most one parent.

-

Default Value

null

-

children

children: Object3D[]

Array with object's children.

-

See

THREE.Object3DGroup | Group for info on manually grouping objects.

-

Default Value

[]

-

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

-

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

-

Readonlyposition

position: Vector3

Object's local position.

-

Default Value

new THREE.Vector3() - that is (0, 0, 0).

-

Readonlyrotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

-

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

-

Readonlyquaternion

quaternion: Quaternion

Object's local rotation as a THREE.Quaternion | Quaternion.

-

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

-

Readonlyscale

scale: Vector3

The object's local scale.

-

Default Value

new THREE.Vector3( 1, 1, 1 )

-

ReadonlymodelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

-

ReadonlynormalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

-

matrix

matrix: Matrix4

The local transform matrix.

-

Default Value

new THREE.Matrix4()

-

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

-

Remarks

If the Object3D has no parent, then it's identical to the local transform THREE.Object3D.matrix | .matrix.

-

Default Value

new THREE.Matrix4()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and
-scale every frame and also recalculates the matrixWorld property.

-

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

-

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates.
-When it isn't, then you have to maintain all matrices in the object and its children yourself.

-

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

-

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

-

Default Value

false

-

layers

layers: Layers

The layer membership of the object.

-

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use.
-This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.

-

Default Value

new THREE.Layers()

-

visible

visible: boolean

Object gets rendered if true.

-

Default Value

true

-

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

-

Default Value

false

-

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

-

Default Value

false

-

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object.
-If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

-

Default Value

true

-

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph
-objects to be overridden although opaque and transparent objects remain sorted independently.

-

Remarks

When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.
-Sorting is from lowest to highest renderOrder.

-

Default Value

0

-

animations

animations: AnimationClip[]

Array with object's animation clips.

-

Default Value

[]

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the Object3D.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default

{}

-

OptionalcustomDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

-

Remarks

Can only be used in context of meshes.
-When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight,
-if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

-

Default Value

undefined

-

OptionalcustomDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

-

Default Value

undefined

-

Methods

onBeforeShadow

  • onBeforeShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterShadow

  • onAfterShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onBeforeRender

  • onBeforeRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterRender

  • onAfterRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

applyMatrix4

  • applyMatrix4(matrix: Matrix4): void

  • Applies the matrix transform to the object and updates the object's position, rotation and scale.

    -

    Parameters

    Returns void

applyQuaternion

  • applyQuaternion(quaternion: Quaternion): this

  • Applies the rotation represented by the quaternion to the object.

    -

    Parameters

    Returns this

setRotationFromAxisAngle

  • setRotationFromAxisAngle(axis: Vector3, angle: number): void

  • Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      Angle in radians. Expects a Float

      -

    Returns void

setRotationFromEuler

  • setRotationFromEuler(euler: Euler): void

  • Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.

    -

    Parameters

    • euler: Euler

      Euler angle specifying rotation amount.

      -

    Returns void

setRotationFromMatrix

  • setRotationFromMatrix(m: Matrix4): void

  • Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

    -

    Parameters

    • m: Matrix4

      Rotate the quaternion by the rotation component of the matrix.

      -

    Returns void

    Remarks

    Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

    -

setRotationFromQuaternion

rotateOnAxis

  • rotateOnAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in object space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

rotateOnWorldAxis

  • rotateOnWorldAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in world space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in world space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized
    -Method Assumes no rotated parent.

    -

rotateX

  • rotateX(angle: number): this

  • Rotates the object around x axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateY

  • rotateY(angle: number): this

  • Rotates the object around y axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateZ

  • rotateZ(angle: number): this

  • Rotates the object around z axis in local space.

    -

    Parameters

    • angle: number

    Returns this

translateOnAxis

  • translateOnAxis(axis: Vector3, distance: number): this

  • Translate an object by distance along an axis in object space

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • distance: number

      The distance to translate. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

translateX

  • translateX(distance: number): this

  • Translates object along x axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateY

  • translateY(distance: number): this

  • Translates object along y axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateZ

  • translateZ(distance: number): this

  • Translates object along z axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

localToWorld

  • localToWorld(vector: Vector3): Vector3

  • Converts the vector from this object's local space to world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in this object's local space.

      -

    Returns Vector3

worldToLocal

  • worldToLocal(vector: Vector3): Vector3

  • Converts the vector from world space to this object's local space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space.

      -

    Returns Vector3

lookAt

  • lookAt(vector: Vector3): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space to look at.

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -
  • lookAt(x: number, y: number, z: number): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -

add

  • add(...object: Object3D[]): this

  • Adds another Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be added
    -Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.

    -

    See

      -
    • attach
      • -
    • THREE.Group | Group for info on manually grouping objects.
      • -
    -

remove

  • remove(...object: Object3D[]): this

  • Removes a Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be removed.

    -

    See

    THREE.Group | Group for info on manually grouping objects.

    -

removeFromParent

  • removeFromParent(): this

  • Removes this object from its current parent.

    -

    Returns this

clear

  • clear(): this

  • Removes all child objects.

    -

    Returns this

attach

  • attach(object: Object3D): this

  • Adds a Object3D as a child of this, while maintaining the object's world transform.

    -

    Parameters

    Returns this

    Remarks

    Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

    -

    See

    add

    -

getObjectById

  • getObjectById(id: number): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    -

    Parameters

    • id: number

      Unique number of the object instance. Expects a Integer

      -

    Returns undefined | Object3D

    Remarks

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    -

    See

    id

    -

getObjectByName

  • getObjectByName(name: string): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

    -

    Parameters

    • name: string

      String to match to the children's Object3D.name property.

      -

    Returns undefined | Object3D

    Remarks

    Note that for most objects the name is an empty string by default
    -You will have to set it manually to make use of this method.

    -

getObjectByProperty

  • getObjectByProperty(name: string, value: any): undefined | Object3D

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      the property name to search for.

      -
    • value: any

      value of the given property.

      -

    Returns undefined | Object3D

getObjectsByProperty

  • getObjectsByProperty(
        name: string,
        value: any,
        optionalTarget?: Object3D[],
    ): Object3D[]

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      The property name to search for.

      -
    • value: any

      Value of the given property.

      -
    • OptionaloptionalTarget: Object3D[]

      target to set the result. Otherwise a new Array is instantiated. If set, you must clear
      -this array prior to each call (i.e., array.length = 0;).

      -

    Returns Object3D[]

getWorldPosition

  • getWorldPosition(target: Vector3): Vector3

  • Returns a vector representing the position of the object in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldQuaternion

getWorldScale

  • getWorldScale(target: Vector3): Vector3

  • Returns a vector of the scaling factors applied to the object for each axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldDirection

  • getWorldDirection(target: Vector3): Vector3

  • Returns a vector representing the direction of object's positive z-axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

raycast

  • raycast(raycaster: Raycaster, intersects: Intersection[]): void

  • Abstract (empty) method to get intersections between a casted ray and this object

    -

    Parameters

    Returns void

    Remarks

    Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

    -

    See

    THREE.Raycaster | Raycaster

    -

    Default Value

    () => {}

    -

traverse

  • traverse(callback: (object: Object3D) => any): void

  • Executes the callback on this object and all descendants.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseVisible

  • traverseVisible(callback: (object: Object3D) => any): void

  • Like traverse, but the callback will only be executed for visible objects

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Descendants of invisible objects are not traversed.
    -Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseAncestors

  • traverseAncestors(callback: (object: Object3D) => any): void

  • Executes the callback on all ancestors.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

updateMatrix

  • updateMatrix(): void

  • Updates local transform.

    -

    Returns void

updateMatrixWorld

  • updateMatrixWorld(force?: boolean): void

  • Updates the global transform of the object.
    -And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

    -

    Parameters

    • Optionalforce: boolean

      A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame.
      -Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

      -

    Returns void

updateWorldMatrix

  • updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void

  • Updates the global transform of the object.

    -

    Parameters

    • updateParents: boolean

      Recursively updates global transform of ancestors.

      -
    • updateChildren: boolean

      Recursively updates global transform of descendants.

      -

    Returns void

toJSON

clone

  • clone(recursive?: boolean): this

  • Returns a clone of this object and optionally all descendants.

    -

    Parameters

    • Optionalrecursive: boolean

      If true, descendants of the object are also cloned. Default true

      -

    Returns this

copy

  • copy(object: Object3D, recursive?: boolean): this

  • Copies the given object into this object.

    -

    Parameters

    • object: Object3D
    • Optionalrecursive: boolean

      If set to true, descendants of the object are copied next to the existing ones. If set to
      -false, descendants are left unchanged. Default is true.

      -

    Returns this

    Remarks

    Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

    -

addEventListener

hasEventListener

removeEventListener

dispatchEvent

  • dispatchEvent<T extends string>(event: BaseEvent<T> & TEventMap[T]): void

  • Fire an event type.

    -

    Type Parameters

    • T extends string

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Box2.html b/docs/classes/Box2.html deleted file mode 100644 index 544f80c..0000000 --- a/docs/classes/Box2.html +++ /dev/null @@ -1,36 +0,0 @@ -Box2 | VFX-JS

Class Box2

Constructors

constructor -

Properties

min -max -

Methods

set -setFromPoints -setFromCenterAndSize -clone -copy -makeEmpty -isEmpty -getCenter -getSize -expandByPoint -expandByVector -expandByScalar -containsPoint -containsBox -getParameter -intersectsBox -clampPoint -distanceToPoint -intersect -union -translate -equals -empty -isIntersectionBox -

Constructors

constructor

Properties

min

min: Vector2

Default

new THREE.Vector2( + Infinity, + Infinity )
-
- -

max

max: Vector2

Default

new THREE.Vector2( - Infinity, - Infinity )
-
- -

Methods

set

setFromPoints

  • setFromPoints(points: Vector2[]): Box2

  • Parameters

    Returns Box2

setFromCenterAndSize

clone

  • clone(): this

  • Returns this

copy

  • copy(box: Box2): this

  • Parameters

    Returns this

makeEmpty

  • makeEmpty(): Box2

  • Returns Box2

isEmpty

  • isEmpty(): boolean

  • Returns boolean

getCenter

getSize

expandByPoint

  • expandByPoint(point: Vector2): Box2

  • Parameters

    Returns Box2

expandByVector

  • expandByVector(vector: Vector2): Box2

  • Parameters

    Returns Box2

expandByScalar

  • expandByScalar(scalar: number): Box2

  • Parameters

    • scalar: number

    Returns Box2

containsPoint

  • containsPoint(point: Vector2): boolean

  • Parameters

    Returns boolean

containsBox

  • containsBox(box: Box2): boolean

  • Parameters

    Returns boolean

getParameter

intersectsBox

  • intersectsBox(box: Box2): boolean

  • Parameters

    Returns boolean

clampPoint

distanceToPoint

  • distanceToPoint(point: Vector2): number

  • Parameters

    Returns number

intersect

  • intersect(box: Box2): Box2

  • Parameters

    Returns Box2

union

  • union(box: Box2): Box2

  • Parameters

    Returns Box2

translate

  • translate(offset: Vector2): Box2

  • Parameters

    Returns Box2

equals

  • equals(box: Box2): boolean

  • Parameters

    Returns boolean

empty

  • empty(): any

  • Returns any

    Deprecated

    Use .isEmpty() instead.

    -

isIntersectionBox

  • isIntersectionBox(b: any): any

  • Parameters

    • b: any

    Returns any

    Deprecated

    Use .intersectsBox() instead.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Box3.html b/docs/classes/Box3.html deleted file mode 100644 index 5a1cd0d..0000000 --- a/docs/classes/Box3.html +++ /dev/null @@ -1,48 +0,0 @@ -Box3 | VFX-JS

Class Box3

Constructors

constructor -

Properties

min -max -isBox3 -

Methods

set -setFromArray -setFromBufferAttribute -setFromPoints -setFromCenterAndSize -setFromObject -clone -copy -makeEmpty -isEmpty -getCenter -getSize -expandByPoint -expandByVector -expandByScalar -expandByObject -containsPoint -containsBox -getParameter -intersectsBox -intersectsSphere -intersectsPlane -intersectsTriangle -clampPoint -distanceToPoint -getBoundingSphere -intersect -union -applyMatrix4 -translate -equals -empty -isIntersectionBox -isIntersectionSphere -

Constructors

constructor

Properties

min

min: Vector3

Default

new THREE.Vector3( + Infinity, + Infinity, + Infinity )
-
- -

max

max: Vector3

Default

new THREE.Vector3( - Infinity, - Infinity, - Infinity )
-
- -

ReadonlyisBox3

isBox3: true

Methods

set

  • set(min: Vector3, max: Vector3): this

  • Parameters

    Returns this

setFromArray

  • setFromArray(array: ArrayLike<number>): this

  • Parameters

    Returns this

setFromBufferAttribute

  • setFromBufferAttribute(bufferAttribute: BufferAttribute): this

  • Parameters

    Returns this

setFromPoints

  • setFromPoints(points: Vector3[]): this

  • Parameters

    Returns this

setFromCenterAndSize

  • setFromCenterAndSize(center: Vector3, size: Vector3): this

  • Parameters

    Returns this

setFromObject

  • setFromObject(object: Object3D, precise?: boolean): this

  • Parameters

    • object: Object3D
    • Optionalprecise: boolean

    Returns this

clone

  • clone(): this

  • Returns this

copy

  • copy(box: Box3): this

  • Parameters

    Returns this

makeEmpty

  • makeEmpty(): this

  • Returns this

isEmpty

  • isEmpty(): boolean

  • Returns boolean

getCenter

getSize

expandByPoint

  • expandByPoint(point: Vector3): this

  • Parameters

    Returns this

expandByVector

  • expandByVector(vector: Vector3): this

  • Parameters

    Returns this

expandByScalar

  • expandByScalar(scalar: number): this

  • Parameters

    • scalar: number

    Returns this

expandByObject

  • expandByObject(object: Object3D, precise?: boolean): this

  • Parameters

    • object: Object3D
    • Optionalprecise: boolean

    Returns this

containsPoint

  • containsPoint(point: Vector3): boolean

  • Parameters

    Returns boolean

containsBox

  • containsBox(box: Box3): boolean

  • Parameters

    Returns boolean

getParameter

intersectsBox

  • intersectsBox(box: Box3): boolean

  • Parameters

    Returns boolean

intersectsSphere

  • intersectsSphere(sphere: Sphere): boolean

  • Parameters

    Returns boolean

intersectsPlane

  • intersectsPlane(plane: Plane): boolean

  • Parameters

    Returns boolean

intersectsTriangle

  • intersectsTriangle(triangle: Triangle): boolean

  • Parameters

    Returns boolean

clampPoint

distanceToPoint

  • distanceToPoint(point: Vector3): number

  • Parameters

    Returns number

getBoundingSphere

  • getBoundingSphere(target: Sphere): Sphere

  • Parameters

    Returns Sphere

intersect

  • intersect(box: Box3): this

  • Parameters

    Returns this

union

  • union(box: Box3): this

  • Parameters

    Returns this

applyMatrix4

  • applyMatrix4(matrix: Matrix4): this

  • Parameters

    Returns this

translate

  • translate(offset: Vector3): this

  • Parameters

    Returns this

equals

  • equals(box: Box3): boolean

  • Parameters

    Returns boolean

empty

  • empty(): any

  • Returns any

    Deprecated

    Use .isEmpty() instead.

    -

isIntersectionBox

  • isIntersectionBox(b: any): any

  • Parameters

    • b: any

    Returns any

    Deprecated

    Use .intersectsBox() instead.

    -

isIntersectionSphere

  • isIntersectionSphere(s: any): any

  • Parameters

    • s: any

    Returns any

    Deprecated

    Use .intersectsSphere() instead.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/BufferAttribute.html b/docs/classes/BufferAttribute.html deleted file mode 100644 index a1d6517..0000000 --- a/docs/classes/BufferAttribute.html +++ /dev/null @@ -1,163 +0,0 @@ -BufferAttribute | VFX-JS

Class BufferAttribute

This class stores data for an attribute (such as vertex positions, face indices, normals, colors, UVs, and any custom attributes )
-associated with a THREE.BufferGeometry | BufferGeometry, which allows for more efficient passing of data to the GPU

-

Remarks

When working with vector-like data, the .fromBufferAttribute( attribute, index ) helper methods on
-THREE.Vector2.fromBufferAttribute | Vector2,
-THREE.Vector3.fromBufferAttribute | Vector3,
-THREE.Vector4.fromBufferAttribute | Vector4, and
-THREE.Color.fromBufferAttribute | Color classes may be helpful.

-

See

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

name -array -itemSize -usage -gpuType -updateRanges -version -normalized -count -isBufferAttribute -onUploadCallback -

Accessors

needsUpdate -

Methods

onUpload -setUsage -addUpdateRange -clearUpdateRanges -clone -copy -copyAt -copyArray -applyMatrix3 -applyMatrix4 -applyNormalMatrix -transformDirection -set -getComponent -setComponent -getX -setX -getY -setY -getZ -setZ -getW -setW -setXY -setXYZ -setXYZW -toJSON -

Constructors

constructor

  • new BufferAttribute(
        array: TypedArray,
        itemSize: number,
        normalized?: boolean,
    ): BufferAttribute

  • This creates a new THREE.GLBufferAttribute | GLBufferAttribute object.

    -

    Parameters

    • array: TypedArray

      Must be a TypedArray. Used to instantiate the buffer.
      -This array should have itemSize * numVertices elements, where numVertices is the number of vertices in the associated THREE.BufferGeometry | BufferGeometry.

      -
    • itemSize: number

      the number of values of the array that should be associated with a particular vertex.
      -For instance, if this attribute is storing a 3-component vector (such as a position, normal, or color),
      -then itemSize should be 3.

      -
    • Optionalnormalized: boolean

      Applies to integer data only.
      -Indicates how the underlying data in the buffer maps to the values in the GLSL code.
      -For instance, if array is an instance of UInt16Array, and normalized is true,
      -the values 0 - +65535 in the array data will be mapped to 0.0f - +1.0f in the GLSL attribute.
      -An Int16Array (signed) would map from -32768 - +32767 to -1.0f - +1.0f.
      -If normalized is false, the values will be converted to floats unmodified,
      -i.e. 32767 becomes 32767.0f.
      -Default false.

      -

    Returns BufferAttribute

    Throws

    TypeError When the array is not a TypedArray;

    -

Properties

name

name: string

Optional name for this attribute instance.

-

Default Value

''
-
- -

array

array: TypedArray

The TypedArray holding data stored in the buffer.

-

Returns

TypedArray

-

itemSize

itemSize: number

The length of vectors that are being stored in the array.

-

Remarks

Expects a Integer

-

usage

usage: Usage

Defines the intended usage pattern of the data store for optimization purposes.
-Corresponds to the usage parameter of
-WebGLRenderingContext.bufferData.

-

Remarks

After the initial use of a buffer, its usage cannot be changed. Instead, instantiate a new one and set the desired usage before the next render.

-

See

-

Default Value

THREE.StaticDrawUsage | THREE.StaticDrawUsage.

-

gpuType

gpuType: AttributeGPUType

Configures the bound GPU type for use in shaders. Either FloatType or IntType, default is FloatType.

-

Note: this only has an effect for integer arrays and is not configurable for float arrays. For lower precision
-float types, see https://threejs.org/docs/#api/en/core/bufferAttributeTypes/BufferAttributeTypes.

-

updateRanges

updateRanges: { start: number; count: number }[]

This can be used to only update some components of stored vectors (for example, just the component related to
-color). Use the .addUpdateRange function to add ranges to this array.

-

Type declaration

  • start: number

    Position at which to start update.

    -
  • count: number

    The number of components to update.

    -

version

version: number

A version number, incremented every time the needsUpdate property is set to true.

-

Remarks

Expects a Integer

-

Default Value

0

-

normalized

normalized: boolean

Indicates how the underlying data in the buffer maps to the values in the GLSL shader code.

-

See

constructor above for details.

-

Default Value

false

-

Readonlycount

count: number

Represents the number of items this buffer attribute stores. It is internally computed by dividing the
-array's length by the itemSize. Read-only
-property.

-

ReadonlyisBufferAttribute

isBufferAttribute: true

Read-only flag to check if a given object is of type BufferAttribute.

-

Remarks

This is a constant value

-

Default Value

true

-

onUploadCallback

onUploadCallback: () => void

A callback function that is executed after the Renderer has transferred the attribute array data to the GPU.

-

Accessors

needsUpdate

  • set needsUpdate(value: boolean): void

  • Flag to indicate that this attribute has changed and should be re-sent to the GPU.
    -Set this to true when you modify the value of the array.

    -

    Parameters

    • value: boolean

    Returns void

    Remarks

    Setting this to true also increments the version.

    -

Methods

onUpload

  • onUpload(callback: () => void): this

  • Sets the value of the onUploadCallback property.

    -

    Parameters

    • callback: () => void

      function that is executed after the Renderer has transferred the attribute array data to the GPU.

      -

    Returns this

    See

    -

setUsage

  • setUsage(usage: Usage): this

  • Set usage

    -

    Parameters

    Returns this

    Remarks

    After the initial use of a buffer, its usage cannot be changed. Instead, instantiate a new one and set the desired usage before the next render.

    -

    See

    -

addUpdateRange

  • addUpdateRange(start: number, count: number): void

  • Adds a range of data in the data array to be updated on the GPU. Adds an object describing the range to the
    -.updateRanges array.

    -

    Parameters

    • start: number
    • count: number

    Returns void

clearUpdateRanges

  • clearUpdateRanges(): void

  • Clears the .updateRanges array.

    -

    Returns void

clone

copy

copyAt

  • copyAt(index1: number, attribute: BufferAttribute, index2: number): this

  • Copy a vector from bufferAttribute[index2] to array[index1].

    -

    Parameters

    Returns this

copyArray

  • copyArray(array: ArrayLike<number>): this

  • Copy the array given here (which can be a normal array or TypedArray) into array.

    -

    Parameters

    Returns this

    See

    TypedArray.set for notes on requirements if copying a TypedArray.

    -

applyMatrix3

  • applyMatrix3(m: Matrix3): this

  • Applies matrix m to every Vector3 element of this BufferAttribute.

    -

    Parameters

    Returns this

applyMatrix4

  • applyMatrix4(m: Matrix4): this

  • Applies matrix m to every Vector3 element of this BufferAttribute.

    -

    Parameters

    Returns this

applyNormalMatrix

  • applyNormalMatrix(m: Matrix3): this

  • Applies normal matrix m to every Vector3 element of this BufferAttribute.

    -

    Parameters

    Returns this

transformDirection

  • transformDirection(m: Matrix4): this

  • Applies matrix m to every Vector3 element of this BufferAttribute, interpreting the elements as a direction vectors.

    -

    Parameters

    Returns this

set

getComponent

  • getComponent(index: number, component: number): number

  • Returns the given component of the vector at the given index.

    -

    Parameters

    • index: number
    • component: number

    Returns number

setComponent

  • setComponent(index: number, component: number, value: number): void

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

    -

    Parameters

    • index: number
    • component: number
    • value: number

    Returns void

getX

  • getX(index: number): number

  • Returns the x component of the vector at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -

    Returns number

setX

  • setX(index: number, x: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • x: number

    Returns this

getY

  • getY(index: number): number

  • Returns the y component of the vector at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -

    Returns number

setY

  • setY(index: number, y: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • y: number

    Returns this

getZ

  • getZ(index: number): number

  • Returns the z component of the vector at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -

    Returns number

setZ

  • setZ(index: number, z: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • z: number

    Returns this

getW

  • getW(index: number): number

  • Returns the w component of the vector at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -

    Returns number

setW

  • setW(index: number, z: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • z: number

    Returns this

setXY

  • setXY(index: number, x: number, y: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • x: number
    • y: number

    Returns this

setXYZ

  • setXYZ(index: number, x: number, y: number, z: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • x: number
    • y: number
    • z: number

    Returns this

setXYZW

  • setXYZW(index: number, x: number, y: number, z: number, w: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • x: number
    • y: number
    • z: number
    • w: number

    Returns this

toJSON

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/BufferGeometry.html b/docs/classes/BufferGeometry.html deleted file mode 100644 index 1c5cbc8..0000000 --- a/docs/classes/BufferGeometry.html +++ /dev/null @@ -1,186 +0,0 @@ -BufferGeometry | VFX-JS

Class BufferGeometry<Attributes>

A representation of mesh, line, or point geometry
-Includes vertex positions, face indices, normals, colors, UVs, and custom attributes within buffers, reducing the cost of passing all this data to the GPU.

-

Remarks

To read and edit data in BufferGeometry attributes, see THREE.BufferAttribute | BufferAttribute documentation.

-

Example

const geometry = new THREE.BufferGeometry();

// create a simple square shape. We duplicate the top left and bottom right
// vertices because each vertex needs to appear once per triangle.
const vertices = new Float32Array( [
  -1.0, -1.0,  1.0, // v0
   1.0, -1.0,  1.0, // v1
   1.0,  1.0,  1.0, // v2

   1.0,  1.0,  1.0, // v3
  -1.0,  1.0,  1.0, // v4
  -1.0, -1.0,  1.0  // v5
] );

// itemSize = 3 because there are 3 values (components) per vertex
geometry.setAttribute( 'position', new THREE.BufferAttribute( vertices, 3 ) );
const material = new THREE.MeshBasicMaterial( { color: 0xff0000 } );
const mesh = new THREE.Mesh( geometry, material );
-
- -

Example

const geometry = new THREE.BufferGeometry();

const vertices = new Float32Array( [
  -1.0, -1.0,  1.0, // v0
   1.0, -1.0,  1.0, // v1
   1.0,  1.0,  1.0, // v2
  -1.0,  1.0,  1.0, // v3
] );
geometry.setAttribute( 'position', new THREE.BufferAttribute( vertices, 3 ) );

const indices = [
  0, 1, 2,
  2, 3, 0,
];

geometry.setIndex( indices );
geometry.setAttribute( 'position', new THREE.BufferAttribute( vertices, 3 ) );

const material = new THREE.MeshBasicMaterial( { color: 0xff0000 } );
const mesh = new THREE.Mesh( geometry, material );
-
- -

See

-

Type Parameters

Hierarchy (View Summary)

Constructors

constructor -

Properties

id -uuid -name -type -index -indirect -attributes -morphAttributes -morphTargetsRelative -groups -boundingBox -boundingSphere -drawRange -userData -isBufferGeometry -

Methods

getIndex -setIndex -setIndirect -getIndirect -setAttribute -getAttribute -deleteAttribute -hasAttribute -addGroup -clearGroups -setDrawRange -applyMatrix4 -applyQuaternion -rotateX -rotateY -rotateZ -translate -scale -lookAt -center -setFromPoints -computeBoundingBox -computeBoundingSphere -computeTangents -computeVertexNormals -normalizeNormals -toNonIndexed -toJSON -clone -copy -dispose -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

id

id: number

Unique number for this THREE.BufferGeometry | BufferGeometry instance.

-

Remarks

Expects a Integer

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name for this THREE.BufferGeometry | BufferGeometry instance.

-

Default Value

''

-

Readonlytype

type: string

A Read-only string to check if this object type.

-

Remarks

Sub-classes will update this value.

-

Default Value

BufferGeometry

-

index

index: null | BufferAttribute

Allows for vertices to be re-used across multiple triangles; this is called using "indexed triangles".
-Each triangle is associated with the indices of three vertices. This attribute therefore stores the index of each vertex for each triangular face.
-If this attribute is not set, the THREE.WebGLRenderer | renderer assumes that each three contiguous positions represent a single triangle.

-

Default Value

null

-

indirect

indirect: null | IndirectStorageBufferAttribute

attributes

attributes: Attributes

This hashmap has as id the name of the attribute to be set and as value the THREE.BufferAttribute | buffer to set it to. Rather than accessing this property directly,
-use .setAttribute and .getAttribute to access attributes of this geometry.

-

Default Value

{}

-

morphAttributes

morphAttributes: {
    [name: string]: (BufferAttribute | InterleavedBufferAttribute)[];
}

Hashmap of THREE.BufferAttribute | BufferAttributes holding details of the geometry's morph targets.

-

Remarks

Once the geometry has been rendered, the morph attribute data cannot be changed.
-You will have to call .dispose(), and create a new instance of THREE.BufferGeometry | BufferGeometry.

-

Default Value

{}

-

morphTargetsRelative

morphTargetsRelative: boolean

Used to control the morph target behavior; when set to true, the morph target data is treated as relative offsets, rather than as absolute positions/normals.

-

Default Value

false

-

groups

groups: GeometryGroup[]

Split the geometry into groups, each of which will be rendered in a separate WebGL draw call. This allows an array of materials to be used with the geometry.

-

Remarks

Every vertex and index must belong to exactly one group — groups must not share vertices or indices, and must not leave vertices or indices unused.

-

Default Value

[]

-

boundingBox

boundingBox: null | Box3

Bounding box for the THREE.BufferGeometry | BufferGeometry, which can be calculated with .computeBoundingBox().

-

Remarks

Bounding boxes aren't computed by default. They need to be explicitly computed, otherwise they are null.

-

Default Value

null

-

boundingSphere

boundingSphere: null | Sphere

Bounding sphere for the THREE.BufferGeometry | BufferGeometry, which can be calculated with .computeBoundingSphere().

-

Remarks

bounding spheres aren't computed by default. They need to be explicitly computed, otherwise they are null.

-

Default Value

null

-

drawRange

drawRange: { start: number; count: number }

Determines the part of the geometry to render. This should not be set directly, instead use .setDrawRange(...).

-

Remarks

For non-indexed THREE.BufferGeometry | BufferGeometry, count is the number of vertices to render.

-

Default Value

{ start: 0, count: Infinity }

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the BufferGeometry. It should not hold references to functions as these will not be cloned.

-

Default Value

{}

-

ReadonlyisBufferGeometry

isBufferGeometry: true

Read-only flag to check if a given object is of type BufferGeometry.

-

Remarks

This is a constant value

-

Default Value

true

-

Methods

getIndex

setIndex

  • setIndex(index: null | number[] | BufferAttribute): this

  • Set the THREE.BufferGeometry.index | .index buffer.

    -

    Parameters

    Returns this

setIndirect

getIndirect

setAttribute

  • setAttribute<K extends string | number | symbol>(
        name: K,
        attribute: Attributes[K],
    ): this

  • Sets an attribute to this geometry with the specified name.

    -

    Type Parameters

    • K extends string | number | symbol

    Parameters

    Returns this

    Remarks

    Use this rather than the attributes property, because an internal hashmap of .attributes is maintained to speed up iterating over attributes.

    -

getAttribute

  • getAttribute<K extends string | number | symbol>(name: K): Attributes[K]

  • Returns the attribute with the specified name.

    -

    Type Parameters

    • K extends string | number | symbol

    Parameters

    • name: K

    Returns Attributes[K]

deleteAttribute

  • deleteAttribute(name: keyof Attributes): this

  • Deletes the attribute with the specified name.

    -

    Parameters

    Returns this

hasAttribute

  • hasAttribute(name: keyof Attributes): boolean

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

    -

    Parameters

    Returns boolean

addGroup

  • addGroup(start: number, count: number, materialIndex?: number): void

  • Adds a group to this geometry

    -

    Parameters

    • start: number
    • count: number
    • OptionalmaterialIndex: number

    Returns void

    See

    the groups property for details.

    -

clearGroups

  • clearGroups(): void

  • Clears all groups.

    -

    Returns void

setDrawRange

  • setDrawRange(start: number, count: number): void

  • Set the .drawRange property

    -

    Parameters

    • start: number
    • count: number

      is the number of vertices or indices to render. Expects a Integer

      -

    Returns void

    Remarks

    For non-indexed BufferGeometry, count is the number of vertices to render

    -

applyMatrix4

  • applyMatrix4(matrix: Matrix4): this

  • Applies the matrix transform to the geometry.

    -

    Parameters

    Returns this

applyQuaternion

  • applyQuaternion(quaternion: Quaternion): this

  • Applies the rotation represented by the quaternion to the geometry.

    -

    Parameters

    Returns this

rotateX

  • rotateX(angle: number): this

  • Rotate the geometry about the X axis. This is typically done as a one time operation, and not during a loop.

    -

    Parameters

    • angle: number

      radians. Expects a Float

      -

    Returns this

    Remarks

    Use THREE.Object3D.rotation | Object3D.rotation for typical real-time mesh rotation.

    -

rotateY

  • rotateY(angle: number): this

  • Rotate the geometry about the Y axis.

    -

    Parameters

    • angle: number

      radians. Expects a Float

      -

    Returns this

    Remarks

    This is typically done as a one time operation, and not during a loop.

    -

rotateZ

  • rotateZ(angle: number): this

  • Rotate the geometry about the Z axis.

    -

    Parameters

    • angle: number

      radians. Expects a Float

      -

    Returns this

    Remarks

    This is typically done as a one time operation, and not during a loop.

    -

translate

  • translate(x: number, y: number, z: number): this

  • Translate the geometry.

    -

    Parameters

    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -

    Returns this

    Remarks

    This is typically done as a one time operation, and not during a loop.

    -

scale

  • scale(x: number, y: number, z: number): this

  • Scale the geometry data.

    -

    Parameters

    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -

    Returns this

    Remarks

    This is typically done as a one time operation, and not during a loop.

    -

lookAt

  • lookAt(vector: Vector3): this

  • Rotates the geometry to face a point in space.

    -

    Parameters

    • vector: Vector3

      A world vector to look at.

      -

    Returns this

    Remarks

    This is typically done as a one time operation, and not during a loop.

    -

center

  • center(): this

  • Center the geometry based on the bounding box.

    -

    Returns this

setFromPoints

  • setFromPoints(points: Vector3[] | Vector2[]): this

  • Defines a geometry by creating a position attribute based on the given array of points. The array can hold
    -instances of Vector2 or Vector3. When using two-dimensional data, the z coordinate for all
    -vertices is set to 0.

    -

    If the method is used with an existing position attribute, the vertex data are overwritten with the data from
    -the array. The length of the array must match the vertex count.

    -

    Parameters

    Returns this

computeBoundingBox

  • computeBoundingBox(): void

  • Computes the bounding box of the geometry, and updates the .boundingBox attribute. The bounding box is
    -not computed by the engine; it must be computed by your app. You may need to recompute the bounding box if the
    -geometry vertices are modified.

    -

    Returns void

computeBoundingSphere

  • computeBoundingSphere(): void

  • Computes the bounding sphere of the geometry, and updates the .boundingSphere attribute. The engine
    -automatically computes the bounding sphere when it is needed, e.g., for ray casting or view frustum culling. You
    -may need to recompute the bounding sphere if the geometry vertices are modified.

    -

    Returns void

computeTangents

  • computeTangents(): void

  • Calculates and adds a tangent attribute to this geometry.
    -The computation is only supported for indexed geometries and if position, normal, and uv attributes are defined

    -

    Returns void

    Remarks

    When using a tangent space normal map, prefer the MikkTSpace algorithm provided by
    -BufferGeometryUtils.computeMikkTSpaceTangents instead.

    -

computeVertexNormals

  • computeVertexNormals(): void

  • Computes vertex normals for the given vertex data. For indexed geometries, the method sets each vertex normal to
    -be the average of the face normals of the faces that share that vertex. For non-indexed geometries, vertices are
    -not shared, and the method sets each vertex normal to be the same as the face normal.

    -

    Returns void

normalizeNormals

  • normalizeNormals(): void

  • Every normal vector in a geometry will have a magnitude of 1

    -

    Returns void

    Remarks

    This will correct lighting on the geometry surfaces.

    -

toNonIndexed

  • toNonIndexed(): BufferGeometry

  • Return a non-index version of an indexed BufferGeometry.

    -

    Returns BufferGeometry

toJSON

clone

  • clone(): this

  • Creates a clone of this BufferGeometry

    -

    Returns this

copy

  • copy(source: BufferGeometry): this

  • Copies another BufferGeometry to this BufferGeometry.

    -

    Parameters

    Returns this

dispose

  • dispose(): void

  • Frees the GPU-related resources allocated by this instance.

    -

    Returns void

    Remarks

    Call this method whenever this instance is no longer used in your app.

    -

addEventListener

hasEventListener

removeEventListener

dispatchEvent

  • dispatchEvent<T extends "dispose">(
        event: BaseEvent<T> & { dispose: {} }[T],
    ): void

  • Fire an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • event: BaseEvent<T> & { dispose: {} }[T]

      The event that gets fired.

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Camera.html b/docs/classes/Camera.html deleted file mode 100644 index f7a381e..0000000 --- a/docs/classes/Camera.html +++ /dev/null @@ -1,342 +0,0 @@ -Camera | VFX-JS

Class Camera

Abstract base class for cameras

-

Remarks

This class should always be inherited when you build a new camera.

-

See

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_UP -DEFAULT_MATRIX_AUTO_UPDATE -DEFAULT_MATRIX_WORLD_AUTO_UPDATE -isCamera -type -layers -matrixWorldInverse -projectionMatrix -projectionMatrixInverse -coordinateSystem -viewport? -isObject3D -id -uuid -name -parent -children -up -position -rotation -quaternion -scale -modelViewMatrix -normalMatrix -matrix -matrixWorld -matrixAutoUpdate -matrixWorldAutoUpdate -matrixWorldNeedsUpdate -visible -castShadow -receiveShadow -frustumCulled -renderOrder -animations -userData -customDepthMaterial? -customDistanceMaterial? -

Methods

getWorldDirection -onBeforeShadow -onAfterShadow -onBeforeRender -onAfterRender -applyMatrix4 -applyQuaternion -setRotationFromAxisAngle -setRotationFromEuler -setRotationFromMatrix -setRotationFromQuaternion -rotateOnAxis -rotateOnWorldAxis -rotateX -rotateY -rotateZ -translateOnAxis -translateX -translateY -translateZ -localToWorld -worldToLocal -lookAt -add -remove -removeFromParent -clear -attach -getObjectById -getObjectByName -getObjectByProperty -getObjectsByProperty -getWorldPosition -getWorldQuaternion -getWorldScale -raycast -traverse -traverseVisible -traverseAncestors -updateMatrix -updateMatrixWorld -updateWorldMatrix -toJSON -clone -copy -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

  • new Camera(): Camera

  • Returns Camera

    Remarks

    Note that this class is not intended to be called directly; you probably want a
    -THREE.PerspectiveCamera | PerspectiveCamera or
    -THREE.OrthographicCamera | OrthographicCamera instead.

    -

Properties

StaticDEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight,
-THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

-

Default Value

new THREE.Vector3( 0, 1, 0)

-

StaticDEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

StaticDEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

ReadonlyisCamera

isCamera: true

Read-only flag to check if a given object is of type Camera.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlytype

type: string

Default Value

Camera

-

layers

layers: Layers

The THREE.Layers | layers that the Camera is a member of.

-

Remarks

Objects must share at least one layer with the Camera to be n when the camera's viewpoint is rendered.

-

Default Value

new THREE.Layers()

-

matrixWorldInverse

matrixWorldInverse: Matrix4

This is the inverse of matrixWorld.

-

Remarks

MatrixWorld contains the Matrix which has the world transform of the Camera .

-

Default Value

THREE.Matrix4 | new THREE.Matrix4()

-

projectionMatrix

projectionMatrix: Matrix4

This is the matrix which contains the projection.

-

Default Value

THREE.Matrix4 | new THREE.Matrix4()

-

projectionMatrixInverse

projectionMatrixInverse: Matrix4

This is the inverse of projectionMatrix.

-

Default Value

THREE.Matrix4 | new THREE.Matrix4()

-

coordinateSystem

coordinateSystem: CoordinateSystem

Optionalviewport

viewport?: Vector4

ReadonlyisObject3D

isObject3D: true

Flag to check if a given object is of type Object3D.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Object3D instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
-Expects a Integer

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

parent

parent: null | Object3D

Object's parent in the scene graph.

-

Remarks

An object can have at most one parent.

-

Default Value

null

-

children

children: Object3D[]

Array with object's children.

-

See

THREE.Object3DGroup | Group for info on manually grouping objects.

-

Default Value

[]

-

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

-

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

-

Readonlyposition

position: Vector3

Object's local position.

-

Default Value

new THREE.Vector3() - that is (0, 0, 0).

-

Readonlyrotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

-

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

-

Readonlyquaternion

quaternion: Quaternion

Object's local rotation as a THREE.Quaternion | Quaternion.

-

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

-

Readonlyscale

scale: Vector3

The object's local scale.

-

Default Value

new THREE.Vector3( 1, 1, 1 )

-

ReadonlymodelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

-

ReadonlynormalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

-

matrix

matrix: Matrix4

The local transform matrix.

-

Default Value

new THREE.Matrix4()

-

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

-

Remarks

If the Object3D has no parent, then it's identical to the local transform THREE.Object3D.matrix | .matrix.

-

Default Value

new THREE.Matrix4()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and
-scale every frame and also recalculates the matrixWorld property.

-

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

-

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates.
-When it isn't, then you have to maintain all matrices in the object and its children yourself.

-

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

-

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

-

Default Value

false

-

visible

visible: boolean

Object gets rendered if true.

-

Default Value

true

-

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

-

Default Value

false

-

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

-

Default Value

false

-

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object.
-If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

-

Default Value

true

-

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph
-objects to be overridden although opaque and transparent objects remain sorted independently.

-

Remarks

When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.
-Sorting is from lowest to highest renderOrder.

-

Default Value

0

-

animations

animations: AnimationClip[]

Array with object's animation clips.

-

Default Value

[]

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the Object3D.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default

{}

-

OptionalcustomDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

-

Remarks

Can only be used in context of meshes.
-When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight,
-if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

-

Default Value

undefined

-

OptionalcustomDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

-

Default Value

undefined

-

Methods

getWorldDirection

  • getWorldDirection(target: Vector3): Vector3

  • Returns a THREE.Vector3 | Vector3 representing the world space direction in which the Camera is looking.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

    Remarks

    Note: A Camera looks down its local, negative z-axis.

    -

onBeforeShadow

  • onBeforeShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterShadow

  • onAfterShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onBeforeRender

  • onBeforeRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterRender

  • onAfterRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

applyMatrix4

  • applyMatrix4(matrix: Matrix4): void

  • Applies the matrix transform to the object and updates the object's position, rotation and scale.

    -

    Parameters

    Returns void

applyQuaternion

  • applyQuaternion(quaternion: Quaternion): this

  • Applies the rotation represented by the quaternion to the object.

    -

    Parameters

    Returns this

setRotationFromAxisAngle

  • setRotationFromAxisAngle(axis: Vector3, angle: number): void

  • Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      Angle in radians. Expects a Float

      -

    Returns void

setRotationFromEuler

  • setRotationFromEuler(euler: Euler): void

  • Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.

    -

    Parameters

    • euler: Euler

      Euler angle specifying rotation amount.

      -

    Returns void

setRotationFromMatrix

  • setRotationFromMatrix(m: Matrix4): void

  • Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

    -

    Parameters

    • m: Matrix4

      Rotate the quaternion by the rotation component of the matrix.

      -

    Returns void

    Remarks

    Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

    -

setRotationFromQuaternion

rotateOnAxis

  • rotateOnAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in object space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

rotateOnWorldAxis

  • rotateOnWorldAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in world space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in world space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized
    -Method Assumes no rotated parent.

    -

rotateX

  • rotateX(angle: number): this

  • Rotates the object around x axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateY

  • rotateY(angle: number): this

  • Rotates the object around y axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateZ

  • rotateZ(angle: number): this

  • Rotates the object around z axis in local space.

    -

    Parameters

    • angle: number

    Returns this

translateOnAxis

  • translateOnAxis(axis: Vector3, distance: number): this

  • Translate an object by distance along an axis in object space

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • distance: number

      The distance to translate. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

translateX

  • translateX(distance: number): this

  • Translates object along x axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateY

  • translateY(distance: number): this

  • Translates object along y axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateZ

  • translateZ(distance: number): this

  • Translates object along z axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

localToWorld

  • localToWorld(vector: Vector3): Vector3

  • Converts the vector from this object's local space to world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in this object's local space.

      -

    Returns Vector3

worldToLocal

  • worldToLocal(vector: Vector3): Vector3

  • Converts the vector from world space to this object's local space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space.

      -

    Returns Vector3

lookAt

  • lookAt(vector: Vector3): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space to look at.

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -
  • lookAt(x: number, y: number, z: number): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -

add

  • add(...object: Object3D[]): this

  • Adds another Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be added
    -Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.

    -

    See

      -
    • attach
      • -
    • THREE.Group | Group for info on manually grouping objects.
      • -
    -

remove

  • remove(...object: Object3D[]): this

  • Removes a Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be removed.

    -

    See

    THREE.Group | Group for info on manually grouping objects.

    -

removeFromParent

  • removeFromParent(): this

  • Removes this object from its current parent.

    -

    Returns this

clear

  • clear(): this

  • Removes all child objects.

    -

    Returns this

attach

  • attach(object: Object3D): this

  • Adds a Object3D as a child of this, while maintaining the object's world transform.

    -

    Parameters

    Returns this

    Remarks

    Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

    -

    See

    add

    -

getObjectById

  • getObjectById(id: number): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    -

    Parameters

    • id: number

      Unique number of the object instance. Expects a Integer

      -

    Returns undefined | Object3D

    Remarks

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    -

    See

    id

    -

getObjectByName

  • getObjectByName(name: string): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

    -

    Parameters

    • name: string

      String to match to the children's Object3D.name property.

      -

    Returns undefined | Object3D

    Remarks

    Note that for most objects the name is an empty string by default
    -You will have to set it manually to make use of this method.

    -

getObjectByProperty

  • getObjectByProperty(name: string, value: any): undefined | Object3D

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      the property name to search for.

      -
    • value: any

      value of the given property.

      -

    Returns undefined | Object3D

getObjectsByProperty

  • getObjectsByProperty(
        name: string,
        value: any,
        optionalTarget?: Object3D[],
    ): Object3D[]

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      The property name to search for.

      -
    • value: any

      Value of the given property.

      -
    • OptionaloptionalTarget: Object3D[]

      target to set the result. Otherwise a new Array is instantiated. If set, you must clear
      -this array prior to each call (i.e., array.length = 0;).

      -

    Returns Object3D[]

getWorldPosition

  • getWorldPosition(target: Vector3): Vector3

  • Returns a vector representing the position of the object in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldQuaternion

getWorldScale

  • getWorldScale(target: Vector3): Vector3

  • Returns a vector of the scaling factors applied to the object for each axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

raycast

  • raycast(raycaster: Raycaster, intersects: Intersection[]): void

  • Abstract (empty) method to get intersections between a casted ray and this object

    -

    Parameters

    Returns void

    Remarks

    Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

    -

    See

    THREE.Raycaster | Raycaster

    -

    Default Value

    () => {}

    -

traverse

  • traverse(callback: (object: Object3D) => any): void

  • Executes the callback on this object and all descendants.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseVisible

  • traverseVisible(callback: (object: Object3D) => any): void

  • Like traverse, but the callback will only be executed for visible objects

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Descendants of invisible objects are not traversed.
    -Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseAncestors

  • traverseAncestors(callback: (object: Object3D) => any): void

  • Executes the callback on all ancestors.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

updateMatrix

  • updateMatrix(): void

  • Updates local transform.

    -

    Returns void

updateMatrixWorld

  • updateMatrixWorld(force?: boolean): void

  • Updates the global transform of the object.
    -And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

    -

    Parameters

    • Optionalforce: boolean

      A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame.
      -Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

      -

    Returns void

updateWorldMatrix

  • updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void

  • Updates the global transform of the object.

    -

    Parameters

    • updateParents: boolean

      Recursively updates global transform of ancestors.

      -
    • updateChildren: boolean

      Recursively updates global transform of descendants.

      -

    Returns void

toJSON

clone

  • clone(recursive?: boolean): this

  • Returns a clone of this object and optionally all descendants.

    -

    Parameters

    • Optionalrecursive: boolean

      If true, descendants of the object are also cloned. Default true

      -

    Returns this

copy

  • copy(object: Object3D, recursive?: boolean): this

  • Copies the given object into this object.

    -

    Parameters

    • object: Object3D
    • Optionalrecursive: boolean

      If set to true, descendants of the object are copied next to the existing ones. If set to
      -false, descendants are left unchanged. Default is true.

      -

    Returns this

    Remarks

    Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

    -

addEventListener

hasEventListener

removeEventListener

dispatchEvent

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Color.html b/docs/classes/Color.html deleted file mode 100644 index 42fa604..0000000 --- a/docs/classes/Color.html +++ /dev/null @@ -1,110 +0,0 @@ -Color | VFX-JS

Class Color

Class representing a color.

-

A Color instance is represented by RGB components in the linear working color space, which defaults to
-LinearSRGBColorSpace. Inputs conventionally using SRGBColorSpace (such as hexadecimals and CSS strings) are
-converted to the working color space automatically.

-
// converted automatically from SRGBColorSpace to LinearSRGBColorSpace
const color = new THREE.Color().setHex( 0x112233 );
-
- -

Source color spaces may be specified explicitly, to ensure correct conversions.

-
// assumed already LinearSRGBColorSpace; no conversion
const color = new THREE.Color().setRGB( 0.5, 0.5, 0.5 );

// converted explicitly from SRGBColorSpace to LinearSRGBColorSpace
const color = new THREE.Color().setRGB( 0.5, 0.5, 0.5, SRGBColorSpace );
-
- -

If THREE.ColorManagement is disabled, no conversions occur. For details, see Color management.

-

Iterating through a Color instance will yield its components (r, g, b) in the corresponding order.

-

Constructors

constructor -

Properties

NAMES -isColor -r -g -b -

Methods

set -setFromVector3 -setScalar -setHex -setRGB -setHSL -setStyle -setColorName -clone -copy -copySRGBToLinear -copyLinearToSRGB -convertSRGBToLinear -convertLinearToSRGB -getHex -getHexString -getHSL -getRGB -getStyle -offsetHSL -add -addColors -addScalar -applyMatrix3 -sub -multiply -multiplyScalar -lerp -lerpColors -lerpHSL -equals -fromArray -toArray -toJSON -fromBufferAttribute -[iterator] -

Constructors

constructor

  • new Color(color?: ColorRepresentation): Color

  • Parameters

    Returns Color

  • new Color(r: number, g: number, b: number): Color

  • Parameters

    • r: number
    • g: number
    • b: number

    Returns Color

Properties

StaticNAMES

NAMES: {
    aliceblue: 15792383;
    antiquewhite: 16444375;
    aqua: 65535;
    aquamarine: 8388564;
    azure: 15794175;
    beige: 16119260;
    bisque: 16770244;
    black: 0;
    blanchedalmond: 16772045;
    blue: 255;
    blueviolet: 9055202;
    brown: 10824234;
    burlywood: 14596231;
    cadetblue: 6266528;
    chartreuse: 8388352;
    chocolate: 13789470;
    coral: 16744272;
    cornflowerblue: 6591981;
    cornsilk: 16775388;
    crimson: 14423100;
    cyan: 65535;
    darkblue: 139;
    darkcyan: 35723;
    darkgoldenrod: 12092939;
    darkgray: 11119017;
    darkgreen: 25600;
    darkgrey: 11119017;
    darkkhaki: 12433259;
    darkmagenta: 9109643;
    darkolivegreen: 5597999;
    darkorange: 16747520;
    darkorchid: 10040012;
    darkred: 9109504;
    darksalmon: 15308410;
    darkseagreen: 9419919;
    darkslateblue: 4734347;
    darkslategray: 3100495;
    darkslategrey: 3100495;
    darkturquoise: 52945;
    darkviolet: 9699539;
    deeppink: 16716947;
    deepskyblue: 49151;
    dimgray: 6908265;
    dimgrey: 6908265;
    dodgerblue: 2003199;
    firebrick: 11674146;
    floralwhite: 16775920;
    forestgreen: 2263842;
    fuchsia: 16711935;
    gainsboro: 14474460;
    ghostwhite: 16316671;
    gold: 16766720;
    goldenrod: 14329120;
    gray: 8421504;
    green: 32768;
    greenyellow: 11403055;
    grey: 8421504;
    honeydew: 15794160;
    hotpink: 16738740;
    indianred: 13458524;
    indigo: 4915330;
    ivory: 16777200;
    khaki: 15787660;
    lavender: 15132410;
    lavenderblush: 16773365;
    lawngreen: 8190976;
    lemonchiffon: 16775885;
    lightblue: 11393254;
    lightcoral: 15761536;
    lightcyan: 14745599;
    lightgoldenrodyellow: 16448210;
    lightgray: 13882323;
    lightgreen: 9498256;
    lightgrey: 13882323;
    lightpink: 16758465;
    lightsalmon: 16752762;
    lightseagreen: 2142890;
    lightskyblue: 8900346;
    lightslategray: 7833753;
    lightslategrey: 7833753;
    lightsteelblue: 11584734;
    lightyellow: 16777184;
    lime: 65280;
    limegreen: 3329330;
    linen: 16445670;
    magenta: 16711935;
    maroon: 8388608;
    mediumaquamarine: 6737322;
    mediumblue: 205;
    mediumorchid: 12211667;
    mediumpurple: 9662683;
    mediumseagreen: 3978097;
    mediumslateblue: 8087790;
    mediumspringgreen: 64154;
    mediumturquoise: 4772300;
    mediumvioletred: 13047173;
    midnightblue: 1644912;
    mintcream: 16121850;
    mistyrose: 16770273;
    moccasin: 16770229;
    navajowhite: 16768685;
    navy: 128;
    oldlace: 16643558;
    olive: 8421376;
    olivedrab: 7048739;
    orange: 16753920;
    orangered: 16729344;
    orchid: 14315734;
    palegoldenrod: 15657130;
    palegreen: 10025880;
    paleturquoise: 11529966;
    palevioletred: 14381203;
    papayawhip: 16773077;
    peachpuff: 16767673;
    peru: 13468991;
    pink: 16761035;
    plum: 14524637;
    powderblue: 11591910;
    purple: 8388736;
    rebeccapurple: 6697881;
    red: 16711680;
    rosybrown: 12357519;
    royalblue: 4286945;
    saddlebrown: 9127187;
    salmon: 16416882;
    sandybrown: 16032864;
    seagreen: 3050327;
    seashell: 16774638;
    sienna: 10506797;
    silver: 12632256;
    skyblue: 8900331;
    slateblue: 6970061;
    slategray: 7372944;
    slategrey: 7372944;
    snow: 16775930;
    springgreen: 65407;
    steelblue: 4620980;
    tan: 13808780;
    teal: 32896;
    thistle: 14204888;
    tomato: 16737095;
    turquoise: 4251856;
    violet: 15631086;
    wheat: 16113331;
    white: 16777215;
    whitesmoke: 16119285;
    yellow: 16776960;
    yellowgreen: 10145074;
}

List of X11 color names.

-

ReadonlyisColor

isColor: true

r

r: number

Red channel value between 0.0 and 1.0. Default is 1.

-

Default

1
-
- -

g

g: number

Green channel value between 0.0 and 1.0. Default is 1.

-

Default

1
-
- -

b

b: number

Blue channel value between 0.0 and 1.0. Default is 1.

-

Default

1
-
- -

Methods

set

  • set(
        ...args:
            | [color: ColorRepresentation]
            | [r: number, g: number, b: number],
    ): this

  • Parameters

    Returns this

setFromVector3

  • setFromVector3(vector: Vector3): this

  • Sets this color's r, g and b components from the x, y, and z components of the specified
    -vector.

    -

    Parameters

    Returns this

setScalar

  • setScalar(scalar: number): Color

  • Parameters

    • scalar: number

    Returns Color

setHex

  • setHex(hex: number, colorSpace?: string): Color

  • Parameters

    • hex: number
    • OptionalcolorSpace: string

    Returns Color

setRGB

  • setRGB(r: number, g: number, b: number, colorSpace?: string): Color

  • Sets this color from RGB values.

    -

    Parameters

    • r: number

      Red channel value between 0 and 1.

      -
    • g: number

      Green channel value between 0 and 1.

      -
    • b: number

      Blue channel value between 0 and 1.

      -
    • OptionalcolorSpace: string

    Returns Color

setHSL

  • setHSL(h: number, s: number, l: number, colorSpace?: string): Color

  • Sets this color from HSL values.
    -Based on MochiKit implementation by Bob Ippolito.

    -

    Parameters

    • h: number

      Hue channel value between 0 and 1.

      -
    • s: number

      Saturation value channel between 0 and 1.

      -
    • l: number

      Value channel value between 0 and 1.

      -
    • OptionalcolorSpace: string

    Returns Color

setStyle

  • setStyle(style: string, colorSpace?: string): Color

  • Sets this color from a CSS context style string.

    -

    Parameters

    • style: string
    • OptionalcolorSpace: string

    Returns Color

setColorName

  • setColorName(style: string, colorSpace?: string): Color

  • Sets this color from a color name.
    -Faster than .setStyle() method if you don't need the other CSS-style formats.

    -

    Parameters

    • style: string

      Color name in X11 format.

      -
    • OptionalcolorSpace: string

    Returns Color

clone

  • clone(): this

  • Clones this color.

    -

    Returns this

copy

  • copy(color: Color): this

  • Copies given color.

    -

    Parameters

    • color: Color

      Color to copy.

      -

    Returns this

copySRGBToLinear

  • copySRGBToLinear(color: Color): Color

  • Copies given color making conversion from SRGBColorSpace to LinearSRGBColorSpace.

    -

    Parameters

    • color: Color

      Color to copy.

      -

    Returns Color

copyLinearToSRGB

  • copyLinearToSRGB(color: Color): Color

  • Copies given color making conversion from LinearSRGBColorSpace to SRGBColorSpace.

    -

    Parameters

    • color: Color

      Color to copy.

      -

    Returns Color

convertSRGBToLinear

  • convertSRGBToLinear(): Color

  • Converts this color from SRGBColorSpace to LinearSRGBColorSpace.

    -

    Returns Color

convertLinearToSRGB

  • convertLinearToSRGB(): Color

  • Converts this color from LinearSRGBColorSpace to SRGBColorSpace.

    -

    Returns Color

getHex

  • getHex(colorSpace?: string): number

  • Returns the hexadecimal value of this color.

    -

    Parameters

    • OptionalcolorSpace: string

    Returns number

getHexString

  • getHexString(colorSpace?: string): string

  • Returns the string formated hexadecimal value of this color.

    -

    Parameters

    • OptionalcolorSpace: string

    Returns string

getHSL

  • getHSL(target: HSL, colorSpace?: string): HSL

  • Parameters

    • target: HSL
    • OptionalcolorSpace: string

    Returns HSL

getRGB

  • getRGB(target: RGB, colorSpace?: string): RGB

  • Parameters

    • target: RGB
    • OptionalcolorSpace: string

    Returns RGB

getStyle

  • getStyle(colorSpace?: string): string

  • Returns the value of this color in CSS context style.
    -Example: rgb(r, g, b)

    -

    Parameters

    • OptionalcolorSpace: string

    Returns string

offsetHSL

  • offsetHSL(h: number, s: number, l: number): this

  • Parameters

    • h: number
    • s: number
    • l: number

    Returns this

add

  • add(color: Color): this

  • Parameters

    Returns this

addColors

  • addColors(color1: Color, color2: Color): this

  • Parameters

    Returns this

addScalar

  • addScalar(s: number): this

  • Parameters

    • s: number

    Returns this

applyMatrix3

  • applyMatrix3(m: Matrix3): this

  • Applies the transform m to this color's RGB components.

    -

    Parameters

    Returns this

sub

  • sub(color: Color): this

  • Parameters

    Returns this

multiply

  • multiply(color: Color): this

  • Parameters

    Returns this

multiplyScalar

  • multiplyScalar(s: number): this

  • Parameters

    • s: number

    Returns this

lerp

  • lerp(color: Color, alpha: number): this

  • Parameters

    • color: Color
    • alpha: number

    Returns this

lerpColors

  • lerpColors(color1: Color, color2: Color, alpha: number): this

  • Parameters

    Returns this

lerpHSL

  • lerpHSL(color: Color, alpha: number): this

  • Parameters

    • color: Color
    • alpha: number

    Returns this

equals

  • equals(color: Color): boolean

  • Parameters

    Returns boolean

fromArray

  • fromArray(array: number[] | ArrayLike<number>, offset?: number): this

  • Sets this color's red, green and blue value from the provided array or array-like.

    -

    Parameters

    • array: number[] | ArrayLike<number>

      the source array or array-like.

      -
    • Optionaloffset: number

      (optional) offset into the array-like. Default is 0.

      -

    Returns this

toArray

  • toArray(array?: number[], offset?: number): number[]

  • Returns an array [red, green, blue], or copies red, green and blue into the provided array.

    -

    Parameters

    • Optionalarray: number[]

      (optional) array to store the color to. If this is not provided, a new array will be created.

      -
    • Optionaloffset: number

      (optional) optional offset into the array.

      -

    Returns number[]

    The created or provided array.

    -
  • toArray(xyz: ArrayLike<number>, offset?: number): ArrayLike<number>

  • Copies red, green and blue into the provided array-like.

    -

    Parameters

    • xyz: ArrayLike<number>
    • Optionaloffset: number

      (optional) optional offset into the array-like.

      -

    Returns ArrayLike<number>

    The provided array-like.

    -

toJSON

  • toJSON(): number

  • This method defines the serialization result of Color.

    -

    Returns number

    The color as a hexadecimal value.

    -

fromBufferAttribute

[iterator]

  • "[iterator]"(): Generator<number, void>

  • Returns Generator<number, void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/ColorBuffer.html b/docs/classes/ColorBuffer.html deleted file mode 100644 index ba4cb63..0000000 --- a/docs/classes/ColorBuffer.html +++ /dev/null @@ -1,6 +0,0 @@ -ColorBuffer | VFX-JS

Class ColorBuffer

Constructors

constructor -

Methods

setMask -setLocked -setClear -reset -

Constructors

constructor

Methods

setMask

  • setMask(colorMask: boolean): void

  • Parameters

    • colorMask: boolean

    Returns void

setLocked

  • setLocked(lock: boolean): void

  • Parameters

    • lock: boolean

    Returns void

setClear

  • setClear(
        r: number,
        g: number,
        b: number,
        a: number,
        premultipliedAlpha: boolean,
    ): void

  • Parameters

    • r: number
    • g: number
    • b: number
    • a: number
    • premultipliedAlpha: boolean

    Returns void

reset

  • reset(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/CubeTexture.html b/docs/classes/CubeTexture.html deleted file mode 100644 index 279fbe5..0000000 --- a/docs/classes/CubeTexture.html +++ /dev/null @@ -1,274 +0,0 @@ -CubeTexture | VFX-JS

Class CubeTexture

Creates a cube texture made up of six images.

-

Remarks

CubeTexture is almost equivalent in functionality and usage to Texture.
-The only differences are that the images are an array of 6 images as opposed to a single image,
-and the mapping options are THREE.CubeReflectionMapping (default) or THREE.CubeRefractionMapping

-

Example

const loader = new THREE.CubeTextureLoader();
loader.setPath('textures/cube/pisa/');
const textureCube = loader.load(['px.png', 'nx.png', 'py.png', 'ny.png', 'pz.png', 'nz.png']);
const material = new THREE.MeshBasicMaterial({
    color: 0xffffff,
    envMap: textureCube
});
-
- -

See

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_ANISOTROPY -DEFAULT_IMAGE -DEFAULT_MAPPING -isCubeTexture -mapping -flipY -isTexture -id -uuid -name -source -mipmaps -channel -wrapS -wrapT -magFilter -minFilter -anisotropy -format -type -internalFormat -matrix -matrixAutoUpdate -offset -repeat -center -rotation -generateMipmaps -premultiplyAlpha -unpackAlignment -colorSpace -isRenderTargetTexture -userData -version -pmremVersion -onUpdate -

Accessors

image -images -needsUpdate -needsPMREMUpdate -

Methods

transformUv -updateMatrix -clone -copy -toJSON -dispose -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

StaticDEFAULT_ANISOTROPY

DEFAULT_ANISOTROPY: number

The Global default value for .anisotropy.

-

Default Value

1.

-

StaticDEFAULT_IMAGE

DEFAULT_IMAGE: any

The Global default value for .image.

-

Default Value

null.

-

StaticDEFAULT_MAPPING

DEFAULT_MAPPING: Mapping

The Global default value for .mapping.

-

Default Value

THREE.UVMapping

-

ReadonlyisCubeTexture

isCubeTexture: true

Read-only flag to check if a given object is of type CubeTexture.

-

Remarks

This is a constant value

-

Default Value

true

-

mapping

mapping: CubeTextureMapping

How the image is applied to the object.

-

Remarks

All Texture types except THREE.CubeTexture expect the values be THREE.Mapping

-

See

Texture Constants

-

Default Value

value of THREE.Texture.DEFAULT_MAPPING

-

flipY

flipY: boolean

If set to true, the texture is flipped along the vertical axis when uploaded to the GPU.

-

Remarks

Note that this property has no effect for ImageBitmap.
-You need to configure on bitmap creation instead. See THREE.ImageBitmapLoader | ImageBitmapLoader.

-

See

THREE.ImageBitmapLoader | ImageBitmapLoader.

-

Default Value

true

-

ReadonlyisTexture

isTexture: true

Read-only flag to check if a given object is of type Texture.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Texture instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

source

source: Source

The data definition of a texture. A reference to the data source can be shared across textures.
-This is often useful in context of spritesheets where multiple textures render the same data
-but with different Texture transformations.

-

mipmaps

mipmaps:
    | undefined
    | CompressedTextureMipmap[]
    | CubeTexture[]
    | HTMLCanvasElement[]

Array of user-specified mipmaps

-

Default Value

[]

-

channel

channel: number

Lets you select the uv attribute to map the texture to. 0 for uv, 1 for uv1, 2 for uv2 and 3 for
-uv3.

-

wrapS

wrapS: Wrapping

This defines how the Texture is wrapped horizontally and corresponds to U in UV mapping.

-

Remarks

for WEBGL1 - tiling of images in textures only functions if image dimensions are powers of two
-(2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, ...) in terms of pixels.
-Individual dimensions need not be equal, but each must be a power of two. This is a limitation of WebGL1, not three.js.
-WEBGL2 does not have this limitation.

-

See

-

Default Value

THREE.ClampToEdgeWrapping

-

wrapT

wrapT: Wrapping

This defines how the Texture is wrapped vertically and corresponds to V in UV mapping.

-

Remarks

for WEBGL1 - tiling of images in textures only functions if image dimensions are powers of two
-(2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, ...) in terms of pixels.
-Individual dimensions need not be equal, but each must be a power of two. This is a limitation of WebGL1, not three.js.
-WEBGL2 does not have this limitation.

-

See

-

Default Value

THREE.ClampToEdgeWrapping

-

magFilter

magFilter: MagnificationTextureFilter

How the Texture is sampled when a texel covers more than one pixel.

-

See

-

Default Value

THREE.LinearFilter

-

minFilter

minFilter: MinificationTextureFilter

How the Texture is sampled when a texel covers less than one pixel.

-

See

-

Default Value

THREE.LinearMipmapLinearFilter

-

anisotropy

anisotropy: number

The number of samples taken along the axis through the pixel that has the highest density of texels.

-

Remarks

A higher value gives a less blurry result than a basic mipmap, at the cost of more Texture samples being used.

-

Default

value of THREE.Texture.DEFAULT_ANISOTROPY. That is normally 1.

-

format

format: AnyPixelFormat

These define how elements of a 2D texture, or texels, are read by shaders.

-

Remarks

All Texture types except THREE.DepthTexture and THREE.CompressedPixelFormat expect the values be THREE.PixelFormat

-

See

-

Default Value

THREE.RGBAFormat.

-

type

type: TextureDataType

This must correspond to the .format.

-

Remarks

THREE.UnsignedByteType, is the type most used by Texture formats.

-

See

-

Default Value

THREE.UnsignedByteType

-

internalFormat

internalFormat: null | PixelFormatGPU

The GPU Pixel Format allows the developer to specify how the data is going to be stored on the GPU.

-

Remarks

Compatible only with WebGL2RenderingContext | WebGL 2 Rendering Context.

-

See

Texture Constants

-

Default Value

The default value is obtained using a combination of .format and .type.

-

matrix

matrix: Matrix3

The uv-transform matrix for the texture.

-

Remarks

When .matrixAutoUpdate property is true.
-Will be updated by the renderer from the properties:

- -

See

.matrixAutoUpdate

-

Default Value

new THREE.Matrix3()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

Whether is to update the texture's uv-transform .matrix.

-

Remarks

Set this to false if you are specifying the uv-transform matrix directly.

-

See

.matrix

-

Default Value

true

-

offset

offset: Vector2

How much a single repetition of the texture is offset from the beginning, in each direction U and V.

-

Remarks

Typical range is 0.0 to 1.0.

-

Default Value

new THREE.Vector2(0, 0)

-

repeat

repeat: Vector2

How many times the texture is repeated across the surface, in each direction U and V.

-

Remarks

If repeat is set greater than 1 in either direction, the corresponding Wrap parameter should
-also be set to THREE.RepeatWrapping or THREE.MirroredRepeatWrapping to achieve the desired tiling effect.

-

See

-

Default Value

new THREE.Vector2( 1, 1 )

-

center

center: Vector2

The point around which rotation occurs.

-

Remarks

A value of (0.5, 0.5) corresponds to the center of the texture.

-

Default Value

new THREE.Vector2( 0, 0 ), lower left.

-

rotation

rotation: number

How much the texture is rotated around the center point, in radians.

-

Remarks

Positive values are counter-clockwise.

-

Default Value

0

-

generateMipmaps

generateMipmaps: boolean

Whether to generate mipmaps, (if possible) for a texture.

-

Remarks

Set this to false if you are creating mipmaps manually.

-

Default Value

true
-
- -

premultiplyAlpha

premultiplyAlpha: boolean

If set to true, the alpha channel, if present, is multiplied into the color channels when the texture is uploaded to the GPU.

-

Remarks

Note that this property has no effect for ImageBitmap.
-You need to configure on bitmap creation instead. See THREE.ImageBitmapLoader | ImageBitmapLoader.

-

See

THREE.ImageBitmapLoader | ImageBitmapLoader.

-

Default Value

false

-

unpackAlignment

unpackAlignment: number

Specifies the alignment requirements for the start of each pixel row in memory.

-

Remarks

The allowable values are:

-
    -
  • 1 (byte-alignment)
    • -
  • 2 (rows aligned to even-numbered bytes)
    • -
  • 4 (word-alignment)
    • -
  • 8 (rows start on double-word boundaries).
    • -
-

See

glPixelStorei for more information.

-

Default Value

4

-

colorSpace

colorSpace: string

The Textures | {@link Texture constants} page for details of other color spaces.

-

Remarks

Textures containing color data should be annotated with SRGBColorSpace THREE.SRGBColorSpace or
-LinearSRGBColorSpace THREE.LinearSRGBColorSpace.

-

See

-

Default Value

THREE.NoColorSpace

-

isRenderTargetTexture

isRenderTargetTexture: boolean

Indicates whether a texture belongs to a render target or not

-

Default Value

false

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the texture.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default Value

{}

-

version

version: number

This starts at 0 and counts how many times .needsUpdate is set to true.

-

Remarks

Expects a Integer

-

Default Value

0

-

pmremVersion

pmremVersion: number

Indicates whether this texture should be processed by PMREMGenerator or not (only relevant for render target
-textures)

-

onUpdate

onUpdate: () => void

A callback function, called when the texture is updated (e.g., when needsUpdate has been set to true and then the texture is used).

-

Accessors

image

  • get image(): any

  • An image object, typically created using the THREE.CubeTextureLoader.load | CubeTextureLoader.load() method.

    -

    Returns any

    See

    Texture.image

    -
  • set image(data: any): void

  • An image object, typically created using the THREE.TextureLoader.load | TextureLoader.load() method.

    -

    Parameters

    • data: any

    Returns void

    Remarks

    This can be any image (e.g., PNG, JPG, GIF, DDS) or video (e.g., MP4, OGG/OGV) type supported by three.js.

    -

images

  • get images(): any

  • An image object, typically created using the THREE.CubeTextureLoader.load | CubeTextureLoader.load() method.

    -

    Returns any

    See

    Texture.image

    -
  • set images(data: any): void

  • Parameters

    • data: any

    Returns void

needsUpdate

  • set needsUpdate(value: boolean): void

  • Set this to true to trigger an update next time the texture is used. Particularly important for setting the wrap mode.

    -

    Parameters

    • value: boolean

    Returns void

needsPMREMUpdate

  • set needsPMREMUpdate(value: boolean): void

  • Indicates whether this texture should be processed by THREE.PMREMGenerator or not.

    -

    Parameters

    • value: boolean

    Returns void

    Remarks

    Only relevant for render target textures.

    -

    Default Value

    false

    -

Methods

transformUv

updateMatrix

clone

  • clone(): this

  • Make copy of the texture

    -

    Returns this

    Remarks

    Note this is not a "deep copy", the image is shared

    -

copy

  • copy(source: Texture): this

  • Parameters

    Returns this

toJSON

dispose

  • dispose(): void

  • Frees the GPU-related resources allocated by this instance

    -

    Returns void

    Remarks

    Call this method whenever this instance is no longer used in your app.

    -

addEventListener

  • addEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, CubeTexture>,
    ): void

  • Adds a listener to an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

      -
    • listener: EventListener<{ dispose: {} }[T], T, CubeTexture>

      The function that gets called when the event is fired.

      -

    Returns void

hasEventListener

  • hasEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, CubeTexture>,
    ): boolean

  • Checks if listener is added to an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

      -
    • listener: EventListener<{ dispose: {} }[T], T, CubeTexture>

      The function that gets called when the event is fired.

      -

    Returns boolean

removeEventListener

  • removeEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, CubeTexture>,
    ): void

  • Removes a listener from an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of the listener that gets removed.

      -
    • listener: EventListener<{ dispose: {} }[T], T, CubeTexture>

      The listener function that gets removed.

      -

    Returns void

dispatchEvent

  • dispatchEvent<T extends "dispose">(
        event: BaseEvent<T> & { dispose: {} }[T],
    ): void

  • Fire an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • event: BaseEvent<T> & { dispose: {} }[T]

      The event that gets fired.

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/CubicInterpolant.html b/docs/classes/CubicInterpolant.html deleted file mode 100644 index 4cb615e..0000000 --- a/docs/classes/CubicInterpolant.html +++ /dev/null @@ -1,8 +0,0 @@ -CubicInterpolant | VFX-JS

Class CubicInterpolant

Hierarchy (View Summary)

Constructors

constructor -

Properties

parameterPositions -sampleValues -valueSize -resultBuffer -

Methods

interpolate_ -evaluate -

Constructors

constructor

  • new CubicInterpolant(
        parameterPositions: any,
        samplesValues: any,
        sampleSize: number,
        resultBuffer?: any,
    ): CubicInterpolant

  • Parameters

    • parameterPositions: any
    • samplesValues: any
    • sampleSize: number
    • OptionalresultBuffer: any

    Returns CubicInterpolant

Properties

parameterPositions

parameterPositions: any

sampleValues

sampleValues: any

valueSize

valueSize: number

resultBuffer

resultBuffer: any

Methods

interpolate_

  • interpolate_(i1: number, t0: number, t: number, t1: number): any

  • Parameters

    • i1: number
    • t0: number
    • t: number
    • t1: number

    Returns any

evaluate

  • evaluate(time: number): any

  • Parameters

    • time: number

    Returns any

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Cylindrical.html b/docs/classes/Cylindrical.html deleted file mode 100644 index c537f92..0000000 --- a/docs/classes/Cylindrical.html +++ /dev/null @@ -1,19 +0,0 @@ -Cylindrical | VFX-JS

Class Cylindrical

Constructors

constructor -

Properties

radius -theta -y -

Methods

clone -copy -set -setFromVector3 -setFromCartesianCoords -

Constructors

constructor

  • new Cylindrical(radius?: number, theta?: number, y?: number): Cylindrical

  • Parameters

    • Optionalradius: number
    • Optionaltheta: number
    • Optionaly: number

    Returns Cylindrical

Properties

radius

radius: number

Default

1
-
- -

theta

theta: number

Default

0
-
- -

y

y: number

Default

0
-
- -

Methods

clone

  • clone(): this

  • Returns this

copy

  • copy(other: Cylindrical): this

  • Parameters

    Returns this

set

  • set(radius: number, theta: number, y: number): this

  • Parameters

    • radius: number
    • theta: number
    • y: number

    Returns this

setFromVector3

  • setFromVector3(vec3: Vector3): this

  • Parameters

    Returns this

setFromCartesianCoords

  • setFromCartesianCoords(x: number, y: number, z: number): this

  • Parameters

    • x: number
    • y: number
    • z: number

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Data3DTexture.html b/docs/classes/Data3DTexture.html deleted file mode 100644 index 8d1dabe..0000000 --- a/docs/classes/Data3DTexture.html +++ /dev/null @@ -1,239 +0,0 @@ -Data3DTexture | VFX-JS

Class Data3DTexture

Creates a three-dimensional texture from raw data, with parameters to divide it into width, height, and depth

-

Example

This creates a[name] with repeating data, 0 to 255
// create a buffer with some data
const sizeX = 64;
const sizeY = 64;
const sizeZ = 64;
const data = new Uint8Array(sizeX * sizeY * sizeZ);
let i = 0;
for (let z = 0; z & lt; sizeZ; z++) {
    for (let y = 0; y & lt; sizeY; y++) {
        for (let x = 0; x & lt; sizeX; x++) {
            data[i] = i % 256;
            i++;
        }
    }
}
// use the buffer to create the texture
const texture = new THREE.Data3DTexture(data, sizeX, sizeY, sizeZ);
texture.needsUpdate = true;
-
- -

See

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_ANISOTROPY -DEFAULT_IMAGE -DEFAULT_MAPPING -isData3DTexture -magFilter -minFilter -wrapR -flipY -generateMipmaps -unpackAlignment -isTexture -id -uuid -name -source -mipmaps -mapping -channel -wrapS -wrapT -anisotropy -format -type -internalFormat -matrix -matrixAutoUpdate -offset -repeat -center -rotation -premultiplyAlpha -colorSpace -isRenderTargetTexture -userData -version -pmremVersion -onUpdate -

Accessors

image -needsUpdate -needsPMREMUpdate -

Methods

transformUv -updateMatrix -clone -copy -toJSON -dispose -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

  • new Data3DTexture(
        data?: null | BufferSource,
        width?: number,
        height?: number,
        depth?: number,
    ): Data3DTexture

  • Create a new instance of Data3DTexture

    -

    Parameters

    • Optionaldata: null | BufferSource

      ArrayBufferView of the texture. Default null.

      -
    • Optionalwidth: number

      Width of the texture. Default 1.

      -
    • Optionalheight: number

      Height of the texture. Default 1.

      -
    • Optionaldepth: number

      Depth of the texture. Default 1.

      -

    Returns Data3DTexture

Properties

StaticDEFAULT_ANISOTROPY

DEFAULT_ANISOTROPY: number

The Global default value for .anisotropy.

-

Default Value

1.

-

StaticDEFAULT_IMAGE

DEFAULT_IMAGE: any

The Global default value for .image.

-

Default Value

null.

-

StaticDEFAULT_MAPPING

DEFAULT_MAPPING: Mapping

The Global default value for .mapping.

-

Default Value

THREE.UVMapping

-

ReadonlyisData3DTexture

isData3DTexture: true

Read-only flag to check if a given object is of type Data3DTexture.

-

Remarks

This is a constant value

-

Default Value

true

-

magFilter

magFilter: MagnificationTextureFilter

Default Value

THREE.NearestFilter

-

minFilter

minFilter: MinificationTextureFilter

Default Value

THREE.NearestFilter

-

wrapR

wrapR: Wrapping

Default Value

THREE.ClampToEdgeWrapping

-

flipY

flipY: boolean

Default Value

false

-

generateMipmaps

generateMipmaps: boolean

Default Value

false

-

unpackAlignment

unpackAlignment: number

Default Value

1

-

ReadonlyisTexture

isTexture: true

Read-only flag to check if a given object is of type Texture.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Texture instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

source

source: Source

The data definition of a texture. A reference to the data source can be shared across textures.
-This is often useful in context of spritesheets where multiple textures render the same data
-but with different Texture transformations.

-

mipmaps

mipmaps:
    | undefined
    | CompressedTextureMipmap[]
    | CubeTexture[]
    | HTMLCanvasElement[]

Array of user-specified mipmaps

-

Default Value

[]

-

mapping

mapping: AnyMapping

How the image is applied to the object.

-

Remarks

All Texture types except THREE.CubeTexture expect the values be THREE.Mapping

-

See

Texture Constants

-

Default Value

value of THREE.Texture.DEFAULT_MAPPING

-

channel

channel: number

Lets you select the uv attribute to map the texture to. 0 for uv, 1 for uv1, 2 for uv2 and 3 for
-uv3.

-

wrapS

wrapS: Wrapping

This defines how the Texture is wrapped horizontally and corresponds to U in UV mapping.

-

Remarks

for WEBGL1 - tiling of images in textures only functions if image dimensions are powers of two
-(2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, ...) in terms of pixels.
-Individual dimensions need not be equal, but each must be a power of two. This is a limitation of WebGL1, not three.js.
-WEBGL2 does not have this limitation.

-

See

-

Default Value

THREE.ClampToEdgeWrapping

-

wrapT

wrapT: Wrapping

This defines how the Texture is wrapped vertically and corresponds to V in UV mapping.

-

Remarks

for WEBGL1 - tiling of images in textures only functions if image dimensions are powers of two
-(2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, ...) in terms of pixels.
-Individual dimensions need not be equal, but each must be a power of two. This is a limitation of WebGL1, not three.js.
-WEBGL2 does not have this limitation.

-

See

-

Default Value

THREE.ClampToEdgeWrapping

-

anisotropy

anisotropy: number

The number of samples taken along the axis through the pixel that has the highest density of texels.

-

Remarks

A higher value gives a less blurry result than a basic mipmap, at the cost of more Texture samples being used.

-

Default

value of THREE.Texture.DEFAULT_ANISOTROPY. That is normally 1.

-

format

format: AnyPixelFormat

These define how elements of a 2D texture, or texels, are read by shaders.

-

Remarks

All Texture types except THREE.DepthTexture and THREE.CompressedPixelFormat expect the values be THREE.PixelFormat

-

See

-

Default Value

THREE.RGBAFormat.

-

type

type: TextureDataType

This must correspond to the .format.

-

Remarks

THREE.UnsignedByteType, is the type most used by Texture formats.

-

See

-

Default Value

THREE.UnsignedByteType

-

internalFormat

internalFormat: null | PixelFormatGPU

The GPU Pixel Format allows the developer to specify how the data is going to be stored on the GPU.

-

Remarks

Compatible only with WebGL2RenderingContext | WebGL 2 Rendering Context.

-

See

Texture Constants

-

Default Value

The default value is obtained using a combination of .format and .type.

-

matrix

matrix: Matrix3

The uv-transform matrix for the texture.

-

Remarks

When .matrixAutoUpdate property is true.
-Will be updated by the renderer from the properties:

- -

See

.matrixAutoUpdate

-

Default Value

new THREE.Matrix3()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

Whether is to update the texture's uv-transform .matrix.

-

Remarks

Set this to false if you are specifying the uv-transform matrix directly.

-

See

.matrix

-

Default Value

true

-

offset

offset: Vector2

How much a single repetition of the texture is offset from the beginning, in each direction U and V.

-

Remarks

Typical range is 0.0 to 1.0.

-

Default Value

new THREE.Vector2(0, 0)

-

repeat

repeat: Vector2

How many times the texture is repeated across the surface, in each direction U and V.

-

Remarks

If repeat is set greater than 1 in either direction, the corresponding Wrap parameter should
-also be set to THREE.RepeatWrapping or THREE.MirroredRepeatWrapping to achieve the desired tiling effect.

-

See

-

Default Value

new THREE.Vector2( 1, 1 )

-

center

center: Vector2

The point around which rotation occurs.

-

Remarks

A value of (0.5, 0.5) corresponds to the center of the texture.

-

Default Value

new THREE.Vector2( 0, 0 ), lower left.

-

rotation

rotation: number

How much the texture is rotated around the center point, in radians.

-

Remarks

Positive values are counter-clockwise.

-

Default Value

0

-

premultiplyAlpha

premultiplyAlpha: boolean

If set to true, the alpha channel, if present, is multiplied into the color channels when the texture is uploaded to the GPU.

-

Remarks

Note that this property has no effect for ImageBitmap.
-You need to configure on bitmap creation instead. See THREE.ImageBitmapLoader | ImageBitmapLoader.

-

See

THREE.ImageBitmapLoader | ImageBitmapLoader.

-

Default Value

false

-

colorSpace

colorSpace: string

The Textures | {@link Texture constants} page for details of other color spaces.

-

Remarks

Textures containing color data should be annotated with SRGBColorSpace THREE.SRGBColorSpace or
-LinearSRGBColorSpace THREE.LinearSRGBColorSpace.

-

See

-

Default Value

THREE.NoColorSpace

-

isRenderTargetTexture

isRenderTargetTexture: boolean

Indicates whether a texture belongs to a render target or not

-

Default Value

false

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the texture.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default Value

{}

-

version

version: number

This starts at 0 and counts how many times .needsUpdate is set to true.

-

Remarks

Expects a Integer

-

Default Value

0

-

pmremVersion

pmremVersion: number

Indicates whether this texture should be processed by PMREMGenerator or not (only relevant for render target
-textures)

-

onUpdate

onUpdate: () => void

A callback function, called when the texture is updated (e.g., when needsUpdate has been set to true and then the texture is used).

-

Accessors

image

  • get image(): Texture3DImageData

  • Overridden with a record type holding data, width and height and depth.

    -

    Returns Texture3DImageData

  • set image(data: Texture3DImageData): void

  • An image object, typically created using the THREE.TextureLoader.load | TextureLoader.load() method.

    -

    Parameters

    Returns void

    Remarks

    This can be any image (e.g., PNG, JPG, GIF, DDS) or video (e.g., MP4, OGG/OGV) type supported by three.js.

    -

needsUpdate

  • set needsUpdate(value: boolean): void

  • Set this to true to trigger an update next time the texture is used. Particularly important for setting the wrap mode.

    -

    Parameters

    • value: boolean

    Returns void

needsPMREMUpdate

  • set needsPMREMUpdate(value: boolean): void

  • Indicates whether this texture should be processed by THREE.PMREMGenerator or not.

    -

    Parameters

    • value: boolean

    Returns void

    Remarks

    Only relevant for render target textures.

    -

    Default Value

    false

    -

Methods

transformUv

updateMatrix

clone

  • clone(): this

  • Make copy of the texture

    -

    Returns this

    Remarks

    Note this is not a "deep copy", the image is shared

    -

copy

  • copy(source: Texture): this

  • Parameters

    Returns this

toJSON

dispose

  • dispose(): void

  • Frees the GPU-related resources allocated by this instance

    -

    Returns void

    Remarks

    Call this method whenever this instance is no longer used in your app.

    -

addEventListener

  • addEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, Data3DTexture>,
    ): void

  • Adds a listener to an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

      -
    • listener: EventListener<{ dispose: {} }[T], T, Data3DTexture>

      The function that gets called when the event is fired.

      -

    Returns void

hasEventListener

  • hasEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, Data3DTexture>,
    ): boolean

  • Checks if listener is added to an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

      -
    • listener: EventListener<{ dispose: {} }[T], T, Data3DTexture>

      The function that gets called when the event is fired.

      -

    Returns boolean

removeEventListener

  • removeEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, Data3DTexture>,
    ): void

  • Removes a listener from an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of the listener that gets removed.

      -
    • listener: EventListener<{ dispose: {} }[T], T, Data3DTexture>

      The listener function that gets removed.

      -

    Returns void

dispatchEvent

  • dispatchEvent<T extends "dispose">(
        event: BaseEvent<T> & { dispose: {} }[T],
    ): void

  • Fire an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • event: BaseEvent<T> & { dispose: {} }[T]

      The event that gets fired.

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/DataArrayTexture.html b/docs/classes/DataArrayTexture.html deleted file mode 100644 index a2227b4..0000000 --- a/docs/classes/DataArrayTexture.html +++ /dev/null @@ -1,246 +0,0 @@ -DataArrayTexture | VFX-JS

Class DataArrayTexture

Creates an array of textures directly from raw data, width and height and depth

-

Example

This creates a[name] where each texture has a different color.
// create a buffer with color data
const width = 512;
const height = 512;
const depth = 100;
const size = width * height;
const data = new Uint8Array(4 * size * depth);
for (let i = 0; i & lt; depth; i++) {
    const color = new THREE.Color(Math.random(), Math.random(), Math.random());
    const r = Math.floor(color.r * 255);
    const g = Math.floor(color.g * 255);
    const b = Math.floor(color.b * 255);
    for (let j = 0; j & lt; size; j++) {
        const stride = (i * size + j) * 4;
        data[stride] = r;
        data[stride + 1] = g;
        data[stride + 2] = b;
        data[stride + 3] = 255;
    }
}
// used the buffer to create a [name]
const texture = new THREE.DataArrayTexture(data, width, height, depth);
texture.needsUpdate = true;
-
- -

See

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_ANISOTROPY -DEFAULT_IMAGE -DEFAULT_MAPPING -isDataArrayTexture -magFilter -minFilter -wrapR -generateMipmaps -flipY -unpackAlignment -layerUpdates -isTexture -id -uuid -name -source -mipmaps -mapping -channel -wrapS -wrapT -anisotropy -format -type -internalFormat -matrix -matrixAutoUpdate -offset -repeat -center -rotation -premultiplyAlpha -colorSpace -isRenderTargetTexture -userData -version -pmremVersion -onUpdate -

Accessors

image -needsUpdate -needsPMREMUpdate -

Methods

addLayerUpdate -clearLayoutUpdates -transformUv -updateMatrix -clone -copy -toJSON -dispose -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

  • new DataArrayTexture(
        data?: null | BufferSource,
        width?: number,
        height?: number,
        depth?: number,
    ): DataArrayTexture

  • This creates a new THREE.DataArrayTexture | DataArrayTexture object.

    -

    Parameters

    • Optionaldata: null | BufferSource

      ArrayBufferView of the texture. Default null.

      -
    • Optionalwidth: number

      Width of the texture. Default 1.

      -
    • Optionalheight: number

      Height of the texture. Default 1.

      -
    • Optionaldepth: number

      Depth of the texture. Default 1.

      -

    Returns DataArrayTexture

    Remarks

    The interpretation of the data depends on format and type.

    -

Properties

StaticDEFAULT_ANISOTROPY

DEFAULT_ANISOTROPY: number

The Global default value for .anisotropy.

-

Default Value

1.

-

StaticDEFAULT_IMAGE

DEFAULT_IMAGE: any

The Global default value for .image.

-

Default Value

null.

-

StaticDEFAULT_MAPPING

DEFAULT_MAPPING: Mapping

The Global default value for .mapping.

-

Default Value

THREE.UVMapping

-

ReadonlyisDataArrayTexture

isDataArrayTexture: true

Read-only flag to check if a given object is of type DataArrayTexture.

-

Remarks

This is a constant value

-

Default Value

true

-

magFilter

magFilter: MagnificationTextureFilter

Default Value

THREE.NearestFilter

-

minFilter

minFilter: MinificationTextureFilter

Default Value

THREE.NearestFilter

-

wrapR

wrapR: boolean

Default Value

THREE.ClampToEdgeWrapping

-

generateMipmaps

generateMipmaps: boolean

Default Value

false

-

flipY

flipY: boolean

Default Value

false

-

unpackAlignment

unpackAlignment: number

Default Value

1

-

layerUpdates

layerUpdates: Set<number>

A set of all layers which need to be updated in the texture. See DataArrayTexture.addLayerUpdate.

-

ReadonlyisTexture

isTexture: true

Read-only flag to check if a given object is of type Texture.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Texture instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

source

source: Source

The data definition of a texture. A reference to the data source can be shared across textures.
-This is often useful in context of spritesheets where multiple textures render the same data
-but with different Texture transformations.

-

mipmaps

mipmaps:
    | undefined
    | CompressedTextureMipmap[]
    | CubeTexture[]
    | HTMLCanvasElement[]

Array of user-specified mipmaps

-

Default Value

[]

-

mapping

mapping: AnyMapping

How the image is applied to the object.

-

Remarks

All Texture types except THREE.CubeTexture expect the values be THREE.Mapping

-

See

Texture Constants

-

Default Value

value of THREE.Texture.DEFAULT_MAPPING

-

channel

channel: number

Lets you select the uv attribute to map the texture to. 0 for uv, 1 for uv1, 2 for uv2 and 3 for
-uv3.

-

wrapS

wrapS: Wrapping

This defines how the Texture is wrapped horizontally and corresponds to U in UV mapping.

-

Remarks

for WEBGL1 - tiling of images in textures only functions if image dimensions are powers of two
-(2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, ...) in terms of pixels.
-Individual dimensions need not be equal, but each must be a power of two. This is a limitation of WebGL1, not three.js.
-WEBGL2 does not have this limitation.

-

See

-

Default Value

THREE.ClampToEdgeWrapping

-

wrapT

wrapT: Wrapping

This defines how the Texture is wrapped vertically and corresponds to V in UV mapping.

-

Remarks

for WEBGL1 - tiling of images in textures only functions if image dimensions are powers of two
-(2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, ...) in terms of pixels.
-Individual dimensions need not be equal, but each must be a power of two. This is a limitation of WebGL1, not three.js.
-WEBGL2 does not have this limitation.

-

See

-

Default Value

THREE.ClampToEdgeWrapping

-

anisotropy

anisotropy: number

The number of samples taken along the axis through the pixel that has the highest density of texels.

-

Remarks

A higher value gives a less blurry result than a basic mipmap, at the cost of more Texture samples being used.

-

Default

value of THREE.Texture.DEFAULT_ANISOTROPY. That is normally 1.

-

format

format: AnyPixelFormat

These define how elements of a 2D texture, or texels, are read by shaders.

-

Remarks

All Texture types except THREE.DepthTexture and THREE.CompressedPixelFormat expect the values be THREE.PixelFormat

-

See

-

Default Value

THREE.RGBAFormat.

-

type

type: TextureDataType

This must correspond to the .format.

-

Remarks

THREE.UnsignedByteType, is the type most used by Texture formats.

-

See

-

Default Value

THREE.UnsignedByteType

-

internalFormat

internalFormat: null | PixelFormatGPU

The GPU Pixel Format allows the developer to specify how the data is going to be stored on the GPU.

-

Remarks

Compatible only with WebGL2RenderingContext | WebGL 2 Rendering Context.

-

See

Texture Constants

-

Default Value

The default value is obtained using a combination of .format and .type.

-

matrix

matrix: Matrix3

The uv-transform matrix for the texture.

-

Remarks

When .matrixAutoUpdate property is true.
-Will be updated by the renderer from the properties:

- -

See

.matrixAutoUpdate

-

Default Value

new THREE.Matrix3()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

Whether is to update the texture's uv-transform .matrix.

-

Remarks

Set this to false if you are specifying the uv-transform matrix directly.

-

See

.matrix

-

Default Value

true

-

offset

offset: Vector2

How much a single repetition of the texture is offset from the beginning, in each direction U and V.

-

Remarks

Typical range is 0.0 to 1.0.

-

Default Value

new THREE.Vector2(0, 0)

-

repeat

repeat: Vector2

How many times the texture is repeated across the surface, in each direction U and V.

-

Remarks

If repeat is set greater than 1 in either direction, the corresponding Wrap parameter should
-also be set to THREE.RepeatWrapping or THREE.MirroredRepeatWrapping to achieve the desired tiling effect.

-

See

-

Default Value

new THREE.Vector2( 1, 1 )

-

center

center: Vector2

The point around which rotation occurs.

-

Remarks

A value of (0.5, 0.5) corresponds to the center of the texture.

-

Default Value

new THREE.Vector2( 0, 0 ), lower left.

-

rotation

rotation: number

How much the texture is rotated around the center point, in radians.

-

Remarks

Positive values are counter-clockwise.

-

Default Value

0

-

premultiplyAlpha

premultiplyAlpha: boolean

If set to true, the alpha channel, if present, is multiplied into the color channels when the texture is uploaded to the GPU.

-

Remarks

Note that this property has no effect for ImageBitmap.
-You need to configure on bitmap creation instead. See THREE.ImageBitmapLoader | ImageBitmapLoader.

-

See

THREE.ImageBitmapLoader | ImageBitmapLoader.

-

Default Value

false

-

colorSpace

colorSpace: string

The Textures | {@link Texture constants} page for details of other color spaces.

-

Remarks

Textures containing color data should be annotated with SRGBColorSpace THREE.SRGBColorSpace or
-LinearSRGBColorSpace THREE.LinearSRGBColorSpace.

-

See

-

Default Value

THREE.NoColorSpace

-

isRenderTargetTexture

isRenderTargetTexture: boolean

Indicates whether a texture belongs to a render target or not

-

Default Value

false

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the texture.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default Value

{}

-

version

version: number

This starts at 0 and counts how many times .needsUpdate is set to true.

-

Remarks

Expects a Integer

-

Default Value

0

-

pmremVersion

pmremVersion: number

Indicates whether this texture should be processed by PMREMGenerator or not (only relevant for render target
-textures)

-

onUpdate

onUpdate: () => void

A callback function, called when the texture is updated (e.g., when needsUpdate has been set to true and then the texture is used).

-

Accessors

image

  • get image(): Texture3DImageData

  • Overridden with a record type holding data, width and height and depth.

    -

    Returns Texture3DImageData

  • set image(data: Texture3DImageData): void

  • An image object, typically created using the THREE.TextureLoader.load | TextureLoader.load() method.

    -

    Parameters

    Returns void

    Remarks

    This can be any image (e.g., PNG, JPG, GIF, DDS) or video (e.g., MP4, OGG/OGV) type supported by three.js.

    -

needsUpdate

  • set needsUpdate(value: boolean): void

  • Set this to true to trigger an update next time the texture is used. Particularly important for setting the wrap mode.

    -

    Parameters

    • value: boolean

    Returns void

needsPMREMUpdate

  • set needsPMREMUpdate(value: boolean): void

  • Indicates whether this texture should be processed by THREE.PMREMGenerator or not.

    -

    Parameters

    • value: boolean

    Returns void

    Remarks

    Only relevant for render target textures.

    -

    Default Value

    false

    -

Methods

addLayerUpdate

  • addLayerUpdate(layerIndex: number): void

  • Describes that a specific layer of the texture needs to be updated. Normally when Texture.needsUpdate is
    -set to true, the entire compressed texture array is sent to the GPU. Marking specific layers will only transmit
    -subsets of all mipmaps associated with a specific depth in the array which is often much more performant.

    -

    Parameters

    • layerIndex: number

    Returns void

clearLayoutUpdates

  • clearLayoutUpdates(): void

  • Resets the layer updates registry. See DataArrayTexture.addLayerUpdate.

    -

    Returns void

transformUv

updateMatrix

clone

  • clone(): this

  • Make copy of the texture

    -

    Returns this

    Remarks

    Note this is not a "deep copy", the image is shared

    -

copy

  • copy(source: Texture): this

  • Parameters

    Returns this

toJSON

dispose

  • dispose(): void

  • Frees the GPU-related resources allocated by this instance

    -

    Returns void

    Remarks

    Call this method whenever this instance is no longer used in your app.

    -

addEventListener

  • addEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, DataArrayTexture>,
    ): void

  • Adds a listener to an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

      -
    • listener: EventListener<{ dispose: {} }[T], T, DataArrayTexture>

      The function that gets called when the event is fired.

      -

    Returns void

hasEventListener

  • hasEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, DataArrayTexture>,
    ): boolean

  • Checks if listener is added to an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

      -
    • listener: EventListener<{ dispose: {} }[T], T, DataArrayTexture>

      The function that gets called when the event is fired.

      -

    Returns boolean

removeEventListener

  • removeEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, DataArrayTexture>,
    ): void

  • Removes a listener from an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    Returns void

dispatchEvent

  • dispatchEvent<T extends "dispose">(
        event: BaseEvent<T> & { dispose: {} }[T],
    ): void

  • Fire an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • event: BaseEvent<T> & { dispose: {} }[T]

      The event that gets fired.

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/DepthBuffer.html b/docs/classes/DepthBuffer.html deleted file mode 100644 index 87ef13a..0000000 --- a/docs/classes/DepthBuffer.html +++ /dev/null @@ -1,10 +0,0 @@ -DepthBuffer | VFX-JS

Class DepthBuffer

Constructors

constructor -

Methods

setReversed -getReversed -setTest -setMask -setFunc -setLocked -setClear -reset -

Constructors

constructor

  • new DepthBuffer(): DepthBuffer

  • Returns DepthBuffer

Methods

setReversed

  • setReversed(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

getReversed

  • getReversed(): boolean

  • Returns boolean

setTest

  • setTest(depthTest: boolean): void

  • Parameters

    • depthTest: boolean

    Returns void

setMask

  • setMask(depthMask: boolean): void

  • Parameters

    • depthMask: boolean

    Returns void

setFunc

  • setFunc(depthFunc: DepthModes): void

  • Parameters

    Returns void

setLocked

  • setLocked(lock: boolean): void

  • Parameters

    • lock: boolean

    Returns void

setClear

  • setClear(depth: number): void

  • Parameters

    • depth: number

    Returns void

reset

  • reset(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/DepthTexture.html b/docs/classes/DepthTexture.html deleted file mode 100644 index 70e4ab7..0000000 --- a/docs/classes/DepthTexture.html +++ /dev/null @@ -1,241 +0,0 @@ -DepthTexture | VFX-JS

Class DepthTexture

This class can be used to automatically save the depth information of a rendering into a texture

-

See

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_ANISOTROPY -DEFAULT_IMAGE -DEFAULT_MAPPING -isDepthTexture -flipY -magFilter -minFilter -generateMipmaps -format -type -compareFunction -isTexture -id -uuid -name -source -mipmaps -mapping -channel -wrapS -wrapT -anisotropy -internalFormat -matrix -matrixAutoUpdate -offset -repeat -center -rotation -premultiplyAlpha -unpackAlignment -colorSpace -isRenderTargetTexture -userData -version -pmremVersion -onUpdate -

Accessors

image -needsUpdate -needsPMREMUpdate -

Methods

transformUv -updateMatrix -clone -copy -toJSON -dispose -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

StaticDEFAULT_ANISOTROPY

DEFAULT_ANISOTROPY: number

The Global default value for .anisotropy.

-

Default Value

1.

-

StaticDEFAULT_IMAGE

DEFAULT_IMAGE: any

The Global default value for .image.

-

Default Value

null.

-

StaticDEFAULT_MAPPING

DEFAULT_MAPPING: Mapping

The Global default value for .mapping.

-

Default Value

THREE.UVMapping

-

ReadonlyisDepthTexture

isDepthTexture: true

Read-only flag to check if a given object is of type DepthTexture.

-

Remarks

This is a constant value

-

Default Value

true

-

flipY

flipY: boolean

Default Value

false

-

magFilter

magFilter: MagnificationTextureFilter

Default Value

THREE.NearestFilter

-

minFilter

minFilter: MinificationTextureFilter

Default Value

THREE.NearestFilter

-

generateMipmaps

generateMipmaps: boolean

Depth textures do not use mipmaps.

-

Default Value

false

-

format

format: DepthTexturePixelFormat

See

Texture.format

-

Default Value

THREE.DepthFormat.

-

type

type: TextureDataType

Default Value

THREE.UnsignedByteType when .format === THREE.DepthFormat

-

Default Value

THREE.UnsignedInt248Type when .format === THREE.DepthStencilFormat

-

compareFunction

compareFunction: null | TextureComparisonFunction

This is used to define the comparison function used when comparing texels in the depth texture to the value in
-the depth buffer. Default is null which means comparison is disabled.

-

See THREE.TextureComparisonFunction for functions.

-

ReadonlyisTexture

isTexture: true

Read-only flag to check if a given object is of type Texture.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Texture instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

source

source: Source

The data definition of a texture. A reference to the data source can be shared across textures.
-This is often useful in context of spritesheets where multiple textures render the same data
-but with different Texture transformations.

-

mipmaps

mipmaps:
    | undefined
    | CompressedTextureMipmap[]
    | CubeTexture[]
    | HTMLCanvasElement[]

Array of user-specified mipmaps

-

Default Value

[]

-

mapping

mapping: AnyMapping

How the image is applied to the object.

-

Remarks

All Texture types except THREE.CubeTexture expect the values be THREE.Mapping

-

See

Texture Constants

-

Default Value

value of THREE.Texture.DEFAULT_MAPPING

-

channel

channel: number

Lets you select the uv attribute to map the texture to. 0 for uv, 1 for uv1, 2 for uv2 and 3 for
-uv3.

-

wrapS

wrapS: Wrapping

This defines how the Texture is wrapped horizontally and corresponds to U in UV mapping.

-

Remarks

for WEBGL1 - tiling of images in textures only functions if image dimensions are powers of two
-(2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, ...) in terms of pixels.
-Individual dimensions need not be equal, but each must be a power of two. This is a limitation of WebGL1, not three.js.
-WEBGL2 does not have this limitation.

-

See

-

Default Value

THREE.ClampToEdgeWrapping

-

wrapT

wrapT: Wrapping

This defines how the Texture is wrapped vertically and corresponds to V in UV mapping.

-

Remarks

for WEBGL1 - tiling of images in textures only functions if image dimensions are powers of two
-(2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, ...) in terms of pixels.
-Individual dimensions need not be equal, but each must be a power of two. This is a limitation of WebGL1, not three.js.
-WEBGL2 does not have this limitation.

-

See

-

Default Value

THREE.ClampToEdgeWrapping

-

anisotropy

anisotropy: number

The number of samples taken along the axis through the pixel that has the highest density of texels.

-

Remarks

A higher value gives a less blurry result than a basic mipmap, at the cost of more Texture samples being used.

-

Default

value of THREE.Texture.DEFAULT_ANISOTROPY. That is normally 1.

-

internalFormat

internalFormat: null | PixelFormatGPU

The GPU Pixel Format allows the developer to specify how the data is going to be stored on the GPU.

-

Remarks

Compatible only with WebGL2RenderingContext | WebGL 2 Rendering Context.

-

See

Texture Constants

-

Default Value

The default value is obtained using a combination of .format and .type.

-

matrix

matrix: Matrix3

The uv-transform matrix for the texture.

-

Remarks

When .matrixAutoUpdate property is true.
-Will be updated by the renderer from the properties:

- -

See

.matrixAutoUpdate

-

Default Value

new THREE.Matrix3()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

Whether is to update the texture's uv-transform .matrix.

-

Remarks

Set this to false if you are specifying the uv-transform matrix directly.

-

See

.matrix

-

Default Value

true

-

offset

offset: Vector2

How much a single repetition of the texture is offset from the beginning, in each direction U and V.

-

Remarks

Typical range is 0.0 to 1.0.

-

Default Value

new THREE.Vector2(0, 0)

-

repeat

repeat: Vector2

How many times the texture is repeated across the surface, in each direction U and V.

-

Remarks

If repeat is set greater than 1 in either direction, the corresponding Wrap parameter should
-also be set to THREE.RepeatWrapping or THREE.MirroredRepeatWrapping to achieve the desired tiling effect.

-

See

-

Default Value

new THREE.Vector2( 1, 1 )

-

center

center: Vector2

The point around which rotation occurs.

-

Remarks

A value of (0.5, 0.5) corresponds to the center of the texture.

-

Default Value

new THREE.Vector2( 0, 0 ), lower left.

-

rotation

rotation: number

How much the texture is rotated around the center point, in radians.

-

Remarks

Positive values are counter-clockwise.

-

Default Value

0

-

premultiplyAlpha

premultiplyAlpha: boolean

If set to true, the alpha channel, if present, is multiplied into the color channels when the texture is uploaded to the GPU.

-

Remarks

Note that this property has no effect for ImageBitmap.
-You need to configure on bitmap creation instead. See THREE.ImageBitmapLoader | ImageBitmapLoader.

-

See

THREE.ImageBitmapLoader | ImageBitmapLoader.

-

Default Value

false

-

unpackAlignment

unpackAlignment: number

Specifies the alignment requirements for the start of each pixel row in memory.

-

Remarks

The allowable values are:

-
    -
  • 1 (byte-alignment)
    • -
  • 2 (rows aligned to even-numbered bytes)
    • -
  • 4 (word-alignment)
    • -
  • 8 (rows start on double-word boundaries).
    • -
-

See

glPixelStorei for more information.

-

Default Value

4

-

colorSpace

colorSpace: string

The Textures | {@link Texture constants} page for details of other color spaces.

-

Remarks

Textures containing color data should be annotated with SRGBColorSpace THREE.SRGBColorSpace or
-LinearSRGBColorSpace THREE.LinearSRGBColorSpace.

-

See

-

Default Value

THREE.NoColorSpace

-

isRenderTargetTexture

isRenderTargetTexture: boolean

Indicates whether a texture belongs to a render target or not

-

Default Value

false

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the texture.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default Value

{}

-

version

version: number

This starts at 0 and counts how many times .needsUpdate is set to true.

-

Remarks

Expects a Integer

-

Default Value

0

-

pmremVersion

pmremVersion: number

Indicates whether this texture should be processed by PMREMGenerator or not (only relevant for render target
-textures)

-

onUpdate

onUpdate: () => void

A callback function, called when the texture is updated (e.g., when needsUpdate has been set to true and then the texture is used).

-

Accessors

image

  • get image(): { width: number; height: number }

  • Overridden with a record type holding width and height.

    -

    Returns { width: number; height: number }

  • set image(value: { width: number; height: number }): void

  • An image object, typically created using the THREE.TextureLoader.load | TextureLoader.load() method.

    -

    Parameters

    • value: { width: number; height: number }

    Returns void

    Remarks

    This can be any image (e.g., PNG, JPG, GIF, DDS) or video (e.g., MP4, OGG/OGV) type supported by three.js.

    -

needsUpdate

  • set needsUpdate(value: boolean): void

  • Set this to true to trigger an update next time the texture is used. Particularly important for setting the wrap mode.

    -

    Parameters

    • value: boolean

    Returns void

needsPMREMUpdate

  • set needsPMREMUpdate(value: boolean): void

  • Indicates whether this texture should be processed by THREE.PMREMGenerator or not.

    -

    Parameters

    • value: boolean

    Returns void

    Remarks

    Only relevant for render target textures.

    -

    Default Value

    false

    -

Methods

transformUv

updateMatrix

clone

  • clone(): this

  • Make copy of the texture

    -

    Returns this

    Remarks

    Note this is not a "deep copy", the image is shared

    -

copy

  • copy(source: Texture): this

  • Parameters

    Returns this

toJSON

dispose

  • dispose(): void

  • Frees the GPU-related resources allocated by this instance

    -

    Returns void

    Remarks

    Call this method whenever this instance is no longer used in your app.

    -

addEventListener

  • addEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, DepthTexture>,
    ): void

  • Adds a listener to an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

      -
    • listener: EventListener<{ dispose: {} }[T], T, DepthTexture>

      The function that gets called when the event is fired.

      -

    Returns void

hasEventListener

  • hasEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, DepthTexture>,
    ): boolean

  • Checks if listener is added to an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

      -
    • listener: EventListener<{ dispose: {} }[T], T, DepthTexture>

      The function that gets called when the event is fired.

      -

    Returns boolean

removeEventListener

  • removeEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, DepthTexture>,
    ): void

  • Removes a listener from an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of the listener that gets removed.

      -
    • listener: EventListener<{ dispose: {} }[T], T, DepthTexture>

      The listener function that gets removed.

      -

    Returns void

dispatchEvent

  • dispatchEvent<T extends "dispose">(
        event: BaseEvent<T> & { dispose: {} }[T],
    ): void

  • Fire an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • event: BaseEvent<T> & { dispose: {} }[T]

      The event that gets fired.

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/DiscreteInterpolant.html b/docs/classes/DiscreteInterpolant.html deleted file mode 100644 index f2dfccb..0000000 --- a/docs/classes/DiscreteInterpolant.html +++ /dev/null @@ -1,8 +0,0 @@ -DiscreteInterpolant | VFX-JS

Class DiscreteInterpolant

Hierarchy (View Summary)

Constructors

constructor -

Properties

parameterPositions -sampleValues -valueSize -resultBuffer -

Methods

interpolate_ -evaluate -

Constructors

constructor

  • new DiscreteInterpolant(
        parameterPositions: any,
        samplesValues: any,
        sampleSize: number,
        resultBuffer?: any,
    ): DiscreteInterpolant

  • Parameters

    • parameterPositions: any
    • samplesValues: any
    • sampleSize: number
    • OptionalresultBuffer: any

    Returns DiscreteInterpolant

Properties

parameterPositions

parameterPositions: any

sampleValues

sampleValues: any

valueSize

valueSize: number

resultBuffer

resultBuffer: any

Methods

interpolate_

  • interpolate_(i1: number, t0: number, t: number, t1: number): any

  • Parameters

    • i1: number
    • t0: number
    • t: number
    • t1: number

    Returns any

evaluate

  • evaluate(time: number): any

  • Parameters

    • time: number

    Returns any

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Euler.html b/docs/classes/Euler.html deleted file mode 100644 index 40ce580..0000000 --- a/docs/classes/Euler.html +++ /dev/null @@ -1,33 +0,0 @@ -Euler | VFX-JS

Class Euler

Constructors

constructor -

Properties

DEFAULT_ORDER -x -y -z -order -isEuler -_onChangeCallback -

Methods

set -clone -copy -setFromRotationMatrix -setFromQuaternion -setFromVector3 -reorder -equals -fromArray -toArray -_onChange -[iterator] -

Constructors

constructor

  • new Euler(x?: number, y?: number, z?: number, order?: EulerOrder): Euler

  • Parameters

    • Optionalx: number
    • Optionaly: number
    • Optionalz: number
    • Optionalorder: EulerOrder

    Returns Euler

Properties

StaticDEFAULT_ORDER

DEFAULT_ORDER: "XYZ"

x

x: number

Default

0
-
- -

y

y: number

Default

0
-
- -

z

z: number

Default

0
-
- -

order

order: EulerOrder

Default

THREE.Euler.DEFAULT_ORDER
-
- -

ReadonlyisEuler

isEuler: true

_onChangeCallback

_onChangeCallback: () => void

Methods

set

  • set(x: number, y: number, z: number, order?: EulerOrder): Euler

  • Parameters

    • x: number
    • y: number
    • z: number
    • Optionalorder: EulerOrder

    Returns Euler

clone

  • clone(): this

  • Returns this

copy

  • copy(euler: Euler): this

  • Parameters

    Returns this

setFromRotationMatrix

setFromQuaternion

setFromVector3

reorder

equals

  • equals(euler: Euler): boolean

  • Parameters

    Returns boolean

fromArray

toArray

  • toArray(
        array?: [x: number, y: number, z: number, order?: EulerOrder],
        offset?: number,
    ): EulerTuple

  • Parameters

    • Optionalarray: [x: number, y: number, z: number, order?: EulerOrder]
    • Optionaloffset: number

    Returns EulerTuple

_onChange

  • _onChange(callback: () => void): this

  • Parameters

    • callback: () => void

    Returns this

[iterator]

  • "[iterator]"(): Generator<string | number, void>

  • Returns Generator<string | number, void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/EventDispatcher.html b/docs/classes/EventDispatcher.html deleted file mode 100644 index 6a0ad3f..0000000 --- a/docs/classes/EventDispatcher.html +++ /dev/null @@ -1,27 +0,0 @@ -EventDispatcher | VFX-JS

Class EventDispatcher<TEventMap>

JavaScript events for custom objects

-

Example

// Adding events to a custom object
class Car extends EventDispatcher {
  start() {
    this.dispatchEvent( { type: 'start', message: 'vroom vroom!' } );
  }
};
// Using events with the custom object
const car = new Car();
car.addEventListener( 'start', ( event ) => {
  alert( event.message );
} );
car.start();
-
- -

See

-

Type Parameters

  • TEventMap extends {} = {}

Hierarchy (View Summary)

Constructors

constructor -

Methods

addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Methods

addEventListener

hasEventListener

removeEventListener

dispatchEvent

  • dispatchEvent<T extends string>(event: BaseEvent<T> & TEventMap[T]): void

  • Fire an event type.

    -

    Type Parameters

    • T extends string

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/Fog.html b/docs/classes/Fog.html deleted file mode 100644 index a9d14d6..0000000 --- a/docs/classes/Fog.html +++ /dev/null @@ -1,37 +0,0 @@ -Fog | VFX-JS

Class Fog

This class contains the parameters that define linear fog, i.e., that grows linearly denser with the distance.

-

Example

const scene = new THREE.Scene();
scene.fog = new THREE.Fog(0xcccccc, 10, 15);
-
- -

See

-

Constructors

constructor -

Properties

isFog -name -color -near -far -

Methods

clone -toJSON -

Constructors

constructor

  • new Fog(color: ColorRepresentation, near?: number, far?: number): Fog

  • The color parameter is passed to the THREE.Color | Color constructor to set the color property

    -

    Parameters

    • color: ColorRepresentation
    • Optionalnear: number

      Expects a Float

      -
    • Optionalfar: number

      Expects a Float

      -

    Returns Fog

    Remarks

    Color can be a hexadecimal integer or a CSS-style string.

    -

Properties

ReadonlyisFog

isFog: true

Read-only flag to check if a given object is of type Fog.

-

Remarks

This is a constant value

-

Default Value

true

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

color

color: Color

Fog color.

-

Remarks

If set to black, far away objects will be rendered black.

-

near

near: number

The minimum distance to start applying fog.

-

Remarks

Objects that are less than near units from the active camera won't be affected by fog.

-

Default Value

1

-

far

far: number

The maximum distance at which fog stops being calculated and applied.

-

Remarks

Objects that are more than far units away from the active camera won't be affected by fog.

-

Default Value

1000

-

Methods

clone

  • clone(): Fog

  • Returns a new Fog instance with the same parameters as this one.

    -

    Returns Fog

toJSON

  • toJSON(): FogJSON

  • Return Fog data in JSON format.

    -

    Returns FogJSON

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/FogExp2.html b/docs/classes/FogExp2.html deleted file mode 100644 index e3537e5..0000000 --- a/docs/classes/FogExp2.html +++ /dev/null @@ -1,33 +0,0 @@ -FogExp2 | VFX-JS

Class FogExp2

This class contains the parameters that define exponential squared fog, which gives a clear view near the camera and a faster than exponentially densening fog farther from the camera.

-

Example

const scene = new THREE.Scene();
scene.fog = new THREE.FogExp2(0xcccccc, 0.002);
-
- -

See

-

Constructors

constructor -

Properties

isFogExp2 -name -color -density -

Methods

clone -toJSON -

Constructors

constructor

  • new FogExp2(color: ColorRepresentation, density?: number): FogExp2

  • The color parameter is passed to the THREE.Color | Color constructor to set the color property

    -

    Parameters

    Returns FogExp2

    Remarks

    Color can be a hexadecimal integer or a CSS-style string.

    -

Properties

ReadonlyisFogExp2

isFogExp2: true

Read-only flag to check if a given object is of type FogExp2.

-

Remarks

This is a constant value

-

Default Value

true

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

color

color: Color

Fog color.

-

Remarks

If set to black, far away objects will be rendered black.

-

density

density: number

Defines how fast the fog will grow dense.

-

Default Value

0.00025

-

Remarks

Expects a Float

-

Methods

clone

  • clone(): FogExp2

  • Returns a new FogExp2 instance with the same parameters as this one.

    -

    Returns FogExp2

toJSON

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Frustum.html b/docs/classes/Frustum.html deleted file mode 100644 index fb63ec4..0000000 --- a/docs/classes/Frustum.html +++ /dev/null @@ -1,14 +0,0 @@ -Frustum | VFX-JS

Class Frustum

Frustums are used to determine what is inside the camera's field of view. They help speed up the rendering process.

-

Constructors

constructor -

Properties

planes -

Methods

set -clone -copy -setFromProjectionMatrix -intersectsObject -intersectsSprite -intersectsSphere -intersectsBox -containsPoint -

Constructors

constructor

Properties

planes

planes: Plane[]

Array of 6 vectors.

-

Methods

set

clone

  • clone(): this

  • Returns this

copy

  • copy(frustum: Frustum): this

  • Parameters

    Returns this

setFromProjectionMatrix

intersectsObject

  • intersectsObject(object: Object3D): boolean

  • Parameters

    Returns boolean

intersectsSprite

  • intersectsSprite(sprite: Sprite): boolean

  • Parameters

    Returns boolean

intersectsSphere

  • intersectsSphere(sphere: Sphere): boolean

  • Parameters

    Returns boolean

intersectsBox

  • intersectsBox(box: Box3): boolean

  • Parameters

    Returns boolean

containsPoint

  • containsPoint(point: Vector3): boolean

  • Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/GLBufferAttribute.html b/docs/classes/GLBufferAttribute.html deleted file mode 100644 index 5e81674..0000000 --- a/docs/classes/GLBufferAttribute.html +++ /dev/null @@ -1,73 +0,0 @@ -GLBufferAttribute | VFX-JS

Class GLBufferAttribute

This buffer attribute class does not construct a VBO.
-Instead, it uses whatever VBO is passed in constructor and can later be altered via the .buffer property.

-

Remarks

It is required to pass additional params alongside the VBO
-Those are: the GL context, the GL data type, the number of components per vertex, the number of bytes per component, and the number of vertices.

-

See

-

Constructors

constructor -

Properties

isGLBufferAttribute -name -buffer -type -itemSize -elementSize -count -version -

Accessors

needsUpdate -

Methods

setBuffer -setType -setItemSize -setCount -

Constructors

constructor

  • new GLBufferAttribute(
        buffer: WebGLBuffer,
        type: number,
        itemSize: number,
        elementSize: 1 | 2 | 4,
        count: number,
    ): GLBufferAttribute

  • This creates a new GLBufferAttribute object.

    -

    Parameters

    Returns GLBufferAttribute

Properties

ReadonlyisGLBufferAttribute

isGLBufferAttribute: true

Read-only flag to check if a given object is of type GLBufferAttribute.

-

Remarks

This is a constant value

-

Default Value

true

-

name

name: string

Optional name for this attribute instance.

-

Default Value

""

-

buffer

buffer: WebGLBuffer

The current WebGLBuffer instance.

-

type

type: number

A WebGL Data Type describing the underlying VBO contents.

-

WebGL Data Type (GLenum)

    -
  • gl.BYTE: 0x1400
    • -
  • gl.UNSIGNED_BYTE: 0x1401
    • -
  • gl.SHORT: 0x1402
    • -
  • gl.UNSIGNED_SHORT: 0x1403
    • -
  • gl.INT: 0x1404
    • -
  • gl.UNSIGNED_INT: 0x1405
    • -
  • gl.FLOAT: 0x1406
    • -
-

Remarks

Set this property together with .elementSize. The recommended way is using the .setType() method.

-

itemSize

itemSize: number

How many values make up each item (vertex).

-

Remarks

The number of values of the array that should be associated with a particular vertex.
-For instance, if this attribute is storing a 3-component vector (such as a position, normal, or color), then itemSize should be 3.

-

elementSize

elementSize: 1 | 2 | 4

Stores the corresponding size in bytes for the current .type property value.

-

The corresponding size (in bytes) for the given "type" param.

-

WebGL Data Type (GLenum)

    -
  • gl.BYTE: 1
    • -
  • gl.UNSIGNED_BYTE: 1
    • -
  • gl.SHORT: 2
    • -
  • gl.UNSIGNED_SHORT: 2
    • -
  • gl.INT: 4
    • -
  • gl.UNSIGNED_INT: 4
    • -
  • gl.FLOAT: 4
    • -
-

Remarks

Set this property together with .type. The recommended way is using the .setType method.

-

See

constructor`` for a list of known type sizes. @remarks Expects a 1, 2or4`

-

count

count: number

The expected number of vertices in VBO.

-

Remarks

Expects a Integer

-

version

version: number

A version number, incremented every time the needsUpdate property is set to true.

-

Remarks

Expects a Integer

-

Accessors

needsUpdate

  • set needsUpdate(value: boolean): void

  • Setting this to true increments .version.

    -

    Parameters

    • value: boolean

    Returns void

    Remarks

    set-only property.

    -

Methods

setBuffer

  • setBuffer(buffer: WebGLBuffer): this

  • Sets the .buffer property.

    -

    Parameters

    Returns this

setType

  • setType(type: number, elementSize: 1 | 2 | 4): this

  • Sets the both type and elementSize properties.

    -

    Parameters

    • type: number
    • elementSize: 1 | 2 | 4

    Returns this

setItemSize

  • setItemSize(itemSize: number): this

  • Sets the itemSize property.

    -

    Parameters

    • itemSize: number

    Returns this

setCount

  • setCount(count: number): this

  • Sets the count property.

    -

    Parameters

    • count: number

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/Group.html b/docs/classes/Group.html deleted file mode 100644 index 97f4744..0000000 --- a/docs/classes/Group.html +++ /dev/null @@ -1,334 +0,0 @@ -Group | VFX-JS

Class Group<TEventMap>

Its purpose is to make working with groups of objects syntactically clearer.

-

Remarks

This is almost identical to an Object3D

-

Example

const geometry = new THREE.BoxGeometry(1, 1, 1);
const material = new THREE.MeshBasicMaterial({
    color: 0x00ff00
});
const cubeA = new THREE.Mesh(geometry, material);
cubeA.position.set(100, 100, 0);
const cubeB = new THREE.Mesh(geometry, material);
cubeB.position.set(-100, -100, 0);
//create a {@link Group} and add the two cubes
//These cubes can now be rotated / scaled etc as a {@link Group}  * const {@link Group} = new THREE.Group();
group.add(cubeA);
group.add(cubeB);
scene.add(group);
-
- -

See

-

Type Parameters

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_UP -DEFAULT_MATRIX_AUTO_UPDATE -DEFAULT_MATRIX_WORLD_AUTO_UPDATE -isGroup -isObject3D -id -uuid -name -type -parent -children -up -position -rotation -quaternion -scale -modelViewMatrix -normalMatrix -matrix -matrixWorld -matrixAutoUpdate -matrixWorldAutoUpdate -matrixWorldNeedsUpdate -layers -visible -castShadow -receiveShadow -frustumCulled -renderOrder -animations -userData -customDepthMaterial? -customDistanceMaterial? -

Methods

onBeforeShadow -onAfterShadow -onBeforeRender -onAfterRender -applyMatrix4 -applyQuaternion -setRotationFromAxisAngle -setRotationFromEuler -setRotationFromMatrix -setRotationFromQuaternion -rotateOnAxis -rotateOnWorldAxis -rotateX -rotateY -rotateZ -translateOnAxis -translateX -translateY -translateZ -localToWorld -worldToLocal -lookAt -add -remove -removeFromParent -clear -attach -getObjectById -getObjectByName -getObjectByProperty -getObjectsByProperty -getWorldPosition -getWorldQuaternion -getWorldScale -getWorldDirection -raycast -traverse -traverseVisible -traverseAncestors -updateMatrix -updateMatrixWorld -updateWorldMatrix -toJSON -clone -copy -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

StaticDEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight,
-THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

-

Default Value

new THREE.Vector3( 0, 1, 0)

-

StaticDEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

StaticDEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

ReadonlyisGroup

isGroup: true

Read-only flag to check if a given object is of type Group.

-

Remarks

This is a constant value

-

Default Value

true

-

ReadonlyisObject3D

isObject3D: true

Flag to check if a given object is of type Object3D.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Object3D instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
-Expects a Integer

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

Readonlytype

type: string

A Read-only string to check this object type.

-

Remarks

This can be used to find a specific type of Object3D in a scene.
-Sub-classes will update this value.

-

Default Value

Object3D

-

parent

parent: null | Object3D

Object's parent in the scene graph.

-

Remarks

An object can have at most one parent.

-

Default Value

null

-

children

children: Object3D[]

Array with object's children.

-

See

THREE.Object3DGroup | Group for info on manually grouping objects.

-

Default Value

[]

-

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

-

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

-

Readonlyposition

position: Vector3

Object's local position.

-

Default Value

new THREE.Vector3() - that is (0, 0, 0).

-

Readonlyrotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

-

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

-

Readonlyquaternion

quaternion: Quaternion

Object's local rotation as a THREE.Quaternion | Quaternion.

-

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

-

Readonlyscale

scale: Vector3

The object's local scale.

-

Default Value

new THREE.Vector3( 1, 1, 1 )

-

ReadonlymodelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

-

ReadonlynormalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

-

matrix

matrix: Matrix4

The local transform matrix.

-

Default Value

new THREE.Matrix4()

-

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

-

Remarks

If the Object3D has no parent, then it's identical to the local transform THREE.Object3D.matrix | .matrix.

-

Default Value

new THREE.Matrix4()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and
-scale every frame and also recalculates the matrixWorld property.

-

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

-

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates.
-When it isn't, then you have to maintain all matrices in the object and its children yourself.

-

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

-

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

-

Default Value

false

-

layers

layers: Layers

The layer membership of the object.

-

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use.
-This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.

-

Default Value

new THREE.Layers()

-

visible

visible: boolean

Object gets rendered if true.

-

Default Value

true

-

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

-

Default Value

false

-

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

-

Default Value

false

-

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object.
-If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

-

Default Value

true

-

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph
-objects to be overridden although opaque and transparent objects remain sorted independently.

-

Remarks

When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.
-Sorting is from lowest to highest renderOrder.

-

Default Value

0

-

animations

animations: AnimationClip[]

Array with object's animation clips.

-

Default Value

[]

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the Object3D.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default

{}

-

OptionalcustomDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

-

Remarks

Can only be used in context of meshes.
-When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight,
-if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

-

Default Value

undefined

-

OptionalcustomDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

-

Default Value

undefined

-

Methods

onBeforeShadow

  • onBeforeShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterShadow

  • onAfterShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onBeforeRender

  • onBeforeRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterRender

  • onAfterRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

applyMatrix4

  • applyMatrix4(matrix: Matrix4): void

  • Applies the matrix transform to the object and updates the object's position, rotation and scale.

    -

    Parameters

    Returns void

applyQuaternion

  • applyQuaternion(quaternion: Quaternion): this

  • Applies the rotation represented by the quaternion to the object.

    -

    Parameters

    Returns this

setRotationFromAxisAngle

  • setRotationFromAxisAngle(axis: Vector3, angle: number): void

  • Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      Angle in radians. Expects a Float

      -

    Returns void

setRotationFromEuler

  • setRotationFromEuler(euler: Euler): void

  • Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.

    -

    Parameters

    • euler: Euler

      Euler angle specifying rotation amount.

      -

    Returns void

setRotationFromMatrix

  • setRotationFromMatrix(m: Matrix4): void

  • Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

    -

    Parameters

    • m: Matrix4

      Rotate the quaternion by the rotation component of the matrix.

      -

    Returns void

    Remarks

    Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

    -

setRotationFromQuaternion

rotateOnAxis

  • rotateOnAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in object space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

rotateOnWorldAxis

  • rotateOnWorldAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in world space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in world space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized
    -Method Assumes no rotated parent.

    -

rotateX

  • rotateX(angle: number): this

  • Rotates the object around x axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateY

  • rotateY(angle: number): this

  • Rotates the object around y axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateZ

  • rotateZ(angle: number): this

  • Rotates the object around z axis in local space.

    -

    Parameters

    • angle: number

    Returns this

translateOnAxis

  • translateOnAxis(axis: Vector3, distance: number): this

  • Translate an object by distance along an axis in object space

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • distance: number

      The distance to translate. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

translateX

  • translateX(distance: number): this

  • Translates object along x axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateY

  • translateY(distance: number): this

  • Translates object along y axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateZ

  • translateZ(distance: number): this

  • Translates object along z axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

localToWorld

  • localToWorld(vector: Vector3): Vector3

  • Converts the vector from this object's local space to world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in this object's local space.

      -

    Returns Vector3

worldToLocal

  • worldToLocal(vector: Vector3): Vector3

  • Converts the vector from world space to this object's local space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space.

      -

    Returns Vector3

lookAt

  • lookAt(vector: Vector3): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space to look at.

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -
  • lookAt(x: number, y: number, z: number): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -

add

  • add(...object: Object3D[]): this

  • Adds another Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be added
    -Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.

    -

    See

      -
    • attach
      • -
    • THREE.Group | Group for info on manually grouping objects.
      • -
    -

remove

  • remove(...object: Object3D[]): this

  • Removes a Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be removed.

    -

    See

    THREE.Group | Group for info on manually grouping objects.

    -

removeFromParent

  • removeFromParent(): this

  • Removes this object from its current parent.

    -

    Returns this

clear

  • clear(): this

  • Removes all child objects.

    -

    Returns this

attach

  • attach(object: Object3D): this

  • Adds a Object3D as a child of this, while maintaining the object's world transform.

    -

    Parameters

    Returns this

    Remarks

    Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

    -

    See

    add

    -

getObjectById

  • getObjectById(id: number): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    -

    Parameters

    • id: number

      Unique number of the object instance. Expects a Integer

      -

    Returns undefined | Object3D

    Remarks

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    -

    See

    id

    -

getObjectByName

  • getObjectByName(name: string): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

    -

    Parameters

    • name: string

      String to match to the children's Object3D.name property.

      -

    Returns undefined | Object3D

    Remarks

    Note that for most objects the name is an empty string by default
    -You will have to set it manually to make use of this method.

    -

getObjectByProperty

  • getObjectByProperty(name: string, value: any): undefined | Object3D

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      the property name to search for.

      -
    • value: any

      value of the given property.

      -

    Returns undefined | Object3D

getObjectsByProperty

  • getObjectsByProperty(
        name: string,
        value: any,
        optionalTarget?: Object3D[],
    ): Object3D[]

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      The property name to search for.

      -
    • value: any

      Value of the given property.

      -
    • OptionaloptionalTarget: Object3D[]

      target to set the result. Otherwise a new Array is instantiated. If set, you must clear
      -this array prior to each call (i.e., array.length = 0;).

      -

    Returns Object3D[]

getWorldPosition

  • getWorldPosition(target: Vector3): Vector3

  • Returns a vector representing the position of the object in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldQuaternion

getWorldScale

  • getWorldScale(target: Vector3): Vector3

  • Returns a vector of the scaling factors applied to the object for each axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldDirection

  • getWorldDirection(target: Vector3): Vector3

  • Returns a vector representing the direction of object's positive z-axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

raycast

  • raycast(raycaster: Raycaster, intersects: Intersection[]): void

  • Abstract (empty) method to get intersections between a casted ray and this object

    -

    Parameters

    Returns void

    Remarks

    Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

    -

    See

    THREE.Raycaster | Raycaster

    -

    Default Value

    () => {}

    -

traverse

  • traverse(callback: (object: Object3D) => any): void

  • Executes the callback on this object and all descendants.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseVisible

  • traverseVisible(callback: (object: Object3D) => any): void

  • Like traverse, but the callback will only be executed for visible objects

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Descendants of invisible objects are not traversed.
    -Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseAncestors

  • traverseAncestors(callback: (object: Object3D) => any): void

  • Executes the callback on all ancestors.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

updateMatrix

  • updateMatrix(): void

  • Updates local transform.

    -

    Returns void

updateMatrixWorld

  • updateMatrixWorld(force?: boolean): void

  • Updates the global transform of the object.
    -And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

    -

    Parameters

    • Optionalforce: boolean

      A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame.
      -Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

      -

    Returns void

updateWorldMatrix

  • updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void

  • Updates the global transform of the object.

    -

    Parameters

    • updateParents: boolean

      Recursively updates global transform of ancestors.

      -
    • updateChildren: boolean

      Recursively updates global transform of descendants.

      -

    Returns void

toJSON

clone

  • clone(recursive?: boolean): this

  • Returns a clone of this object and optionally all descendants.

    -

    Parameters

    • Optionalrecursive: boolean

      If true, descendants of the object are also cloned. Default true

      -

    Returns this

copy

  • copy(object: Object3D, recursive?: boolean): this

  • Copies the given object into this object.

    -

    Parameters

    • object: Object3D
    • Optionalrecursive: boolean

      If set to true, descendants of the object are copied next to the existing ones. If set to
      -false, descendants are left unchanged. Default is true.

      -

    Returns this

    Remarks

    Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

    -

addEventListener

hasEventListener

removeEventListener

dispatchEvent

  • dispatchEvent<T extends string>(event: BaseEvent<T> & TEventMap[T]): void

  • Fire an event type.

    -

    Type Parameters

    • T extends string

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/IndirectStorageBufferAttribute.html b/docs/classes/IndirectStorageBufferAttribute.html deleted file mode 100644 index 9cd4fd9..0000000 --- a/docs/classes/IndirectStorageBufferAttribute.html +++ /dev/null @@ -1,150 +0,0 @@ -IndirectStorageBufferAttribute | VFX-JS

Class IndirectStorageBufferAttribute

This class stores data for an attribute (such as vertex positions, face indices, normals, colors, UVs, and any custom attributes )
-associated with a THREE.BufferGeometry | BufferGeometry, which allows for more efficient passing of data to the GPU

-

Remarks

When working with vector-like data, the .fromBufferAttribute( attribute, index ) helper methods on
-THREE.Vector2.fromBufferAttribute | Vector2,
-THREE.Vector3.fromBufferAttribute | Vector3,
-THREE.Vector4.fromBufferAttribute | Vector4, and
-THREE.Color.fromBufferAttribute | Color classes may be helpful.

-

See

-

Hierarchy (View Summary)

  • default
    • IndirectStorageBufferAttribute

Constructors

constructor -

Properties

isIndirectStorageBufferAttribute -isStorageBufferAttribute -name -array -itemSize -usage -gpuType -updateRanges -version -normalized -count -isBufferAttribute -onUploadCallback -

Accessors

needsUpdate -

Methods

onUpload -setUsage -addUpdateRange -clearUpdateRanges -clone -copy -copyAt -copyArray -applyMatrix3 -applyMatrix4 -applyNormalMatrix -transformDirection -set -getComponent -setComponent -getX -setX -getY -setY -getZ -setZ -getW -setW -setXY -setXYZ -setXYZW -toJSON -

Constructors

constructor

Properties

ReadonlyisIndirectStorageBufferAttribute

isIndirectStorageBufferAttribute: true

ReadonlyisStorageBufferAttribute

isStorageBufferAttribute: true

name

name: string

Optional name for this attribute instance.

-

Default Value

''
-
- -

array

array: TypedArray

The TypedArray holding data stored in the buffer.

-

Returns

TypedArray

-

itemSize

itemSize: number

The length of vectors that are being stored in the array.

-

Remarks

Expects a Integer

-

usage

usage: Usage

Defines the intended usage pattern of the data store for optimization purposes.
-Corresponds to the usage parameter of
-WebGLRenderingContext.bufferData.

-

Remarks

After the initial use of a buffer, its usage cannot be changed. Instead, instantiate a new one and set the desired usage before the next render.

-

See

-

Default Value

THREE.StaticDrawUsage | THREE.StaticDrawUsage.

-

gpuType

gpuType: AttributeGPUType

Configures the bound GPU type for use in shaders. Either FloatType or IntType, default is FloatType.

-

Note: this only has an effect for integer arrays and is not configurable for float arrays. For lower precision
-float types, see https://threejs.org/docs/#api/en/core/bufferAttributeTypes/BufferAttributeTypes.

-

updateRanges

updateRanges: { start: number; count: number }[]

This can be used to only update some components of stored vectors (for example, just the component related to
-color). Use the .addUpdateRange function to add ranges to this array.

-

Type declaration

  • start: number

    Position at which to start update.

    -
  • count: number

    The number of components to update.

    -

version

version: number

A version number, incremented every time the needsUpdate property is set to true.

-

Remarks

Expects a Integer

-

Default Value

0

-

normalized

normalized: boolean

Indicates how the underlying data in the buffer maps to the values in the GLSL shader code.

-

See

constructor above for details.

-

Default Value

false

-

Readonlycount

count: number

Represents the number of items this buffer attribute stores. It is internally computed by dividing the
-array's length by the itemSize. Read-only
-property.

-

ReadonlyisBufferAttribute

isBufferAttribute: true

Read-only flag to check if a given object is of type BufferAttribute.

-

Remarks

This is a constant value

-

Default Value

true

-

onUploadCallback

onUploadCallback: () => void

A callback function that is executed after the Renderer has transferred the attribute array data to the GPU.

-

Accessors

needsUpdate

  • set needsUpdate(value: boolean): void

  • Flag to indicate that this attribute has changed and should be re-sent to the GPU.
    -Set this to true when you modify the value of the array.

    -

    Parameters

    • value: boolean

    Returns void

    Remarks

    Setting this to true also increments the version.

    -

Methods

onUpload

  • onUpload(callback: () => void): this

  • Sets the value of the onUploadCallback property.

    -

    Parameters

    • callback: () => void

      function that is executed after the Renderer has transferred the attribute array data to the GPU.

      -

    Returns this

    See

    -

setUsage

  • setUsage(usage: Usage): this

  • Set usage

    -

    Parameters

    Returns this

    Remarks

    After the initial use of a buffer, its usage cannot be changed. Instead, instantiate a new one and set the desired usage before the next render.

    -

    See

    -

addUpdateRange

  • addUpdateRange(start: number, count: number): void

  • Adds a range of data in the data array to be updated on the GPU. Adds an object describing the range to the
    -.updateRanges array.

    -

    Parameters

    • start: number
    • count: number

    Returns void

clearUpdateRanges

  • clearUpdateRanges(): void

  • Clears the .updateRanges array.

    -

    Returns void

clone

copy

copyAt

  • copyAt(index1: number, attribute: BufferAttribute, index2: number): this

  • Copy a vector from bufferAttribute[index2] to array[index1].

    -

    Parameters

    Returns this

copyArray

  • copyArray(array: ArrayLike<number>): this

  • Copy the array given here (which can be a normal array or TypedArray) into array.

    -

    Parameters

    Returns this

    See

    TypedArray.set for notes on requirements if copying a TypedArray.

    -

applyMatrix3

applyMatrix4

applyNormalMatrix

transformDirection

  • transformDirection(m: Matrix4): this

  • Applies matrix m to every Vector3 element of this BufferAttribute, interpreting the elements as a direction vectors.

    -

    Parameters

    Returns this

set

getComponent

  • getComponent(index: number, component: number): number

  • Returns the given component of the vector at the given index.

    -

    Parameters

    • index: number
    • component: number

    Returns number

setComponent

  • setComponent(index: number, component: number, value: number): void

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

    -

    Parameters

    • index: number
    • component: number
    • value: number

    Returns void

getX

  • getX(index: number): number

  • Returns the x component of the vector at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -

    Returns number

setX

  • setX(index: number, x: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • x: number

    Returns this

getY

  • getY(index: number): number

  • Returns the y component of the vector at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -

    Returns number

setY

  • setY(index: number, y: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • y: number

    Returns this

getZ

  • getZ(index: number): number

  • Returns the z component of the vector at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -

    Returns number

setZ

  • setZ(index: number, z: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • z: number

    Returns this

getW

  • getW(index: number): number

  • Returns the w component of the vector at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -

    Returns number

setW

  • setW(index: number, z: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • z: number

    Returns this

setXY

  • setXY(index: number, x: number, y: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • x: number
    • y: number

    Returns this

setXYZ

  • setXYZ(index: number, x: number, y: number, z: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • x: number
    • y: number
    • z: number

    Returns this

setXYZW

  • setXYZW(index: number, x: number, y: number, z: number, w: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • x: number
    • y: number
    • z: number
    • w: number

    Returns this

toJSON

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/InterleavedBuffer.html b/docs/classes/InterleavedBuffer.html deleted file mode 100644 index 9a6be0d..0000000 --- a/docs/classes/InterleavedBuffer.html +++ /dev/null @@ -1,89 +0,0 @@ -InterleavedBuffer | VFX-JS

Class InterleavedBuffer

"Interleaved" means that multiple attributes, possibly of different types, (e.g., position, normal, uv, color) are packed into a single array buffer.
-An introduction into interleaved arrays can be found here: Interleaved array basics

-

See

-

Constructors

constructor -

Properties

isInterleavedBuffer -array -stride -usage -updateRanges -version -count -uuid -onUploadCallback -

Accessors

needsUpdate -

Methods

onUpload -set -setUsage -addUpdateRange -clearUpdateRanges -copy -copyAt -clone -toJSON -

Constructors

constructor

Properties

ReadonlyisInterleavedBuffer

isInterleavedBuffer: true

array

array: TypedArray

A TypedArray with a shared buffer. Stores the geometry data.

-

stride

stride: number

The number of TypedArray elements per vertex.

-

Remarks

Expects a Integer

-

usage

usage: Usage

Defines the intended usage pattern of the data store for optimization purposes.
-Corresponds to the usage parameter of
-WebGLRenderingContext.bufferData.

-

Remarks

After the initial use of a buffer, its usage cannot be changed. Instead, instantiate a new one and set the desired usage before the next render.

-

See

-

Default Value

THREE.StaticDrawUsage | THREE.StaticDrawUsage.

-

updateRanges

updateRanges: { start: number; count: number }[]

This can be used to only update some components of stored data. Use the .addUpdateRange function to add
-ranges to this array.

-

Type declaration

  • start: number

    Position at which to start update.

    -
  • count: number

    The number of components to update.

    -

version

version: number

A version number, incremented every time the needsUpdate property is set to true.

-

Remarks

Expects a Integer

-

Default Value

0

-

count

count: number

Gives the total number of elements in the array.

-

Remarks

Expects a Integer

-

Default Value

0
-
- -

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

onUploadCallback

onUploadCallback: () => void

A callback function that is executed after the Renderer has transferred the geometry data to the GPU.

-

Accessors

needsUpdate

  • set needsUpdate(value: boolean): void

  • Flag to indicate that this attribute has changed and should be re-sent to the GPU.
    -Set this to true when you modify the value of the array.

    -

    Parameters

    • value: boolean

    Returns void

    Remarks

    Setting this to true also increments the version.

    -

Methods

onUpload

  • onUpload(callback: () => void): this

  • Sets the value of the onUploadCallback property.

    -

    Parameters

    • callback: () => void

      function that is executed after the Renderer has transferred the geometry data to the GPU.

      -

    Returns this

    See

    onUploadCallback

    -

set

  • set(value: ArrayLike<number>, offset: number): this

  • Calls TypedArray.set( value, offset )
    -on the array.

    -

    Parameters

    • value: ArrayLike<number>

      The source TypedArray.

      -
    • offset: number

      index of the array at which to start copying. Expects a Integer. Default 0.

      -

    Returns this

    Throws

    RangeError When offset is negative or is too large.

    -

setUsage

  • setUsage(value: Usage): this

  • Set usage

    -

    Parameters

    Returns this

    Remarks

    After the initial use of a buffer, its usage cannot be changed. Instead, instantiate a new one and set the desired usage before the next render.

    -

    See

    -

addUpdateRange

  • addUpdateRange(start: number, count: number): void

  • Adds a range of data in the data array to be updated on the GPU. Adds an object describing the range to the
    -.updateRanges array.

    -

    Parameters

    • start: number
    • count: number

    Returns void

clearUpdateRanges

  • clearUpdateRanges(): void

  • Clears the .updateRanges array.

    -

    Returns void

copy

copyAt

clone

  • clone(data: {}): InterleavedBuffer

  • Creates a clone of this InterleavedBuffer.

    -

    Parameters

    • data: {}

      This object holds shared array buffers required for properly cloning geometries with interleaved attributes.

      -

    Returns InterleavedBuffer

toJSON

  • toJSON(data: {}): { uuid: string; buffer: string; type: string; stride: number }

  • Serializes this InterleavedBuffer.
    -Converting to JSON Geometry format v4,

    -

    Parameters

    • data: {}

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

      -

    Returns { uuid: string; buffer: string; type: string; stride: number }

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/InterleavedBufferAttribute.html b/docs/classes/InterleavedBufferAttribute.html deleted file mode 100644 index 7f51c0d..0000000 --- a/docs/classes/InterleavedBufferAttribute.html +++ /dev/null @@ -1,97 +0,0 @@ -InterleavedBufferAttribute | VFX-JS

Class InterleavedBufferAttribute

See

-

Constructors

constructor -

Properties

name -data -itemSize -offset -normalized -isInterleavedBufferAttribute -

Accessors

count -array -needsUpdate -

Methods

applyMatrix4 -applyNormalMatrix -transformDirection -getComponent -setComponent -getX -setX -getY -setY -getZ -setZ -getW -setW -setXY -setXYZ -setXYZW -clone -toJSON -

Constructors

constructor

  • new InterleavedBufferAttribute(
        interleavedBuffer: InterleavedBuffer,
        itemSize: number,
        offset: number,
        normalized?: boolean,
    ): InterleavedBufferAttribute

  • Create a new instance of THREE.InterleavedBufferAttribute | InterleavedBufferAttribute.

    -

    Parameters

    • interleavedBuffer: InterleavedBuffer
    • itemSize: number
    • offset: number
    • Optionalnormalized: boolean

      Default false.

      -

    Returns InterleavedBufferAttribute

Properties

name

name: string

Optional name for this attribute instance.

-

Default Value

''

-

data

data: InterleavedBuffer

The InterleavedBuffer instance passed in the constructor.

-

itemSize

itemSize: number

How many values make up each item.

-

Remarks

Expects a Integer

-

offset

offset: number

The offset in the underlying array buffer where an item starts.

-

Remarks

Expects a Integer

-

normalized

normalized: boolean

Default Value

false

-

ReadonlyisInterleavedBufferAttribute

isInterleavedBufferAttribute: true

Read-only flag to check if a given object is of type InterleavedBufferAttribute.

-

Remarks

This is a constant value

-

Default Value

true

-

Accessors

count

  • get count(): number

  • The value of .data.count.
    -If the buffer is storing a 3-component item (such as a position, normal, or color), then this will count the number of such items stored.

    -

    Returns number

    Remarks

    get-only property.

    -

array

  • get array(): TypedArray

  • The value of data.array.

    -

    Returns TypedArray

    Remarks

    get-only property.

    -

needsUpdate

  • set needsUpdate(value: boolean): void

  • Flag to indicate that the .data (InterleavedBuffer) attribute has changed and should be re-sent to the GPU.

    -

    Parameters

    • value: boolean

    Returns void

    Remarks

    Setting this to have the same result of setting true also increments the InterleavedBuffer.needsUpdate of .data.

    -

Methods

applyMatrix4

  • applyMatrix4(m: Matrix4): this

  • Applies matrix m to every Vector3 element of this InterleavedBufferAttribute.

    -

    Parameters

    Returns this

applyNormalMatrix

  • applyNormalMatrix(m: Matrix3): this

  • Applies normal matrix m to every Vector3 element of this InterleavedBufferAttribute.

    -

    Parameters

    Returns this

transformDirection

  • transformDirection(m: Matrix4): this

  • Applies matrix m to every Vector3 element of this InterleavedBufferAttribute, interpreting the elements as a direction vectors.

    -

    Parameters

    Returns this

getComponent

  • getComponent(index: number, component: number): number

  • Returns the given component of the vector at the given index.

    -

    Parameters

    • index: number
    • component: number

    Returns number

setComponent

  • setComponent(index: number, component: number, value: number): this

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

    -

    Parameters

    • index: number
    • component: number
    • value: number

    Returns this

getX

  • getX(index: number): number

  • Returns the x component of the item at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -

    Returns number

setX

  • setX(index: number, x: number): this

  • Sets the x component of the item at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • x: number

      Expects a Float

      -

    Returns this

getY

  • getY(index: number): number

  • Returns the y component of the item at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -

    Returns number

setY

  • setY(index: number, y: number): this

  • Sets the y component of the item at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • y: number

      Expects a Float

      -

    Returns this

getZ

  • getZ(index: number): number

  • Returns the z component of the item at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -

    Returns number

setZ

  • setZ(index: number, z: number): this

  • Sets the z component of the item at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • z: number

      Expects a Float

      -

    Returns this

getW

  • getW(index: number): number

  • Returns the w component of the item at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -

    Returns number

setW

  • setW(index: number, z: number): this

  • Sets the w component of the item at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • z: number

    Returns this

setXY

  • setXY(index: number, x: number, y: number): this

  • Sets the x and y components of the item at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -

    Returns this

setXYZ

  • setXYZ(index: number, x: number, y: number, z: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -

    Returns this

setXYZW

  • setXYZW(index: number, x: number, y: number, z: number, w: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -
    • w: number

      Expects a Float

      -

    Returns this

clone

  • clone(data?: {}): BufferAttribute

  • Creates a clone of this InterleavedBufferAttribute.

    -

    Parameters

    • Optionaldata: {}

      This object holds shared array buffers required for properly cloning geometries with interleaved attributes.

      -

    Returns BufferAttribute

toJSON

  • toJSON(
        data?: {},
    ): {
        isInterleavedBufferAttribute: true;
        itemSize: number;
        data: string;
        offset: number;
        normalized: boolean;
    }

  • Serializes this InterleavedBufferAttribute.
    -Converting to JSON Geometry format v4,

    -

    Parameters

    • Optionaldata: {}

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

      -

    Returns {
        isInterleavedBufferAttribute: true;
        itemSize: number;
        data: string;
        offset: number;
        normalized: boolean;
    }

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/Interpolant.html b/docs/classes/Interpolant.html deleted file mode 100644 index a1b6ff7..0000000 --- a/docs/classes/Interpolant.html +++ /dev/null @@ -1,7 +0,0 @@ -Interpolant | VFX-JS

Class InterpolantAbstract

Hierarchy (View Summary)

Constructors

constructor -

Properties

parameterPositions -sampleValues -valueSize -resultBuffer -

Methods

evaluate -

Constructors

constructor

  • new Interpolant(
        parameterPositions: any,
        sampleValues: any,
        sampleSize: number,
        resultBuffer?: any,
    ): Interpolant

  • Parameters

    • parameterPositions: any
    • sampleValues: any
    • sampleSize: number
    • OptionalresultBuffer: any

    Returns Interpolant

Properties

parameterPositions

parameterPositions: any

sampleValues

sampleValues: any

valueSize

valueSize: number

resultBuffer

resultBuffer: any

Methods

evaluate

  • evaluate(time: number): any

  • Parameters

    • time: number

    Returns any

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/KeyframeTrack.html b/docs/classes/KeyframeTrack.html deleted file mode 100644 index c8b59e7..0000000 --- a/docs/classes/KeyframeTrack.html +++ /dev/null @@ -1,26 +0,0 @@ -KeyframeTrack | VFX-JS

Class KeyframeTrack

Constructors

constructor -

Properties

name -times -values -ValueTypeName -TimeBufferType -ValueBufferType -DefaultInterpolation -

Methods

toJSON -InterpolantFactoryMethodDiscrete -InterpolantFactoryMethodLinear -InterpolantFactoryMethodSmooth -setInterpolation -getInterpolation -createInterpolant -getValueSize -shift -scale -trim -validate -optimize -clone -

Constructors

constructor

Properties

name

name: string

times

times: Float32Array

values

values: Float32Array

ValueTypeName

ValueTypeName: string

TimeBufferType

TimeBufferType: Float32Array

ValueBufferType

ValueBufferType: Float32Array

DefaultInterpolation

DefaultInterpolation: InterpolationModes

Default

THREE.InterpolateLinear
-
- -

Methods

StatictoJSON

InterpolantFactoryMethodDiscrete

InterpolantFactoryMethodLinear

  • InterpolantFactoryMethodLinear(result: any): LinearInterpolant

  • Parameters

    • result: any

    Returns LinearInterpolant

InterpolantFactoryMethodSmooth

  • InterpolantFactoryMethodSmooth(result: any): CubicInterpolant

  • Parameters

    • result: any

    Returns CubicInterpolant

setInterpolation

getInterpolation

createInterpolant

  • createInterpolant(): Interpolant

  • Returns Interpolant

getValueSize

  • getValueSize(): number

  • Returns number

shift

  • shift(timeOffset: number): KeyframeTrack

  • Parameters

    • timeOffset: number

    Returns KeyframeTrack

scale

  • scale(timeScale: number): KeyframeTrack

  • Parameters

    • timeScale: number

    Returns KeyframeTrack

trim

  • trim(startTime: number, endTime: number): KeyframeTrack

  • Parameters

    • startTime: number
    • endTime: number

    Returns KeyframeTrack

validate

  • validate(): boolean

  • Returns boolean

optimize

clone

  • clone(): this

  • Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Layers.html b/docs/classes/Layers.html deleted file mode 100644 index 19cd081..0000000 --- a/docs/classes/Layers.html +++ /dev/null @@ -1,39 +0,0 @@ -Layers | VFX-JS

Class Layers

A THREE.Layers | Layers object assigns an THREE.Object3D | Object3D to 1 or more of 32 layers numbered 0 to 31 - internally the
-layers are stored as a bit mask, and
-by default all Object3Ds are a member of layer 0.

-

Remarks

This can be used to control visibility - an object must share a layer with a camera to be visible when that camera's view is rendered.

-

See

-

Constructors

constructor -

Properties

mask -

Methods

set -enable -enableAll -toggle -disable -disableAll -test -isEnabled -

Constructors

constructor

  • new Layers(): Layers

  • Create a new Layers object, with membership initially set to layer 0.

    -

    Returns Layers

Properties

mask

mask: number

A bit mask storing which of the 32 layers this layers object is currently a member of.

-

Default Value

1 | 0

-

Remarks

Expects a Integer

-

Methods

set

  • set(layer: number): void

  • Set membership to layer, and remove membership all other layers.

    -

    Parameters

    • layer: number

      An integer from 0 to 31.

      -

    Returns void

enable

  • enable(layer: number): void

  • Add membership of this layer.

    -

    Parameters

    • layer: number

      An integer from 0 to 31.

      -

    Returns void

enableAll

  • enableAll(): void

  • Add membership to all layers.

    -

    Returns void

toggle

  • toggle(layer: number): void

  • Toggle membership of layer.

    -

    Parameters

    • layer: number

      An integer from 0 to 31.

      -

    Returns void

disable

  • disable(layer: number): void

  • Remove membership of this layer.

    -

    Parameters

    • layer: number

      An integer from 0 to 31.

      -

    Returns void

disableAll

  • disableAll(): void

  • Remove membership from all layers.

    -

    Returns void

test

  • test(layers: Layers): boolean

  • Returns true if this and the passed layers object have at least one layer in common.

    -

    Parameters

    • layers: Layers

      A Layers object

      -

    Returns boolean

isEnabled

  • isEnabled(layer: number): boolean

  • Returns true if the given layer is enabled.

    -

    Parameters

    • layer: number

      An integer from 0 to 31.

      -

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Light.html b/docs/classes/Light.html deleted file mode 100644 index d72aac2..0000000 --- a/docs/classes/Light.html +++ /dev/null @@ -1,339 +0,0 @@ -Light | VFX-JS

Class Light<TShadowSupport>Abstract

Abstract base class for lights.

-

Remarks

All other light types inherit the properties and methods described here.

-

Type Parameters

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_UP -DEFAULT_MATRIX_AUTO_UPDATE -DEFAULT_MATRIX_WORLD_AUTO_UPDATE -isLight -type -color -intensity -shadow -isObject3D -id -uuid -name -parent -children -up -position -rotation -quaternion -scale -modelViewMatrix -normalMatrix -matrix -matrixWorld -matrixAutoUpdate -matrixWorldAutoUpdate -matrixWorldNeedsUpdate -layers -visible -castShadow -receiveShadow -frustumCulled -renderOrder -animations -userData -customDepthMaterial? -customDistanceMaterial? -

Methods

copy -dispose -toJSON -onBeforeShadow -onAfterShadow -onBeforeRender -onAfterRender -applyMatrix4 -applyQuaternion -setRotationFromAxisAngle -setRotationFromEuler -setRotationFromMatrix -setRotationFromQuaternion -rotateOnAxis -rotateOnWorldAxis -rotateX -rotateY -rotateZ -translateOnAxis -translateX -translateY -translateZ -localToWorld -worldToLocal -lookAt -add -remove -removeFromParent -clear -attach -getObjectById -getObjectByName -getObjectByProperty -getObjectsByProperty -getWorldPosition -getWorldQuaternion -getWorldScale -getWorldDirection -raycast -traverse -traverseVisible -traverseAncestors -updateMatrix -updateMatrixWorld -updateWorldMatrix -clone -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

StaticDEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight,
-THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

-

Default Value

new THREE.Vector3( 0, 1, 0)

-

StaticDEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

StaticDEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

ReadonlyisLight

isLight: true

Read-only flag to check if a given object is of type HemisphereLight.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlytype

type: string

A Read-only string to check if this object type.

-

Remarks

Sub-classes will update this value.

-

Default Value

Light

-

color

color: Color

Color of the light. \

-

Default Value

new THREE.Color(0xffffff) (white).

-

intensity

intensity: number

The light's intensity, or strength.
-The units of intensity depend on the type of light.

-

Default Value

1

-

shadow

shadow: TShadowSupport

A THREE.LightShadow | LightShadow used to calculate shadows for this light.

-

Remarks

Available only on Light's that support shadows.

-

ReadonlyisObject3D

isObject3D: true

Flag to check if a given object is of type Object3D.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Object3D instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
-Expects a Integer

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

parent

parent: null | Object3D

Object's parent in the scene graph.

-

Remarks

An object can have at most one parent.

-

Default Value

null

-

children

children: Object3D[]

Array with object's children.

-

See

THREE.Object3DGroup | Group for info on manually grouping objects.

-

Default Value

[]

-

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

-

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

-

Readonlyposition

position: Vector3

Object's local position.

-

Default Value

new THREE.Vector3() - that is (0, 0, 0).

-

Readonlyrotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

-

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

-

Readonlyquaternion

quaternion: Quaternion

Object's local rotation as a THREE.Quaternion | Quaternion.

-

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

-

Readonlyscale

scale: Vector3

The object's local scale.

-

Default Value

new THREE.Vector3( 1, 1, 1 )

-

ReadonlymodelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

-

ReadonlynormalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

-

matrix

matrix: Matrix4

The local transform matrix.

-

Default Value

new THREE.Matrix4()

-

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

-

Remarks

If the Object3D has no parent, then it's identical to the local transform THREE.Object3D.matrix | .matrix.

-

Default Value

new THREE.Matrix4()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and
-scale every frame and also recalculates the matrixWorld property.

-

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

-

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates.
-When it isn't, then you have to maintain all matrices in the object and its children yourself.

-

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

-

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

-

Default Value

false

-

layers

layers: Layers

The layer membership of the object.

-

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use.
-This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.

-

Default Value

new THREE.Layers()

-

visible

visible: boolean

Object gets rendered if true.

-

Default Value

true

-

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

-

Default Value

false

-

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

-

Default Value

false

-

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object.
-If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

-

Default Value

true

-

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph
-objects to be overridden although opaque and transparent objects remain sorted independently.

-

Remarks

When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.
-Sorting is from lowest to highest renderOrder.

-

Default Value

0

-

animations

animations: AnimationClip[]

Array with object's animation clips.

-

Default Value

[]

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the Object3D.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default

{}

-

OptionalcustomDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

-

Remarks

Can only be used in context of meshes.
-When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight,
-if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

-

Default Value

undefined

-

OptionalcustomDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

-

Default Value

undefined

-

Methods

copy

  • copy(source: this, recursive?: boolean): this

  • Copies value of all the properties from the source to this instance.

    -

    Parameters

    • source: this
    • Optionalrecursive: boolean

    Returns this

dispose

  • dispose(): void

  • Frees the GPU-related resources allocated by this instance

    -

    Returns void

    Remarks

    Call this method whenever this instance is no longer used in your app.

    -

toJSON

onBeforeShadow

  • onBeforeShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterShadow

  • onAfterShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onBeforeRender

  • onBeforeRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterRender

  • onAfterRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

applyMatrix4

  • applyMatrix4(matrix: Matrix4): void

  • Applies the matrix transform to the object and updates the object's position, rotation and scale.

    -

    Parameters

    Returns void

applyQuaternion

  • applyQuaternion(quaternion: Quaternion): this

  • Applies the rotation represented by the quaternion to the object.

    -

    Parameters

    Returns this

setRotationFromAxisAngle

  • setRotationFromAxisAngle(axis: Vector3, angle: number): void

  • Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      Angle in radians. Expects a Float

      -

    Returns void

setRotationFromEuler

  • setRotationFromEuler(euler: Euler): void

  • Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.

    -

    Parameters

    • euler: Euler

      Euler angle specifying rotation amount.

      -

    Returns void

setRotationFromMatrix

  • setRotationFromMatrix(m: Matrix4): void

  • Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

    -

    Parameters

    • m: Matrix4

      Rotate the quaternion by the rotation component of the matrix.

      -

    Returns void

    Remarks

    Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

    -

setRotationFromQuaternion

rotateOnAxis

  • rotateOnAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in object space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

rotateOnWorldAxis

  • rotateOnWorldAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in world space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in world space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized
    -Method Assumes no rotated parent.

    -

rotateX

  • rotateX(angle: number): this

  • Rotates the object around x axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateY

  • rotateY(angle: number): this

  • Rotates the object around y axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateZ

  • rotateZ(angle: number): this

  • Rotates the object around z axis in local space.

    -

    Parameters

    • angle: number

    Returns this

translateOnAxis

  • translateOnAxis(axis: Vector3, distance: number): this

  • Translate an object by distance along an axis in object space

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • distance: number

      The distance to translate. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

translateX

  • translateX(distance: number): this

  • Translates object along x axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateY

  • translateY(distance: number): this

  • Translates object along y axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateZ

  • translateZ(distance: number): this

  • Translates object along z axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

localToWorld

  • localToWorld(vector: Vector3): Vector3

  • Converts the vector from this object's local space to world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in this object's local space.

      -

    Returns Vector3

worldToLocal

  • worldToLocal(vector: Vector3): Vector3

  • Converts the vector from world space to this object's local space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space.

      -

    Returns Vector3

lookAt

  • lookAt(vector: Vector3): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space to look at.

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -
  • lookAt(x: number, y: number, z: number): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -

add

  • add(...object: Object3D[]): this

  • Adds another Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be added
    -Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.

    -

    See

      -
    • attach
      • -
    • THREE.Group | Group for info on manually grouping objects.
      • -
    -

remove

  • remove(...object: Object3D[]): this

  • Removes a Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be removed.

    -

    See

    THREE.Group | Group for info on manually grouping objects.

    -

removeFromParent

  • removeFromParent(): this

  • Removes this object from its current parent.

    -

    Returns this

clear

  • clear(): this

  • Removes all child objects.

    -

    Returns this

attach

  • attach(object: Object3D): this

  • Adds a Object3D as a child of this, while maintaining the object's world transform.

    -

    Parameters

    Returns this

    Remarks

    Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

    -

    See

    add

    -

getObjectById

  • getObjectById(id: number): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    -

    Parameters

    • id: number

      Unique number of the object instance. Expects a Integer

      -

    Returns undefined | Object3D

    Remarks

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    -

    See

    id

    -

getObjectByName

  • getObjectByName(name: string): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

    -

    Parameters

    • name: string

      String to match to the children's Object3D.name property.

      -

    Returns undefined | Object3D

    Remarks

    Note that for most objects the name is an empty string by default
    -You will have to set it manually to make use of this method.

    -

getObjectByProperty

  • getObjectByProperty(name: string, value: any): undefined | Object3D

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      the property name to search for.

      -
    • value: any

      value of the given property.

      -

    Returns undefined | Object3D

getObjectsByProperty

  • getObjectsByProperty(
        name: string,
        value: any,
        optionalTarget?: Object3D[],
    ): Object3D[]

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      The property name to search for.

      -
    • value: any

      Value of the given property.

      -
    • OptionaloptionalTarget: Object3D[]

      target to set the result. Otherwise a new Array is instantiated. If set, you must clear
      -this array prior to each call (i.e., array.length = 0;).

      -

    Returns Object3D[]

getWorldPosition

  • getWorldPosition(target: Vector3): Vector3

  • Returns a vector representing the position of the object in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldQuaternion

getWorldScale

  • getWorldScale(target: Vector3): Vector3

  • Returns a vector of the scaling factors applied to the object for each axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldDirection

  • getWorldDirection(target: Vector3): Vector3

  • Returns a vector representing the direction of object's positive z-axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

raycast

  • raycast(raycaster: Raycaster, intersects: Intersection[]): void

  • Abstract (empty) method to get intersections between a casted ray and this object

    -

    Parameters

    Returns void

    Remarks

    Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

    -

    See

    THREE.Raycaster | Raycaster

    -

    Default Value

    () => {}

    -

traverse

  • traverse(callback: (object: Object3D) => any): void

  • Executes the callback on this object and all descendants.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseVisible

  • traverseVisible(callback: (object: Object3D) => any): void

  • Like traverse, but the callback will only be executed for visible objects

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Descendants of invisible objects are not traversed.
    -Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseAncestors

  • traverseAncestors(callback: (object: Object3D) => any): void

  • Executes the callback on all ancestors.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

updateMatrix

  • updateMatrix(): void

  • Updates local transform.

    -

    Returns void

updateMatrixWorld

  • updateMatrixWorld(force?: boolean): void

  • Updates the global transform of the object.
    -And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

    -

    Parameters

    • Optionalforce: boolean

      A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame.
      -Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

      -

    Returns void

updateWorldMatrix

  • updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void

  • Updates the global transform of the object.

    -

    Parameters

    • updateParents: boolean

      Recursively updates global transform of ancestors.

      -
    • updateChildren: boolean

      Recursively updates global transform of descendants.

      -

    Returns void

clone

  • clone(recursive?: boolean): this

  • Returns a clone of this object and optionally all descendants.

    -

    Parameters

    • Optionalrecursive: boolean

      If true, descendants of the object are also cloned. Default true

      -

    Returns this

addEventListener

hasEventListener

removeEventListener

dispatchEvent

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/LightShadow.html b/docs/classes/LightShadow.html deleted file mode 100644 index 56e4137..0000000 --- a/docs/classes/LightShadow.html +++ /dev/null @@ -1,85 +0,0 @@ -LightShadow | VFX-JS

Class LightShadow<TCamera>

Serves as a base class for the other shadow classes.

-

See

-

Type Parameters

Constructors

constructor -

Properties

camera -intensity -bias -normalBias -radius -blurSamples -mapSize -map -mapPass -matrix -autoUpdate -needsUpdate -

Methods

getViewportCount -copy -clone -toJSON -getFrustum -updateMatrices -getViewport -getFrameExtents -dispose -

Constructors

constructor

Properties

camera

camera: TCamera

The light's view of the world.

-

Remark

This is used to generate a depth map of the scene; objects behind other objects from the light's perspective will be in shadow.

-

intensity

intensity: number

The intensity of the shadow. The default is 1. Valid values are in the range [0, 1].

-

bias

bias: number

Shadow map bias, how much to add or subtract from the normalized depth when deciding whether a surface is in shadow.

-

Remark

The Very tiny adjustments here (in the order of 0.0001) may help reduce artifacts in shadows.

-

Remarks

Expects a Float

-

Default Value

0

-

normalBias

normalBias: number

Defines how much the position used to query the shadow map is offset along the object normal.

-

Remark

The Increasing this value can be used to reduce shadow acne especially in large scenes where light shines onto geometry at a shallow angle.

-

Remark

The cost is that shadows may appear distorted.

-

Remarks

Expects a Float

-

Default Value

0

-

radius

radius: number

Setting this to values greater than 1 will blur the edges of the shadow.toi

-

Remark

High values will cause unwanted banding effects in the shadows - a greater mapSize will allow for a higher value to be used here before these effects become visible. @remark If {@link THREE.WebGLRenderer.shadowMap.type | WebGLRenderer.shadowMap.type is set to PCFSoftShadowMap,
-radius has no effect and it is recommended to increase softness by decreasing mapSize instead.

-

Remark

Note that this has no effect if the THREE.WebGLRenderer.shadowMap | WebGLRenderer.shadowMap.THREE.WebGLShadowMap.type | type
-is set to THREE.BasicShadowMap | BasicShadowMap.

-

Remarks

Expects a Float

-

Default Value

1

-

blurSamples

blurSamples: number

The amount of samples to use when blurring a VSM shadow map.

-

Remarks

Expects a Integer

-

Default Value

8

-

mapSize

mapSize: Vector2

A THREE.Vector2 | Vector2 defining the width and height of the shadow map.

-

Remarks

Higher values give better quality shadows at the cost of computation time.

-

Default Value

new THREE.Vector2(512, 512)

-

map

map: null | WebGLRenderTarget

The depth map generated using the internal camera; a location beyond a pixel's depth is in shadow. Computed internally during rendering.

-

Default Value

null
-
- -

mapPass

mapPass: null | WebGLRenderTarget

The distribution map generated using the internal camera; an occlusion is calculated based on the distribution of depths. Computed internally during rendering.

-

Default Value

null
-
- -

matrix

matrix: Matrix4

Model to shadow camera space, to compute location and depth in shadow map.
-Stored in a Matrix4.

-

Remarks

This is computed internally during rendering.

-

Default Value

new THREE.Matrix4()
-
- -

autoUpdate

autoUpdate: boolean

Enables automatic updates of the light's shadow. If you do not require dynamic lighting / shadows, you may set this to false.

-

Default Value

true

-

needsUpdate

needsUpdate: boolean

When set to true, shadow maps will be updated in the next render call.
-If you have set autoUpdate to false, you will need to set this property to true and then make a render call to update the light's shadow.

-

Default Value

false

-

Methods

getViewportCount

  • getViewportCount(): number

  • Used internally by the renderer to get the number of viewports that need to be rendered for this shadow.

    -

    Returns number

copy

  • copy(source: LightShadow): this

  • Copies value of all the properties from the {@link LightShadow | source} to this Light.

    -

    Parameters

    Returns this

clone

  • clone(recursive?: boolean): this

  • Creates a new LightShadow with the same properties as this one.

    -

    Parameters

    • Optionalrecursive: boolean

    Returns this

toJSON

getFrustum

  • getFrustum(): Frustum

  • Gets the shadow cameras frustum

    -

    Returns Frustum

    Remarks

    Used internally by the renderer to cull objects.

    -

updateMatrices

  • updateMatrices(light: Light): void

  • Update the matrices for the camera and shadow, used internally by the renderer.

    -

    Parameters

    • light: Light

      The light for which the shadow is being rendered.

      -

    Returns void

getViewport

  • getViewport(viewportIndex: number): Vector4

  • Parameters

    • viewportIndex: number

    Returns Vector4

getFrameExtents

  • getFrameExtents(): Vector2

  • Used internally by the renderer to extend the shadow map to contain all viewports

    -

    Returns Vector2

dispose

  • dispose(): void

  • Frees the GPU-related resources allocated by this instance

    -

    Returns void

    Remarks

    Call this method whenever this instance is no longer used in your app.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Line3.html b/docs/classes/Line3.html deleted file mode 100644 index 72f62ba..0000000 --- a/docs/classes/Line3.html +++ /dev/null @@ -1,22 +0,0 @@ -Line3 | VFX-JS

Class Line3

Constructors

constructor -

Properties

start -end -

Methods

set -clone -copy -getCenter -delta -distanceSq -distance -at -closestPointToPointParameter -closestPointToPoint -applyMatrix4 -equals -

Constructors

constructor

Properties

start

start: Vector3

Default

new THREE.Vector3()
-
- -

end

end: Vector3

Default

new THREE.Vector3()
-
- -

Methods

set

clone

  • clone(): this

  • Returns this

copy

  • copy(line: Line3): this

  • Parameters

    Returns this

getCenter

delta

distanceSq

  • distanceSq(): number

  • Returns number

distance

  • distance(): number

  • Returns number

at

  • at(t: number, target: Vector3): Vector3

  • Parameters

    Returns Vector3

closestPointToPointParameter

  • closestPointToPointParameter(point: Vector3, clampToLine?: boolean): number

  • Parameters

    • point: Vector3
    • OptionalclampToLine: boolean

    Returns number

closestPointToPoint

  • closestPointToPoint(
        point: Vector3,
        clampToLine: boolean,
        target: Vector3,
    ): Vector3

  • Parameters

    Returns Vector3

applyMatrix4

  • applyMatrix4(matrix: Matrix4): Line3

  • Parameters

    Returns Line3

equals

  • equals(line: Line3): boolean

  • Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/LinearInterpolant.html b/docs/classes/LinearInterpolant.html deleted file mode 100644 index a88803c..0000000 --- a/docs/classes/LinearInterpolant.html +++ /dev/null @@ -1,8 +0,0 @@ -LinearInterpolant | VFX-JS

Class LinearInterpolant

Hierarchy (View Summary)

Constructors

constructor -

Properties

parameterPositions -sampleValues -valueSize -resultBuffer -

Methods

interpolate_ -evaluate -

Constructors

constructor

  • new LinearInterpolant(
        parameterPositions: any,
        samplesValues: any,
        sampleSize: number,
        resultBuffer?: any,
    ): LinearInterpolant

  • Parameters

    • parameterPositions: any
    • samplesValues: any
    • sampleSize: number
    • OptionalresultBuffer: any

    Returns LinearInterpolant

Properties

parameterPositions

parameterPositions: any

sampleValues

sampleValues: any

valueSize

valueSize: number

resultBuffer

resultBuffer: any

Methods

interpolate_

  • interpolate_(i1: number, t0: number, t: number, t1: number): any

  • Parameters

    • i1: number
    • t0: number
    • t: number
    • t1: number

    Returns any

evaluate

  • evaluate(time: number): any

  • Parameters

    • time: number

    Returns any

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Loader.html b/docs/classes/Loader.html deleted file mode 100644 index 201dfc8..0000000 --- a/docs/classes/Loader.html +++ /dev/null @@ -1,32 +0,0 @@ -Loader | VFX-JS

Class Loader<TData, TUrl>

Base class for implementing loaders.

-

Type Parameters

  • TData = unknown
  • TUrl = string

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_MATERIAL_NAME -crossOrigin -withCredentials -path -resourcePath -manager -requestHeader -

Methods

load -loadAsync -setCrossOrigin -setWithCredentials -setPath -setResourcePath -setRequestHeader -

Constructors

constructor

Properties

StaticDEFAULT_MATERIAL_NAME

DEFAULT_MATERIAL_NAME: string

crossOrigin

crossOrigin: string

Default

'anonymous'
-
- -

withCredentials

withCredentials: boolean

Default

false
-
- -

path

path: string

Default

''
-
- -

resourcePath

resourcePath: string

Default

''
-
- -

manager

manager: LoadingManager

requestHeader

requestHeader: { [header: string]: string }

Default

{}
-
- -

Methods

load

  • load(
        url: TUrl,
        onLoad: (data: TData) => void,
        onProgress?: (event: ProgressEvent) => void,
        onError?: (err: unknown) => void,
    ): void

  • Parameters

    • url: TUrl
    • onLoad: (data: TData) => void
    • OptionalonProgress: (event: ProgressEvent) => void
    • OptionalonError: (err: unknown) => void

    Returns void

loadAsync

  • loadAsync(
        url: TUrl,
        onProgress?: (event: ProgressEvent) => void,
    ): Promise<TData>

  • Parameters

    Returns Promise<TData>

setCrossOrigin

  • setCrossOrigin(crossOrigin: string): this

  • Parameters

    • crossOrigin: string

    Returns this

setWithCredentials

  • setWithCredentials(value: boolean): this

  • Parameters

    • value: boolean

    Returns this

setPath

  • setPath(path: string): this

  • Parameters

    • path: string

    Returns this

setResourcePath

  • setResourcePath(resourcePath: string): this

  • Parameters

    • resourcePath: string

    Returns this

setRequestHeader

  • setRequestHeader(requestHeader: { [header: string]: string }): this

  • Parameters

    • requestHeader: { [header: string]: string }

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/LoadingManager.html b/docs/classes/LoadingManager.html deleted file mode 100644 index e363d27..0000000 --- a/docs/classes/LoadingManager.html +++ /dev/null @@ -1,36 +0,0 @@ -LoadingManager | VFX-JS

Class LoadingManager

Handles and keeps track of loaded and pending data.

-

Constructors

constructor -

Properties

onStart? -onLoad -onProgress -onError -

Methods

setURLModifier -resolveURL -itemStart -itemEnd -itemError -addHandler -removeHandler -getHandler -

Constructors

constructor

  • new LoadingManager(
        onLoad?: () => void,
        onProgress?: (url: string, loaded: number, total: number) => void,
        onError?: (url: string) => void,
    ): LoadingManager

  • Parameters

    • OptionalonLoad: () => void
    • OptionalonProgress: (url: string, loaded: number, total: number) => void
    • OptionalonError: (url: string) => void

    Returns LoadingManager

Properties

OptionalonStart

onStart?: (url: string, loaded: number, total: number) => void

Will be called when loading of an item starts.

-

Type declaration

    • (url: string, loaded: number, total: number): void

    • Parameters

      • url: string

        The url of the item that started loading.

        -
      • loaded: number

        The number of items already loaded so far.

        -
      • total: number

        The total amount of items to be loaded.

        -

      Returns void

onLoad

onLoad: () => void

Will be called when all items finish loading.
-The default is a function with empty body.

-

onProgress

onProgress: (url: string, loaded: number, total: number) => void

Will be called for each loaded item.
-The default is a function with empty body.

-

Type declaration

    • (url: string, loaded: number, total: number): void

    • Parameters

      • url: string

        The url of the item just loaded.

        -
      • loaded: number

        The number of items already loaded so far.

        -
      • total: number

        The total amount of items to be loaded.

        -

      Returns void

onError

onError: (url: string) => void

Will be called when item loading fails.
-The default is a function with empty body.

-

Type declaration

    • (url: string): void

    • Parameters

      • url: string

        The url of the item that errored.

        -

      Returns void

Methods

setURLModifier

  • setURLModifier(callback?: (url: string) => string): this

  • If provided, the callback will be passed each resource URL before a request is sent.
    -The callback may return the original URL, or a new URL to override loading behavior.
    -This behavior can be used to load assets from .ZIP files, drag-and-drop APIs, and Data URIs.

    -

    Parameters

    • Optionalcallback: (url: string) => string

      URL modifier callback. Called with url argument, and must return resolvedURL.

      -

    Returns this

resolveURL

  • resolveURL(url: string): string

  • Given a URL, uses the URL modifier callback (if any) and returns a resolved URL.
    -If no URL modifier is set, returns the original URL.

    -

    Parameters

    • url: string

      the url to load

      -

    Returns string

itemStart

  • itemStart(url: string): void

  • Parameters

    • url: string

    Returns void

itemEnd

  • itemEnd(url: string): void

  • Parameters

    • url: string

    Returns void

itemError

  • itemError(url: string): void

  • Parameters

    • url: string

    Returns void

addHandler

  • addHandler(regex: RegExp, loader: Loader): this

  • Parameters

    Returns this

removeHandler

  • removeHandler(regex: RegExp): this

  • Parameters

    • regex: RegExp

    Returns this

getHandler

  • getHandler(file: string): null | Loader

  • Parameters

    • file: string

    Returns null | Loader

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Material.html b/docs/classes/Material.html deleted file mode 100644 index 8851129..0000000 --- a/docs/classes/Material.html +++ /dev/null @@ -1,310 +0,0 @@ -Material | VFX-JS

Class Material

Materials describe the appearance of objects. They are defined in a (mostly) renderer-independent way, so you don't have to rewrite materials if you decide to use a different renderer.

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

isMaterial -type -alphaHash -alphaToCoverage -blendAlpha -blendColor -blendDst -blendDstAlpha -blendEquation -blendEquationAlpha -blending -blendSrc -blendSrcAlpha -clipIntersection -clippingPlanes -clipShadows -colorWrite -defines -depthFunc -depthTest -depthWrite -id -stencilWrite -stencilFunc -stencilRef -stencilWriteMask -stencilFuncMask -stencilFail -stencilZFail -stencilZPass -name -opacity -polygonOffset -polygonOffsetFactor -polygonOffsetUnits -precision -premultipliedAlpha -forceSinglePass -dithering -side -shadowSide -toneMapped -transparent -uuid -vertexColors -visible -userData -version -

Accessors

alphaTest -needsUpdate -

Methods

onBeforeRender -onBeforeCompile -customProgramCacheKey -setValues -toJSON -clone -copy -dispose -onBuild -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

ReadonlyisMaterial

isMaterial: true

Read-only flag to check if a given object is of type Material.

-

Remarks

This is a constant value

-

Default Value

true

-

type

type: string

Value is the string 'Material'. This shouldn't be changed, and can be used to find all objects of this type in a
-scene.

-

alphaHash

alphaHash: boolean

Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material
-will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise,
-but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the
-resulting noise.

-

alphaToCoverage

alphaToCoverage: boolean

Enables alpha to coverage. Can only be used with MSAA-enabled rendering contexts (meaning when the renderer was
-created with antialias parameter set to true). Enabling this will smooth aliasing on clip plane edges and
-alphaTest-clipped edges.

-

Default

false
-
- -

blendAlpha

blendAlpha: number

Represents the alpha value of the constant blend color. This property has only an effect when using custom
-blending with ConstantAlphaFactor or OneMinusConstantAlphaFactor.

-

Default

0
-
- -

blendColor

blendColor: Color

Represent the RGB values of the constant blend color. This property has only an effect when using custom
-blending with ConstantColorFactor or OneMinusConstantColorFactor.

-

Default

0x000000
-
- -

blendDst

blendDst: BlendingDstFactor

Blending destination. It's one of the blending mode constants defined in Three.js. Default is OneMinusSrcAlphaFactor.

-

Default

THREE.OneMinusSrcAlphaFactor
-
- -

blendDstAlpha

blendDstAlpha: null | number

The tranparency of the .blendDst. Default is null.

-

Default

null
-
- -

blendEquation

blendEquation: BlendingEquation

Blending equation to use when applying blending. It's one of the constants defined in Three.js. Default is AddEquation.

-

Default

THREE.AddEquation
-
- -

blendEquationAlpha

blendEquationAlpha: null | number

The tranparency of the .blendEquation. Default is null.

-

Default

null
-
- -

blending

blending: Blending

Which blending to use when displaying objects with this material. Default is NormalBlending.

-

Default

THREE.NormalBlending
-
- -

blendSrc

blendSrc:
    | 200
    | 201
    | 202
    | 203
    | 204
    | 205
    | 206
    | 207
    | 208
    | 209
    | 210
    | 211
    | 212
    | 213
    | 214

Blending source. It's one of the blending mode constants defined in Three.js. Default is SrcAlphaFactor.

-

Default

THREE.SrcAlphaFactor
-
- -

blendSrcAlpha

blendSrcAlpha: null | number

The tranparency of the .blendSrc. Default is null.

-

Default

null
-
- -

clipIntersection

clipIntersection: boolean

Changes the behavior of clipping planes so that only their intersection is clipped, rather than their union. Default is false.

-

Default

false
-
- -

clippingPlanes

clippingPlanes: null | Plane[]

User-defined clipping planes specified as THREE.Plane objects in world space.
-These planes apply to the objects this material is attached to.
-Points in space whose signed distance to the plane is negative are clipped (not rendered).
-See the WebGL / clipping /intersection example. Default is null.

-

Default

null
-
- -

clipShadows

clipShadows: boolean

Defines whether to clip shadows according to the clipping planes specified on this material. Default is false.

-

Default

false
-
- -

colorWrite

colorWrite: boolean

Whether to render the material's color. This can be used in conjunction with a mesh's .renderOrder property to create invisible objects that occlude other objects. Default is true.

-

Default

true
-
- -

defines

defines: undefined | { [key: string]: any }

Custom defines to be injected into the shader. These are passed in form of an object literal, with key/value pairs. { MY_CUSTOM_DEFINE: '' , PI2: Math.PI * 2 }.
-The pairs are defined in both vertex and fragment shaders. Default is undefined.

-

Default

undefined
-
- -

depthFunc

depthFunc: DepthModes

Which depth function to use. Default is LessEqualDepth. See the depth mode constants for all possible values.

-

Default

THREE.LessEqualDepth
-
- -

depthTest

depthTest: boolean

Whether to have depth test enabled when rendering this material. When the depth test is disabled, the depth write
-will also be implicitly disabled.

-

Default

true
-
- -

depthWrite

depthWrite: boolean

Whether rendering this material has any effect on the depth buffer. Default is true.
-When drawing 2D overlays it can be useful to disable the depth writing in order to layer several things together without creating z-index artifacts.

-

Default

true
-
- -

id

id: number

Unique number of this material instance.

-

stencilWrite

stencilWrite: boolean

Whether rendering this material has any effect on the stencil buffer. Default is false.

-

Default

false
-
- -

stencilFunc

stencilFunc: StencilFunc

The stencil comparison function to use. Default is AlwaysStencilFunc. See stencil operation constants for all possible values.

-

Default

THREE.AlwaysStencilFunc
-
- -

stencilRef

stencilRef: number

The value to use when performing stencil comparisons or stencil operations. Default is 0.

-

Default

0
-
- -

stencilWriteMask

stencilWriteMask: number

The bit mask to use when writing to the stencil buffer. Default is 0xFF.

-

Default

0xff
-
- -

stencilFuncMask

stencilFuncMask: number

The bit mask to use when comparing against the stencil buffer. Default is 0xFF.

-

Default

0xff
-
- -

stencilFail

stencilFail: StencilOp

Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

-

Default

THREE.KeepStencilOp
-
- -

stencilZFail

stencilZFail: StencilOp

Which stencil operation to perform when the comparison function returns true but the depth test fails.
-Default is KeepStencilOp.
-See the stencil operation constants for all possible values.

-

Default

THREE.KeepStencilOp
-
- -

stencilZPass

stencilZPass: StencilOp

Which stencil operation to perform when the comparison function returns true and the depth test passes.
-Default is KeepStencilOp.
-See the stencil operation constants for all possible values.

-

Default

THREE.KeepStencilOp
-
- -

name

name: string

Material name. Default is an empty string.

-

Default

''
-
- -

opacity

opacity: number

Opacity. Default is 1.

-

Default

1
-
- -

polygonOffset

polygonOffset: boolean

Whether to use polygon offset. Default is false. This corresponds to the POLYGON_OFFSET_FILL WebGL feature.

-

Default

false
-
- -

polygonOffsetFactor

polygonOffsetFactor: number

Sets the polygon offset factor. Default is 0.

-

Default

0
-
- -

polygonOffsetUnits

polygonOffsetUnits: number

Sets the polygon offset units. Default is 0.

-

Default

0
-
- -

precision

precision: null | "highp" | "mediump" | "lowp"

Override the renderer's default precision for this material. Can be "highp", "mediump" or "lowp". Defaults is null.

-

Default

null
-
- -

premultipliedAlpha

premultipliedAlpha: boolean

Whether to premultiply the alpha (transparency) value. See WebGL / Materials / Transparency for an example of the difference. Default is false.

-

Default

false
-
- -

forceSinglePass

forceSinglePass: boolean

Default

false
-
- -

dithering

dithering: boolean

Whether to apply dithering to the color to remove the appearance of banding. Default is false.

-

Default

false
-
- -

side

side: Side

Defines which of the face sides will be rendered - front, back or both.
-Default is THREE.FrontSide. Other options are THREE.BackSide and THREE.DoubleSide.

-

Default

THREE.FrontSide

-

shadowSide

shadowSide: null | Side

Defines which of the face sides will cast shadows. Default is null.
-If null, the value is opposite that of side, above.

-

Default

null
-
- -

toneMapped

toneMapped: boolean

Defines whether this material is tone mapped according to the renderer's
-toneMapping setting. It is ignored when rendering to a render target or using
-post processing.

-

Default

true
-
- -

transparent

transparent: boolean

Defines whether this material is transparent. This has an effect on rendering as transparent objects need special treatment and are rendered after non-transparent objects.
-When set to true, the extent to which the material is transparent is controlled by setting it's .opacity property.

-

Default

false
-
- -

uuid

uuid: string

UUID of this material instance. This gets automatically assigned, so this shouldn't be edited.

-

vertexColors

vertexColors: boolean

Defines whether vertex coloring is used. Default is false.

-

Default

false
-
- -

visible

visible: boolean

Defines whether this material is visible. Default is true.

-

Default

true
-
- -

userData

userData: Record<string, any>

An object that can be used to store custom data about the Material. It should not hold references to functions as these will not be cloned.

-

Default

{}
-
- -

version

version: number

This starts at 0 and counts how many times .needsUpdate is set to true.

-

Default

0
-
- -

Accessors

alphaTest

  • get alphaTest(): number

  • Gets the alpha value to be used when running an alpha test. Default is 0.

    -

    Returns number

    Default

    0
-
    - -
  • set alphaTest(value: number): void

  • Sets the alpha value to be used when running an alpha test. Default is 0.

    -

    Parameters

    • value: number

    Returns void

    Default

    0
-
    - -

needsUpdate

  • set needsUpdate(value: boolean): void

  • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL.
    -This property is automatically set to true when instancing a new material.

    -

    Parameters

    • value: boolean

    Returns void

    Default

    false
-
    - -

Methods

onBeforeRender

  • onBeforeRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        object: Object3D,
        group: Group,
    ): void

  • An optional callback that is executed immediately before the material is used to render a 3D object.
    -Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON().
    -This callback is only supported in WebGLRenderer (not WebGPURenderer).

    -

    Parameters

    Returns void

onBeforeCompile

  • onBeforeCompile(
        parameters: WebGLProgramParametersWithUniforms,
        renderer: WebGLRenderer,
    ): void

  • An optional callback that is executed immediately before the shader program is compiled.
    -This function is called with the shader source code as a parameter.
    -Useful for the modification of built-in materials.
    -Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON().
    -This callback is only supported in WebGLRenderer (not WebGPURenderer).

    -

    Parameters

    Returns void

customProgramCacheKey

  • customProgramCacheKey(): string

  • In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.

    -

    Returns string

setValues

  • setValues(values: MaterialParameters): void

  • Sets the properties based on the values.

    -

    Parameters

    Returns void

toJSON

  • toJSON(meta?: JSONMeta): MaterialJSON

  • Convert the material to three.js JSON format.

    -

    Parameters

    • Optionalmeta: JSONMeta

      Object containing metadata such as textures or images for the material.

      -

    Returns MaterialJSON

clone

  • clone(): this

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

    -

    Returns this

copy

  • copy(material: Material): this

  • Copy the parameters from the passed material into this material.

    -

    Parameters

    Returns this

dispose

  • dispose(): void

  • Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer
    -used in your app.

    -

    Material textures must be disposed of by the dispose() method of Texture.

    -

    Returns void

onBuild

addEventListener

  • addEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, Material>,
    ): void

  • Adds a listener to an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

      -
    • listener: EventListener<{ dispose: {} }[T], T, Material>

      The function that gets called when the event is fired.

      -

    Returns void

hasEventListener

  • hasEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, Material>,
    ): boolean

  • Checks if listener is added to an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

      -
    • listener: EventListener<{ dispose: {} }[T], T, Material>

      The function that gets called when the event is fired.

      -

    Returns boolean

removeEventListener

  • removeEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, Material>,
    ): void

  • Removes a listener from an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of the listener that gets removed.

      -
    • listener: EventListener<{ dispose: {} }[T], T, Material>

      The listener function that gets removed.

      -

    Returns void

dispatchEvent

  • dispatchEvent<T extends "dispose">(
        event: BaseEvent<T> & { dispose: {} }[T],
    ): void

  • Fire an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • event: BaseEvent<T> & { dispose: {} }[T]

      The event that gets fired.

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/Matrix3.html b/docs/classes/Matrix3.html deleted file mode 100644 index 7998c3f..0000000 --- a/docs/classes/Matrix3.html +++ /dev/null @@ -1,71 +0,0 @@ -Matrix3 | VFX-JS

Class Matrix3

Constructors

constructor -

Properties

isMatrix3 -elements -

Methods

set -identity -copy -extractBasis -setFromMatrix4 -multiply -premultiply -multiplyMatrices -multiplyScalar -determinant -invert -transpose -getNormalMatrix -transposeIntoArray -setUvTransform -scale -rotate -translate -makeTranslation -makeRotation -makeScale -equals -fromArray -toArray -clone -

Constructors

constructor

  • new Matrix3(): Matrix3

  • Creates an identity matrix.

    -

    Returns Matrix3

  • new Matrix3(
        n11: number,
        n12: number,
        n13: number,
        n21: number,
        n22: number,
        n23: number,
        n31: number,
        n32: number,
        n33: number,
    ): Matrix3

  • Creates a 3x3 matrix with the given arguments in row-major order.

    -

    Parameters

    • n11: number
    • n12: number
    • n13: number
    • n21: number
    • n22: number
    • n23: number
    • n31: number
    • n32: number
    • n33: number

    Returns Matrix3

Properties

ReadonlyisMatrix3

isMatrix3: true

elements

elements: Matrix3Tuple

Array with matrix values.

-

Default

[1, 0, 0, 0, 1, 0, 0, 0, 1]
-
- -

Methods

set

  • set(
        n11: number,
        n12: number,
        n13: number,
        n21: number,
        n22: number,
        n23: number,
        n31: number,
        n32: number,
        n33: number,
    ): Matrix3

  • Parameters

    • n11: number
    • n12: number
    • n13: number
    • n21: number
    • n22: number
    • n23: number
    • n31: number
    • n32: number
    • n33: number

    Returns Matrix3

identity

  • identity(): this

  • Returns this

copy

  • copy(m: Matrix3): this

  • Parameters

    Returns this

extractBasis

setFromMatrix4

multiply

  • multiply(m: Matrix3): this

  • Multiplies this matrix by m.

    -

    Parameters

    Returns this

premultiply

  • premultiply(m: Matrix3): this

  • Parameters

    Returns this

multiplyMatrices

  • multiplyMatrices(a: Matrix3, b: Matrix3): this

  • Sets this matrix to a x b.

    -

    Parameters

    Returns this

multiplyScalar

  • multiplyScalar(s: number): this

  • Parameters

    • s: number

    Returns this

determinant

  • determinant(): number

  • Returns number

invert

  • invert(): this

  • Inverts this matrix in place.

    -

    Returns this

transpose

  • transpose(): this

  • Transposes this matrix in place.

    -

    Returns this

getNormalMatrix

  • getNormalMatrix(matrix4: Matrix4): this

  • Parameters

    Returns this

transposeIntoArray

  • transposeIntoArray(r: number[]): this

  • Transposes this matrix into the supplied array r, and returns itself.

    -

    Parameters

    • r: number[]

    Returns this

setUvTransform

  • setUvTransform(
        tx: number,
        ty: number,
        sx: number,
        sy: number,
        rotation: number,
        cx: number,
        cy: number,
    ): this

  • Parameters

    • tx: number
    • ty: number
    • sx: number
    • sy: number
    • rotation: number
    • cx: number
    • cy: number

    Returns this

scale

  • scale(sx: number, sy: number): this

  • Parameters

    • sx: number
    • sy: number

    Returns this

rotate

  • rotate(theta: number): this

  • Parameters

    • theta: number

    Returns this

translate

  • translate(tx: number, ty: number): this

  • Parameters

    • tx: number
    • ty: number

    Returns this

makeTranslation

  • makeTranslation(v: Vector2): this

  • Sets this matrix as a 2D translation transform:

    -
    1, 0, x,
    0, 1, y,
    0, 0, 1
-
    - -

    Parameters

    • v: Vector2

      the amount to translate.

      -

    Returns this

  • makeTranslation(x: number, y: number): this

  • Sets this matrix as a 2D translation transform:

    -
    1, 0, x,
    0, 1, y,
    0, 0, 1
-
    - -

    Parameters

    • x: number

      the amount to translate in the X axis.

      -
    • y: number

      the amount to translate in the Y axis.

      -

    Returns this

makeRotation

  • makeRotation(theta: number): this

  • Sets this matrix as a 2D rotational transformation by theta radians. The resulting matrix will be:

    -
    cos(θ) -sin(θ) 0
    sin(θ) cos(θ)  0
    0      0       1
-
    - -

    Parameters

    • theta: number

      Rotation angle in radians. Positive values rotate counterclockwise.

      -

    Returns this

makeScale

  • makeScale(x: number, y: number): this

  • Sets this matrix as a 2D scale transform:

    -
    x, 0, 0,
    0, y, 0,
    0, 0, 1
-
    - -

    Parameters

    • x: number

      the amount to scale in the X axis.

      -
    • y: number

      the amount to scale in the Y axis.

      -

    Returns this

equals

  • equals(matrix: Matrix3): boolean

  • Parameters

    Returns boolean

fromArray

  • fromArray(array: ArrayLike<number>, offset?: number): this

  • Sets the values of this matrix from the provided array or array-like.

    -

    Parameters

    • array: ArrayLike<number>

      the source array or array-like.

      -
    • Optionaloffset: number

      (optional) offset into the array-like. Default is 0.

      -

    Returns this

toArray

  • toArray(): Matrix3Tuple

  • Writes the elements of this matrix to an array in
    -column-major format.

    -

    Returns Matrix3Tuple

  • toArray<TArray extends ArrayLike<number>>(
        array: TArray,
        offset?: number,
    ): TArray

  • Writes the elements of this matrix to an array in
    -column-major format.

    -

    Type Parameters

    Parameters

    • array: TArray

      array to store the resulting vector in. If not given a new array will be created.

      -
    • Optionaloffset: number

      (optional) offset in the array at which to put the result.

      -

    Returns TArray

clone

  • clone(): this

  • Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Matrix4.html b/docs/classes/Matrix4.html deleted file mode 100644 index 1ffc01e..0000000 --- a/docs/classes/Matrix4.html +++ /dev/null @@ -1,92 +0,0 @@ -Matrix4 | VFX-JS

Class Matrix4

A 4x4 Matrix.

-

Example

// Simple rig for rotating around 3 axes
const m = new THREE.Matrix4();
const m1 = new THREE.Matrix4();
const m2 = new THREE.Matrix4();
const m3 = new THREE.Matrix4();
const alpha = 0;
const beta = Math.PI;
const gamma = Math.PI/2;
m1.makeRotationX( alpha );
m2.makeRotationY( beta );
m3.makeRotationZ( gamma );
m.multiplyMatrices( m1, m2 );
m.multiply( m3 );
-
- -

Constructors

constructor -

Properties

isMatrix4 -elements -

Methods

set -identity -clone -copy -copyPosition -setFromMatrix3 -extractBasis -makeBasis -extractRotation -makeRotationFromEuler -makeRotationFromQuaternion -lookAt -multiply -premultiply -multiplyMatrices -multiplyScalar -determinant -transpose -setPosition -invert -scale -getMaxScaleOnAxis -makeTranslation -makeRotationX -makeRotationY -makeRotationZ -makeRotationAxis -makeScale -makeShear -compose -decompose -makePerspective -makeOrthographic -equals -fromArray -toArray -

Constructors

constructor

  • new Matrix4(): Matrix4

  • Creates an identity matrix.

    -

    Returns Matrix4

  • new Matrix4(
        n11: number,
        n12: number,
        n13: number,
        n14: number,
        n21: number,
        n22: number,
        n23: number,
        n24: number,
        n31: number,
        n32: number,
        n33: number,
        n34: number,
        n41: number,
        n42: number,
        n43: number,
        n44: number,
    ): Matrix4

  • Creates a 4x4 matrix with the given arguments in row-major order.

    -

    Parameters

    • n11: number
    • n12: number
    • n13: number
    • n14: number
    • n21: number
    • n22: number
    • n23: number
    • n24: number
    • n31: number
    • n32: number
    • n33: number
    • n34: number
    • n41: number
    • n42: number
    • n43: number
    • n44: number

    Returns Matrix4

Properties

ReadonlyisMatrix4

isMatrix4: true

elements

elements: Matrix4Tuple

Array with matrix values.

-

Default

[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]
-
- -

Methods

set

  • set(
        n11: number,
        n12: number,
        n13: number,
        n14: number,
        n21: number,
        n22: number,
        n23: number,
        n24: number,
        n31: number,
        n32: number,
        n33: number,
        n34: number,
        n41: number,
        n42: number,
        n43: number,
        n44: number,
    ): this

  • Sets all fields of this matrix.

    -

    Parameters

    • n11: number
    • n12: number
    • n13: number
    • n14: number
    • n21: number
    • n22: number
    • n23: number
    • n24: number
    • n31: number
    • n32: number
    • n33: number
    • n34: number
    • n41: number
    • n42: number
    • n43: number
    • n44: number

    Returns this

identity

  • identity(): this

  • Resets this matrix to identity.

    -

    Returns this

clone

  • clone(): Matrix4

  • Returns Matrix4

copy

  • copy(m: Matrix4): this

  • Parameters

    Returns this

copyPosition

  • copyPosition(m: Matrix4): this

  • Parameters

    Returns this

setFromMatrix3

  • setFromMatrix3(m: Matrix3): this

  • Set the upper 3x3 elements of this matrix to the values of the Matrix3 m.

    -

    Parameters

    Returns this

extractBasis

makeBasis

extractRotation

  • extractRotation(m: Matrix4): this

  • Copies the rotation component of the supplied matrix m into this matrix rotation component.

    -

    Parameters

    Returns this

makeRotationFromEuler

  • makeRotationFromEuler(euler: Euler): this

  • Parameters

    Returns this

makeRotationFromQuaternion

  • makeRotationFromQuaternion(q: Quaternion): this

  • Parameters

    Returns this

lookAt

  • lookAt(eye: Vector3, target: Vector3, up: Vector3): this

  • Constructs a rotation matrix, looking from eye towards center with defined up vector.

    -

    Parameters

    Returns this

multiply

  • multiply(m: Matrix4): this

  • Multiplies this matrix by m.

    -

    Parameters

    Returns this

premultiply

  • premultiply(m: Matrix4): this

  • Parameters

    Returns this

multiplyMatrices

  • multiplyMatrices(a: Matrix4, b: Matrix4): this

  • Sets this matrix to a x b.

    -

    Parameters

    Returns this

multiplyScalar

  • multiplyScalar(s: number): this

  • Multiplies this matrix by s.

    -

    Parameters

    • s: number

    Returns this

determinant

transpose

  • transpose(): this

  • Transposes this matrix.

    -

    Returns this

setPosition

  • setPosition(v: Vector3): this

  • Sets the position component for this matrix from vector v.

    -

    Parameters

    Returns this

  • setPosition(x: number, y: number, z: number): this

  • Sets the position component for this matrix from vector v.

    -

    Parameters

    • x: number
    • y: number
    • z: number

    Returns this

invert

  • invert(): this

  • Inverts this matrix.

    -

    Returns this

scale

  • scale(v: Vector3): this

  • Multiplies the columns of this matrix by vector v.

    -

    Parameters

    Returns this

getMaxScaleOnAxis

  • getMaxScaleOnAxis(): number

  • Returns number

makeTranslation

  • makeTranslation(v: Vector3): this

  • Sets this matrix as translation transform.

    -

    Parameters

    Returns this

  • makeTranslation(x: number, y: number, z: number): this

  • Sets this matrix as translation transform.

    -

    Parameters

    • x: number
    • y: number
    • z: number

    Returns this

makeRotationX

  • makeRotationX(theta: number): this

  • Sets this matrix as rotation transform around x axis by theta radians.

    -

    Parameters

    • theta: number

      Rotation angle in radians.

      -

    Returns this

makeRotationY

  • makeRotationY(theta: number): this

  • Sets this matrix as rotation transform around y axis by theta radians.

    -

    Parameters

    • theta: number

      Rotation angle in radians.

      -

    Returns this

makeRotationZ

  • makeRotationZ(theta: number): this

  • Sets this matrix as rotation transform around z axis by theta radians.

    -

    Parameters

    • theta: number

      Rotation angle in radians.

      -

    Returns this

makeRotationAxis

makeScale

  • makeScale(x: number, y: number, z: number): this

  • Sets this matrix as scale transform.

    -

    Parameters

    • x: number
    • y: number
    • z: number

    Returns this

makeShear

  • makeShear(
        xy: number,
        xz: number,
        yx: number,
        yz: number,
        zx: number,
        zy: number,
    ): this

  • Sets this matrix as shear transform.

    -

    Parameters

    • xy: number
    • xz: number
    • yx: number
    • yz: number
    • zx: number
    • zy: number

    Returns this

compose

  • compose(position: Vector3, quaternion: Quaternion, scale: Vector3): this

  • Sets this matrix to the transformation composed of translation, rotation and scale.

    -

    Parameters

    Returns this

decompose

  • decompose(position: Vector3, quaternion: Quaternion, scale: Vector3): this

  • Decomposes this matrix into it's position, quaternion and scale components.

    -

    Parameters

    Returns this

makePerspective

  • makePerspective(
        left: number,
        right: number,
        top: number,
        bottom: number,
        near: number,
        far: number,
        coordinateSystem?: CoordinateSystem,
    ): this

  • Creates a perspective projection matrix.

    -

    Parameters

    • left: number
    • right: number
    • top: number
    • bottom: number
    • near: number
    • far: number
    • OptionalcoordinateSystem: CoordinateSystem

    Returns this

makeOrthographic

  • makeOrthographic(
        left: number,
        right: number,
        top: number,
        bottom: number,
        near: number,
        far: number,
        coordinateSystem?: CoordinateSystem,
    ): this

  • Creates an orthographic projection matrix.

    -

    Parameters

    • left: number
    • right: number
    • top: number
    • bottom: number
    • near: number
    • far: number
    • OptionalcoordinateSystem: CoordinateSystem

    Returns this

equals

  • equals(matrix: Matrix4): boolean

  • Parameters

    Returns boolean

fromArray

  • fromArray(array: ArrayLike<number>, offset?: number): this

  • Sets the values of this matrix from the provided array or array-like.

    -

    Parameters

    • array: ArrayLike<number>

      the source array or array-like.

      -
    • Optionaloffset: number

      (optional) offset into the array-like. Default is 0.

      -

    Returns this

toArray

  • toArray(): Matrix4Tuple

  • Writes the elements of this matrix to an array in
    -column-major format.

    -

    Returns Matrix4Tuple

  • toArray<TArray extends ArrayLike<number>>(
        array: TArray,
        offset?: number,
    ): TArray

  • Writes the elements of this matrix to an array in
    -column-major format.

    -

    Type Parameters

    Parameters

    • array: TArray

      array to store the resulting vector in.

      -
    • Optionaloffset: number

      (optional) offset in the array at which to put the result.

      -

    Returns TArray

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Mesh.html b/docs/classes/Mesh.html deleted file mode 100644 index 1e15b3e..0000000 --- a/docs/classes/Mesh.html +++ /dev/null @@ -1,352 +0,0 @@ -Mesh | VFX-JS

Class Mesh<TGeometry, TMaterial, TEventMap>

Class representing triangular polygon mesh based objects.

-

Remarks

Also serves as a base for other classes such as THREE.SkinnedMesh | SkinnedMesh, THREE.InstancedMesh | InstancedMesh.

-

Example

const geometry = new THREE.BoxGeometry(1, 1, 1);
const material = new THREE.MeshBasicMaterial({
    color: 0xffff00
});
const {@link Mesh} = new THREE.Mesh(geometry, material);
scene.add(mesh);
-
- -

See

-

Type Parameters

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_UP -DEFAULT_MATRIX_AUTO_UPDATE -DEFAULT_MATRIX_WORLD_AUTO_UPDATE -isMesh -type -geometry -material -morphTargetInfluences? -morphTargetDictionary? -isObject3D -id -uuid -name -parent -children -up -position -rotation -quaternion -scale -modelViewMatrix -normalMatrix -matrix -matrixWorld -matrixAutoUpdate -matrixWorldAutoUpdate -matrixWorldNeedsUpdate -layers -visible -castShadow -receiveShadow -frustumCulled -renderOrder -animations -userData -customDepthMaterial? -customDistanceMaterial? -

Methods

updateMorphTargets -getVertexPosition -toJSON -onBeforeShadow -onAfterShadow -onBeforeRender -onAfterRender -applyMatrix4 -applyQuaternion -setRotationFromAxisAngle -setRotationFromEuler -setRotationFromMatrix -setRotationFromQuaternion -rotateOnAxis -rotateOnWorldAxis -rotateX -rotateY -rotateZ -translateOnAxis -translateX -translateY -translateZ -localToWorld -worldToLocal -lookAt -add -remove -removeFromParent -clear -attach -getObjectById -getObjectByName -getObjectByProperty -getObjectsByProperty -getWorldPosition -getWorldQuaternion -getWorldScale -getWorldDirection -raycast -traverse -traverseVisible -traverseAncestors -updateMatrix -updateMatrixWorld -updateWorldMatrix -clone -copy -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

StaticDEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight,
-THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

-

Default Value

new THREE.Vector3( 0, 1, 0)

-

StaticDEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

StaticDEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

ReadonlyisMesh

isMesh: true

Read-only flag to check if a given object is of type Mesh.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlytype

type: string

Default Value

Mesh

-

geometry

geometry: TGeometry

An instance of THREE.BufferGeometry | BufferGeometry (or derived classes), defining the object's structure.

-

Default Value

THREE.BufferGeometry | new THREE.BufferGeometry().

-

material

material: TMaterial

An instance of material derived from the THREE.Material | Material base class or an array of materials, defining the object's appearance.

-

Default Value

THREE.MeshBasicMaterial | new THREE.MeshBasicMaterial().

-

OptionalmorphTargetInfluences

morphTargetInfluences?: number[]

An array of weights typically from 0-1 that specify how much of the morph is applied.

-

Default Value

undefined, but reset to a blank array by .updateMorphTargets().

-

OptionalmorphTargetDictionary

morphTargetDictionary?: { [key: string]: number }

A dictionary of morphTargets based on the morphTarget.name property.

-

Default Value

undefined, but rebuilt by .updateMorphTargets().

-

ReadonlyisObject3D

isObject3D: true

Flag to check if a given object is of type Object3D.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Object3D instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
-Expects a Integer

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

parent

parent: null | Object3D

Object's parent in the scene graph.

-

Remarks

An object can have at most one parent.

-

Default Value

null

-

children

children: Object3D[]

Array with object's children.

-

See

THREE.Object3DGroup | Group for info on manually grouping objects.

-

Default Value

[]

-

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

-

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

-

Readonlyposition

position: Vector3

Object's local position.

-

Default Value

new THREE.Vector3() - that is (0, 0, 0).

-

Readonlyrotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

-

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

-

Readonlyquaternion

quaternion: Quaternion

Object's local rotation as a THREE.Quaternion | Quaternion.

-

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

-

Readonlyscale

scale: Vector3

The object's local scale.

-

Default Value

new THREE.Vector3( 1, 1, 1 )

-

ReadonlymodelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

-

ReadonlynormalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

-

matrix

matrix: Matrix4

The local transform matrix.

-

Default Value

new THREE.Matrix4()

-

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

-

Remarks

If the Object3D has no parent, then it's identical to the local transform THREE.Object3D.matrix | .matrix.

-

Default Value

new THREE.Matrix4()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and
-scale every frame and also recalculates the matrixWorld property.

-

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

-

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates.
-When it isn't, then you have to maintain all matrices in the object and its children yourself.

-

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

-

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

-

Default Value

false

-

layers

layers: Layers

The layer membership of the object.

-

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use.
-This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.

-

Default Value

new THREE.Layers()

-

visible

visible: boolean

Object gets rendered if true.

-

Default Value

true

-

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

-

Default Value

false

-

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

-

Default Value

false

-

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object.
-If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

-

Default Value

true

-

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph
-objects to be overridden although opaque and transparent objects remain sorted independently.

-

Remarks

When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.
-Sorting is from lowest to highest renderOrder.

-

Default Value

0

-

animations

animations: AnimationClip[]

Array with object's animation clips.

-

Default Value

[]

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the Object3D.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default

{}

-

OptionalcustomDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

-

Remarks

Can only be used in context of meshes.
-When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight,
-if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

-

Default Value

undefined

-

OptionalcustomDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

-

Default Value

undefined

-

Methods

updateMorphTargets

  • updateMorphTargets(): void

  • Updates the morphTargets to have no influence on the object

    -

    Returns void

    Remarks

    Resets the morphTargetInfluences and morphTargetDictionary properties.

    -

getVertexPosition

  • getVertexPosition(index: number, target: Vector3): Vector3

  • Get the local-space position of the vertex at the given index,
    -taking into account the current animation state of both morph targets and skinning.

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • target: Vector3

    Returns Vector3

toJSON

onBeforeShadow

  • onBeforeShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterShadow

  • onAfterShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onBeforeRender

  • onBeforeRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterRender

  • onAfterRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

applyMatrix4

  • applyMatrix4(matrix: Matrix4): void

  • Applies the matrix transform to the object and updates the object's position, rotation and scale.

    -

    Parameters

    Returns void

applyQuaternion

  • applyQuaternion(quaternion: Quaternion): this

  • Applies the rotation represented by the quaternion to the object.

    -

    Parameters

    Returns this

setRotationFromAxisAngle

  • setRotationFromAxisAngle(axis: Vector3, angle: number): void

  • Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      Angle in radians. Expects a Float

      -

    Returns void

setRotationFromEuler

  • setRotationFromEuler(euler: Euler): void

  • Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.

    -

    Parameters

    • euler: Euler

      Euler angle specifying rotation amount.

      -

    Returns void

setRotationFromMatrix

  • setRotationFromMatrix(m: Matrix4): void

  • Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

    -

    Parameters

    • m: Matrix4

      Rotate the quaternion by the rotation component of the matrix.

      -

    Returns void

    Remarks

    Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

    -

setRotationFromQuaternion

rotateOnAxis

  • rotateOnAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in object space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

rotateOnWorldAxis

  • rotateOnWorldAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in world space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in world space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized
    -Method Assumes no rotated parent.

    -

rotateX

  • rotateX(angle: number): this

  • Rotates the object around x axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateY

  • rotateY(angle: number): this

  • Rotates the object around y axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateZ

  • rotateZ(angle: number): this

  • Rotates the object around z axis in local space.

    -

    Parameters

    • angle: number

    Returns this

translateOnAxis

  • translateOnAxis(axis: Vector3, distance: number): this

  • Translate an object by distance along an axis in object space

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • distance: number

      The distance to translate. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

translateX

  • translateX(distance: number): this

  • Translates object along x axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateY

  • translateY(distance: number): this

  • Translates object along y axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateZ

  • translateZ(distance: number): this

  • Translates object along z axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

localToWorld

  • localToWorld(vector: Vector3): Vector3

  • Converts the vector from this object's local space to world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in this object's local space.

      -

    Returns Vector3

worldToLocal

  • worldToLocal(vector: Vector3): Vector3

  • Converts the vector from world space to this object's local space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space.

      -

    Returns Vector3

lookAt

  • lookAt(vector: Vector3): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space to look at.

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -
  • lookAt(x: number, y: number, z: number): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -

add

  • add(...object: Object3D[]): this

  • Adds another Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be added
    -Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.

    -

    See

      -
    • attach
      • -
    • THREE.Group | Group for info on manually grouping objects.
      • -
    -

remove

  • remove(...object: Object3D[]): this

  • Removes a Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be removed.

    -

    See

    THREE.Group | Group for info on manually grouping objects.

    -

removeFromParent

  • removeFromParent(): this

  • Removes this object from its current parent.

    -

    Returns this

clear

  • clear(): this

  • Removes all child objects.

    -

    Returns this

attach

  • attach(object: Object3D): this

  • Adds a Object3D as a child of this, while maintaining the object's world transform.

    -

    Parameters

    Returns this

    Remarks

    Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

    -

    See

    add

    -

getObjectById

  • getObjectById(id: number): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    -

    Parameters

    • id: number

      Unique number of the object instance. Expects a Integer

      -

    Returns undefined | Object3D

    Remarks

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    -

    See

    id

    -

getObjectByName

  • getObjectByName(name: string): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

    -

    Parameters

    • name: string

      String to match to the children's Object3D.name property.

      -

    Returns undefined | Object3D

    Remarks

    Note that for most objects the name is an empty string by default
    -You will have to set it manually to make use of this method.

    -

getObjectByProperty

  • getObjectByProperty(name: string, value: any): undefined | Object3D

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      the property name to search for.

      -
    • value: any

      value of the given property.

      -

    Returns undefined | Object3D

getObjectsByProperty

  • getObjectsByProperty(
        name: string,
        value: any,
        optionalTarget?: Object3D[],
    ): Object3D[]

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      The property name to search for.

      -
    • value: any

      Value of the given property.

      -
    • OptionaloptionalTarget: Object3D[]

      target to set the result. Otherwise a new Array is instantiated. If set, you must clear
      -this array prior to each call (i.e., array.length = 0;).

      -

    Returns Object3D[]

getWorldPosition

  • getWorldPosition(target: Vector3): Vector3

  • Returns a vector representing the position of the object in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldQuaternion

getWorldScale

  • getWorldScale(target: Vector3): Vector3

  • Returns a vector of the scaling factors applied to the object for each axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldDirection

  • getWorldDirection(target: Vector3): Vector3

  • Returns a vector representing the direction of object's positive z-axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

raycast

  • raycast(raycaster: Raycaster, intersects: Intersection[]): void

  • Abstract (empty) method to get intersections between a casted ray and this object

    -

    Parameters

    Returns void

    Remarks

    Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

    -

    See

    THREE.Raycaster | Raycaster

    -

    Default Value

    () => {}

    -

traverse

  • traverse(callback: (object: Object3D) => any): void

  • Executes the callback on this object and all descendants.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseVisible

  • traverseVisible(callback: (object: Object3D) => any): void

  • Like traverse, but the callback will only be executed for visible objects

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Descendants of invisible objects are not traversed.
    -Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseAncestors

  • traverseAncestors(callback: (object: Object3D) => any): void

  • Executes the callback on all ancestors.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

updateMatrix

  • updateMatrix(): void

  • Updates local transform.

    -

    Returns void

updateMatrixWorld

  • updateMatrixWorld(force?: boolean): void

  • Updates the global transform of the object.
    -And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

    -

    Parameters

    • Optionalforce: boolean

      A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame.
      -Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

      -

    Returns void

updateWorldMatrix

  • updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void

  • Updates the global transform of the object.

    -

    Parameters

    • updateParents: boolean

      Recursively updates global transform of ancestors.

      -
    • updateChildren: boolean

      Recursively updates global transform of descendants.

      -

    Returns void

clone

  • clone(recursive?: boolean): this

  • Returns a clone of this object and optionally all descendants.

    -

    Parameters

    • Optionalrecursive: boolean

      If true, descendants of the object are also cloned. Default true

      -

    Returns this

copy

  • copy(object: Object3D, recursive?: boolean): this

  • Copies the given object into this object.

    -

    Parameters

    • object: Object3D
    • Optionalrecursive: boolean

      If set to true, descendants of the object are copied next to the existing ones. If set to
      -false, descendants are left unchanged. Default is true.

      -

    Returns this

    Remarks

    Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

    -

addEventListener

hasEventListener

removeEventListener

dispatchEvent

  • dispatchEvent<T extends string>(event: BaseEvent<T> & TEventMap[T]): void

  • Fire an event type.

    -

    Type Parameters

    • T extends string

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Object3D.html b/docs/classes/Object3D.html deleted file mode 100644 index c007d22..0000000 --- a/docs/classes/Object3D.html +++ /dev/null @@ -1,328 +0,0 @@ -Object3D | VFX-JS

Class Object3D<TEventMap>

This is the base class for most objects in three.js and provides a set of properties and methods for manipulating objects in 3D space.

-

Remarks

Note that this can be used for grouping objects via the THREE.Object3D.add | .add() method which adds the object as a child,
-however it is better to use THREE.Group | Group for this.

-

See

-

Type Parameters

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_UP -DEFAULT_MATRIX_AUTO_UPDATE -DEFAULT_MATRIX_WORLD_AUTO_UPDATE -isObject3D -id -uuid -name -type -parent -children -up -position -rotation -quaternion -scale -modelViewMatrix -normalMatrix -matrix -matrixWorld -matrixAutoUpdate -matrixWorldAutoUpdate -matrixWorldNeedsUpdate -layers -visible -castShadow -receiveShadow -frustumCulled -renderOrder -animations -userData -customDepthMaterial? -customDistanceMaterial? -

Methods

onBeforeShadow -onAfterShadow -onBeforeRender -onAfterRender -applyMatrix4 -applyQuaternion -setRotationFromAxisAngle -setRotationFromEuler -setRotationFromMatrix -setRotationFromQuaternion -rotateOnAxis -rotateOnWorldAxis -rotateX -rotateY -rotateZ -translateOnAxis -translateX -translateY -translateZ -localToWorld -worldToLocal -lookAt -add -remove -removeFromParent -clear -attach -getObjectById -getObjectByName -getObjectByProperty -getObjectsByProperty -getWorldPosition -getWorldQuaternion -getWorldScale -getWorldDirection -raycast -traverse -traverseVisible -traverseAncestors -updateMatrix -updateMatrixWorld -updateWorldMatrix -toJSON -clone -copy -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

StaticDEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight,
-THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

-

Default Value

new THREE.Vector3( 0, 1, 0)

-

StaticDEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

StaticDEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

ReadonlyisObject3D

isObject3D: true

Flag to check if a given object is of type Object3D.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Object3D instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
-Expects a Integer

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

Readonlytype

type: string

A Read-only string to check this object type.

-

Remarks

This can be used to find a specific type of Object3D in a scene.
-Sub-classes will update this value.

-

Default Value

Object3D

-

parent

parent: null | Object3D

Object's parent in the scene graph.

-

Remarks

An object can have at most one parent.

-

Default Value

null

-

children

children: Object3D[]

Array with object's children.

-

See

THREE.Object3DGroup | Group for info on manually grouping objects.

-

Default Value

[]

-

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

-

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

-

Readonlyposition

position: Vector3

Object's local position.

-

Default Value

new THREE.Vector3() - that is (0, 0, 0).

-

Readonlyrotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

-

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

-

Readonlyquaternion

quaternion: Quaternion

Object's local rotation as a THREE.Quaternion | Quaternion.

-

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

-

Readonlyscale

scale: Vector3

The object's local scale.

-

Default Value

new THREE.Vector3( 1, 1, 1 )

-

ReadonlymodelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

-

ReadonlynormalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

-

matrix

matrix: Matrix4

The local transform matrix.

-

Default Value

new THREE.Matrix4()

-

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

-

Remarks

If the Object3D has no parent, then it's identical to the local transform THREE.Object3D.matrix | .matrix.

-

Default Value

new THREE.Matrix4()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and
-scale every frame and also recalculates the matrixWorld property.

-

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

-

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates.
-When it isn't, then you have to maintain all matrices in the object and its children yourself.

-

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

-

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

-

Default Value

false

-

layers

layers: Layers

The layer membership of the object.

-

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use.
-This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.

-

Default Value

new THREE.Layers()

-

visible

visible: boolean

Object gets rendered if true.

-

Default Value

true

-

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

-

Default Value

false

-

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

-

Default Value

false

-

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object.
-If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

-

Default Value

true

-

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph
-objects to be overridden although opaque and transparent objects remain sorted independently.

-

Remarks

When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.
-Sorting is from lowest to highest renderOrder.

-

Default Value

0

-

animations

animations: AnimationClip[]

Array with object's animation clips.

-

Default Value

[]

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the Object3D.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default

{}

-

OptionalcustomDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

-

Remarks

Can only be used in context of meshes.
-When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight,
-if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

-

Default Value

undefined

-

OptionalcustomDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

-

Default Value

undefined

-

Methods

onBeforeShadow

  • onBeforeShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterShadow

  • onAfterShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onBeforeRender

  • onBeforeRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterRender

  • onAfterRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

applyMatrix4

  • applyMatrix4(matrix: Matrix4): void

  • Applies the matrix transform to the object and updates the object's position, rotation and scale.

    -

    Parameters

    Returns void

applyQuaternion

  • applyQuaternion(quaternion: Quaternion): this

  • Applies the rotation represented by the quaternion to the object.

    -

    Parameters

    Returns this

setRotationFromAxisAngle

  • setRotationFromAxisAngle(axis: Vector3, angle: number): void

  • Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      Angle in radians. Expects a Float

      -

    Returns void

setRotationFromEuler

  • setRotationFromEuler(euler: Euler): void

  • Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.

    -

    Parameters

    • euler: Euler

      Euler angle specifying rotation amount.

      -

    Returns void

setRotationFromMatrix

  • setRotationFromMatrix(m: Matrix4): void

  • Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

    -

    Parameters

    • m: Matrix4

      Rotate the quaternion by the rotation component of the matrix.

      -

    Returns void

    Remarks

    Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

    -

setRotationFromQuaternion

  • setRotationFromQuaternion(q: Quaternion): void

  • Copy the given THREE.Quaternion | Quaternion into .quaternion.

    -

    Parameters

    Returns void

rotateOnAxis

  • rotateOnAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in object space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

rotateOnWorldAxis

  • rotateOnWorldAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in world space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in world space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized
    -Method Assumes no rotated parent.

    -

rotateX

  • rotateX(angle: number): this

  • Rotates the object around x axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateY

  • rotateY(angle: number): this

  • Rotates the object around y axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateZ

  • rotateZ(angle: number): this

  • Rotates the object around z axis in local space.

    -

    Parameters

    • angle: number

    Returns this

translateOnAxis

  • translateOnAxis(axis: Vector3, distance: number): this

  • Translate an object by distance along an axis in object space

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • distance: number

      The distance to translate. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

translateX

  • translateX(distance: number): this

  • Translates object along x axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateY

  • translateY(distance: number): this

  • Translates object along y axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateZ

  • translateZ(distance: number): this

  • Translates object along z axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

localToWorld

  • localToWorld(vector: Vector3): Vector3

  • Converts the vector from this object's local space to world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in this object's local space.

      -

    Returns Vector3

worldToLocal

  • worldToLocal(vector: Vector3): Vector3

  • Converts the vector from world space to this object's local space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space.

      -

    Returns Vector3

lookAt

  • lookAt(vector: Vector3): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space to look at.

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -
  • lookAt(x: number, y: number, z: number): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -

add

  • add(...object: Object3D[]): this

  • Adds another Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be added
    -Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.

    -

    See

      -
    • attach
      • -
    • THREE.Group | Group for info on manually grouping objects.
      • -
    -

remove

  • remove(...object: Object3D[]): this

  • Removes a Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be removed.

    -

    See

    THREE.Group | Group for info on manually grouping objects.

    -

removeFromParent

  • removeFromParent(): this

  • Removes this object from its current parent.

    -

    Returns this

clear

  • clear(): this

  • Removes all child objects.

    -

    Returns this

attach

  • attach(object: Object3D): this

  • Adds a Object3D as a child of this, while maintaining the object's world transform.

    -

    Parameters

    Returns this

    Remarks

    Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

    -

    See

    add

    -

getObjectById

  • getObjectById(id: number): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    -

    Parameters

    • id: number

      Unique number of the object instance. Expects a Integer

      -

    Returns undefined | Object3D

    Remarks

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    -

    See

    id

    -

getObjectByName

  • getObjectByName(name: string): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

    -

    Parameters

    • name: string

      String to match to the children's Object3D.name property.

      -

    Returns undefined | Object3D

    Remarks

    Note that for most objects the name is an empty string by default
    -You will have to set it manually to make use of this method.

    -

getObjectByProperty

  • getObjectByProperty(name: string, value: any): undefined | Object3D

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      the property name to search for.

      -
    • value: any

      value of the given property.

      -

    Returns undefined | Object3D

getObjectsByProperty

  • getObjectsByProperty(
        name: string,
        value: any,
        optionalTarget?: Object3D[],
    ): Object3D[]

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      The property name to search for.

      -
    • value: any

      Value of the given property.

      -
    • OptionaloptionalTarget: Object3D[]

      target to set the result. Otherwise a new Array is instantiated. If set, you must clear
      -this array prior to each call (i.e., array.length = 0;).

      -

    Returns Object3D[]

getWorldPosition

  • getWorldPosition(target: Vector3): Vector3

  • Returns a vector representing the position of the object in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldQuaternion

  • getWorldQuaternion(target: Quaternion): Quaternion

  • Returns a quaternion representing the rotation of the object in world space.

    -

    Parameters

    • target: Quaternion

      The result will be copied into this Quaternion.

      -

    Returns Quaternion

getWorldScale

  • getWorldScale(target: Vector3): Vector3

  • Returns a vector of the scaling factors applied to the object for each axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldDirection

  • getWorldDirection(target: Vector3): Vector3

  • Returns a vector representing the direction of object's positive z-axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

raycast

  • raycast(raycaster: Raycaster, intersects: Intersection[]): void

  • Abstract (empty) method to get intersections between a casted ray and this object

    -

    Parameters

    Returns void

    Remarks

    Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

    -

    See

    THREE.Raycaster | Raycaster

    -

    Default Value

    () => {}

    -

traverse

  • traverse(callback: (object: Object3D) => any): void

  • Executes the callback on this object and all descendants.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseVisible

  • traverseVisible(callback: (object: Object3D) => any): void

  • Like traverse, but the callback will only be executed for visible objects

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Descendants of invisible objects are not traversed.
    -Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseAncestors

  • traverseAncestors(callback: (object: Object3D) => any): void

  • Executes the callback on all ancestors.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

updateMatrix

  • updateMatrix(): void

  • Updates local transform.

    -

    Returns void

updateMatrixWorld

  • updateMatrixWorld(force?: boolean): void

  • Updates the global transform of the object.
    -And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

    -

    Parameters

    • Optionalforce: boolean

      A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame.
      -Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

      -

    Returns void

updateWorldMatrix

  • updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void

  • Updates the global transform of the object.

    -

    Parameters

    • updateParents: boolean

      Recursively updates global transform of ancestors.

      -
    • updateChildren: boolean

      Recursively updates global transform of descendants.

      -

    Returns void

toJSON

clone

  • clone(recursive?: boolean): this

  • Returns a clone of this object and optionally all descendants.

    -

    Parameters

    • Optionalrecursive: boolean

      If true, descendants of the object are also cloned. Default true

      -

    Returns this

copy

  • copy(object: Object3D, recursive?: boolean): this

  • Copies the given object into this object.

    -

    Parameters

    • object: Object3D
    • Optionalrecursive: boolean

      If set to true, descendants of the object are copied next to the existing ones. If set to
      -false, descendants are left unchanged. Default is true.

      -

    Returns this

    Remarks

    Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

    -

addEventListener

hasEventListener

removeEventListener

dispatchEvent

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/PerspectiveCamera.html b/docs/classes/PerspectiveCamera.html deleted file mode 100644 index c397a87..0000000 --- a/docs/classes/PerspectiveCamera.html +++ /dev/null @@ -1,440 +0,0 @@ -PerspectiveCamera | VFX-JS

Class PerspectiveCamera

Camera that uses perspective projection.
-This projection mode is designed to mimic the way the human eye sees

-

Remarks

It is the most common projection mode used for rendering a 3D scene.

-

Example

const camera = new THREE.PerspectiveCamera(45, width / height, 1, 1000);
scene.add(camera);
-
- -

See

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_UP -DEFAULT_MATRIX_AUTO_UPDATE -DEFAULT_MATRIX_WORLD_AUTO_UPDATE -isPerspectiveCamera -type -zoom -fov -aspect -near -far -focus -view -filmGauge -filmOffset -isCamera -layers -matrixWorldInverse -projectionMatrix -projectionMatrixInverse -coordinateSystem -viewport? -isObject3D -id -uuid -name -parent -children -up -position -rotation -quaternion -scale -modelViewMatrix -normalMatrix -matrix -matrixWorld -matrixAutoUpdate -matrixWorldAutoUpdate -matrixWorldNeedsUpdate -visible -castShadow -receiveShadow -frustumCulled -renderOrder -animations -userData -customDepthMaterial? -customDistanceMaterial? -

Methods

getFocalLength -setFocalLength -getEffectiveFOV -getFilmWidth -getFilmHeight -getViewBounds -getViewSize -setViewOffset -clearViewOffset -updateProjectionMatrix -setLens -toJSON -getWorldDirection -onBeforeShadow -onAfterShadow -onBeforeRender -onAfterRender -applyMatrix4 -applyQuaternion -setRotationFromAxisAngle -setRotationFromEuler -setRotationFromMatrix -setRotationFromQuaternion -rotateOnAxis -rotateOnWorldAxis -rotateX -rotateY -rotateZ -translateOnAxis -translateX -translateY -translateZ -localToWorld -worldToLocal -lookAt -add -remove -removeFromParent -clear -attach -getObjectById -getObjectByName -getObjectByProperty -getObjectsByProperty -getWorldPosition -getWorldQuaternion -getWorldScale -raycast -traverse -traverseVisible -traverseAncestors -updateMatrix -updateMatrixWorld -updateWorldMatrix -clone -copy -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

  • new PerspectiveCamera(
        fov?: number,
        aspect?: number,
        near?: number,
        far?: number,
    ): PerspectiveCamera

  • Creates a new PerspectiveCamera.

    -

    Parameters

    • Optionalfov: number

      Camera frustum vertical field of view. Default 50.

      -
    • Optionalaspect: number

      Camera frustum aspect ratio. Default 1.

      -
    • Optionalnear: number

      Camera frustum near plane. Default 0.1.

      -
    • Optionalfar: number

      Camera frustum far plane. Default 2000.

      -

    Returns PerspectiveCamera

    Remarks

    Together these define the camera's viewing frustum.

    -

Properties

StaticDEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight,
-THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

-

Default Value

new THREE.Vector3( 0, 1, 0)

-

StaticDEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

StaticDEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

ReadonlyisPerspectiveCamera

isPerspectiveCamera: true

Read-only flag to check if a given object is of type Camera.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlytype

type: string

Default Value

PerspectiveCamera

-

zoom

zoom: number

Gets or sets the zoom factor of the camera.

-

Default Value

1

-

fov

fov: number

Camera frustum vertical field of view, from bottom to top of view, in degrees.

-

Remarks

Expects a Float

-

Default Value

50

-

aspect

aspect: number

Camera frustum aspect ratio, usually the canvas width / canvas height.

-

Remarks

Expects a Float

-

Default Value

1, (square canvas).

-

near

near: number

Camera frustum near plane.

-

Remarks

The valid range is greater than 0 and less than the current value of the .far plane.

-

Default Value

0.1

-

far

far: number

Camera frustum far plane.

-

Remarks

Must be greater than the current value of .near plane.

-

Default Value

2000

-

focus

focus: number

Object distance used for stereoscopy and depth-of-field effects.

-

Remarks

This parameter does not influence the projection matrix unless a THREE.StereoCamera | StereoCamera is being used.

-

Default Value

10

-

view

view:
    | null
    | {
        enabled: boolean;
        fullWidth: number;
        fullHeight: number;
        offsetX: number;
        offsetY: number;
        width: number;
        height: number;
    }

Frustum window specification or null.
-This is set using the .setViewOffset method and cleared using .clearViewOffset.

-

Default Value

null

-

filmGauge

filmGauge: number

Film size used for the larger axis.
-This parameter does not influence the projection matrix unless .filmOffset is set to a nonzero value.

-

Remarks

Expects a Float

-

Default Value

35, millimeters.

-

filmOffset

filmOffset: number

Horizontal off-center offset in the same unit as .filmGauge.

-

Remarks

Expects a Float

-

Default Value

0

-

ReadonlyisCamera

isCamera: true

Read-only flag to check if a given object is of type Camera.

-

Remarks

This is a constant value

-

Default Value

true

-

layers

layers: Layers

The THREE.Layers | layers that the Camera is a member of.

-

Remarks

Objects must share at least one layer with the Camera to be n when the camera's viewpoint is rendered.

-

Default Value

new THREE.Layers()

-

matrixWorldInverse

matrixWorldInverse: Matrix4

This is the inverse of matrixWorld.

-

Remarks

MatrixWorld contains the Matrix which has the world transform of the Camera .

-

Default Value

THREE.Matrix4 | new THREE.Matrix4()

-

projectionMatrix

projectionMatrix: Matrix4

This is the matrix which contains the projection.

-

Default Value

THREE.Matrix4 | new THREE.Matrix4()

-

projectionMatrixInverse

projectionMatrixInverse: Matrix4

This is the inverse of projectionMatrix.

-

Default Value

THREE.Matrix4 | new THREE.Matrix4()

-

coordinateSystem

coordinateSystem: CoordinateSystem

Optionalviewport

viewport?: Vector4

ReadonlyisObject3D

isObject3D: true

Flag to check if a given object is of type Object3D.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Object3D instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
-Expects a Integer

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

parent

parent: null | Object3D

Object's parent in the scene graph.

-

Remarks

An object can have at most one parent.

-

Default Value

null

-

children

children: Object3D[]

Array with object's children.

-

See

THREE.Object3DGroup | Group for info on manually grouping objects.

-

Default Value

[]

-

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

-

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

-

Readonlyposition

position: Vector3

Object's local position.

-

Default Value

new THREE.Vector3() - that is (0, 0, 0).

-

Readonlyrotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

-

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

-

Readonlyquaternion

quaternion: Quaternion

Object's local rotation as a THREE.Quaternion | Quaternion.

-

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

-

Readonlyscale

scale: Vector3

The object's local scale.

-

Default Value

new THREE.Vector3( 1, 1, 1 )

-

ReadonlymodelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

-

ReadonlynormalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

-

matrix

matrix: Matrix4

The local transform matrix.

-

Default Value

new THREE.Matrix4()

-

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

-

Remarks

If the Object3D has no parent, then it's identical to the local transform THREE.Object3D.matrix | .matrix.

-

Default Value

new THREE.Matrix4()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and
-scale every frame and also recalculates the matrixWorld property.

-

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

-

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates.
-When it isn't, then you have to maintain all matrices in the object and its children yourself.

-

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

-

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

-

Default Value

false

-

visible

visible: boolean

Object gets rendered if true.

-

Default Value

true

-

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

-

Default Value

false

-

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

-

Default Value

false

-

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object.
-If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

-

Default Value

true

-

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph
-objects to be overridden although opaque and transparent objects remain sorted independently.

-

Remarks

When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.
-Sorting is from lowest to highest renderOrder.

-

Default Value

0

-

animations

animations: AnimationClip[]

Array with object's animation clips.

-

Default Value

[]

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the Object3D.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default

{}

-

OptionalcustomDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

-

Remarks

Can only be used in context of meshes.
-When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight,
-if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

-

Default Value

undefined

-

OptionalcustomDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

-

Default Value

undefined

-

Methods

getFocalLength

  • getFocalLength(): number

  • Returns the focal length of the current .fov | fov in respect to .filmGauge.

    -

    Returns number

setFocalLength

  • setFocalLength(focalLength: number): void

  • Sets the FOV by focal length in respect to the current .filmGauge.

    -

    Parameters

    • focalLength: number

      Expects a Float

      -

    Returns void

    Remarks

    By default, the focal length is specified for a 35mm (full frame) camera.

    -

getEffectiveFOV

  • getEffectiveFOV(): number

  • Returns the current vertical field of view angle in degrees considering .zoom.

    -

    Returns number

getFilmWidth

  • getFilmWidth(): number

  • Returns the width of the image on the film

    -

    Returns number

    Remarks

    If .aspect. is greater than or equal to one (landscape format), the result equals .filmGauge.

    -

getFilmHeight

  • getFilmHeight(): number

  • Returns the height of the image on the film

    -

    Returns number

    Remarks

    If .aspect. is less than or equal to one (portrait format), the result equals .filmGauge.

    -

getViewBounds

  • getViewBounds(distance: number, minTarget: Vector2, maxTarget: Vector2): void

  • Computes the 2D bounds of the camera's viewable rectangle at a given distance along the viewing direction.
    -Sets minTarget and maxTarget to the coordinates of the lower-left and upper-right corners of the view rectangle.

    -

    Parameters

    Returns void

getViewSize

  • getViewSize(distance: number, target: Vector2): Vector2

  • Computes the width and height of the camera's viewable rectangle at a given distance along the viewing direction.
    -Copies the result into the target Vector2, where x is width and y is height.

    -

    Parameters

    Returns Vector2

setViewOffset

  • setViewOffset(
        fullWidth: number,
        fullHeight: number,
        x: number,
        y: number,
        width: number,
        height: number,
    ): void

  • Sets an offset in a larger frustum.

    -

    Parameters

    • fullWidth: number

      Full width of multiview setup Expects a Float.

      -
    • fullHeight: number

      Full height of multiview setup Expects a Float.

      -
    • x: number

      Horizontal offset of subcamera Expects a Float.

      -
    • y: number

      Vertical offset of subcamera Expects a Float.

      -
    • width: number

      Width of subcamera Expects a Float.

      -
    • height: number

      Height of subcamera Expects a Float.

      -

    Returns void

    Remarks

    This is useful for multi-window or multi-monitor/multi-machine setups.

    -

    For example, if you have 3x2 monitors and each monitor is 1920x1080 and
    -the monitors are in grid like this

    -
    ┌───┬───┬───┐
    │ A │ B │ C │
    ├───┼───┼───┤
    │ D │ E │ F │
    └───┴───┴───┘
-
    - -

    then for each monitor you would call it like this

    -
      const w = 1920;
      const h = 1080;
      const fullWidth = w * 3;
      const fullHeight = h * 2;

      // Monitor - A
      camera.setViewOffset( fullWidth, fullHeight, w * 0, h * 0, w, h );
      // Monitor - B
      camera.setViewOffset( fullWidth, fullHeight, w * 1, h * 0, w, h );
      // Monitor - C
      camera.setViewOffset( fullWidth, fullHeight, w * 2, h * 0, w, h );
      // Monitor - D
      camera.setViewOffset( fullWidth, fullHeight, w * 0, h * 1, w, h );
      // Monitor - E
      camera.setViewOffset( fullWidth, fullHeight, w * 1, h * 1, w, h );
      // Monitor - F
      camera.setViewOffset( fullWidth, fullHeight, w * 2, h * 1, w, h );
-
    - -

    Note there is no reason monitors have to be the same size or in a grid.

    -

clearViewOffset

  • clearViewOffset(): void

  • Removes any offset set by the .setViewOffset method.

    -

    Returns void

updateProjectionMatrix

  • updateProjectionMatrix(): void

  • Updates the camera projection matrix

    -

    Returns void

    Remarks

    Must be called after any change of parameters.

    -

setLens

  • setLens(focalLength: number, frameHeight?: number): void

  • Parameters

    • focalLength: number
    • OptionalframeHeight: number

    Returns void

    Deprecated

    Use .setFocalLength() and .filmGauge instead.

    -

toJSON

getWorldDirection

  • getWorldDirection(target: Vector3): Vector3

  • Returns a THREE.Vector3 | Vector3 representing the world space direction in which the Camera is looking.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

    Remarks

    Note: A Camera looks down its local, negative z-axis.

    -

onBeforeShadow

  • onBeforeShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterShadow

  • onAfterShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onBeforeRender

  • onBeforeRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterRender

  • onAfterRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

applyMatrix4

  • applyMatrix4(matrix: Matrix4): void

  • Applies the matrix transform to the object and updates the object's position, rotation and scale.

    -

    Parameters

    Returns void

applyQuaternion

  • applyQuaternion(quaternion: Quaternion): this

  • Applies the rotation represented by the quaternion to the object.

    -

    Parameters

    Returns this

setRotationFromAxisAngle

  • setRotationFromAxisAngle(axis: Vector3, angle: number): void

  • Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      Angle in radians. Expects a Float

      -

    Returns void

setRotationFromEuler

  • setRotationFromEuler(euler: Euler): void

  • Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.

    -

    Parameters

    • euler: Euler

      Euler angle specifying rotation amount.

      -

    Returns void

setRotationFromMatrix

  • setRotationFromMatrix(m: Matrix4): void

  • Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

    -

    Parameters

    • m: Matrix4

      Rotate the quaternion by the rotation component of the matrix.

      -

    Returns void

    Remarks

    Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

    -

setRotationFromQuaternion

rotateOnAxis

  • rotateOnAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in object space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

rotateOnWorldAxis

  • rotateOnWorldAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in world space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in world space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized
    -Method Assumes no rotated parent.

    -

rotateX

  • rotateX(angle: number): this

  • Rotates the object around x axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateY

  • rotateY(angle: number): this

  • Rotates the object around y axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateZ

  • rotateZ(angle: number): this

  • Rotates the object around z axis in local space.

    -

    Parameters

    • angle: number

    Returns this

translateOnAxis

  • translateOnAxis(axis: Vector3, distance: number): this

  • Translate an object by distance along an axis in object space

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • distance: number

      The distance to translate. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

translateX

  • translateX(distance: number): this

  • Translates object along x axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateY

  • translateY(distance: number): this

  • Translates object along y axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateZ

  • translateZ(distance: number): this

  • Translates object along z axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

localToWorld

  • localToWorld(vector: Vector3): Vector3

  • Converts the vector from this object's local space to world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in this object's local space.

      -

    Returns Vector3

worldToLocal

  • worldToLocal(vector: Vector3): Vector3

  • Converts the vector from world space to this object's local space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space.

      -

    Returns Vector3

lookAt

  • lookAt(vector: Vector3): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space to look at.

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -
  • lookAt(x: number, y: number, z: number): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -

add

  • add(...object: Object3D[]): this

  • Adds another Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be added
    -Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.

    -

    See

      -
    • attach
      • -
    • THREE.Group | Group for info on manually grouping objects.
      • -
    -

remove

  • remove(...object: Object3D[]): this

  • Removes a Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be removed.

    -

    See

    THREE.Group | Group for info on manually grouping objects.

    -

removeFromParent

  • removeFromParent(): this

  • Removes this object from its current parent.

    -

    Returns this

clear

  • clear(): this

  • Removes all child objects.

    -

    Returns this

attach

  • attach(object: Object3D): this

  • Adds a Object3D as a child of this, while maintaining the object's world transform.

    -

    Parameters

    Returns this

    Remarks

    Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

    -

    See

    add

    -

getObjectById

  • getObjectById(id: number): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    -

    Parameters

    • id: number

      Unique number of the object instance. Expects a Integer

      -

    Returns undefined | Object3D

    Remarks

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    -

    See

    id

    -

getObjectByName

  • getObjectByName(name: string): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

    -

    Parameters

    • name: string

      String to match to the children's Object3D.name property.

      -

    Returns undefined | Object3D

    Remarks

    Note that for most objects the name is an empty string by default
    -You will have to set it manually to make use of this method.

    -

getObjectByProperty

  • getObjectByProperty(name: string, value: any): undefined | Object3D

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      the property name to search for.

      -
    • value: any

      value of the given property.

      -

    Returns undefined | Object3D

getObjectsByProperty

  • getObjectsByProperty(
        name: string,
        value: any,
        optionalTarget?: Object3D[],
    ): Object3D[]

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      The property name to search for.

      -
    • value: any

      Value of the given property.

      -
    • OptionaloptionalTarget: Object3D[]

      target to set the result. Otherwise a new Array is instantiated. If set, you must clear
      -this array prior to each call (i.e., array.length = 0;).

      -

    Returns Object3D[]

getWorldPosition

  • getWorldPosition(target: Vector3): Vector3

  • Returns a vector representing the position of the object in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldQuaternion

  • getWorldQuaternion(target: Quaternion): Quaternion

  • Returns a quaternion representing the rotation of the object in world space.

    -

    Parameters

    • target: Quaternion

      The result will be copied into this Quaternion.

      -

    Returns Quaternion

getWorldScale

  • getWorldScale(target: Vector3): Vector3

  • Returns a vector of the scaling factors applied to the object for each axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

raycast

  • raycast(raycaster: Raycaster, intersects: Intersection[]): void

  • Abstract (empty) method to get intersections between a casted ray and this object

    -

    Parameters

    Returns void

    Remarks

    Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

    -

    See

    THREE.Raycaster | Raycaster

    -

    Default Value

    () => {}

    -

traverse

  • traverse(callback: (object: Object3D) => any): void

  • Executes the callback on this object and all descendants.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseVisible

  • traverseVisible(callback: (object: Object3D) => any): void

  • Like traverse, but the callback will only be executed for visible objects

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Descendants of invisible objects are not traversed.
    -Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseAncestors

  • traverseAncestors(callback: (object: Object3D) => any): void

  • Executes the callback on all ancestors.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

updateMatrix

  • updateMatrix(): void

  • Updates local transform.

    -

    Returns void

updateMatrixWorld

  • updateMatrixWorld(force?: boolean): void

  • Updates the global transform of the object.
    -And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

    -

    Parameters

    • Optionalforce: boolean

      A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame.
      -Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

      -

    Returns void

updateWorldMatrix

  • updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void

  • Updates the global transform of the object.

    -

    Parameters

    • updateParents: boolean

      Recursively updates global transform of ancestors.

      -
    • updateChildren: boolean

      Recursively updates global transform of descendants.

      -

    Returns void

clone

  • clone(recursive?: boolean): this

  • Returns a clone of this object and optionally all descendants.

    -

    Parameters

    • Optionalrecursive: boolean

      If true, descendants of the object are also cloned. Default true

      -

    Returns this

copy

  • copy(object: Object3D, recursive?: boolean): this

  • Copies the given object into this object.

    -

    Parameters

    • object: Object3D
    • Optionalrecursive: boolean

      If set to true, descendants of the object are copied next to the existing ones. If set to
      -false, descendants are left unchanged. Default is true.

      -

    Returns this

    Remarks

    Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

    -

addEventListener

hasEventListener

removeEventListener

dispatchEvent

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Plane.html b/docs/classes/Plane.html deleted file mode 100644 index 7aa9cac..0000000 --- a/docs/classes/Plane.html +++ /dev/null @@ -1,32 +0,0 @@ -Plane | VFX-JS

Class Plane

Constructors

constructor -

Properties

normal -constant -isPlane -

Methods

set -setComponents -setFromNormalAndCoplanarPoint -setFromCoplanarPoints -clone -copy -normalize -negate -distanceToPoint -distanceToSphere -projectPoint -intersectLine -intersectsLine -intersectsBox -intersectsSphere -coplanarPoint -applyMatrix4 -translate -equals -isIntersectionLine -

Constructors

constructor

  • new Plane(normal?: Vector3, constant?: number): Plane

  • Parameters

    • Optionalnormal: Vector3
    • Optionalconstant: number

    Returns Plane

Properties

normal

normal: Vector3

Default

new THREE.Vector3( 1, 0, 0 )
-
- -

constant

constant: number

Default

0
-
- -

ReadonlyisPlane

isPlane: true

Methods

set

  • set(normal: Vector3, constant: number): Plane

  • Parameters

    Returns Plane

setComponents

  • setComponents(x: number, y: number, z: number, w: number): Plane

  • Parameters

    • x: number
    • y: number
    • z: number
    • w: number

    Returns Plane

setFromNormalAndCoplanarPoint

setFromCoplanarPoints

clone

  • clone(): this

  • Returns this

copy

  • copy(plane: Plane): this

  • Parameters

    Returns this

normalize

  • normalize(): Plane

  • Returns Plane

negate

  • negate(): Plane

  • Returns Plane

distanceToPoint

  • distanceToPoint(point: Vector3): number

  • Parameters

    Returns number

distanceToSphere

  • distanceToSphere(sphere: Sphere): number

  • Parameters

    Returns number

projectPoint

intersectLine

intersectsLine

  • intersectsLine(line: Line3): boolean

  • Parameters

    Returns boolean

intersectsBox

  • intersectsBox(box: Box3): boolean

  • Parameters

    Returns boolean

intersectsSphere

  • intersectsSphere(sphere: Sphere): boolean

  • Parameters

    Returns boolean

coplanarPoint

applyMatrix4

  • applyMatrix4(matrix: Matrix4, optionalNormalMatrix?: Matrix3): Plane

  • Parameters

    Returns Plane

translate

  • translate(offset: Vector3): Plane

  • Parameters

    Returns Plane

equals

  • equals(plane: Plane): boolean

  • Parameters

    Returns boolean

isIntersectionLine

  • isIntersectionLine(l: any): any

  • Parameters

    • l: any

    Returns any

    Deprecated

    Use .intersectsLine() instead.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Quaternion.html b/docs/classes/Quaternion.html deleted file mode 100644 index 78001ca..0000000 --- a/docs/classes/Quaternion.html +++ /dev/null @@ -1,93 +0,0 @@ -Quaternion | VFX-JS

Class Quaternion

Implementation of a quaternion. This is used for rotating things without incurring in the dreaded gimbal lock issue, amongst other advantages.

-

Example

const quaternion = new THREE.Quaternion();
quaternion.setFromAxisAngle( new THREE.Vector3( 0, 1, 0 ), Math.PI / 2 );
const vector = new THREE.Vector3( 1, 0, 0 );
vector.applyQuaternion( quaternion );
-
- -

Constructors

constructor -

Properties

x -y -z -w -isQuaternion -_onChangeCallback -

Methods

slerpFlat -multiplyQuaternionsFlat -set -clone -copy -setFromEuler -setFromAxisAngle -setFromRotationMatrix -setFromUnitVectors -angleTo -rotateTowards -identity -invert -conjugate -dot -lengthSq -length -normalize -multiply -premultiply -multiplyQuaternions -slerp -slerpQuaternions -equals -fromArray -toArray -toJSON -fromBufferAttribute -_onChange -random -[iterator] -

Constructors

constructor

  • new Quaternion(x?: number, y?: number, z?: number, w?: number): Quaternion

  • Parameters

    • Optionalx: number

      x coordinate

      -
    • Optionaly: number

      y coordinate

      -
    • Optionalz: number

      z coordinate

      -
    • Optionalw: number

      w coordinate

      -

    Returns Quaternion

Properties

x

x: number

Default

0
-
- -

y

y: number

Default

0
-
- -

z

z: number

Default

0
-
- -

w

w: number

Default

1
-
- -

ReadonlyisQuaternion

isQuaternion: true

_onChangeCallback

_onChangeCallback: () => void

Methods

StaticslerpFlat

  • slerpFlat(
        dst: number[],
        dstOffset: number,
        src0: number[],
        srcOffset: number,
        src1: number[],
        stcOffset1: number,
        t: number,
    ): void

  • Parameters

    • dst: number[]
    • dstOffset: number
    • src0: number[]
    • srcOffset: number
    • src1: number[]
    • stcOffset1: number
    • t: number

    Returns void

StaticmultiplyQuaternionsFlat

  • multiplyQuaternionsFlat(
        dst: number[],
        dstOffset: number,
        src0: number[],
        srcOffset: number,
        src1: number[],
        stcOffset1: number,
    ): number[]

  • Parameters

    • dst: number[]
    • dstOffset: number
    • src0: number[]
    • srcOffset: number
    • src1: number[]
    • stcOffset1: number

    Returns number[]

set

  • set(x: number, y: number, z: number, w: number): this

  • Sets values of this quaternion.

    -

    Parameters

    • x: number
    • y: number
    • z: number
    • w: number

    Returns this

clone

  • clone(): this

  • Clones this quaternion.

    -

    Returns this

copy

  • copy(q: QuaternionLike): this

  • Copies values of q to this quaternion.

    -

    Parameters

    Returns this

setFromEuler

  • setFromEuler(euler: Euler, update?: boolean): this

  • Sets this quaternion from rotation specified by Euler angles.

    -

    Parameters

    • euler: Euler
    • Optionalupdate: boolean

    Returns this

setFromAxisAngle

setFromRotationMatrix

setFromUnitVectors

angleTo

  • angleTo(q: Quaternion): number

  • Parameters

    Returns number

rotateTowards

  • rotateTowards(q: Quaternion, step: number): this

  • Parameters

    Returns this

identity

  • identity(): this

  • Returns this

invert

  • invert(): this

  • Inverts this quaternion.

    -

    Returns this

conjugate

  • conjugate(): this

  • Returns this

dot

  • dot(v: Quaternion): number

  • Parameters

    Returns number

lengthSq

  • lengthSq(): number

  • Returns number

length

  • length(): number

  • Computes length of this quaternion.

    -

    Returns number

normalize

  • normalize(): this

  • Normalizes this quaternion.

    -

    Returns this

multiply

  • multiply(q: Quaternion): this

  • Multiplies this quaternion by b.

    -

    Parameters

    Returns this

premultiply

  • premultiply(q: Quaternion): this

  • Parameters

    Returns this

multiplyQuaternions

slerp

  • slerp(qb: Quaternion, t: number): this

  • Parameters

    Returns this

slerpQuaternions

equals

  • equals(v: Quaternion): boolean

  • Parameters

    Returns boolean

fromArray

  • fromArray(array: number[] | ArrayLike<number>, offset?: number): this

  • Sets this quaternion's x, y, z and w value from the provided array or array-like.

    -

    Parameters

    • array: number[] | ArrayLike<number>

      the source array or array-like.

      -
    • Optionaloffset: number

      (optional) offset into the array. Default is 0.

      -

    Returns this

toArray

  • toArray(array?: number[], offset?: number): number[]

  • Returns an array [x, y, z, w], or copies x, y, z and w into the provided array.

    -

    Parameters

    • Optionalarray: number[]

      (optional) array to store the quaternion to. If this is not provided, a new array will be created.

      -
    • Optionaloffset: number

      (optional) optional offset into the array.

      -

    Returns number[]

    The created or provided array.

    -
  • toArray(array?: QuaternionTuple, offset?: 0): QuaternionTuple

  • Returns an array [x, y, z, w], or copies x, y, z and w into the provided array.

    -

    Parameters

    • Optionalarray: QuaternionTuple

      (optional) array to store the quaternion to. If this is not provided, a new array will be created.

      -
    • Optionaloffset: 0

      (optional) optional offset into the array.

      -

    Returns QuaternionTuple

    The created or provided array.

    -
  • toArray(array: ArrayLike<number>, offset?: number): ArrayLike<number>

  • Copies x, y, z and w into the provided array-like.

    -

    Parameters

    • array: ArrayLike<number>

      array-like to store the quaternion to.

      -
    • Optionaloffset: number

      (optional) optional offset into the array.

      -

    Returns ArrayLike<number>

    The provided array-like.

    -

toJSON

  • toJSON(): [number, number, number, number]

  • This method defines the serialization result of Quaternion.

    -

    Returns [number, number, number, number]

    The numerical elements of this quaternion in an array of format [x, y, z, w].

    -

fromBufferAttribute

_onChange

  • _onChange(callback: () => void): this

  • Parameters

    • callback: () => void

    Returns this

random

  • random(): this

  • Returns this

[iterator]

  • "[iterator]"(): Generator<number, void>

  • Returns Generator<number, void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Ray.html b/docs/classes/Ray.html deleted file mode 100644 index 3bd5954..0000000 --- a/docs/classes/Ray.html +++ /dev/null @@ -1,36 +0,0 @@ -Ray | VFX-JS

Class Ray

Constructors

constructor -

Properties

origin -direction -

Methods

set -clone -copy -at -lookAt -recast -closestPointToPoint -distanceToPoint -distanceSqToPoint -distanceSqToSegment -intersectSphere -intersectsSphere -distanceToPlane -intersectPlane -intersectsPlane -intersectBox -intersectsBox -intersectTriangle -applyMatrix4 -equals -isIntersectionBox -isIntersectionPlane -isIntersectionSphere -

Constructors

constructor

  • new Ray(origin?: Vector3, direction?: Vector3): Ray

  • Parameters

    Returns Ray

Properties

origin

origin: Vector3

Default

new THREE.Vector3()
-
- -

direction

direction: Vector3

Default

new THREE.Vector3( 0, 0, - 1 )
-
- -

Methods

set

clone

  • clone(): this

  • Returns this

copy

  • copy(ray: Ray): this

  • Parameters

    Returns this

at

  • at(t: number, target: Vector3): Vector3

  • Parameters

    Returns Vector3

lookAt

  • lookAt(v: Vector3): Ray

  • Parameters

    Returns Ray

recast

  • recast(t: number): Ray

  • Parameters

    • t: number

    Returns Ray

closestPointToPoint

distanceToPoint

  • distanceToPoint(point: Vector3): number

  • Parameters

    Returns number

distanceSqToPoint

  • distanceSqToPoint(point: Vector3): number

  • Parameters

    Returns number

distanceSqToSegment

  • distanceSqToSegment(
        v0: Vector3,
        v1: Vector3,
        optionalPointOnRay?: Vector3,
        optionalPointOnSegment?: Vector3,
    ): number

  • Parameters

    Returns number

intersectSphere

intersectsSphere

  • intersectsSphere(sphere: Sphere): boolean

  • Parameters

    Returns boolean

distanceToPlane

  • distanceToPlane(plane: Plane): number

  • Parameters

    Returns number

intersectPlane

intersectsPlane

  • intersectsPlane(plane: Plane): boolean

  • Parameters

    Returns boolean

intersectBox

intersectsBox

  • intersectsBox(box: Box3): boolean

  • Parameters

    Returns boolean

intersectTriangle

applyMatrix4

  • applyMatrix4(matrix4: Matrix4): Ray

  • Parameters

    Returns Ray

equals

  • equals(ray: Ray): boolean

  • Parameters

    Returns boolean

isIntersectionBox

  • isIntersectionBox(b: any): any

  • Parameters

    • b: any

    Returns any

    Deprecated

    Use .intersectsBox() instead.

    -

isIntersectionPlane

  • isIntersectionPlane(p: any): any

  • Parameters

    • p: any

    Returns any

    Deprecated

    Use .intersectsPlane() instead.

    -

isIntersectionSphere

  • isIntersectionSphere(s: any): any

  • Parameters

    • s: any

    Returns any

    Deprecated

    Use .intersectsSphere() instead.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Raycaster.html b/docs/classes/Raycaster.html deleted file mode 100644 index 5b1b6d2..0000000 --- a/docs/classes/Raycaster.html +++ /dev/null @@ -1,81 +0,0 @@ -Raycaster | VFX-JS

Class Raycaster

This class is designed to assist with raycasting

-

Remarks

Raycasting is used for mouse picking (working out what objects in the 3d space the mouse is over) amongst other things.

-

Example

const raycaster = new THREE.Raycaster();
const pointer = new THREE.Vector2();

function onPointerMove(event) {
    // calculate pointer position in normalized device coordinates (-1 to +1) for both components
    pointer.x = (event.clientX / window.innerWidth) * 2 - 1;
    pointer.y = -(event.clientY / window.innerHeight) * 2 + 1;
}

function render() {
    // update the picking ray with the camera and pointer position
    raycaster.setFromCamera(pointer, camera);
    // calculate objects intersecting the picking ray
    const intersects = raycaster.intersectObjects(scene.children);
    for (let i = 0; i & lt; intersects.length; i++) {
        intersects[i].object.material.color.set(0xff0000);
    }
    renderer.render(scene, camera);
}
window.addEventListener('pointermove', onPointerMove);
window.requestAnimationFrame(render);
-
- -

See

-

Constructors

constructor -

Properties

ray -near -far -camera -layers -params -

Methods

set -setFromCamera -setFromXRController -intersectObject -intersectObjects -

Constructors

constructor

  • new Raycaster(
        origin?: Vector3,
        direction?: Vector3,
        near?: number,
        far?: number,
    ): Raycaster

  • This creates a new Raycaster object.

    -

    Parameters

    • Optionalorigin: Vector3

      The origin vector where the ray casts from. Default new Vector3()

      -
    • Optionaldirection: Vector3

      The direction vector that gives direction to the ray. Should be normalized. Default new Vector3(0, 0, -1)

      -
    • Optionalnear: number

      All results returned are further away than near. Near can't be negative. Expects a Float. Default 0

      -
    • Optionalfar: number

      All results returned are closer than far. Far can't be lower than near. Expects a Float. Default Infinity

      -

    Returns Raycaster

Properties

ray

ray: Ray

The THREE.RaycasterRay | Ray used for the raycasting.

-

near

near: number

The near factor of the raycaster. This value indicates which objects can be discarded based on the distance.
-This value shouldn't be negative and should be smaller than the far property.

-

Remarks

Expects a Float

-

Default Value

0

-

far

far: number

The far factor of the raycaster. This value indicates which objects can be discarded based on the distance.
-This value shouldn't be negative and should be larger than the near property.

-

Remarks

Expects a Float

-

Default Value

Infinity

-

camera

camera: Camera

The camera to use when raycasting against view-dependent objects such as billboarded objects like THREE.Sprites | Sprites.
-This field can be set manually or is set when calling setFromCamera.

-

Default Value

null

-

layers

layers: Layers

Used by Raycaster to selectively ignore 3D objects when performing intersection tests.
-The following code example ensures that only 3D objects on layer 1 will be honored by the instance of Raycaster.

-
raycaster.layers.set( 1 );
object.layers.enable( 1 );
-
- -

Default Value

new THREE.Layers() - See THREE.Layers | Layers.

-

params

params: RaycasterParameters

An data object where threshold is the precision of the Raycaster when intersecting objects, in world units.

-

Default Value

{ Mesh: {}, Line: { threshold: 1 }, LOD: {}, Points: { threshold: 1 }, Sprite: {} }

-

Methods

set

  • set(origin: Vector3, direction: Vector3): void

  • Updates the ray with a new origin and direction

    -

    Parameters

    • origin: Vector3

      The origin vector where the ray casts from.

      -
    • direction: Vector3

      The normalized direction vector that gives direction to the ray.

      -

    Returns void

    Remarks

    Please note that this method only copies the values from the arguments.

    -

setFromCamera

  • setFromCamera(coords: Vector2, camera: Camera): void

  • Updates the ray with a new origin and direction.

    -

    Parameters

    • coords: Vector2

      2D coordinates of the mouse, in normalized device coordinates (NDC)---X and Y components should be between -1 and 1.

      -
    • camera: Camera

      camera from which the ray should originate

      -

    Returns void

setFromXRController

  • setFromXRController(controller: XRTargetRaySpace): this

  • Updates the ray with a new origin and direction.

    -

    Parameters

    • controller: XRTargetRaySpace

      The controller to copy the position and direction from.

      -

    Returns this

intersectObject

  • intersectObject<TIntersected extends Object3D>(
        object: Object3D,
        recursive?: boolean,
        optionalTarget?: Intersection<TIntersected>[],
    ): Intersection<TIntersected>[]

  • Checks all intersection between the ray and the object with or without the descendants

    -

    Type Parameters

    Parameters

    • object: Object3D

      The object to check for intersection with the ray.

      -
    • Optionalrecursive: boolean

      If true, it also checks all descendants. Otherwise it only checks intersection with the object. Default true

      -
    • OptionaloptionalTarget: Intersection<TIntersected>[]

      Target to set the result. Otherwise a new Array | Array is instantiated.
      -If set, you must clear this array prior to each call (i.e., array.length = 0;). Default []

      -

    Returns Intersection<TIntersected>[]

    An array of intersections is returned.

    -

    Remarks

    Intersections are returned sorted by distance, closest first

    -

    See

    .intersectObjects().

    -

intersectObjects

  • intersectObjects<TIntersected extends Object3D>(
        objects: Object3D[],
        recursive?: boolean,
        optionalTarget?: Intersection<TIntersected>[],
    ): Intersection<TIntersected>[]

  • Checks all intersection between the ray and the objects with or without the descendants

    -

    Type Parameters

    Parameters

    • objects: Object3D[]

      The objects to check for intersection with the ray.

      -
    • Optionalrecursive: boolean

      If true, it also checks all descendants of the objects. Otherwise it only checks intersection with the objects. Default true

      -
    • OptionaloptionalTarget: Intersection<TIntersected>[]

      Target to set the result. Otherwise a new Array | Array is instantiated.
      -If set, you must clear this array prior to each call (i.e., array.length = 0;). Default []

      -

    Returns Intersection<TIntersected>[]

    An array of intersections is returned.

    -

    Remarks

    Intersections are returned sorted by distance, closest first

    -

    See

    .intersectObject().

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/RenderTarget.html b/docs/classes/RenderTarget.html deleted file mode 100644 index 66cf012..0000000 --- a/docs/classes/RenderTarget.html +++ /dev/null @@ -1,70 +0,0 @@ -RenderTarget | VFX-JS

Class RenderTarget<TTexture>

JavaScript events for custom objects

-

Example

// Adding events to a custom object
class Car extends EventDispatcher {
  start() {
    this.dispatchEvent( { type: 'start', message: 'vroom vroom!' } );
  }
};
// Using events with the custom object
const car = new Car();
car.addEventListener( 'start', ( event ) => {
  alert( event.message );
} );
car.start();
-
- -

See

-

Type Parameters

Hierarchy (View Summary)

Constructors

constructor -

Properties

isRenderTarget -width -height -depth -scissor -scissorTest -viewport -textures -depthBuffer -stencilBuffer -resolveDepthBuffer -resolveStencilBuffer -depthTexture -samples -

Accessors

texture -

Methods

setSize -clone -copy -dispose -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

ReadonlyisRenderTarget

isRenderTarget: true

width

width: number

height

height: number

depth

depth: number

scissor

scissor: Vector4

scissorTest

scissorTest: boolean

Default

false
-
- -

viewport

viewport: Vector4

textures

textures: TTexture[]

depthBuffer

depthBuffer: boolean

Default

true
-
- -

stencilBuffer

stencilBuffer: boolean

Default

false
-
- -

resolveDepthBuffer

resolveDepthBuffer: boolean

Defines whether the depth buffer should be resolved when rendering into a multisampled render target.

-

Default

true
-
- -

resolveStencilBuffer

resolveStencilBuffer: boolean

Defines whether the stencil buffer should be resolved when rendering into a multisampled render target.
-This property has no effect when .resolveDepthBuffer is set to false.

-

Default

true
-
- -

depthTexture

depthTexture: null | DepthTexture

Default

null
-
- -

samples

samples: number

Defines the count of MSAA samples. Can only be used with WebGL 2. Default is 0.

-

Default

0
-
- -

Accessors

texture

  • get texture(): TTexture

  • Returns TTexture

  • set texture(value: TTexture): void

  • Parameters

    Returns void

Methods

setSize

  • setSize(width: number, height: number, depth?: number): void

  • Parameters

    • width: number
    • height: number
    • Optionaldepth: number

    Returns void

clone

  • clone(): this

  • Returns this

copy

  • copy(source: RenderTarget): this

  • Parameters

    Returns this

dispose

  • dispose(): void

  • Returns void

addEventListener

hasEventListener

  • hasEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, RenderTarget<TTexture>>,
    ): boolean

  • Checks if listener is added to an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    Returns boolean

removeEventListener

dispatchEvent

  • dispatchEvent<T extends "dispose">(
        event: BaseEvent<T> & { dispose: {} }[T],
    ): void

  • Fire an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • event: BaseEvent<T> & { dispose: {} }[T]

      The event that gets fired.

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/Scene.html b/docs/classes/Scene.html deleted file mode 100644 index 79d5afc..0000000 --- a/docs/classes/Scene.html +++ /dev/null @@ -1,368 +0,0 @@ -Scene | VFX-JS

Class Scene

Scenes allow you to set up what and where is to be rendered by three.js

-

Remarks

This is where you place objects, lights and cameras.

-

See

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_UP -DEFAULT_MATRIX_AUTO_UPDATE -DEFAULT_MATRIX_WORLD_AUTO_UPDATE -isScene -type -fog -backgroundBlurriness -backgroundIntensity -overrideMaterial -background -backgroundRotation -environment -environmentIntensity -environmentRotation -isObject3D -id -uuid -name -parent -children -up -position -rotation -quaternion -scale -modelViewMatrix -normalMatrix -matrix -matrixWorld -matrixAutoUpdate -matrixWorldAutoUpdate -matrixWorldNeedsUpdate -layers -visible -castShadow -receiveShadow -frustumCulled -renderOrder -animations -userData -customDepthMaterial? -customDistanceMaterial? -

Methods

toJSON -onBeforeShadow -onAfterShadow -onBeforeRender -onAfterRender -applyMatrix4 -applyQuaternion -setRotationFromAxisAngle -setRotationFromEuler -setRotationFromMatrix -setRotationFromQuaternion -rotateOnAxis -rotateOnWorldAxis -rotateX -rotateY -rotateZ -translateOnAxis -translateX -translateY -translateZ -localToWorld -worldToLocal -lookAt -add -remove -removeFromParent -clear -attach -getObjectById -getObjectByName -getObjectByProperty -getObjectsByProperty -getWorldPosition -getWorldQuaternion -getWorldScale -getWorldDirection -raycast -traverse -traverseVisible -traverseAncestors -updateMatrix -updateMatrixWorld -updateWorldMatrix -clone -copy -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

StaticDEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight,
-THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

-

Default Value

new THREE.Vector3( 0, 1, 0)

-

StaticDEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

StaticDEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

ReadonlyisScene

isScene: true

Read-only flag to check if a given object is of type Scene.

-

Remarks

This is a constant value

-

Default Value

true

-

type

type: "Scene"

Default Value

Scene

-

fog

fog: null | Fog | FogExp2

A fog instance defining the type of fog that affects everything rendered in the scene.

-

Default Value

null

-

backgroundBlurriness

backgroundBlurriness: number

Sets the blurriness of the background. Only influences environment maps assigned to THREE.Scene.background | Scene.background.

-

Default Value

0

-

Remarks

Expects a Float between 0 and 1.

-

backgroundIntensity

backgroundIntensity: number

Attenuates the color of the background. Only applies to background textures.

-

Default Value

1

-

Remarks

Expects a Float

-

overrideMaterial

overrideMaterial: null | Material

Forces everything in the Scene to be rendered with the defined material.

-

Default Value

null

-

background

background: null | Texture | CubeTexture | Color

Defines the background of the scene.

-

Remarks

Valid inputs are:

-
    -
  • A THREE.Color | Color for defining a uniform colored background.
    • -
  • A THREE.Texture | Texture for defining a (flat) textured background.
    • -
  • Texture cubes (THREE.CubeTexture | CubeTexture) or equirectangular textures for defining a skybox.
    • -
-

Default Value

null

-

backgroundRotation

backgroundRotation: Euler

The rotation of the background in radians. Only influences environment maps assigned to .background.
-Default is (0,0,0).

-

environment

environment: null | Texture

Sets the environment map for all physical materials in the scene.
-However, it's not possible to overwrite an existing texture assigned to THREE.MeshStandardMaterial.envMap | MeshStandardMaterial.envMap.

-

Default Value

null

-

environmentIntensity

environmentIntensity: number

Attenuates the color of the environment. Only influences environment maps assigned to Scene.environment.

-

Default

1
-
- -

environmentRotation

environmentRotation: Euler

The rotation of the environment map in radians. Only influences physical materials in the scene when
-.environment is used. Default is (0,0,0).

-

ReadonlyisObject3D

isObject3D: true

Flag to check if a given object is of type Object3D.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Object3D instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
-Expects a Integer

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

parent

parent: null | Object3D

Object's parent in the scene graph.

-

Remarks

An object can have at most one parent.

-

Default Value

null

-

children

children: Object3D[]

Array with object's children.

-

See

THREE.Object3DGroup | Group for info on manually grouping objects.

-

Default Value

[]

-

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

-

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

-

Readonlyposition

position: Vector3

Object's local position.

-

Default Value

new THREE.Vector3() - that is (0, 0, 0).

-

Readonlyrotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

-

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

-

Readonlyquaternion

quaternion: Quaternion

Object's local rotation as a THREE.Quaternion | Quaternion.

-

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

-

Readonlyscale

scale: Vector3

The object's local scale.

-

Default Value

new THREE.Vector3( 1, 1, 1 )

-

ReadonlymodelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

-

ReadonlynormalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

-

matrix

matrix: Matrix4

The local transform matrix.

-

Default Value

new THREE.Matrix4()

-

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

-

Remarks

If the Object3D has no parent, then it's identical to the local transform THREE.Object3D.matrix | .matrix.

-

Default Value

new THREE.Matrix4()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and
-scale every frame and also recalculates the matrixWorld property.

-

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

-

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates.
-When it isn't, then you have to maintain all matrices in the object and its children yourself.

-

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

-

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

-

Default Value

false

-

layers

layers: Layers

The layer membership of the object.

-

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use.
-This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.

-

Default Value

new THREE.Layers()

-

visible

visible: boolean

Object gets rendered if true.

-

Default Value

true

-

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

-

Default Value

false

-

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

-

Default Value

false

-

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object.
-If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

-

Default Value

true

-

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph
-objects to be overridden although opaque and transparent objects remain sorted independently.

-

Remarks

When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.
-Sorting is from lowest to highest renderOrder.

-

Default Value

0

-

animations

animations: AnimationClip[]

Array with object's animation clips.

-

Default Value

[]

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the Object3D.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default

{}

-

OptionalcustomDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

-

Remarks

Can only be used in context of meshes.
-When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight,
-if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

-

Default Value

undefined

-

OptionalcustomDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

-

Default Value

undefined

-

Methods

toJSON

onBeforeShadow

  • onBeforeShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterShadow

  • onAfterShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onBeforeRender

  • onBeforeRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterRender

  • onAfterRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

applyMatrix4

  • applyMatrix4(matrix: Matrix4): void

  • Applies the matrix transform to the object and updates the object's position, rotation and scale.

    -

    Parameters

    Returns void

applyQuaternion

  • applyQuaternion(quaternion: Quaternion): this

  • Applies the rotation represented by the quaternion to the object.

    -

    Parameters

    Returns this

setRotationFromAxisAngle

  • setRotationFromAxisAngle(axis: Vector3, angle: number): void

  • Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      Angle in radians. Expects a Float

      -

    Returns void

setRotationFromEuler

  • setRotationFromEuler(euler: Euler): void

  • Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.

    -

    Parameters

    • euler: Euler

      Euler angle specifying rotation amount.

      -

    Returns void

setRotationFromMatrix

  • setRotationFromMatrix(m: Matrix4): void

  • Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

    -

    Parameters

    • m: Matrix4

      Rotate the quaternion by the rotation component of the matrix.

      -

    Returns void

    Remarks

    Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

    -

setRotationFromQuaternion

rotateOnAxis

  • rotateOnAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in object space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

rotateOnWorldAxis

  • rotateOnWorldAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in world space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in world space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized
    -Method Assumes no rotated parent.

    -

rotateX

  • rotateX(angle: number): this

  • Rotates the object around x axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateY

  • rotateY(angle: number): this

  • Rotates the object around y axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateZ

  • rotateZ(angle: number): this

  • Rotates the object around z axis in local space.

    -

    Parameters

    • angle: number

    Returns this

translateOnAxis

  • translateOnAxis(axis: Vector3, distance: number): this

  • Translate an object by distance along an axis in object space

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • distance: number

      The distance to translate. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

translateX

  • translateX(distance: number): this

  • Translates object along x axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateY

  • translateY(distance: number): this

  • Translates object along y axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateZ

  • translateZ(distance: number): this

  • Translates object along z axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

localToWorld

  • localToWorld(vector: Vector3): Vector3

  • Converts the vector from this object's local space to world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in this object's local space.

      -

    Returns Vector3

worldToLocal

  • worldToLocal(vector: Vector3): Vector3

  • Converts the vector from world space to this object's local space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space.

      -

    Returns Vector3

lookAt

  • lookAt(vector: Vector3): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space to look at.

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -
  • lookAt(x: number, y: number, z: number): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -

add

  • add(...object: Object3D[]): this

  • Adds another Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be added
    -Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.

    -

    See

      -
    • attach
      • -
    • THREE.Group | Group for info on manually grouping objects.
      • -
    -

remove

  • remove(...object: Object3D[]): this

  • Removes a Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be removed.

    -

    See

    THREE.Group | Group for info on manually grouping objects.

    -

removeFromParent

  • removeFromParent(): this

  • Removes this object from its current parent.

    -

    Returns this

clear

  • clear(): this

  • Removes all child objects.

    -

    Returns this

attach

  • attach(object: Object3D): this

  • Adds a Object3D as a child of this, while maintaining the object's world transform.

    -

    Parameters

    Returns this

    Remarks

    Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

    -

    See

    add

    -

getObjectById

  • getObjectById(id: number): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    -

    Parameters

    • id: number

      Unique number of the object instance. Expects a Integer

      -

    Returns undefined | Object3D

    Remarks

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    -

    See

    id

    -

getObjectByName

  • getObjectByName(name: string): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

    -

    Parameters

    • name: string

      String to match to the children's Object3D.name property.

      -

    Returns undefined | Object3D

    Remarks

    Note that for most objects the name is an empty string by default
    -You will have to set it manually to make use of this method.

    -

getObjectByProperty

  • getObjectByProperty(name: string, value: any): undefined | Object3D

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      the property name to search for.

      -
    • value: any

      value of the given property.

      -

    Returns undefined | Object3D

getObjectsByProperty

  • getObjectsByProperty(
        name: string,
        value: any,
        optionalTarget?: Object3D[],
    ): Object3D[]

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      The property name to search for.

      -
    • value: any

      Value of the given property.

      -
    • OptionaloptionalTarget: Object3D[]

      target to set the result. Otherwise a new Array is instantiated. If set, you must clear
      -this array prior to each call (i.e., array.length = 0;).

      -

    Returns Object3D[]

getWorldPosition

  • getWorldPosition(target: Vector3): Vector3

  • Returns a vector representing the position of the object in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldQuaternion

getWorldScale

  • getWorldScale(target: Vector3): Vector3

  • Returns a vector of the scaling factors applied to the object for each axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldDirection

  • getWorldDirection(target: Vector3): Vector3

  • Returns a vector representing the direction of object's positive z-axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

raycast

  • raycast(raycaster: Raycaster, intersects: Intersection[]): void

  • Abstract (empty) method to get intersections between a casted ray and this object

    -

    Parameters

    Returns void

    Remarks

    Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

    -

    See

    THREE.Raycaster | Raycaster

    -

    Default Value

    () => {}

    -

traverse

  • traverse(callback: (object: Object3D) => any): void

  • Executes the callback on this object and all descendants.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseVisible

  • traverseVisible(callback: (object: Object3D) => any): void

  • Like traverse, but the callback will only be executed for visible objects

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Descendants of invisible objects are not traversed.
    -Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseAncestors

  • traverseAncestors(callback: (object: Object3D) => any): void

  • Executes the callback on all ancestors.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

updateMatrix

  • updateMatrix(): void

  • Updates local transform.

    -

    Returns void

updateMatrixWorld

  • updateMatrixWorld(force?: boolean): void

  • Updates the global transform of the object.
    -And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

    -

    Parameters

    • Optionalforce: boolean

      A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame.
      -Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

      -

    Returns void

updateWorldMatrix

  • updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void

  • Updates the global transform of the object.

    -

    Parameters

    • updateParents: boolean

      Recursively updates global transform of ancestors.

      -
    • updateChildren: boolean

      Recursively updates global transform of descendants.

      -

    Returns void

clone

  • clone(recursive?: boolean): this

  • Returns a clone of this object and optionally all descendants.

    -

    Parameters

    • Optionalrecursive: boolean

      If true, descendants of the object are also cloned. Default true

      -

    Returns this

copy

  • copy(object: Object3D, recursive?: boolean): this

  • Copies the given object into this object.

    -

    Parameters

    • object: Object3D
    • Optionalrecursive: boolean

      If set to true, descendants of the object are copied next to the existing ones. If set to
      -false, descendants are left unchanged. Default is true.

      -

    Returns this

    Remarks

    Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

    -

addEventListener

hasEventListener

removeEventListener

dispatchEvent

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Source.html b/docs/classes/Source.html deleted file mode 100644 index b3d9051..0000000 --- a/docs/classes/Source.html +++ /dev/null @@ -1,38 +0,0 @@ -Source | VFX-JS

Class Source

Represents the data Source of a texture.

-

See

-

Constructors

constructor -

Properties

isSource -id -data -dataReady -uuid -version -

Accessors

needsUpdate -

Methods

toJSON -

Constructors

constructor

  • new Source(data: any): Source

  • Create a new instance of Source

    -

    Parameters

    • data: any

      The data definition of a texture. Default null

      -

    Returns Source

Properties

ReadonlyisSource

isSource: true

Flag to check if a given object is of type Source.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

data

data: any

The actual data of a texture.

-

Remarks

The type of this property depends on the texture that uses this instance.

-

dataReady

dataReady: boolean

This property is only relevant when .needsUpdate is set to true and provides more control on how
-texture data should be processed.
-When dataReady is set to false, the engine performs the memory allocation (if necessary) but does not
-transfer the data into the GPU memory.

-

Default

true
-
- -

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

version

version: number

This starts at 0 and counts how many times .needsUpdate is set to true.

-

Remarks

Expects a Integer

-

Default Value

0

-

Accessors

needsUpdate

  • set needsUpdate(value: boolean): void

  • When the property is set to true, the engine allocates the memory for the texture (if necessary) and triggers
    -the actual texture upload to the GPU next time the source is used.

    -

    Parameters

    • value: boolean

    Returns void

Methods

toJSON

  • toJSON(meta?: string | {}): SourceJSON

  • Convert the data Source to three.js JSON Object/Scene format.

    -

    Parameters

    • Optionalmeta: string | {}

      Optional object containing metadata.

      -

    Returns SourceJSON

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/SourceJSON.html b/docs/classes/SourceJSON.html deleted file mode 100644 index 86b3930..0000000 --- a/docs/classes/SourceJSON.html +++ /dev/null @@ -1,4 +0,0 @@ -SourceJSON | VFX-JS

Class SourceJSON

Constructors

constructor -

Properties

uuid -url -

Constructors

constructor

Properties

uuid

uuid: string

url

url: SerializedImage | SerializedImage[]

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/Sphere.html b/docs/classes/Sphere.html deleted file mode 100644 index 562afcb..0000000 --- a/docs/classes/Sphere.html +++ /dev/null @@ -1,32 +0,0 @@ -Sphere | VFX-JS

Class Sphere

Constructors

constructor -

Properties

isSphere -center -radius -

Methods

set -setFromPoints -clone -copy -expandByPoint -isEmpty -makeEmpty -containsPoint -distanceToPoint -intersectsSphere -intersectsBox -intersectsPlane -clampPoint -getBoundingBox -applyMatrix4 -translate -equals -union -empty -

Constructors

constructor

  • new Sphere(center?: Vector3, radius?: number): Sphere

  • Parameters

    • Optionalcenter: Vector3
    • Optionalradius: number

    Returns Sphere

Properties

ReadonlyisSphere

isSphere: true

Read-only flag to check if a given object is of type Sphere.

-

center

center: Vector3

Default

new Vector3()
-
- -

radius

radius: number

Default

1
-
- -

Methods

set

  • set(center: Vector3, radius: number): Sphere

  • Parameters

    Returns Sphere

setFromPoints

clone

  • clone(): this

  • Returns this

copy

  • copy(sphere: Sphere): this

  • Parameters

    Returns this

expandByPoint

  • expandByPoint(point: Vector3): this

  • Parameters

    Returns this

isEmpty

  • isEmpty(): boolean

  • Returns boolean

makeEmpty

  • makeEmpty(): this

  • Returns this

containsPoint

  • containsPoint(point: Vector3): boolean

  • Parameters

    Returns boolean

distanceToPoint

  • distanceToPoint(point: Vector3): number

  • Parameters

    Returns number

intersectsSphere

  • intersectsSphere(sphere: Sphere): boolean

  • Parameters

    Returns boolean

intersectsBox

  • intersectsBox(box: Box3): boolean

  • Parameters

    Returns boolean

intersectsPlane

  • intersectsPlane(plane: Plane): boolean

  • Parameters

    Returns boolean

clampPoint

getBoundingBox

  • getBoundingBox(target: Box3): Box3

  • Parameters

    Returns Box3

applyMatrix4

  • applyMatrix4(matrix: Matrix4): Sphere

  • Parameters

    Returns Sphere

translate

  • translate(offset: Vector3): Sphere

  • Parameters

    Returns Sphere

equals

  • equals(sphere: Sphere): boolean

  • Parameters

    Returns boolean

union

  • union(sphere: Sphere): this

  • Parameters

    Returns this

empty

  • empty(): any

  • Returns any

    Deprecated

    Use .isEmpty() instead.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Spherical.html b/docs/classes/Spherical.html deleted file mode 100644 index cd35c94..0000000 --- a/docs/classes/Spherical.html +++ /dev/null @@ -1,20 +0,0 @@ -Spherical | VFX-JS

Class Spherical

Constructors

constructor -

Properties

radius -phi -theta -

Methods

set -clone -copy -makeSafe -setFromVector3 -setFromCartesianCoords -

Constructors

constructor

  • new Spherical(radius?: number, phi?: number, theta?: number): Spherical

  • Parameters

    • Optionalradius: number
    • Optionalphi: number
    • Optionaltheta: number

    Returns Spherical

Properties

radius

radius: number

Default

1
-
- -

phi

phi: number

Default

0
-
- -

theta

theta: number

Default

0
-
- -

Methods

set

  • set(radius: number, phi: number, theta: number): this

  • Parameters

    • radius: number
    • phi: number
    • theta: number

    Returns this

clone

  • clone(): this

  • Returns this

copy

  • copy(other: Spherical): this

  • Parameters

    Returns this

makeSafe

  • makeSafe(): this

  • Returns this

setFromVector3

  • setFromVector3(v: Vector3): this

  • Parameters

    Returns this

setFromCartesianCoords

  • setFromCartesianCoords(x: number, y: number, z: number): this

  • Parameters

    • x: number
    • y: number
    • z: number

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Sprite.html b/docs/classes/Sprite.html deleted file mode 100644 index 4796467..0000000 --- a/docs/classes/Sprite.html +++ /dev/null @@ -1,338 +0,0 @@ -Sprite | VFX-JS

Class Sprite<TEventMap>

A Sprite is a plane that always faces towards the camera, generally with a partially transparent texture applied.

-

Remarks

Sprites do not cast shadows, setting castShadow = true will have no effect.

-

Example

const map = new THREE.TextureLoader().load('sprite.png');
const material = new THREE.SpriteMaterial({
    map: map
});
const {@link Sprite} = new THREE.Sprite(material);
scene.add(sprite);
-
- -

See

-

Type Parameters

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_UP -DEFAULT_MATRIX_AUTO_UPDATE -DEFAULT_MATRIX_WORLD_AUTO_UPDATE -isSprite -type -geometry -material -center -isObject3D -id -uuid -name -parent -children -up -position -rotation -quaternion -scale -modelViewMatrix -normalMatrix -matrix -matrixWorld -matrixAutoUpdate -matrixWorldAutoUpdate -matrixWorldNeedsUpdate -layers -visible -receiveShadow -frustumCulled -renderOrder -animations -userData -customDepthMaterial? -customDistanceMaterial? -

Methods

onBeforeShadow -onAfterShadow -onBeforeRender -onAfterRender -applyMatrix4 -applyQuaternion -setRotationFromAxisAngle -setRotationFromEuler -setRotationFromMatrix -setRotationFromQuaternion -rotateOnAxis -rotateOnWorldAxis -rotateX -rotateY -rotateZ -translateOnAxis -translateX -translateY -translateZ -localToWorld -worldToLocal -lookAt -add -remove -removeFromParent -clear -attach -getObjectById -getObjectByName -getObjectByProperty -getObjectsByProperty -getWorldPosition -getWorldQuaternion -getWorldScale -getWorldDirection -raycast -traverse -traverseVisible -traverseAncestors -updateMatrix -updateMatrixWorld -updateWorldMatrix -toJSON -clone -copy -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

StaticDEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight,
-THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

-

Default Value

new THREE.Vector3( 0, 1, 0)

-

StaticDEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

StaticDEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

ReadonlyisSprite

isSprite: true

Read-only flag to check if a given object is of type Sprite.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlytype

type: string

Default Value

Sprite

-

geometry

geometry: BufferGeometry

material

material: SpriteMaterial

An instance of THREE.SpriteMaterial | SpriteMaterial, defining the object's appearance.

-

Default Value

THREE.SpriteMaterial | new SpriteMaterial(), with white color.

-

center

center: Vector2

The sprite's anchor point, and the point around which the Sprite rotates.
-A value of (0.5, 0.5) corresponds to the midpoint of the sprite.
-A value of (0, 0) corresponds to the lower left corner of the sprite.

-

Default Value

THREE.Vector2 | new Vector2(0.5, 0.5).

-

ReadonlyisObject3D

isObject3D: true

Flag to check if a given object is of type Object3D.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Object3D instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
-Expects a Integer

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

parent

parent: null | Object3D

Object's parent in the scene graph.

-

Remarks

An object can have at most one parent.

-

Default Value

null

-

children

children: Object3D[]

Array with object's children.

-

See

THREE.Object3DGroup | Group for info on manually grouping objects.

-

Default Value

[]

-

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

-

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

-

Readonlyposition

position: Vector3

Object's local position.

-

Default Value

new THREE.Vector3() - that is (0, 0, 0).

-

Readonlyrotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

-

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

-

Readonlyquaternion

quaternion: Quaternion

Object's local rotation as a THREE.Quaternion | Quaternion.

-

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

-

Readonlyscale

scale: Vector3

The object's local scale.

-

Default Value

new THREE.Vector3( 1, 1, 1 )

-

ReadonlymodelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

-

ReadonlynormalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

-

matrix

matrix: Matrix4

The local transform matrix.

-

Default Value

new THREE.Matrix4()

-

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

-

Remarks

If the Object3D has no parent, then it's identical to the local transform THREE.Object3D.matrix | .matrix.

-

Default Value

new THREE.Matrix4()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and
-scale every frame and also recalculates the matrixWorld property.

-

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

-

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates.
-When it isn't, then you have to maintain all matrices in the object and its children yourself.

-

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

-

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

-

Default Value

false

-

layers

layers: Layers

The layer membership of the object.

-

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use.
-This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.

-

Default Value

new THREE.Layers()

-

visible

visible: boolean

Object gets rendered if true.

-

Default Value

true

-

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

-

Default Value

false

-

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object.
-If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

-

Default Value

true

-

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph
-objects to be overridden although opaque and transparent objects remain sorted independently.

-

Remarks

When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.
-Sorting is from lowest to highest renderOrder.

-

Default Value

0

-

animations

animations: AnimationClip[]

Array with object's animation clips.

-

Default Value

[]

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the Object3D.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default

{}

-

OptionalcustomDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

-

Remarks

Can only be used in context of meshes.
-When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight,
-if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

-

Default Value

undefined

-

OptionalcustomDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

-

Default Value

undefined

-

Methods

onBeforeShadow

  • onBeforeShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterShadow

  • onAfterShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onBeforeRender

  • onBeforeRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterRender

  • onAfterRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

applyMatrix4

  • applyMatrix4(matrix: Matrix4): void

  • Applies the matrix transform to the object and updates the object's position, rotation and scale.

    -

    Parameters

    Returns void

applyQuaternion

  • applyQuaternion(quaternion: Quaternion): this

  • Applies the rotation represented by the quaternion to the object.

    -

    Parameters

    Returns this

setRotationFromAxisAngle

  • setRotationFromAxisAngle(axis: Vector3, angle: number): void

  • Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      Angle in radians. Expects a Float

      -

    Returns void

setRotationFromEuler

  • setRotationFromEuler(euler: Euler): void

  • Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.

    -

    Parameters

    • euler: Euler

      Euler angle specifying rotation amount.

      -

    Returns void

setRotationFromMatrix

  • setRotationFromMatrix(m: Matrix4): void

  • Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

    -

    Parameters

    • m: Matrix4

      Rotate the quaternion by the rotation component of the matrix.

      -

    Returns void

    Remarks

    Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

    -

setRotationFromQuaternion

rotateOnAxis

  • rotateOnAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in object space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

rotateOnWorldAxis

  • rotateOnWorldAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in world space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in world space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized
    -Method Assumes no rotated parent.

    -

rotateX

  • rotateX(angle: number): this

  • Rotates the object around x axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateY

  • rotateY(angle: number): this

  • Rotates the object around y axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateZ

  • rotateZ(angle: number): this

  • Rotates the object around z axis in local space.

    -

    Parameters

    • angle: number

    Returns this

translateOnAxis

  • translateOnAxis(axis: Vector3, distance: number): this

  • Translate an object by distance along an axis in object space

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • distance: number

      The distance to translate. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

translateX

  • translateX(distance: number): this

  • Translates object along x axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateY

  • translateY(distance: number): this

  • Translates object along y axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateZ

  • translateZ(distance: number): this

  • Translates object along z axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

localToWorld

  • localToWorld(vector: Vector3): Vector3

  • Converts the vector from this object's local space to world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in this object's local space.

      -

    Returns Vector3

worldToLocal

  • worldToLocal(vector: Vector3): Vector3

  • Converts the vector from world space to this object's local space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space.

      -

    Returns Vector3

lookAt

  • lookAt(vector: Vector3): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space to look at.

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -
  • lookAt(x: number, y: number, z: number): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -

add

  • add(...object: Object3D[]): this

  • Adds another Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be added
    -Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.

    -

    See

      -
    • attach
      • -
    • THREE.Group | Group for info on manually grouping objects.
      • -
    -

remove

  • remove(...object: Object3D[]): this

  • Removes a Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be removed.

    -

    See

    THREE.Group | Group for info on manually grouping objects.

    -

removeFromParent

  • removeFromParent(): this

  • Removes this object from its current parent.

    -

    Returns this

clear

  • clear(): this

  • Removes all child objects.

    -

    Returns this

attach

  • attach(object: Object3D): this

  • Adds a Object3D as a child of this, while maintaining the object's world transform.

    -

    Parameters

    Returns this

    Remarks

    Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

    -

    See

    add

    -

getObjectById

  • getObjectById(id: number): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    -

    Parameters

    • id: number

      Unique number of the object instance. Expects a Integer

      -

    Returns undefined | Object3D

    Remarks

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    -

    See

    id

    -

getObjectByName

  • getObjectByName(name: string): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

    -

    Parameters

    • name: string

      String to match to the children's Object3D.name property.

      -

    Returns undefined | Object3D

    Remarks

    Note that for most objects the name is an empty string by default
    -You will have to set it manually to make use of this method.

    -

getObjectByProperty

  • getObjectByProperty(name: string, value: any): undefined | Object3D

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      the property name to search for.

      -
    • value: any

      value of the given property.

      -

    Returns undefined | Object3D

getObjectsByProperty

  • getObjectsByProperty(
        name: string,
        value: any,
        optionalTarget?: Object3D[],
    ): Object3D[]

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      The property name to search for.

      -
    • value: any

      Value of the given property.

      -
    • OptionaloptionalTarget: Object3D[]

      target to set the result. Otherwise a new Array is instantiated. If set, you must clear
      -this array prior to each call (i.e., array.length = 0;).

      -

    Returns Object3D[]

getWorldPosition

  • getWorldPosition(target: Vector3): Vector3

  • Returns a vector representing the position of the object in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldQuaternion

getWorldScale

  • getWorldScale(target: Vector3): Vector3

  • Returns a vector of the scaling factors applied to the object for each axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldDirection

  • getWorldDirection(target: Vector3): Vector3

  • Returns a vector representing the direction of object's positive z-axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

raycast

  • raycast(raycaster: Raycaster, intersects: Intersection[]): void

  • Abstract (empty) method to get intersections between a casted ray and this object

    -

    Parameters

    Returns void

    Remarks

    Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

    -

    See

    THREE.Raycaster | Raycaster

    -

    Default Value

    () => {}

    -

traverse

  • traverse(callback: (object: Object3D) => any): void

  • Executes the callback on this object and all descendants.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseVisible

  • traverseVisible(callback: (object: Object3D) => any): void

  • Like traverse, but the callback will only be executed for visible objects

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Descendants of invisible objects are not traversed.
    -Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseAncestors

  • traverseAncestors(callback: (object: Object3D) => any): void

  • Executes the callback on all ancestors.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

updateMatrix

  • updateMatrix(): void

  • Updates local transform.

    -

    Returns void

updateMatrixWorld

  • updateMatrixWorld(force?: boolean): void

  • Updates the global transform of the object.
    -And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

    -

    Parameters

    • Optionalforce: boolean

      A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame.
      -Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

      -

    Returns void

updateWorldMatrix

  • updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void

  • Updates the global transform of the object.

    -

    Parameters

    • updateParents: boolean

      Recursively updates global transform of ancestors.

      -
    • updateChildren: boolean

      Recursively updates global transform of descendants.

      -

    Returns void

toJSON

clone

  • clone(recursive?: boolean): this

  • Returns a clone of this object and optionally all descendants.

    -

    Parameters

    • Optionalrecursive: boolean

      If true, descendants of the object are also cloned. Default true

      -

    Returns this

copy

  • copy(object: Object3D, recursive?: boolean): this

  • Copies the given object into this object.

    -

    Parameters

    • object: Object3D
    • Optionalrecursive: boolean

      If set to true, descendants of the object are copied next to the existing ones. If set to
      -false, descendants are left unchanged. Default is true.

      -

    Returns this

    Remarks

    Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

    -

addEventListener

hasEventListener

removeEventListener

dispatchEvent

  • dispatchEvent<T extends string>(event: BaseEvent<T> & TEventMap[T]): void

  • Fire an event type.

    -

    Type Parameters

    • T extends string

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/SpriteMaterial.html b/docs/classes/SpriteMaterial.html deleted file mode 100644 index e1ba529..0000000 --- a/docs/classes/SpriteMaterial.html +++ /dev/null @@ -1,336 +0,0 @@ -SpriteMaterial | VFX-JS

Class SpriteMaterial

Materials describe the appearance of objects. They are defined in a (mostly) renderer-independent way, so you don't have to rewrite materials if you decide to use a different renderer.

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

isSpriteMaterial -color -map -alphaMap -rotation -sizeAttenuation -transparent -fog -isMaterial -type -alphaHash -alphaToCoverage -blendAlpha -blendColor -blendDst -blendDstAlpha -blendEquation -blendEquationAlpha -blending -blendSrc -blendSrcAlpha -clipIntersection -clippingPlanes -clipShadows -colorWrite -defines -depthFunc -depthTest -depthWrite -id -stencilWrite -stencilFunc -stencilRef -stencilWriteMask -stencilFuncMask -stencilFail -stencilZFail -stencilZPass -name -opacity -polygonOffset -polygonOffsetFactor -polygonOffsetUnits -precision -premultipliedAlpha -forceSinglePass -dithering -side -shadowSide -toneMapped -uuid -vertexColors -visible -userData -version -

Accessors

alphaTest -needsUpdate -

Methods

setValues -copy -onBeforeRender -onBeforeCompile -customProgramCacheKey -toJSON -clone -dispose -onBuild -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

ReadonlyisSpriteMaterial

isSpriteMaterial: true

Read-only flag to check if a given object is of type SpriteMaterial.

-

Remarks

This is a constant value

-

Default Value

true

-

color

color: Color

Default

new THREE.Color( 0xffffff )
-
- -

map

map: null | Texture

Default

null
-
- -

alphaMap

alphaMap: null | Texture

Default

null
-
- -

rotation

rotation: number

Default

0
-
- -

sizeAttenuation

sizeAttenuation: boolean

Default

true
-
- -

transparent

transparent: boolean

Default

true
-
- -

fog

fog: boolean

Whether the material is affected by fog. Default is true.

-

Default

fog
-
- -

ReadonlyisMaterial

isMaterial: true

Read-only flag to check if a given object is of type Material.

-

Remarks

This is a constant value

-

Default Value

true

-

type

type: string

Value is the string 'Material'. This shouldn't be changed, and can be used to find all objects of this type in a
-scene.

-

alphaHash

alphaHash: boolean

Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material
-will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise,
-but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the
-resulting noise.

-

alphaToCoverage

alphaToCoverage: boolean

Enables alpha to coverage. Can only be used with MSAA-enabled rendering contexts (meaning when the renderer was
-created with antialias parameter set to true). Enabling this will smooth aliasing on clip plane edges and
-alphaTest-clipped edges.

-

Default

false
-
- -

blendAlpha

blendAlpha: number

Represents the alpha value of the constant blend color. This property has only an effect when using custom
-blending with ConstantAlphaFactor or OneMinusConstantAlphaFactor.

-

Default

0
-
- -

blendColor

blendColor: Color

Represent the RGB values of the constant blend color. This property has only an effect when using custom
-blending with ConstantColorFactor or OneMinusConstantColorFactor.

-

Default

0x000000
-
- -

blendDst

blendDst: BlendingDstFactor

Blending destination. It's one of the blending mode constants defined in Three.js. Default is OneMinusSrcAlphaFactor.

-

Default

THREE.OneMinusSrcAlphaFactor
-
- -

blendDstAlpha

blendDstAlpha: null | number

The tranparency of the .blendDst. Default is null.

-

Default

null
-
- -

blendEquation

blendEquation: BlendingEquation

Blending equation to use when applying blending. It's one of the constants defined in Three.js. Default is AddEquation.

-

Default

THREE.AddEquation
-
- -

blendEquationAlpha

blendEquationAlpha: null | number

The tranparency of the .blendEquation. Default is null.

-

Default

null
-
- -

blending

blending: Blending

Which blending to use when displaying objects with this material. Default is NormalBlending.

-

Default

THREE.NormalBlending
-
- -

blendSrc

blendSrc:
    | 200
    | 201
    | 202
    | 203
    | 204
    | 205
    | 206
    | 207
    | 208
    | 209
    | 210
    | 211
    | 212
    | 213
    | 214

Blending source. It's one of the blending mode constants defined in Three.js. Default is SrcAlphaFactor.

-

Default

THREE.SrcAlphaFactor
-
- -

blendSrcAlpha

blendSrcAlpha: null | number

The tranparency of the .blendSrc. Default is null.

-

Default

null
-
- -

clipIntersection

clipIntersection: boolean

Changes the behavior of clipping planes so that only their intersection is clipped, rather than their union. Default is false.

-

Default

false
-
- -

clippingPlanes

clippingPlanes: null | Plane[]

User-defined clipping planes specified as THREE.Plane objects in world space.
-These planes apply to the objects this material is attached to.
-Points in space whose signed distance to the plane is negative are clipped (not rendered).
-See the WebGL / clipping /intersection example. Default is null.

-

Default

null
-
- -

clipShadows

clipShadows: boolean

Defines whether to clip shadows according to the clipping planes specified on this material. Default is false.

-

Default

false
-
- -

colorWrite

colorWrite: boolean

Whether to render the material's color. This can be used in conjunction with a mesh's .renderOrder property to create invisible objects that occlude other objects. Default is true.

-

Default

true
-
- -

defines

defines: undefined | { [key: string]: any }

Custom defines to be injected into the shader. These are passed in form of an object literal, with key/value pairs. { MY_CUSTOM_DEFINE: '' , PI2: Math.PI * 2 }.
-The pairs are defined in both vertex and fragment shaders. Default is undefined.

-

Default

undefined
-
- -

depthFunc

depthFunc: DepthModes

Which depth function to use. Default is LessEqualDepth. See the depth mode constants for all possible values.

-

Default

THREE.LessEqualDepth
-
- -

depthTest

depthTest: boolean

Whether to have depth test enabled when rendering this material. When the depth test is disabled, the depth write
-will also be implicitly disabled.

-

Default

true
-
- -

depthWrite

depthWrite: boolean

Whether rendering this material has any effect on the depth buffer. Default is true.
-When drawing 2D overlays it can be useful to disable the depth writing in order to layer several things together without creating z-index artifacts.

-

Default

true
-
- -

id

id: number

Unique number of this material instance.

-

stencilWrite

stencilWrite: boolean

Whether rendering this material has any effect on the stencil buffer. Default is false.

-

Default

false
-
- -

stencilFunc

stencilFunc: StencilFunc

The stencil comparison function to use. Default is AlwaysStencilFunc. See stencil operation constants for all possible values.

-

Default

THREE.AlwaysStencilFunc
-
- -

stencilRef

stencilRef: number

The value to use when performing stencil comparisons or stencil operations. Default is 0.

-

Default

0
-
- -

stencilWriteMask

stencilWriteMask: number

The bit mask to use when writing to the stencil buffer. Default is 0xFF.

-

Default

0xff
-
- -

stencilFuncMask

stencilFuncMask: number

The bit mask to use when comparing against the stencil buffer. Default is 0xFF.

-

Default

0xff
-
- -

stencilFail

stencilFail: StencilOp

Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

-

Default

THREE.KeepStencilOp
-
- -

stencilZFail

stencilZFail: StencilOp

Which stencil operation to perform when the comparison function returns true but the depth test fails.
-Default is KeepStencilOp.
-See the stencil operation constants for all possible values.

-

Default

THREE.KeepStencilOp
-
- -

stencilZPass

stencilZPass: StencilOp

Which stencil operation to perform when the comparison function returns true and the depth test passes.
-Default is KeepStencilOp.
-See the stencil operation constants for all possible values.

-

Default

THREE.KeepStencilOp
-
- -

name

name: string

Material name. Default is an empty string.

-

Default

''
-
- -

opacity

opacity: number

Opacity. Default is 1.

-

Default

1
-
- -

polygonOffset

polygonOffset: boolean

Whether to use polygon offset. Default is false. This corresponds to the POLYGON_OFFSET_FILL WebGL feature.

-

Default

false
-
- -

polygonOffsetFactor

polygonOffsetFactor: number

Sets the polygon offset factor. Default is 0.

-

Default

0
-
- -

polygonOffsetUnits

polygonOffsetUnits: number

Sets the polygon offset units. Default is 0.

-

Default

0
-
- -

precision

precision: null | "highp" | "mediump" | "lowp"

Override the renderer's default precision for this material. Can be "highp", "mediump" or "lowp". Defaults is null.

-

Default

null
-
- -

premultipliedAlpha

premultipliedAlpha: boolean

Whether to premultiply the alpha (transparency) value. See WebGL / Materials / Transparency for an example of the difference. Default is false.

-

Default

false
-
- -

forceSinglePass

forceSinglePass: boolean

Default

false
-
- -

dithering

dithering: boolean

Whether to apply dithering to the color to remove the appearance of banding. Default is false.

-

Default

false
-
- -

side

side: Side

Defines which of the face sides will be rendered - front, back or both.
-Default is THREE.FrontSide. Other options are THREE.BackSide and THREE.DoubleSide.

-

Default

THREE.FrontSide

-

shadowSide

shadowSide: null | Side

Defines which of the face sides will cast shadows. Default is null.
-If null, the value is opposite that of side, above.

-

Default

null
-
- -

toneMapped

toneMapped: boolean

Defines whether this material is tone mapped according to the renderer's
-toneMapping setting. It is ignored when rendering to a render target or using
-post processing.

-

Default

true
-
- -

uuid

uuid: string

UUID of this material instance. This gets automatically assigned, so this shouldn't be edited.

-

vertexColors

vertexColors: boolean

Defines whether vertex coloring is used. Default is false.

-

Default

false
-
- -

visible

visible: boolean

Defines whether this material is visible. Default is true.

-

Default

true
-
- -

userData

userData: Record<string, any>

An object that can be used to store custom data about the Material. It should not hold references to functions as these will not be cloned.

-

Default

{}
-
- -

version

version: number

This starts at 0 and counts how many times .needsUpdate is set to true.

-

Default

0
-
- -

Accessors

alphaTest

  • get alphaTest(): number

  • Gets the alpha value to be used when running an alpha test. Default is 0.

    -

    Returns number

    Default

    0
-
    - -
  • set alphaTest(value: number): void

  • Sets the alpha value to be used when running an alpha test. Default is 0.

    -

    Parameters

    • value: number

    Returns void

    Default

    0
-
    - -

needsUpdate

  • set needsUpdate(value: boolean): void

  • Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL.
    -This property is automatically set to true when instancing a new material.

    -

    Parameters

    • value: boolean

    Returns void

    Default

    false
-
    - -

Methods

setValues

copy

  • copy(source: SpriteMaterial): this

  • Copy the parameters from the passed material into this material.

    -

    Parameters

    Returns this

onBeforeRender

  • onBeforeRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        object: Object3D,
        group: Group,
    ): void

  • An optional callback that is executed immediately before the material is used to render a 3D object.
    -Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON().
    -This callback is only supported in WebGLRenderer (not WebGPURenderer).

    -

    Parameters

    Returns void

onBeforeCompile

  • onBeforeCompile(
        parameters: WebGLProgramParametersWithUniforms,
        renderer: WebGLRenderer,
    ): void

  • An optional callback that is executed immediately before the shader program is compiled.
    -This function is called with the shader source code as a parameter.
    -Useful for the modification of built-in materials.
    -Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON().
    -This callback is only supported in WebGLRenderer (not WebGPURenderer).

    -

    Parameters

    Returns void

customProgramCacheKey

  • customProgramCacheKey(): string

  • In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.

    -

    Returns string

toJSON

  • toJSON(meta?: JSONMeta): MaterialJSON

  • Convert the material to three.js JSON format.

    -

    Parameters

    • Optionalmeta: JSONMeta

      Object containing metadata such as textures or images for the material.

      -

    Returns MaterialJSON

clone

  • clone(): this

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

    -

    Returns this

dispose

  • dispose(): void

  • Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer
    -used in your app.

    -

    Material textures must be disposed of by the dispose() method of Texture.

    -

    Returns void

onBuild

addEventListener

  • addEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, SpriteMaterial>,
    ): void

  • Adds a listener to an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

      -
    • listener: EventListener<{ dispose: {} }[T], T, SpriteMaterial>

      The function that gets called when the event is fired.

      -

    Returns void

hasEventListener

  • hasEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, SpriteMaterial>,
    ): boolean

  • Checks if listener is added to an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

      -
    • listener: EventListener<{ dispose: {} }[T], T, SpriteMaterial>

      The function that gets called when the event is fired.

      -

    Returns boolean

removeEventListener

  • removeEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, SpriteMaterial>,
    ): void

  • Removes a listener from an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of the listener that gets removed.

      -
    • listener: EventListener<{ dispose: {} }[T], T, SpriteMaterial>

      The listener function that gets removed.

      -

    Returns void

dispatchEvent

  • dispatchEvent<T extends "dispose">(
        event: BaseEvent<T> & { dispose: {} }[T],
    ): void

  • Fire an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • event: BaseEvent<T> & { dispose: {} }[T]

      The event that gets fired.

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/StencilBuffer.html b/docs/classes/StencilBuffer.html deleted file mode 100644 index 5bfde78..0000000 --- a/docs/classes/StencilBuffer.html +++ /dev/null @@ -1,9 +0,0 @@ -StencilBuffer | VFX-JS

Class StencilBuffer

Constructors

constructor -

Methods

setTest -setMask -setFunc -setOp -setLocked -setClear -reset -

Constructors

constructor

  • new StencilBuffer(): StencilBuffer

  • Returns StencilBuffer

Methods

setTest

  • setTest(stencilTest: boolean): void

  • Parameters

    • stencilTest: boolean

    Returns void

setMask

  • setMask(stencilMask: number): void

  • Parameters

    • stencilMask: number

    Returns void

setFunc

  • setFunc(stencilFunc: number, stencilRef: number, stencilMask: number): void

  • Parameters

    • stencilFunc: number
    • stencilRef: number
    • stencilMask: number

    Returns void

setOp

  • setOp(stencilFail: number, stencilZFail: number, stencilZPass: number): void

  • Parameters

    • stencilFail: number
    • stencilZFail: number
    • stencilZPass: number

    Returns void

setLocked

  • setLocked(lock: boolean): void

  • Parameters

    • lock: boolean

    Returns void

setClear

  • setClear(stencil: number): void

  • Parameters

    • stencil: number

    Returns void

reset

  • reset(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/Texture.html b/docs/classes/Texture.html deleted file mode 100644 index 8738487..0000000 --- a/docs/classes/Texture.html +++ /dev/null @@ -1,267 +0,0 @@ -Texture | VFX-JS

Class Texture

Create a Texture to apply to a surface or as a reflection or refraction map.

-

Remarks

After the initial use of a texture, its dimensions, format, and type cannot be changed
-Instead, call .dispose() on the Texture and instantiate a new Texture.

-

Example

// load a texture, set wrap mode to repeat
const texture = new THREE.TextureLoader().load("textures/water.jpg");
texture.wrapS = THREE.RepeatWrapping;
texture.wrapT = THREE.RepeatWrapping;
texture.repeat.set(4, 4);
-
- -

See

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_ANISOTROPY -DEFAULT_IMAGE -DEFAULT_MAPPING -isTexture -id -uuid -name -source -mipmaps -mapping -channel -wrapS -wrapT -magFilter -minFilter -anisotropy -format -type -internalFormat -matrix -matrixAutoUpdate -offset -repeat -center -rotation -generateMipmaps -premultiplyAlpha -flipY -unpackAlignment -colorSpace -isRenderTargetTexture -userData -version -pmremVersion -onUpdate -

Accessors

image -needsUpdate -needsPMREMUpdate -

Methods

transformUv -updateMatrix -clone -copy -toJSON -dispose -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

StaticDEFAULT_ANISOTROPY

DEFAULT_ANISOTROPY: number

The Global default value for .anisotropy.

-

Default Value

1.

-

StaticDEFAULT_IMAGE

DEFAULT_IMAGE: any

The Global default value for .image.

-

Default Value

null.

-

StaticDEFAULT_MAPPING

DEFAULT_MAPPING: Mapping

The Global default value for .mapping.

-

Default Value

THREE.UVMapping

-

ReadonlyisTexture

isTexture: true

Read-only flag to check if a given object is of type Texture.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Texture instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

source

source: Source

The data definition of a texture. A reference to the data source can be shared across textures.
-This is often useful in context of spritesheets where multiple textures render the same data
-but with different Texture transformations.

-

mipmaps

mipmaps:
    | undefined
    | CompressedTextureMipmap[]
    | CubeTexture[]
    | HTMLCanvasElement[]

Array of user-specified mipmaps

-

Default Value

[]

-

mapping

mapping: AnyMapping

How the image is applied to the object.

-

Remarks

All Texture types except THREE.CubeTexture expect the values be THREE.Mapping

-

See

Texture Constants

-

Default Value

value of THREE.Texture.DEFAULT_MAPPING

-

channel

channel: number

Lets you select the uv attribute to map the texture to. 0 for uv, 1 for uv1, 2 for uv2 and 3 for
-uv3.

-

wrapS

wrapS: Wrapping

This defines how the Texture is wrapped horizontally and corresponds to U in UV mapping.

-

Remarks

for WEBGL1 - tiling of images in textures only functions if image dimensions are powers of two
-(2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, ...) in terms of pixels.
-Individual dimensions need not be equal, but each must be a power of two. This is a limitation of WebGL1, not three.js.
-WEBGL2 does not have this limitation.

-

See

-

Default Value

THREE.ClampToEdgeWrapping

-

wrapT

wrapT: Wrapping

This defines how the Texture is wrapped vertically and corresponds to V in UV mapping.

-

Remarks

for WEBGL1 - tiling of images in textures only functions if image dimensions are powers of two
-(2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, ...) in terms of pixels.
-Individual dimensions need not be equal, but each must be a power of two. This is a limitation of WebGL1, not three.js.
-WEBGL2 does not have this limitation.

-

See

-

Default Value

THREE.ClampToEdgeWrapping

-

magFilter

magFilter: MagnificationTextureFilter

How the Texture is sampled when a texel covers more than one pixel.

-

See

-

Default Value

THREE.LinearFilter

-

minFilter

minFilter: MinificationTextureFilter

How the Texture is sampled when a texel covers less than one pixel.

-

See

-

Default Value

THREE.LinearMipmapLinearFilter

-

anisotropy

anisotropy: number

The number of samples taken along the axis through the pixel that has the highest density of texels.

-

Remarks

A higher value gives a less blurry result than a basic mipmap, at the cost of more Texture samples being used.

-

Default

value of THREE.Texture.DEFAULT_ANISOTROPY. That is normally 1.

-

format

format: AnyPixelFormat

These define how elements of a 2D texture, or texels, are read by shaders.

-

Remarks

All Texture types except THREE.DepthTexture and THREE.CompressedPixelFormat expect the values be THREE.PixelFormat

-

See

-

Default Value

THREE.RGBAFormat.

-

type

type: TextureDataType

This must correspond to the .format.

-

Remarks

THREE.UnsignedByteType, is the type most used by Texture formats.

-

See

-

Default Value

THREE.UnsignedByteType

-

internalFormat

internalFormat: null | PixelFormatGPU

The GPU Pixel Format allows the developer to specify how the data is going to be stored on the GPU.

-

Remarks

Compatible only with WebGL2RenderingContext | WebGL 2 Rendering Context.

-

See

Texture Constants

-

Default Value

The default value is obtained using a combination of .format and .type.

-

matrix

matrix: Matrix3

The uv-transform matrix for the texture.

-

Remarks

When .matrixAutoUpdate property is true.
-Will be updated by the renderer from the properties:

- -

See

.matrixAutoUpdate

-

Default Value

new THREE.Matrix3()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

Whether is to update the texture's uv-transform .matrix.

-

Remarks

Set this to false if you are specifying the uv-transform matrix directly.

-

See

.matrix

-

Default Value

true

-

offset

offset: Vector2

How much a single repetition of the texture is offset from the beginning, in each direction U and V.

-

Remarks

Typical range is 0.0 to 1.0.

-

Default Value

new THREE.Vector2(0, 0)

-

repeat

repeat: Vector2

How many times the texture is repeated across the surface, in each direction U and V.

-

Remarks

If repeat is set greater than 1 in either direction, the corresponding Wrap parameter should
-also be set to THREE.RepeatWrapping or THREE.MirroredRepeatWrapping to achieve the desired tiling effect.

-

See

-

Default Value

new THREE.Vector2( 1, 1 )

-

center

center: Vector2

The point around which rotation occurs.

-

Remarks

A value of (0.5, 0.5) corresponds to the center of the texture.

-

Default Value

new THREE.Vector2( 0, 0 ), lower left.

-

rotation

rotation: number

How much the texture is rotated around the center point, in radians.

-

Remarks

Positive values are counter-clockwise.

-

Default Value

0

-

generateMipmaps

generateMipmaps: boolean

Whether to generate mipmaps, (if possible) for a texture.

-

Remarks

Set this to false if you are creating mipmaps manually.

-

Default Value

true
-
- -

premultiplyAlpha

premultiplyAlpha: boolean

If set to true, the alpha channel, if present, is multiplied into the color channels when the texture is uploaded to the GPU.

-

Remarks

Note that this property has no effect for ImageBitmap.
-You need to configure on bitmap creation instead. See THREE.ImageBitmapLoader | ImageBitmapLoader.

-

See

THREE.ImageBitmapLoader | ImageBitmapLoader.

-

Default Value

false

-

flipY

flipY: boolean

If set to true, the texture is flipped along the vertical axis when uploaded to the GPU.

-

Remarks

Note that this property has no effect for ImageBitmap.
-You need to configure on bitmap creation instead. See THREE.ImageBitmapLoader | ImageBitmapLoader.

-

See

THREE.ImageBitmapLoader | ImageBitmapLoader.

-

Default Value

true

-

unpackAlignment

unpackAlignment: number

Specifies the alignment requirements for the start of each pixel row in memory.

-

Remarks

The allowable values are:

-
    -
  • 1 (byte-alignment)
    • -
  • 2 (rows aligned to even-numbered bytes)
    • -
  • 4 (word-alignment)
    • -
  • 8 (rows start on double-word boundaries).
    • -
-

See

glPixelStorei for more information.

-

Default Value

4

-

colorSpace

colorSpace: string

The Textures | {@link Texture constants} page for details of other color spaces.

-

Remarks

Textures containing color data should be annotated with SRGBColorSpace THREE.SRGBColorSpace or
-LinearSRGBColorSpace THREE.LinearSRGBColorSpace.

-

See

-

Default Value

THREE.NoColorSpace

-

isRenderTargetTexture

isRenderTargetTexture: boolean

Indicates whether a texture belongs to a render target or not

-

Default Value

false

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the texture.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default Value

{}

-

version

version: number

This starts at 0 and counts how many times .needsUpdate is set to true.

-

Remarks

Expects a Integer

-

Default Value

0

-

pmremVersion

pmremVersion: number

Indicates whether this texture should be processed by PMREMGenerator or not (only relevant for render target
-textures)

-

onUpdate

onUpdate: () => void

A callback function, called when the texture is updated (e.g., when needsUpdate has been set to true and then the texture is used).

-

Accessors

image

  • get image(): any

  • An image object, typically created using the THREE.TextureLoader.load | TextureLoader.load() method.

    -

    Returns any

    Remarks

    This can be any image (e.g., PNG, JPG, GIF, DDS) or video (e.g., MP4, OGG/OGV) type supported by three.js.

    -
  • set image(data: any): void

  • Parameters

    • data: any

    Returns void

needsUpdate

  • set needsUpdate(value: boolean): void

  • Set this to true to trigger an update next time the texture is used. Particularly important for setting the wrap mode.

    -

    Parameters

    • value: boolean

    Returns void

needsPMREMUpdate

  • set needsPMREMUpdate(value: boolean): void

  • Indicates whether this texture should be processed by THREE.PMREMGenerator or not.

    -

    Parameters

    • value: boolean

    Returns void

    Remarks

    Only relevant for render target textures.

    -

    Default Value

    false

    -

Methods

transformUv

updateMatrix

  • updateMatrix(): void

  • Update the texture's UV-transform .matrix from the texture properties
    -.offset,
    -.repeat,
    -.rotation and
    -.center.

    -

    Returns void

clone

  • clone(): this

  • Make copy of the texture

    -

    Returns this

    Remarks

    Note this is not a "deep copy", the image is shared

    -

copy

  • copy(source: Texture): this

  • Parameters

    Returns this

toJSON

  • toJSON(meta?: string | {}): TextureJSON

  • Convert the texture to three.js JSON Object/Scene format.

    -

    Parameters

    • Optionalmeta: string | {}

      Optional object containing metadata.

      -

    Returns TextureJSON

dispose

  • dispose(): void

  • Frees the GPU-related resources allocated by this instance

    -

    Returns void

    Remarks

    Call this method whenever this instance is no longer used in your app.

    -

addEventListener

  • addEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, Texture>,
    ): void

  • Adds a listener to an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

      -
    • listener: EventListener<{ dispose: {} }[T], T, Texture>

      The function that gets called when the event is fired.

      -

    Returns void

hasEventListener

  • hasEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, Texture>,
    ): boolean

  • Checks if listener is added to an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

      -
    • listener: EventListener<{ dispose: {} }[T], T, Texture>

      The function that gets called when the event is fired.

      -

    Returns boolean

removeEventListener

  • removeEventListener<T extends "dispose">(
        type: T,
        listener: EventListener<{ dispose: {} }[T], T, Texture>,
    ): void

  • Removes a listener from an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of the listener that gets removed.

      -
    • listener: EventListener<{ dispose: {} }[T], T, Texture>

      The listener function that gets removed.

      -

    Returns void

dispatchEvent

  • dispatchEvent<T extends "dispose">(
        event: BaseEvent<T> & { dispose: {} }[T],
    ): void

  • Fire an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • event: BaseEvent<T> & { dispose: {} }[T]

      The event that gets fired.

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/TextureLoader.html b/docs/classes/TextureLoader.html deleted file mode 100644 index 4ff4ad1..0000000 --- a/docs/classes/TextureLoader.html +++ /dev/null @@ -1,33 +0,0 @@ -TextureLoader | VFX-JS

Class TextureLoader

Class for loading a texture.
-Unlike other loaders, this one emits events instead of using predefined callbacks. So if you're interested in getting notified when things happen, you need to add listeners to the object.

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_MATERIAL_NAME -crossOrigin -withCredentials -path -resourcePath -manager -requestHeader -

Methods

load -loadAsync -setCrossOrigin -setWithCredentials -setPath -setResourcePath -setRequestHeader -

Constructors

constructor

Properties

StaticDEFAULT_MATERIAL_NAME

DEFAULT_MATERIAL_NAME: string

crossOrigin

crossOrigin: string

Default

'anonymous'
-
- -

withCredentials

withCredentials: boolean

Default

false
-
- -

path

path: string

Default

''
-
- -

resourcePath

resourcePath: string

Default

''
-
- -

manager

manager: LoadingManager

requestHeader

requestHeader: { [header: string]: string }

Default

{}
-
- -

Methods

load

  • load(
        url: string,
        onLoad?: (data: Texture) => void,
        onProgress?: (event: ProgressEvent) => void,
        onError?: (err: unknown) => void,
    ): Texture

  • Parameters

    • url: string
    • OptionalonLoad: (data: Texture) => void
    • OptionalonProgress: (event: ProgressEvent) => void
    • OptionalonError: (err: unknown) => void

    Returns Texture

loadAsync

  • loadAsync(
        url: string,
        onProgress?: (event: ProgressEvent) => void,
    ): Promise<Texture>

  • Parameters

    Returns Promise<Texture>

setCrossOrigin

  • setCrossOrigin(crossOrigin: string): this

  • Parameters

    • crossOrigin: string

    Returns this

setWithCredentials

  • setWithCredentials(value: boolean): this

  • Parameters

    • value: boolean

    Returns this

setPath

  • setPath(path: string): this

  • Parameters

    • path: string

    Returns this

setResourcePath

  • setResourcePath(resourcePath: string): this

  • Parameters

    • resourcePath: string

    Returns this

setRequestHeader

  • setRequestHeader(requestHeader: { [header: string]: string }): this

  • Parameters

    • requestHeader: { [header: string]: string }

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Triangle.html b/docs/classes/Triangle.html deleted file mode 100644 index 4e6e0d8..0000000 --- a/docs/classes/Triangle.html +++ /dev/null @@ -1,36 +0,0 @@ -Triangle | VFX-JS

Class Triangle

Constructors

constructor -

Properties

a -b -c -

Methods

getNormal -getBarycoord -containsPoint -getInterpolation -getInterpolatedAttribute -isFrontFacing -set -setFromPointsAndIndices -setFromAttributeAndIndices -clone -copy -getArea -getMidpoint -getNormal -getPlane -getBarycoord -getInterpolation -containsPoint -intersectsBox -isFrontFacing -closestPointToPoint -equals -

Constructors

constructor

Properties

a

a: Vector3

Default

new THREE.Vector3()
-
- -

b

b: Vector3

Default

new THREE.Vector3()
-
- -

c

c: Vector3

Default

new THREE.Vector3()
-
- -

Methods

StaticgetNormal

StaticgetBarycoord

StaticcontainsPoint

StaticgetInterpolation

StaticgetInterpolatedAttribute

StaticisFrontFacing

set

setFromPointsAndIndices

  • setFromPointsAndIndices(
        points: Vector3[],
        i0: number,
        i1: number,
        i2: number,
    ): this

  • Parameters

    • points: Vector3[]
    • i0: number
    • i1: number
    • i2: number

    Returns this

setFromAttributeAndIndices

clone

  • clone(): this

  • Returns this

copy

  • copy(triangle: Triangle): this

  • Parameters

    Returns this

getArea

  • getArea(): number

  • Returns number

getMidpoint

getNormal

getPlane

  • getPlane(target: Plane): Plane

  • Parameters

    Returns Plane

getBarycoord

getInterpolation

containsPoint

  • containsPoint(point: Vector3): boolean

  • Parameters

    Returns boolean

intersectsBox

  • intersectsBox(box: Box3): boolean

  • Parameters

    Returns boolean

isFrontFacing

  • isFrontFacing(direction: Vector3): boolean

  • Parameters

    Returns boolean

closestPointToPoint

equals

  • equals(triangle: Triangle): boolean

  • Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/VFX.html b/docs/classes/VFX.html index ba7e5bb..6181e80 100644 --- a/docs/classes/VFX.html +++ b/docs/classes/VFX.html @@ -1,5 +1,5 @@ -VFX | VFX-JS

Class VFX

The main interface of VFX-JS.

-

Constructors

constructor +VFX | VFX-JS

Class VFX

The main interface of VFX-JS.

+

Constructors

constructor

Methods

add remove update @@ -7,14 +7,14 @@ stop destroy

Constructors

constructor

Methods

add

  • add(element: HTMLElement, opts: VFXProps): void

  • Register an element to track the position and render visual effects in the area.

    -

    Parameters

    Returns void

remove

  • remove(element: HTMLElement): void

  • Remove the element from VFX and stop rendering the shader.

    -

    Parameters

    • element: HTMLElement

    Returns void

update

  • update(element: HTMLElement): Promise<void>

  • Update the texture for the given element.

    +

    Parameters

    Returns VFX

Methods

add

  • add(element: HTMLElement, opts: VFXProps): void

  • Register an element to track the position and render visual effects in the area.

    +

    Parameters

    Returns void

remove

  • remove(element: HTMLElement): void

  • Remove the element from VFX and stop rendering the shader.

    +

    Parameters

    • element: HTMLElement

    Returns void

update

  • update(element: HTMLElement): Promise<void>

  • Update the texture for the given element.

    If the element is an HTMLImageElemnt or HTMLVideoElement, VFX-JS does nothing.
    Otherwise, VFX-JS captures a new snapshot of the DOM tree under the elemnt and udpate the WebGL texture with it.

    This is useful to apply effects to eleents whose contents change dynamically (e.g. input, textare etc).

    -

    Parameters

    • element: HTMLElement

    Returns Promise<void>

play

stop

  • stop(): void

  • Stop rendering VFX.
    +

    Parameters

    • element: HTMLElement

    Returns Promise<void>

play

  • play(): void

  • Start rendering VFX.

    +

    Returns void

stop

destroy

Settings

Member Visibility

On This Page

Constructors
Methods
+

Returns void

destroy

  • destroy(): void

  • Destroy VFX and stop rendering.

    +

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/Vector2.html b/docs/classes/Vector2.html deleted file mode 100644 index ee39383..0000000 --- a/docs/classes/Vector2.html +++ /dev/null @@ -1,150 +0,0 @@ -Vector2 | VFX-JS

Class Vector2

2D vector.

-

Constructors

constructor -

Properties

x -y -width -height -isVector2 -

Methods

set -setScalar -setX -setY -setComponent -getComponent -clone -copy -add -addScalar -addVectors -addScaledVector -sub -subScalar -subVectors -multiply -multiplyScalar -divide -divideScalar -applyMatrix3 -min -max -clamp -clampScalar -clampLength -floor -ceil -round -roundToZero -negate -dot -cross -lengthSq -length -manhattanLength -normalize -angle -angleTo -distanceTo -distanceToSquared -manhattanDistanceTo -setLength -lerp -lerpVectors -equals -fromArray -toArray -fromBufferAttribute -rotateAround -random -[iterator] -

Constructors

constructor

  • new Vector2(x?: number, y?: number): Vector2

  • Parameters

    • Optionalx: number
    • Optionaly: number

    Returns Vector2

Properties

x

x: number

Default

0
-
- -

y

y: number

Default

0
-
- -

width

width: number

height

height: number

ReadonlyisVector2

isVector2: true

Methods

set

  • set(x: number, y: number): this

  • Sets value of this vector.

    -

    Parameters

    • x: number
    • y: number

    Returns this

setScalar

  • setScalar(scalar: number): this

  • Sets the x and y values of this vector both equal to scalar.

    -

    Parameters

    • scalar: number

    Returns this

setX

  • setX(x: number): this

  • Sets X component of this vector.

    -

    Parameters

    • x: number

    Returns this

setY

  • setY(y: number): this

  • Sets Y component of this vector.

    -

    Parameters

    • y: number

    Returns this

setComponent

  • setComponent(index: number, value: number): this

  • Sets a component of this vector.

    -

    Parameters

    • index: number
    • value: number

    Returns this

getComponent

  • getComponent(index: number): number

  • Gets a component of this vector.

    -

    Parameters

    • index: number

    Returns number

clone

  • clone(): this

  • Returns a new Vector2 instance with the same x and y values.

    -

    Returns this

copy

  • copy(v: Vector2Like): this

  • Copies value of v to this vector.

    -

    Parameters

    Returns this

add

  • add(v: Vector2Like): this

  • Adds v to this vector.

    -

    Parameters

    Returns this

addScalar

  • addScalar(s: number): this

  • Adds the scalar value s to this vector's x and y values.

    -

    Parameters

    • s: number

    Returns this

addVectors

addScaledVector

  • addScaledVector(v: Vector2Like, s: number): this

  • Adds the multiple of v and s to this vector.

    -

    Parameters

    Returns this

sub

  • sub(v: Vector2Like): this

  • Subtracts v from this vector.

    -

    Parameters

    Returns this

subScalar

  • subScalar(s: number): this

  • Subtracts s from this vector's x and y components.

    -

    Parameters

    • s: number

    Returns this

subVectors

multiply

  • multiply(v: Vector2Like): this

  • Multiplies this vector by v.

    -

    Parameters

    Returns this

multiplyScalar

  • multiplyScalar(scalar: number): this

  • Multiplies this vector by scalar s.

    -

    Parameters

    • scalar: number

    Returns this

divide

  • divide(v: Vector2Like): this

  • Divides this vector by v.

    -

    Parameters

    Returns this

divideScalar

  • divideScalar(s: number): this

  • Divides this vector by scalar s.
    -Set vector to ( 0, 0 ) if s == 0.

    -

    Parameters

    • s: number

    Returns this

applyMatrix3

  • applyMatrix3(m: Matrix3): this

  • Multiplies this vector (with an implicit 1 as the 3rd component) by m.

    -

    Parameters

    Returns this

min

  • min(v: Vector2Like): this

  • If this vector's x or y value is greater than v's x or y value, replace that value with the corresponding min value.

    -

    Parameters

    Returns this

max

  • max(v: Vector2Like): this

  • If this vector's x or y value is less than v's x or y value, replace that value with the corresponding max value.

    -

    Parameters

    Returns this

clamp

  • clamp(min: Vector2Like, max: Vector2Like): this

  • If this vector's x or y value is greater than the max vector's x or y value, it is replaced by the corresponding value.
    -If this vector's x or y value is less than the min vector's x or y value, it is replaced by the corresponding value.

    -

    Parameters

    • min: Vector2Like

      the minimum x and y values.

      -
    • max: Vector2Like

      the maximum x and y values in the desired range.

      -

    Returns this

clampScalar

  • clampScalar(min: number, max: number): this

  • If this vector's x or y values are greater than the max value, they are replaced by the max value.
    -If this vector's x or y values are less than the min value, they are replaced by the min value.

    -

    Parameters

    • min: number

      the minimum value the components will be clamped to.

      -
    • max: number

      the maximum value the components will be clamped to.

      -

    Returns this

clampLength

  • clampLength(min: number, max: number): this

  • If this vector's length is greater than the max value, it is replaced by the max value.
    -If this vector's length is less than the min value, it is replaced by the min value.

    -

    Parameters

    • min: number

      the minimum value the length will be clamped to.

      -
    • max: number

      the maximum value the length will be clamped to.

      -

    Returns this

floor

  • floor(): this

  • The components of the vector are rounded down to the nearest integer value.

    -

    Returns this

ceil

  • ceil(): this

  • The x and y components of the vector are rounded up to the nearest integer value.

    -

    Returns this

round

  • round(): this

  • The components of the vector are rounded to the nearest integer value.

    -

    Returns this

roundToZero

  • roundToZero(): this

  • The components of the vector are rounded towards zero (up if negative, down if positive) to an integer value.

    -

    Returns this

negate

  • negate(): this

  • Inverts this vector.

    -

    Returns this

dot

  • dot(v: Vector2Like): number

  • Computes dot product of this vector and v.

    -

    Parameters

    Returns number

cross

  • cross(v: Vector2Like): number

  • Computes cross product of this vector and v.

    -

    Parameters

    Returns number

lengthSq

  • lengthSq(): number

  • Computes squared length of this vector.

    -

    Returns number

length

  • length(): number

  • Computes length of this vector.

    -

    Returns number

manhattanLength

  • manhattanLength(): number

  • Computes the Manhattan length of this vector.

    -

    see Taxicab Geometry

    -

    Returns number

normalize

  • normalize(): this

  • Normalizes this vector.

    -

    Returns this

angle

  • angle(): number

  • computes the angle in radians with respect to the positive x-axis

    -

    Returns number

angleTo

  • angleTo(v: Vector2): number

  • Returns the angle between this vector and vector v in radians.

    -

    Parameters

    Returns number

distanceTo

  • distanceTo(v: Vector2Like): number

  • Computes distance of this vector to v.

    -

    Parameters

    Returns number

distanceToSquared

  • distanceToSquared(v: Vector2Like): number

  • Computes squared distance of this vector to v.

    -

    Parameters

    Returns number

manhattanDistanceTo

  • manhattanDistanceTo(v: Vector2Like): number

  • Computes the Manhattan length (distance) from this vector to the given vector v

    -

    see Taxicab Geometry

    -

    Parameters

    Returns number

setLength

  • setLength(length: number): this

  • Normalizes this vector and multiplies it by l.

    -

    Parameters

    • length: number

    Returns this

lerp

  • lerp(v: Vector2Like, alpha: number): this

  • Linearly interpolates between this vector and v, where alpha is the distance along the line - alpha = 0 will be this vector, and alpha = 1 will be v.

    -

    Parameters

    • v: Vector2Like

      vector to interpolate towards.

      -
    • alpha: number

      interpolation factor in the closed interval [0, 1].

      -

    Returns this

lerpVectors

  • lerpVectors(v1: Vector2Like, v2: Vector2Like, alpha: number): this

  • Sets this vector to be the vector linearly interpolated between v1 and v2 where alpha is the distance along the line connecting the two vectors - alpha = 0 will be v1, and alpha = 1 will be v2.

    -

    Parameters

    • v1: Vector2Like

      the starting vector.

      -
    • v2: Vector2Like

      vector to interpolate towards.

      -
    • alpha: number

      interpolation factor in the closed interval [0, 1].

      -

    Returns this

equals

  • equals(v: Vector2Like): boolean

  • Checks for strict equality of this vector and v.

    -

    Parameters

    Returns boolean

fromArray

  • fromArray(array: number[] | ArrayLike<number>, offset?: number): this

  • Sets this vector's x and y value from the provided array or array-like.

    -

    Parameters

    • array: number[] | ArrayLike<number>

      the source array or array-like.

      -
    • Optionaloffset: number

      (optional) offset into the array. Default is 0.

      -

    Returns this

toArray

  • toArray(array?: number[], offset?: number): number[]

  • Returns an array [x, y], or copies x and y into the provided array.

    -

    Parameters

    • Optionalarray: number[]

      (optional) array to store the vector to. If this is not provided, a new array will be created.

      -
    • Optionaloffset: number

      (optional) optional offset into the array.

      -

    Returns number[]

    The created or provided array.

    -
  • toArray(array?: Vector2Tuple, offset?: 0): Vector2Tuple

  • Returns an array [x, y], or copies x and y into the provided array.

    -

    Parameters

    • Optionalarray: Vector2Tuple

      (optional) array to store the vector to. If this is not provided, a new array will be created.

      -
    • Optionaloffset: 0

      (optional) optional offset into the array.

      -

    Returns Vector2Tuple

    The created or provided array.

    -
  • toArray(array: ArrayLike<number>, offset?: number): ArrayLike<number>

  • Copies x and y into the provided array-like.

    -

    Parameters

    • array: ArrayLike<number>

      array-like to store the vector to.

      -
    • Optionaloffset: number

      (optional) optional offset into the array.

      -

    Returns ArrayLike<number>

    The provided array-like.

    -

fromBufferAttribute

  • fromBufferAttribute(attribute: BufferAttribute, index: number): this

  • Sets this vector's x and y values from the attribute.

    -

    Parameters

    • attribute: BufferAttribute

      the source attribute.

      -
    • index: number

      index in the attribute.

      -

    Returns this

rotateAround

  • rotateAround(center: Vector2Like, angle: number): this

  • Rotates the vector around center by angle radians.

    -

    Parameters

    • center: Vector2Like

      the point around which to rotate.

      -
    • angle: number

      the angle to rotate, in radians.

      -

    Returns this

random

  • random(): this

  • Sets this vector's x and y from Math.random

    -

    Returns this

[iterator]

  • "[iterator]"(): Iterator<number>

  • Iterating through a Vector2 instance will yield its components (x, y) in the corresponding order.

    -

    Returns Iterator<number>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Vector3.html b/docs/classes/Vector3.html deleted file mode 100644 index 0eca2f7..0000000 --- a/docs/classes/Vector3.html +++ /dev/null @@ -1,143 +0,0 @@ -Vector3 | VFX-JS

Class Vector3

3D vector.

-

see https://github.com/mrdoob/three.js/blob/master/src/math/Vector3.js

-

Example

const a = new THREE.Vector3( 1, 0, 0 );
const b = new THREE.Vector3( 0, 1, 0 );
const c = new THREE.Vector3();
c.crossVectors( a, b );
-
- -

Constructors

constructor -

Properties

x -y -z -isVector3 -

Methods

set -setScalar -setX -setY -setZ -setComponent -getComponent -clone -copy -add -addScalar -addVectors -addScaledVector -sub -subScalar -subVectors -multiply -multiplyScalar -multiplyVectors -applyEuler -applyAxisAngle -applyMatrix3 -applyNormalMatrix -applyMatrix4 -applyQuaternion -project -unproject -transformDirection -divide -divideScalar -min -max -clamp -clampScalar -clampLength -floor -ceil -round -roundToZero -negate -dot -lengthSq -length -manhattanLength -normalize -setLength -lerp -lerpVectors -cross -crossVectors -projectOnVector -projectOnPlane -reflect -angleTo -distanceTo -distanceToSquared -manhattanDistanceTo -setFromSpherical -setFromSphericalCoords -setFromCylindrical -setFromCylindricalCoords -setFromMatrixPosition -setFromMatrixScale -setFromMatrixColumn -setFromMatrix3Column -setFromEuler -setFromColor -equals -fromArray -toArray -fromBufferAttribute -random -randomDirection -[iterator] -

Constructors

constructor

  • new Vector3(x?: number, y?: number, z?: number): Vector3

  • Parameters

    • Optionalx: number
    • Optionaly: number
    • Optionalz: number

    Returns Vector3

Properties

x

x: number

Default

0
-
- -

y

y: number

Default

0
-
- -

z

z: number

Default

0
-
- -

ReadonlyisVector3

isVector3: true

Methods

set

  • set(x: number, y: number, z: number): this

  • Sets value of this vector.

    -

    Parameters

    • x: number
    • y: number
    • z: number

    Returns this

setScalar

  • setScalar(scalar: number): this

  • Sets all values of this vector.

    -

    Parameters

    • scalar: number

    Returns this

setX

  • setX(x: number): this

  • Sets x value of this vector.

    -

    Parameters

    • x: number

    Returns this

setY

  • setY(y: number): this

  • Sets y value of this vector.

    -

    Parameters

    • y: number

    Returns this

setZ

  • setZ(z: number): this

  • Sets z value of this vector.

    -

    Parameters

    • z: number

    Returns this

setComponent

  • setComponent(index: number, value: number): this

  • Parameters

    • index: number
    • value: number

    Returns this

getComponent

  • getComponent(index: number): number

  • Parameters

    • index: number

    Returns number

clone

  • clone(): this

  • Clones this vector.

    -

    Returns this

copy

  • copy(v: Vector3Like): this

  • Copies value of v to this vector.

    -

    Parameters

    Returns this

add

  • add(v: Vector3Like): this

  • Adds v to this vector.

    -

    Parameters

    Returns this

addScalar

  • addScalar(s: number): this

  • Parameters

    • s: number

    Returns this

addVectors

addScaledVector

  • addScaledVector(v: Vector3, s: number): this

  • Parameters

    Returns this

sub

  • sub(a: Vector3Like): this

  • Subtracts v from this vector.

    -

    Parameters

    Returns this

subScalar

  • subScalar(s: number): this

  • Parameters

    • s: number

    Returns this

subVectors

multiply

  • multiply(v: Vector3Like): this

  • Parameters

    Returns this

multiplyScalar

  • multiplyScalar(s: number): this

  • Multiplies this vector by scalar s.

    -

    Parameters

    • s: number

    Returns this

multiplyVectors

applyEuler

  • applyEuler(euler: Euler): this

  • Parameters

    Returns this

applyAxisAngle

  • applyAxisAngle(axis: Vector3, angle: number): this

  • Parameters

    Returns this

applyMatrix3

  • applyMatrix3(m: Matrix3): this

  • Parameters

    Returns this

applyNormalMatrix

  • applyNormalMatrix(m: Matrix3): this

  • Parameters

    Returns this

applyMatrix4

  • applyMatrix4(m: Matrix4): this

  • Parameters

    Returns this

applyQuaternion

  • applyQuaternion(q: QuaternionLike): this

  • Parameters

    Returns this

project

  • project(camera: Camera): this

  • Parameters

    Returns this

unproject

  • unproject(camera: Camera): this

  • Parameters

    Returns this

transformDirection

  • transformDirection(m: Matrix4): this

  • Parameters

    Returns this

divide

  • divide(v: Vector3Like): this

  • Parameters

    Returns this

divideScalar

  • divideScalar(s: number): this

  • Divides this vector by scalar s.
    -Set vector to ( 0, 0, 0 ) if s == 0.

    -

    Parameters

    • s: number

    Returns this

min

  • min(v: Vector3Like): this

  • Parameters

    Returns this

max

  • max(v: Vector3Like): this

  • Parameters

    Returns this

clamp

clampScalar

  • clampScalar(min: number, max: number): this

  • Parameters

    • min: number
    • max: number

    Returns this

clampLength

  • clampLength(min: number, max: number): this

  • Parameters

    • min: number
    • max: number

    Returns this

floor

  • floor(): this

  • Returns this

ceil

  • ceil(): this

  • Returns this

round

  • round(): this

  • Returns this

roundToZero

  • roundToZero(): this

  • Returns this

negate

  • negate(): this

  • Inverts this vector.

    -

    Returns this

dot

  • dot(v: Vector3Like): number

  • Computes dot product of this vector and v.

    -

    Parameters

    Returns number

lengthSq

  • lengthSq(): number

  • Computes squared length of this vector.

    -

    Returns number

length

  • length(): number

  • Computes length of this vector.

    -

    Returns number

manhattanLength

  • manhattanLength(): number

  • Computes the Manhattan length of this vector.

    -

    see Taxicab Geometry

    -

    Returns number

normalize

  • normalize(): this

  • Normalizes this vector.

    -

    Returns this

setLength

  • setLength(l: number): this

  • Normalizes this vector and multiplies it by l.

    -

    Parameters

    • l: number

    Returns this

lerp

  • lerp(v: Vector3Like, alpha: number): this

  • Parameters

    Returns this

lerpVectors

cross

  • cross(a: Vector3Like): this

  • Sets this vector to cross product of itself and v.

    -

    Parameters

    Returns this

crossVectors

projectOnVector

  • projectOnVector(v: Vector3): this

  • Parameters

    Returns this

projectOnPlane

  • projectOnPlane(planeNormal: Vector3): this

  • Parameters

    Returns this

reflect

  • reflect(vector: Vector3Like): this

  • Parameters

    Returns this

angleTo

  • angleTo(v: Vector3): number

  • Parameters

    Returns number

distanceTo

  • distanceTo(v: Vector3Like): number

  • Computes distance of this vector to v.

    -

    Parameters

    Returns number

distanceToSquared

  • distanceToSquared(v: Vector3Like): number

  • Computes squared distance of this vector to v.

    -

    Parameters

    Returns number

manhattanDistanceTo

  • manhattanDistanceTo(v: Vector3Like): number

  • Computes the Manhattan length (distance) from this vector to the given vector v

    -

    see Taxicab Geometry

    -

    Parameters

    Returns number

setFromSpherical

  • setFromSpherical(s: Spherical): this

  • Parameters

    Returns this

setFromSphericalCoords

  • setFromSphericalCoords(r: number, phi: number, theta: number): this

  • Parameters

    • r: number
    • phi: number
    • theta: number

    Returns this

setFromCylindrical

  • setFromCylindrical(s: Cylindrical): this

  • Parameters

    Returns this

setFromCylindricalCoords

  • setFromCylindricalCoords(radius: number, theta: number, y: number): this

  • Parameters

    • radius: number
    • theta: number
    • y: number

    Returns this

setFromMatrixPosition

  • setFromMatrixPosition(m: Matrix4): this

  • Parameters

    Returns this

setFromMatrixScale

  • setFromMatrixScale(m: Matrix4): this

  • Parameters

    Returns this

setFromMatrixColumn

  • setFromMatrixColumn(matrix: Matrix4, index: number): this

  • Parameters

    Returns this

setFromMatrix3Column

  • setFromMatrix3Column(matrix: Matrix3, index: number): this

  • Parameters

    Returns this

setFromEuler

  • setFromEuler(e: Euler): this

  • Sets this vector's x, y and z components from the x, y, and z components of the specified Euler Angle.

    -

    Parameters

    Returns this

setFromColor

  • setFromColor(color: RGB): this

  • Sets this vector's x, y and z components from the r, g, and b components of the specified
    -color.

    -

    Parameters

    Returns this

equals

  • equals(v: Vector3Like): boolean

  • Checks for strict equality of this vector and v.

    -

    Parameters

    Returns boolean

fromArray

  • fromArray(array: number[] | ArrayLike<number>, offset?: number): this

  • Sets this vector's x, y and z value from the provided array or array-like.

    -

    Parameters

    • array: number[] | ArrayLike<number>

      the source array or array-like.

      -
    • Optionaloffset: number

      (optional) offset into the array. Default is 0.

      -

    Returns this

toArray

  • toArray(array?: number[], offset?: number): number[]

  • Returns an array [x, y, z], or copies x, y and z into the provided array.

    -

    Parameters

    • Optionalarray: number[]

      (optional) array to store the vector to. If this is not provided, a new array will be created.

      -
    • Optionaloffset: number

      (optional) optional offset into the array.

      -

    Returns number[]

    The created or provided array.

    -
  • toArray(array?: Vector3Tuple, offset?: 0): Vector3Tuple

  • Returns an array [x, y, z], or copies x, y and z into the provided array.

    -

    Parameters

    • Optionalarray: Vector3Tuple

      (optional) array to store the vector to. If this is not provided, a new array will be created.

      -
    • Optionaloffset: 0

      (optional) optional offset into the array.

      -

    Returns Vector3Tuple

    The created or provided array.

    -
  • toArray(array: ArrayLike<number>, offset?: number): ArrayLike<number>

  • Copies x, y and z into the provided array-like.

    -

    Parameters

    • array: ArrayLike<number>

      array-like to store the vector to.

      -
    • Optionaloffset: number

      (optional) optional offset into the array-like.

      -

    Returns ArrayLike<number>

    The provided array-like.

    -

fromBufferAttribute

random

  • random(): this

  • Sets this vector's x, y and z from Math.random

    -

    Returns this

randomDirection

  • randomDirection(): this

  • Returns this

[iterator]

  • "[iterator]"(): Iterator<number>

  • Iterating through a Vector3 instance will yield its components (x, y, z) in the corresponding order.

    -

    Returns Iterator<number>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Vector4.html b/docs/classes/Vector4.html deleted file mode 100644 index e5011d4..0000000 --- a/docs/classes/Vector4.html +++ /dev/null @@ -1,118 +0,0 @@ -Vector4 | VFX-JS

Class Vector4

4D vector.

-

Constructors

constructor -

Properties

x -y -z -w -width -height -isVector4 -

Methods

set -setScalar -setX -setY -setZ -setW -setComponent -getComponent -clone -copy -add -addScalar -addVectors -addScaledVector -sub -subScalar -subVectors -multiply -multiplyScalar -applyMatrix4 -divide -divideScalar -setAxisAngleFromQuaternion -setAxisAngleFromRotationMatrix -setFromMatrixPosition -min -max -clamp -clampScalar -floor -ceil -round -roundToZero -negate -dot -lengthSq -length -manhattanLength -normalize -setLength -lerp -lerpVectors -equals -fromArray -toArray -fromBufferAttribute -random -[iterator] -

Constructors

constructor

  • new Vector4(x?: number, y?: number, z?: number, w?: number): Vector4

  • Parameters

    • Optionalx: number
    • Optionaly: number
    • Optionalz: number
    • Optionalw: number

    Returns Vector4

Properties

x

x: number

Default

0
-
- -

y

y: number

Default

0
-
- -

z

z: number

Default

0
-
- -

w

w: number

Default

0
-
- -

width

width: number

height

height: number

ReadonlyisVector4

isVector4: true

Methods

set

  • set(x: number, y: number, z: number, w: number): this

  • Sets value of this vector.

    -

    Parameters

    • x: number
    • y: number
    • z: number
    • w: number

    Returns this

setScalar

  • setScalar(scalar: number): this

  • Sets all values of this vector.

    -

    Parameters

    • scalar: number

    Returns this

setX

  • setX(x: number): this

  • Sets X component of this vector.

    -

    Parameters

    • x: number

    Returns this

setY

  • setY(y: number): this

  • Sets Y component of this vector.

    -

    Parameters

    • y: number

    Returns this

setZ

  • setZ(z: number): this

  • Sets Z component of this vector.

    -

    Parameters

    • z: number

    Returns this

setW

  • setW(w: number): this

  • Sets w component of this vector.

    -

    Parameters

    • w: number

    Returns this

setComponent

  • setComponent(index: number, value: number): this

  • Parameters

    • index: number
    • value: number

    Returns this

getComponent

  • getComponent(index: number): number

  • Parameters

    • index: number

    Returns number

clone

  • clone(): this

  • Clones this vector.

    -

    Returns this

copy

  • copy(v: Vector4Like): this

  • Copies value of v to this vector.

    -

    Parameters

    Returns this

add

  • add(v: Vector4Like): this

  • Adds v to this vector.

    -

    Parameters

    Returns this

addScalar

  • addScalar(scalar: number): this

  • Parameters

    • scalar: number

    Returns this

addVectors

addScaledVector

  • addScaledVector(v: Vector4Like, s: number): this

  • Parameters

    Returns this

sub

  • sub(v: Vector4Like): this

  • Subtracts v from this vector.

    -

    Parameters

    Returns this

subScalar

  • subScalar(s: number): this

  • Parameters

    • s: number

    Returns this

subVectors

multiply

  • multiply(v: Vector4Like): this

  • Parameters

    Returns this

multiplyScalar

  • multiplyScalar(s: number): this

  • Multiplies this vector by scalar s.

    -

    Parameters

    • s: number

    Returns this

applyMatrix4

  • applyMatrix4(m: Matrix4): this

  • Parameters

    Returns this

divide

  • divide(v: Vector4Like): this

  • Parameters

    Returns this

divideScalar

  • divideScalar(s: number): this

  • Divides this vector by scalar s.
    -Set vector to ( 0, 0, 0 ) if s == 0.

    -

    Parameters

    • s: number

    Returns this

setAxisAngleFromQuaternion

setAxisAngleFromRotationMatrix

setFromMatrixPosition

min

  • min(v: Vector4Like): this

  • Parameters

    Returns this

max

  • max(v: Vector4Like): this

  • Parameters

    Returns this

clamp

clampScalar

  • clampScalar(min: number, max: number): this

  • Parameters

    • min: number
    • max: number

    Returns this

floor

  • floor(): this

  • Returns this

ceil

  • ceil(): this

  • Returns this

round

  • round(): this

  • Returns this

roundToZero

  • roundToZero(): this

  • Returns this

negate

  • negate(): this

  • Inverts this vector.

    -

    Returns this

dot

  • dot(v: Vector4Like): number

  • Computes dot product of this vector and v.

    -

    Parameters

    Returns number

lengthSq

  • lengthSq(): number

  • Computes squared length of this vector.

    -

    Returns number

length

  • length(): number

  • Computes length of this vector.

    -

    Returns number

manhattanLength

  • manhattanLength(): number

  • Computes the Manhattan length of this vector.

    -

    see Taxicab Geometry

    -

    Returns number

normalize

  • normalize(): this

  • Normalizes this vector.

    -

    Returns this

setLength

  • setLength(length: number): this

  • Normalizes this vector and multiplies it by l.

    -

    Parameters

    • length: number

    Returns this

lerp

  • lerp(v: Vector4Like, alpha: number): this

  • Linearly interpolate between this vector and v with alpha factor.

    -

    Parameters

    Returns this

lerpVectors

equals

  • equals(v: Vector4Like): boolean

  • Checks for strict equality of this vector and v.

    -

    Parameters

    Returns boolean

fromArray

  • fromArray(array: number[] | ArrayLike<number>, offset?: number): this

  • Sets this vector's x, y, z and w value from the provided array or array-like.

    -

    Parameters

    • array: number[] | ArrayLike<number>

      the source array or array-like.

      -
    • Optionaloffset: number

      (optional) offset into the array. Default is 0.

      -

    Returns this

toArray

  • toArray(array?: number[], offset?: number): number[]

  • Returns an array [x, y, z, w], or copies x, y, z and w into the provided array.

    -

    Parameters

    • Optionalarray: number[]

      (optional) array to store the vector to. If this is not provided, a new array will be created.

      -
    • Optionaloffset: number

      (optional) optional offset into the array.

      -

    Returns number[]

    The created or provided array.

    -
  • toArray(array?: Vector4Tuple, offset?: 0): Vector4Tuple

  • Returns an array [x, y, z, w], or copies x, y, z and w into the provided array.

    -

    Parameters

    • Optionalarray: Vector4Tuple

      (optional) array to store the vector to. If this is not provided, a new array will be created.

      -
    • Optionaloffset: 0

      (optional) optional offset into the array.

      -

    Returns Vector4Tuple

    The created or provided array.

    -
  • toArray(array: ArrayLike<number>, offset?: number): ArrayLike<number>

  • Copies x, y, z and w into the provided array-like.

    -

    Parameters

    • array: ArrayLike<number>

      array-like to store the vector to.

      -
    • Optionaloffset: number

      (optional) optional offset into the array-like.

      -

    Returns ArrayLike<number>

    The provided array-like.

    -

fromBufferAttribute

  • fromBufferAttribute(attribute: BufferAttribute, index: number): this

  • Parameters

    Returns this

random

  • random(): this

  • Sets this vector's x, y, z and w from Math.random

    -

    Returns this

[iterator]

  • "[iterator]"(): Iterator<number>

  • Iterating through a Vector4 instance will yield its components (x, y, z, w) in the corresponding order.

    -

    Returns Iterator<number>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/WebGLCapabilities.html b/docs/classes/WebGLCapabilities.html deleted file mode 100644 index 933161f..0000000 --- a/docs/classes/WebGLCapabilities.html +++ /dev/null @@ -1,20 +0,0 @@ -WebGLCapabilities | VFX-JS

Class WebGLCapabilities

Constructors

constructor -

Properties

isWebGL2 -getMaxAnisotropy -getMaxPrecision -textureFormatReadable -textureTypeReadable -precision -logarithmicDepthBuffer -reverseDepthBuffer -maxTextures -maxVertexTextures -maxTextureSize -maxCubemapSize -maxAttributes -maxVertexUniforms -maxVaryings -maxFragmentUniforms -vertexTextures -maxSamples -

Constructors

constructor

Properties

ReadonlyisWebGL2

isWebGL2: boolean

getMaxAnisotropy

getMaxAnisotropy: () => number

getMaxPrecision

getMaxPrecision: (precision: string) => string

textureFormatReadable

textureFormatReadable: (textureFormat: PixelFormat) => boolean

textureTypeReadable

textureTypeReadable: (textureType: TextureDataType) => boolean

precision

precision: string

logarithmicDepthBuffer

logarithmicDepthBuffer: boolean

reverseDepthBuffer

reverseDepthBuffer: boolean

maxTextures

maxTextures: number

maxVertexTextures

maxVertexTextures: number

maxTextureSize

maxTextureSize: number

maxCubemapSize

maxCubemapSize: number

maxAttributes

maxAttributes: number

maxVertexUniforms

maxVertexUniforms: number

maxVaryings

maxVaryings: number

maxFragmentUniforms

maxFragmentUniforms: number

vertexTextures

vertexTextures: boolean

maxSamples

maxSamples: number

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/WebGLExtensions.html b/docs/classes/WebGLExtensions.html deleted file mode 100644 index 47540a7..0000000 --- a/docs/classes/WebGLExtensions.html +++ /dev/null @@ -1,5 +0,0 @@ -WebGLExtensions | VFX-JS

Class WebGLExtensions

Constructors

constructor -

Methods

has -init -get -

Constructors

constructor

  • new WebGLExtensions(gl: WebGLRenderingContext): WebGLExtensions

  • Parameters

    • gl: WebGLRenderingContext

    Returns WebGLExtensions

Methods

has

  • has(name: string): boolean

  • Parameters

    • name: string

    Returns boolean

init

  • init(): void

  • Returns void

get

  • get(name: string): any

  • Parameters

    • name: string

    Returns any

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/WebGLInfo.html b/docs/classes/WebGLInfo.html deleted file mode 100644 index 160c6af..0000000 --- a/docs/classes/WebGLInfo.html +++ /dev/null @@ -1,21 +0,0 @@ -WebGLInfo | VFX-JS

Class WebGLInfo

An object with a series of statistical information about the graphics board memory and the rendering process.

-

Constructors

constructor -

Properties

autoReset -memory -programs -render -

Methods

update -reset -

Constructors

constructor

  • new WebGLInfo(gl: WebGLRenderingContext): WebGLInfo

  • Parameters

    • gl: WebGLRenderingContext

    Returns WebGLInfo

Properties

autoReset

autoReset: boolean

Default

true
-
- -

memory

memory: { geometries: number; textures: number }

Default

{ geometries: 0, textures: 0 }
-
- -

programs

programs: null | WebGLProgram[]

Default

null
-
- -

render

render: {
    calls: number;
    frame: number;
    lines: number;
    points: number;
    triangles: number;
}

Default

{ frame: 0, calls: 0, triangles: 0, points: 0, lines: 0 }
-
- -

Methods

update

  • update(count: number, mode: number, instanceCount: number): void

  • Parameters

    • count: number
    • mode: number
    • instanceCount: number

    Returns void

reset

  • reset(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/WebGLObjects.html b/docs/classes/WebGLObjects.html deleted file mode 100644 index f8f1d86..0000000 --- a/docs/classes/WebGLObjects.html +++ /dev/null @@ -1,4 +0,0 @@ -WebGLObjects | VFX-JS

Class WebGLObjects

Constructors

constructor -

Methods

update -dispose -

Constructors

constructor

  • new WebGLObjects(
        gl: WebGLRenderingContext,
        geometries: any,
        attributes: any,
        info: any,
    ): WebGLObjects

  • Parameters

    • gl: WebGLRenderingContext
    • geometries: any
    • attributes: any
    • info: any

    Returns WebGLObjects

Methods

update

  • update(object: any): any

  • Parameters

    • object: any

    Returns any

dispose

  • dispose(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/WebGLProgram.html b/docs/classes/WebGLProgram.html deleted file mode 100644 index 6f8e2a7..0000000 --- a/docs/classes/WebGLProgram.html +++ /dev/null @@ -1,19 +0,0 @@ -WebGLProgram | VFX-JS

Class WebGLProgram

Constructors

constructor -

Properties

name -id -cacheKey -usedTimes -program -vertexShader -fragmentShader -uniforms -attributes -

Methods

getUniforms -getAttributes -destroy -

Constructors

constructor

  • new WebGLProgram(
        renderer: WebGLRenderer,
        cacheKey: string,
        parameters: object,
    ): WebGLProgram

  • Parameters

    Returns WebGLProgram

Properties

name

name: string

id

id: number

cacheKey

cacheKey: string

usedTimes

usedTimes: number

Default

1
-
- -

program

program: any

vertexShader

vertexShader: WebGLShader

fragmentShader

fragmentShader: WebGLShader

uniforms

uniforms: any

Deprecated

Use getUniforms() instead.

-

attributes

attributes: any

Deprecated

Use getAttributes() instead.

-

Methods

getUniforms

getAttributes

  • getAttributes(): any

  • Returns any

destroy

  • destroy(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/WebGLProperties.html b/docs/classes/WebGLProperties.html deleted file mode 100644 index a886581..0000000 --- a/docs/classes/WebGLProperties.html +++ /dev/null @@ -1,7 +0,0 @@ -WebGLProperties | VFX-JS

Class WebGLProperties

Constructors

constructor -

Properties

has -get -remove -update -dispose -

Constructors

constructor

Properties

has

has: (object: unknown) => boolean

get

get: (object: unknown) => unknown

remove

remove: (object: unknown) => void

update

update: (object: unknown, key: unknown, value: unknown) => unknown

dispose

dispose: () => void

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/WebGLRenderList.html b/docs/classes/WebGLRenderList.html deleted file mode 100644 index ff2e21d..0000000 --- a/docs/classes/WebGLRenderList.html +++ /dev/null @@ -1,19 +0,0 @@ -WebGLRenderList | VFX-JS

Class WebGLRenderList

Constructors

constructor -

Properties

opaque -transparent -transmissive -

Methods

init -push -unshift -sort -finish -

Constructors

constructor

Properties

opaque

opaque: RenderItem[]

Default

[]
-
- -

transparent

transparent: RenderItem[]

Default

[]
-
- -

transmissive

transmissive: RenderItem[]

Default

[]
-
- -

Methods

init

  • init(): void

  • Returns void

push

  • push(
        object: Object3D,
        geometry: null | BufferGeometry,
        material: Material,
        groupOrder: number,
        z: number,
        group: null | Group,
    ): void

  • Parameters

    Returns void

unshift

  • unshift(
        object: Object3D,
        geometry: null | BufferGeometry,
        material: Material,
        groupOrder: number,
        z: number,
        group: null | Group,
    ): void

  • Parameters

    Returns void

sort

  • sort(
        opaqueSort: (a: any, b: any) => number,
        transparentSort: (a: any, b: any) => number,
    ): void

  • Parameters

    • opaqueSort: (a: any, b: any) => number
    • transparentSort: (a: any, b: any) => number

    Returns void

finish

  • finish(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/WebGLRenderLists.html b/docs/classes/WebGLRenderLists.html deleted file mode 100644 index 52c3271..0000000 --- a/docs/classes/WebGLRenderLists.html +++ /dev/null @@ -1,4 +0,0 @@ -WebGLRenderLists | VFX-JS

Class WebGLRenderLists

Constructors

constructor -

Methods

dispose -get -

Constructors

constructor

Methods

dispose

  • dispose(): void

  • Returns void

get

  • get(scene: Scene, renderCallDepth: number): WebGLRenderList

  • Parameters

    • scene: Scene
    • renderCallDepth: number

    Returns WebGLRenderList

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/WebGLRenderTarget.html b/docs/classes/WebGLRenderTarget.html deleted file mode 100644 index 4589daf..0000000 --- a/docs/classes/WebGLRenderTarget.html +++ /dev/null @@ -1,71 +0,0 @@ -WebGLRenderTarget | VFX-JS

Class WebGLRenderTarget<TTexture>

JavaScript events for custom objects

-

Example

// Adding events to a custom object
class Car extends EventDispatcher {
  start() {
    this.dispatchEvent( { type: 'start', message: 'vroom vroom!' } );
  }
};
// Using events with the custom object
const car = new Car();
car.addEventListener( 'start', ( event ) => {
  alert( event.message );
} );
car.start();
-
- -

See

-

Type Parameters

Hierarchy (View Summary)

Constructors

constructor -

Properties

isWebGLRenderTarget -isRenderTarget -width -height -depth -scissor -scissorTest -viewport -textures -depthBuffer -stencilBuffer -resolveDepthBuffer -resolveStencilBuffer -depthTexture -samples -

Accessors

texture -

Methods

setSize -clone -copy -dispose -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

ReadonlyisWebGLRenderTarget

isWebGLRenderTarget: true

ReadonlyisRenderTarget

isRenderTarget: true

width

width: number

height

height: number

depth

depth: number

scissor

scissor: Vector4

scissorTest

scissorTest: boolean

Default

false
-
- -

viewport

viewport: Vector4

textures

textures: TTexture[]

depthBuffer

depthBuffer: boolean

Default

true
-
- -

stencilBuffer

stencilBuffer: boolean

Default

false
-
- -

resolveDepthBuffer

resolveDepthBuffer: boolean

Defines whether the depth buffer should be resolved when rendering into a multisampled render target.

-

Default

true
-
- -

resolveStencilBuffer

resolveStencilBuffer: boolean

Defines whether the stencil buffer should be resolved when rendering into a multisampled render target.
-This property has no effect when .resolveDepthBuffer is set to false.

-

Default

true
-
- -

depthTexture

depthTexture: null | DepthTexture

Default

null
-
- -

samples

samples: number

Defines the count of MSAA samples. Can only be used with WebGL 2. Default is 0.

-

Default

0
-
- -

Accessors

texture

  • get texture(): TTexture

  • Returns TTexture

  • set texture(value: TTexture): void

  • Parameters

    Returns void

Methods

setSize

  • setSize(width: number, height: number, depth?: number): void

  • Parameters

    • width: number
    • height: number
    • Optionaldepth: number

    Returns void

clone

  • clone(): this

  • Returns this

copy

dispose

  • dispose(): void

  • Returns void

addEventListener

hasEventListener

removeEventListener

dispatchEvent

  • dispatchEvent<T extends "dispose">(
        event: BaseEvent<T> & { dispose: {} }[T],
    ): void

  • Fire an event type.

    -

    Type Parameters

    • T extends "dispose"

    Parameters

    • event: BaseEvent<T> & { dispose: {} }[T]

      The event that gets fired.

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/WebGLRenderer.html b/docs/classes/WebGLRenderer.html deleted file mode 100644 index 07108f0..0000000 --- a/docs/classes/WebGLRenderer.html +++ /dev/null @@ -1,230 +0,0 @@ -WebGLRenderer | VFX-JS

Class WebGLRenderer

The WebGL renderer displays your beautifully crafted scenes using WebGL, if your device supports it.
-This renderer has way better performance than CanvasRenderer.

-

see https://github.com/mrdoob/three.js/blob/master/src/renderers/WebGLRenderer.js|src/renderers/WebGLRenderer.js

-

Implements

Constructors

constructor -

Properties

domElement -autoClear -autoClearColor -autoClearDepth -autoClearStencil -debug -sortObjects -clippingPlanes -localClippingEnabled -extensions -toneMapping -toneMappingExposure -info -shadowMap -pixelRatio -capabilities -properties -renderLists -state -xr -compile -compileAsync -vr -shadowMapEnabled -shadowMapType -shadowMapCullFace -

Accessors

outputColorSpace -coordinateSystem -

Methods

getContext -getContextAttributes -forceContextLoss -forceContextRestore -getMaxAnisotropy -getPrecision -getPixelRatio -setPixelRatio -getDrawingBufferSize -setDrawingBufferSize -getSize -setSize -getCurrentViewport -getViewport -setViewport -getScissor -setScissor -getScissorTest -setScissorTest -setOpaqueSort -setTransparentSort -getClearColor -setClearColor -getClearAlpha -setClearAlpha -clear -clearColor -clearDepth -clearStencil -clearTarget -resetGLState -dispose -renderBufferDirect -setAnimationLoop -animate -render -getActiveCubeFace -getActiveMipmapLevel -getRenderTarget -getCurrentRenderTarget -setRenderTarget -readRenderTargetPixels -readRenderTargetPixelsAsync -copyFramebufferToTexture -copyTextureToTexture -copyTextureToTexture3D -initRenderTarget -initTexture -resetState -supportsFloatTextures -supportsHalfFloatTextures -supportsStandardDerivatives -supportsCompressedTextureS3TC -supportsCompressedTexturePVRTC -supportsBlendMinMax -supportsVertexTextures -supportsInstancedArrays -enableScissorTest -

Constructors

constructor

  • new WebGLRenderer(parameters?: WebGLRendererParameters): WebGLRenderer

  • parameters is an optional object with properties defining the renderer's behavior.
    -The constructor also accepts no parameters at all.
    -In all cases, it will assume sane defaults when parameters are missing.

    -

    Parameters

    Returns WebGLRenderer

Properties

domElement

domElement: HTMLCanvasElement

A Canvas where the renderer draws its output.
-This is automatically created by the renderer in the constructor (if not provided already); you just need to add it to your page.

-

Default

document.createElementNS( 'http://www.w3.org/1999/xhtml', 'canvas' )
-
- -

autoClear

autoClear: boolean

Defines whether the renderer should automatically clear its output before rendering.

-

Default

true
-
- -

autoClearColor

autoClearColor: boolean

If autoClear is true, defines whether the renderer should clear the color buffer. Default is true.

-

Default

true
-
- -

autoClearDepth

autoClearDepth: boolean

If autoClear is true, defines whether the renderer should clear the depth buffer. Default is true.

-

Default

true
-
- -

autoClearStencil

autoClearStencil: boolean

If autoClear is true, defines whether the renderer should clear the stencil buffer. Default is true.

-

Default

true
-
- -

debug

debug: WebGLDebug

Debug configurations.

-

Default

{ checkShaderErrors: true }
-
- -

sortObjects

sortObjects: boolean

Defines whether the renderer should sort objects. Default is true.

-

Default

true
-
- -

clippingPlanes

clippingPlanes: Plane[]

Default

[]
-
- -

localClippingEnabled

localClippingEnabled: boolean

Default

false
-
- -

extensions

extensions: WebGLExtensions

toneMapping

toneMapping: ToneMapping

Default

THREE.NoToneMapping
-
- -

toneMappingExposure

toneMappingExposure: number

Default

1
-
- -

info

info: WebGLInfo

shadowMap

shadowMap: WebGLShadowMap

pixelRatio

pixelRatio: number

capabilities

capabilities: WebGLCapabilities

properties

properties: WebGLProperties

renderLists

renderLists: WebGLRenderLists

state

state: WebGLState

xr

xr: WebXRManager

compile

compile: (
    scene: Object3D,
    camera: Camera,
    targetScene?: null | Scene,
) => Set<Material>

Compiles all materials in the scene with the camera. This is useful to precompile shaders before the first
-rendering. If you want to add a 3D object to an existing scene, use the third optional parameter for applying the
-target scene.
-Note that the (target) scene's lighting should be configured before calling this method.

-

compileAsync

compileAsync: (
    scene: Object3D,
    camera: Camera,
    targetScene?: null | Scene,
) => Promise<Object3D>

Asynchronous version of compile(). The method returns a Promise that resolves when the given scene can be
-rendered without unnecessary stalling due to shader compilation.
-This method makes use of the KHR_parallel_shader_compile WebGL extension.

-

vr

vr: boolean

Deprecated

Use .xr instead.

-

shadowMapEnabled

shadowMapEnabled: boolean

Deprecated

Use .shadowMap.enabled instead.

-

shadowMapType

shadowMapType: ShadowMapType

Deprecated

Use .shadowMap.type instead.

-

shadowMapCullFace

shadowMapCullFace: CullFace

Deprecated

Use .shadowMap.cullFace instead.

-

Accessors

outputColorSpace

  • get outputColorSpace(): string

  • Color space used for output to HTMLCanvasElement. Supported values are
    -SRGBColorSpace and LinearSRGBColorSpace.

    -

    Returns string

    Default

    THREE.SRGBColorSpace.
-
    - -
  • set outputColorSpace(colorSpace: string): void

  • Parameters

    • colorSpace: string

    Returns void

coordinateSystem

  • get coordinateSystem(): 2000

  • Returns 2000

Methods

getContext

  • getContext(): WebGLRenderingContext | WebGL2RenderingContext

  • Return the WebGL context.

    -

    Returns WebGLRenderingContext | WebGL2RenderingContext

getContextAttributes

  • getContextAttributes(): any

  • Returns any

forceContextLoss

  • forceContextLoss(): void

  • Returns void

forceContextRestore

  • forceContextRestore(): void

  • Returns void

getMaxAnisotropy

  • getMaxAnisotropy(): number

  • Returns number

    Deprecated

    Use .capabilities.getMaxAnisotropy() instead.

    -

getPrecision

  • getPrecision(): string

  • Returns string

    Deprecated

    Use .capabilities.precision instead.

    -

getPixelRatio

  • getPixelRatio(): number

  • Returns number

setPixelRatio

  • setPixelRatio(value: number): void

  • Parameters

    • value: number

    Returns void

getDrawingBufferSize

  • getDrawingBufferSize(target: Vector2): Vector2

  • Parameters

    Returns Vector2

setDrawingBufferSize

  • setDrawingBufferSize(width: number, height: number, pixelRatio: number): void

  • Parameters

    • width: number
    • height: number
    • pixelRatio: number

    Returns void

getSize

  • getSize(target: Vector2): Vector2

  • Parameters

    Returns Vector2

setSize

  • setSize(width: number, height: number, updateStyle?: boolean): void

  • Resizes the output canvas to (width, height), and also sets the viewport to fit that size, starting in (0, 0).

    -

    Parameters

    • width: number
    • height: number
    • OptionalupdateStyle: boolean

    Returns void

getCurrentViewport

  • getCurrentViewport(target: Vector4): Vector4

  • Parameters

    Returns Vector4

getViewport

  • getViewport(target: Vector4): Vector4

  • Copies the viewport into target.

    -

    Parameters

    Returns Vector4

setViewport

  • setViewport(
        x: number | Vector4,
        y?: number,
        width?: number,
        height?: number,
    ): void

  • Sets the viewport to render from (x, y) to (x + width, y + height).
    -(x, y) is the lower-left corner of the region.

    -

    Parameters

    • x: number | Vector4
    • Optionaly: number
    • Optionalwidth: number
    • Optionalheight: number

    Returns void

getScissor

  • getScissor(target: Vector4): Vector4

  • Copies the scissor area into target.

    -

    Parameters

    Returns Vector4

setScissor

  • setScissor(
        x: number | Vector4,
        y?: number,
        width?: number,
        height?: number,
    ): void

  • Sets the scissor area from (x, y) to (x + width, y + height).

    -

    Parameters

    • x: number | Vector4
    • Optionaly: number
    • Optionalwidth: number
    • Optionalheight: number

    Returns void

getScissorTest

  • getScissorTest(): boolean

  • Returns true if scissor test is enabled; returns false otherwise.

    -

    Returns boolean

setScissorTest

  • setScissorTest(enable: boolean): void

  • Enable the scissor test. When this is enabled, only the pixels within the defined scissor area will be affected by further renderer actions.

    -

    Parameters

    • enable: boolean

    Returns void

setOpaqueSort

  • setOpaqueSort(method: (a: any, b: any) => number): void

  • Sets the custom opaque sort function for the WebGLRenderLists. Pass null to use the default painterSortStable function.

    -

    Parameters

    • method: (a: any, b: any) => number

    Returns void

setTransparentSort

  • setTransparentSort(method: (a: any, b: any) => number): void

  • Sets the custom transparent sort function for the WebGLRenderLists. Pass null to use the default reversePainterSortStable function.

    -

    Parameters

    • method: (a: any, b: any) => number

    Returns void

getClearColor

  • getClearColor(target: Color): Color

  • Returns a THREE.Color instance with the current clear color.

    -

    Parameters

    Returns Color

setClearColor

  • setClearColor(color: ColorRepresentation, alpha?: number): void

  • Sets the clear color, using color for the color and alpha for the opacity.

    -

    Parameters

    Returns void

getClearAlpha

  • getClearAlpha(): number

  • Returns a float with the current clear alpha. Ranges from 0 to 1.

    -

    Returns number

setClearAlpha

  • setClearAlpha(alpha: number): void

  • Parameters

    • alpha: number

    Returns void

clear

  • clear(color?: boolean, depth?: boolean, stencil?: boolean): void

  • Tells the renderer to clear its color, depth or stencil drawing buffer(s).
    -Arguments default to true

    -

    Parameters

    • Optionalcolor: boolean
    • Optionaldepth: boolean
    • Optionalstencil: boolean

    Returns void

clearColor

  • clearColor(): void

  • Returns void

clearDepth

  • clearDepth(): void

  • Returns void

clearStencil

  • clearStencil(): void

  • Returns void

clearTarget

  • clearTarget(
        renderTarget: WebGLRenderTarget,
        color: boolean,
        depth: boolean,
        stencil: boolean,
    ): void

  • Parameters

    Returns void

resetGLState

  • resetGLState(): void

  • Returns void

    Deprecated

    Use .state.reset() instead.

    -

dispose

  • dispose(): void

  • Returns void

renderBufferDirect

setAnimationLoop

  • setAnimationLoop(callback: null | XRFrameRequestCallback): void

  • A build in function that can be used instead of requestAnimationFrame. For WebXR projects this function must be used.

    -

    Parameters

    • callback: null | XRFrameRequestCallback

      The function will be called every available frame. If null is passed it will stop any already ongoing animation.

      -

    Returns void

animate

  • animate(callback: () => void): void

  • Parameters

    • callback: () => void

    Returns void

    Deprecated

    Use .setAnimationLoop() instead.

    -

render

  • render(scene: Object3D, camera: Camera): void

  • Render a scene or an object using a camera.
    -The render is done to a previously specified WebGLRenderTarget#renderTarget .renderTarget set by calling
    -.setRenderTarget or to the canvas as usual.

    -

    By default render buffers are cleared before rendering but you can prevent this by setting the property
    -autoClear to false. If you want to prevent only certain buffers being cleared
    -you can set either the autoClearColor,
    -autoClearStencil or autoClearDepth
    -properties to false. To forcibly clear one ore more buffers call .clear.

    -

    Parameters

    Returns void

getActiveCubeFace

  • getActiveCubeFace(): number

  • Returns the current active cube face.

    -

    Returns number

getActiveMipmapLevel

  • getActiveMipmapLevel(): number

  • Returns the current active mipmap level.

    -

    Returns number

getRenderTarget

  • getRenderTarget(): null | WebGLRenderTarget

  • Returns the current render target. If no render target is set, null is returned.

    -

    Returns null | WebGLRenderTarget

getCurrentRenderTarget

setRenderTarget

  • setRenderTarget(
        renderTarget: null | WebGLRenderTarget | WebGLRenderTarget<Texture[]>,
        activeCubeFace?: number,
        activeMipmapLevel?: number,
    ): void

  • Sets the active render target.

    -

    Parameters

    • renderTarget: null | WebGLRenderTarget | WebGLRenderTarget<Texture[]>

      The renderTarget that needs to be activated. When null is given, the canvas is set as the active render target instead.

      -
    • OptionalactiveCubeFace: number

      Specifies the active cube side (PX 0, NX 1, PY 2, NY 3, PZ 4, NZ 5) of WebGLCubeRenderTarget.

      -
    • OptionalactiveMipmapLevel: number

      Specifies the active mipmap level.

      -

    Returns void

readRenderTargetPixels

readRenderTargetPixelsAsync

copyFramebufferToTexture

  • copyFramebufferToTexture(
        texture: Texture,
        position?: null | Vector2,
        level?: number,
    ): void

  • Copies a region of the currently bound framebuffer into the selected mipmap level of the selected texture.
    -This region is defined by the size of the destination texture's mip level, offset by the input position.

    -

    Parameters

    • texture: Texture

      Specifies the destination texture.

      -
    • Optionalposition: null | Vector2

      Specifies the pixel offset from which to copy out of the framebuffer.

      -
    • Optionallevel: number

      Specifies the destination mipmap level of the texture.

      -

    Returns void

copyTextureToTexture

  • copyTextureToTexture(
        srcTexture: Texture,
        dstTexture: Texture,
        srcRegion?: null | Box2 | Box3,
        dstPosition?: null | Vector3 | Vector2,
        srcLevel?: number,
        dstLevel?: number,
    ): void

  • Copies the pixels of a texture in the bounds [srcRegion]Box3 in the destination texture starting from the
    -given position. 2D Texture, 3D Textures, or a mix of the two can be used as source and destination texture
    -arguments for copying between layers of 3d textures

    -

    The depthTexture and texture property of render targets are supported as well.

    -

    When using render target textures as srcTexture and dstTexture, you must make sure both render targets are
    -initialized e.g. via .initRenderTarget().

    -

    Parameters

    • srcTexture: Texture

      Specifies the source texture.

      -
    • dstTexture: Texture

      Specifies the destination texture.

      -
    • OptionalsrcRegion: null | Box2 | Box3

      Specifies the bounds

      -
    • OptionaldstPosition: null | Vector3 | Vector2

      Specifies the pixel offset into the dstTexture where the copy will occur.

      -
    • OptionalsrcLevel: number

      Specifies the source mipmap level of the texture.

      -
    • OptionaldstLevel: number

      Specifies the destination mipmap level of the texture.

      -

    Returns void

copyTextureToTexture3D

  • copyTextureToTexture3D(
        srcTexture: Texture,
        dstTexture: Data3DTexture | DataArrayTexture,
        srcRegion?: null | Box3,
        dstPosition?: null | Vector3,
        level?: number,
    ): void

  • Parameters

    • srcTexture: Texture

      Specifies the source texture.

      -
    • dstTexture: Data3DTexture | DataArrayTexture

      Specifies the destination texture.

      -
    • OptionalsrcRegion: null | Box3

      Specifies the bounds

      -
    • OptionaldstPosition: null | Vector3

      Specifies the pixel offset into the dstTexture where the copy will occur.

      -
    • Optionallevel: number

      Specifies the destination mipmap level of the texture.

      -

    Returns void

    Deprecated

    Use "copyTextureToTexture" instead.

    -

    Copies the pixels of a texture in the bounds srcRegion in the destination texture starting from the given
    -position. The depthTexture and texture property of 3D render targets are supported as well.

    -

    When using render target textures as srcTexture and dstTexture, you must make sure both render targets are
    -intitialized e.g. via .initRenderTarget().

    -

initRenderTarget

  • initRenderTarget(target: WebGLRenderTarget): void

  • Initializes the given WebGLRenderTarget memory. Useful for initializing a render target so data can be copied
    -into it using WebGLRenderer.copyTextureToTexture before it has been rendered to.

    -

    Parameters

    Returns void

initTexture

  • initTexture(texture: Texture): void

  • Initializes the given texture. Can be used to preload a texture rather than waiting until first render (which can cause noticeable lags due to decode and GPU upload overhead).

    -

    Parameters

    • texture: Texture

      The texture to Initialize.

      -

    Returns void

resetState

  • resetState(): void

  • Can be used to reset the internal WebGL state.

    -

    Returns void

supportsFloatTextures

supportsHalfFloatTextures

supportsStandardDerivatives

supportsCompressedTextureS3TC

supportsCompressedTexturePVRTC

supportsBlendMinMax

supportsVertexTextures

  • supportsVertexTextures(): any

  • Returns any

    Deprecated

    Use .capabilities.vertexTextures instead.

    -

supportsInstancedArrays

enableScissorTest

  • enableScissorTest(boolean: any): any

  • Parameters

    • boolean: any

    Returns any

    Deprecated

    Use .setScissorTest() instead.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
getContextgetContextAttributesforceContextLossforceContextRestoregetMaxAnisotropygetPrecisiongetPixelRatiosetPixelRatiogetDrawingBufferSizesetDrawingBufferSizegetSizesetSizegetCurrentViewportgetViewportsetViewportgetScissorsetScissorgetScissorTestsetScissorTestsetOpaqueSortsetTransparentSortgetClearColorsetClearColorgetClearAlphasetClearAlphaclearclearColorclearDepthclearStencilclearTargetresetGLStatedisposerenderBufferDirectsetAnimationLoopanimaterendergetActiveCubeFacegetActiveMipmapLevelgetRenderTargetgetCurrentRenderTargetsetRenderTargetreadRenderTargetPixelsreadRenderTargetPixelsAsynccopyFramebufferToTexturecopyTextureToTexturecopyTextureToTexture3DinitRenderTargetinitTextureresetStatesupportsFloatTexturessupportsHalfFloatTexturessupportsStandardDerivativessupportsCompressedTextureS3TCsupportsCompressedTexturePVRTCsupportsBlendMinMaxsupportsVertexTexturessupportsInstancedArraysenableScissorTest
diff --git a/docs/classes/WebGLShadowMap.html b/docs/classes/WebGLShadowMap.html deleted file mode 100644 index 09518f0..0000000 --- a/docs/classes/WebGLShadowMap.html +++ /dev/null @@ -1,21 +0,0 @@ -WebGLShadowMap | VFX-JS

Class WebGLShadowMap

Constructors

constructor -

Properties

enabled -autoUpdate -needsUpdate -type -cullFace -

Methods

render -

Constructors

constructor

Properties

enabled

enabled: boolean

Default

false
-
- -

autoUpdate

autoUpdate: boolean

Default

true
-
- -

needsUpdate

needsUpdate: boolean

Default

false
-
- -

type

type: ShadowMapType

Default

THREE.PCFShadowMap
-
- -

cullFace

cullFace: any

Deprecated

Use Material#shadowSide instead.

-

Methods

render

  • render(shadowsArray: Light[], scene: Scene, camera: Camera): void

  • Parameters

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/WebGLState.html b/docs/classes/WebGLState.html deleted file mode 100644 index 4df04ca..0000000 --- a/docs/classes/WebGLState.html +++ /dev/null @@ -1,24 +0,0 @@ -WebGLState | VFX-JS

Class WebGLState

Constructors

constructor -

Properties

buffers -

Methods

enable -disable -bindFramebuffer -drawBuffers -useProgram -setBlending -setMaterial -setFlipSided -setCullFace -setLineWidth -setPolygonOffset -setScissorTest -activeTexture -bindTexture -unbindTexture -compressedTexImage2D -texImage2D -texImage3D -scissor -viewport -reset -

Constructors

constructor

  • new WebGLState(
        gl: WebGLRenderingContext,
        extensions: WebGLExtensions,
    ): WebGLState

  • Parameters

    Returns WebGLState

Properties

buffers

buffers: { color: ColorBuffer; depth: DepthBuffer; stencil: StencilBuffer }

Methods

enable

  • enable(id: number): void

  • Parameters

    • id: number

    Returns void

disable

  • disable(id: number): void

  • Parameters

    • id: number

    Returns void

bindFramebuffer

  • bindFramebuffer(target: number, framebuffer: null | WebGLFramebuffer): void

  • Parameters

    Returns void

drawBuffers

useProgram

  • useProgram(program: any): boolean

  • Parameters

    • program: any

    Returns boolean

setBlending

setMaterial

  • setMaterial(
        material: Material,
        frontFaceCW: boolean,
        hardwareClippingPlanes: number,
    ): void

  • Parameters

    • material: Material
    • frontFaceCW: boolean
    • hardwareClippingPlanes: number

    Returns void

setFlipSided

  • setFlipSided(flipSided: boolean): void

  • Parameters

    • flipSided: boolean

    Returns void

setCullFace

  • setCullFace(cullFace: CullFace): void

  • Parameters

    Returns void

setLineWidth

  • setLineWidth(width: number): void

  • Parameters

    • width: number

    Returns void

setPolygonOffset

  • setPolygonOffset(polygonoffset: boolean, factor?: number, units?: number): void

  • Parameters

    • polygonoffset: boolean
    • Optionalfactor: number
    • Optionalunits: number

    Returns void

setScissorTest

  • setScissorTest(scissorTest: boolean): void

  • Parameters

    • scissorTest: boolean

    Returns void

activeTexture

  • activeTexture(webglSlot: number): void

  • Parameters

    • webglSlot: number

    Returns void

bindTexture

  • bindTexture(webglType: number, webglTexture: any): void

  • Parameters

    • webglType: number
    • webglTexture: any

    Returns void

unbindTexture

  • unbindTexture(): void

  • Returns void

compressedTexImage2D

  • compressedTexImage2D(
        target: number,
        level: number,
        internalformat: number,
        width: number,
        height: number,
        border: number,
        data: ArrayBufferView,
    ): void

  • Parameters

    • target: number
    • level: number
    • internalformat: number
    • width: number
    • height: number
    • border: number
    • data: ArrayBufferView

    Returns void

texImage2D

  • texImage2D(
        target: number,
        level: number,
        internalformat: number,
        width: number,
        height: number,
        border: number,
        format: number,
        type: number,
        pixels: null | ArrayBufferView,
    ): void

  • Parameters

    • target: number
    • level: number
    • internalformat: number
    • width: number
    • height: number
    • border: number
    • format: number
    • type: number
    • pixels: null | ArrayBufferView

    Returns void

  • texImage2D(
        target: number,
        level: number,
        internalformat: number,
        format: number,
        type: number,
        source: any,
    ): void

  • Parameters

    • target: number
    • level: number
    • internalformat: number
    • format: number
    • type: number
    • source: any

    Returns void

texImage3D

  • texImage3D(
        target: number,
        level: number,
        internalformat: number,
        width: number,
        height: number,
        depth: number,
        border: number,
        format: number,
        type: number,
        pixels: any,
    ): void

  • Parameters

    • target: number
    • level: number
    • internalformat: number
    • width: number
    • height: number
    • depth: number
    • border: number
    • format: number
    • type: number
    • pixels: any

    Returns void

scissor

  • scissor(scissor: Vector4): void

  • Parameters

    Returns void

viewport

  • viewport(viewport: Vector4): void

  • Parameters

    Returns void

reset

  • reset(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/WebGLTextures.html b/docs/classes/WebGLTextures.html deleted file mode 100644 index 7d9a4a5..0000000 --- a/docs/classes/WebGLTextures.html +++ /dev/null @@ -1,13 +0,0 @@ -WebGLTextures | VFX-JS

Class WebGLTextures

Constructors

constructor -

Methods

allocateTextureUnit -resetTextureUnits -setTexture2D -setTexture2DArray -setTexture3D -setTextureCube -setupRenderTarget -updateRenderTargetMipmap -updateMultisampleRenderTarget -safeSetTexture2D -safeSetTextureCube -

Constructors

constructor

Methods

allocateTextureUnit

  • allocateTextureUnit(): void

  • Returns void

resetTextureUnits

  • resetTextureUnits(): void

  • Returns void

setTexture2D

  • setTexture2D(texture: any, slot: number): void

  • Parameters

    • texture: any
    • slot: number

    Returns void

setTexture2DArray

  • setTexture2DArray(texture: any, slot: number): void

  • Parameters

    • texture: any
    • slot: number

    Returns void

setTexture3D

  • setTexture3D(texture: any, slot: number): void

  • Parameters

    • texture: any
    • slot: number

    Returns void

setTextureCube

  • setTextureCube(texture: any, slot: number): void

  • Parameters

    • texture: any
    • slot: number

    Returns void

setupRenderTarget

  • setupRenderTarget(renderTarget: any): void

  • Parameters

    • renderTarget: any

    Returns void

updateRenderTargetMipmap

  • updateRenderTargetMipmap(renderTarget: any): void

  • Parameters

    • renderTarget: any

    Returns void

updateMultisampleRenderTarget

  • updateMultisampleRenderTarget(renderTarget: any): void

  • Parameters

    • renderTarget: any

    Returns void

safeSetTexture2D

  • safeSetTexture2D(texture: any, slot: number): void

  • Parameters

    • texture: any
    • slot: number

    Returns void

safeSetTextureCube

  • safeSetTextureCube(texture: any, slot: number): void

  • Parameters

    • texture: any
    • slot: number

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/WebGLUniforms.html b/docs/classes/WebGLUniforms.html deleted file mode 100644 index 6cebf39..0000000 --- a/docs/classes/WebGLUniforms.html +++ /dev/null @@ -1,6 +0,0 @@ -WebGLUniforms | VFX-JS

Class WebGLUniforms

Constructors

constructor -

Methods

upload -seqWithValue -setValue -setOptional -

Constructors

constructor

  • new WebGLUniforms(
        gl: WebGLRenderingContext,
        program: WebGLProgram,
    ): WebGLUniforms

  • Parameters

    Returns WebGLUniforms

Methods

Staticupload

  • upload(
        gl: WebGLRenderingContext,
        seq: any,
        values: any[],
        textures: WebGLTextures,
    ): void

  • Parameters

    • gl: WebGLRenderingContext
    • seq: any
    • values: any[]
    • textures: WebGLTextures

    Returns void

StaticseqWithValue

  • seqWithValue(seq: any, values: any[]): any[]

  • Parameters

    • seq: any
    • values: any[]

    Returns any[]

setValue

  • setValue(
        gl: WebGLRenderingContext,
        name: string,
        value: any,
        textures: WebGLTextures,
    ): void

  • Parameters

    • gl: WebGLRenderingContext
    • name: string
    • value: any
    • textures: WebGLTextures

    Returns void

setOptional

  • setOptional(gl: WebGLRenderingContext, object: any, name: string): void

  • Parameters

    • gl: WebGLRenderingContext
    • object: any
    • name: string

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/WebGLUtils.html b/docs/classes/WebGLUtils.html deleted file mode 100644 index 00f8a2b..0000000 --- a/docs/classes/WebGLUtils.html +++ /dev/null @@ -1,3 +0,0 @@ -WebGLUtils | VFX-JS

Class WebGLUtils

Constructors

constructor -

Methods

convert -

Constructors

constructor

  • new WebGLUtils(
        gl: WebGLRenderingContext | WebGL2RenderingContext,
        extensions: WebGLExtensions,
    ): WebGLUtils

  • Parameters

    • gl: WebGLRenderingContext | WebGL2RenderingContext
    • extensions: WebGLExtensions

    Returns WebGLUtils

Methods

convert

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/WebXRController.html b/docs/classes/WebXRController.html deleted file mode 100644 index fe03360..0000000 --- a/docs/classes/WebXRController.html +++ /dev/null @@ -1,9 +0,0 @@ -WebXRController | VFX-JS

Class WebXRController

Constructors

constructor -

Methods

getHandSpace -getTargetRaySpace -getGripSpace -dispatchEvent -connect -disconnect -update -

Constructors

constructor

Methods

getHandSpace

  • getHandSpace(): XRHandSpace

  • Returns XRHandSpace

getTargetRaySpace

getGripSpace

  • getGripSpace(): XRGripSpace

  • Returns XRGripSpace

dispatchEvent

connect

  • connect(inputSource: XRInputSource): this

  • Parameters

    Returns this

disconnect

  • disconnect(inputSource: XRInputSource): this

  • Parameters

    Returns this

update

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/WebXRManager.html b/docs/classes/WebXRManager.html deleted file mode 100644 index 62d345a..0000000 --- a/docs/classes/WebXRManager.html +++ /dev/null @@ -1,60 +0,0 @@ -WebXRManager | VFX-JS

Class WebXRManager

JavaScript events for custom objects

-

Example

// Adding events to a custom object
class Car extends EventDispatcher {
  start() {
    this.dispatchEvent( { type: 'start', message: 'vroom vroom!' } );
  }
};
// Using events with the custom object
const car = new Car();
car.addEventListener( 'start', ( event ) => {
  alert( event.message );
} );
car.start();
-
- -

See

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

cameraAutoUpdate -enabled -isPresenting -getController -getControllerGrip -getHand -setFramebufferScaleFactor -setReferenceSpaceType -getReferenceSpace -setReferenceSpace -getBaseLayer -getBinding -getFrame -getSession -setSession -getEnvironmentBlendMode -getDepthTexture -updateCamera -getCamera -getFoveation -setFoveation -hasDepthSensing -getDepthSensingMesh -setAnimationLoop -dispose -

Methods

addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

cameraAutoUpdate

cameraAutoUpdate: boolean

Default

true
-
- -

enabled

enabled: boolean

Default

false
-
- -

isPresenting

isPresenting: boolean

Default

false
-
- -

getController

getController: (index: number) => XRTargetRaySpace

getControllerGrip

getControllerGrip: (index: number) => XRGripSpace

getHand

getHand: (index: number) => XRHandSpace

setFramebufferScaleFactor

setFramebufferScaleFactor: (value: number) => void

setReferenceSpaceType

setReferenceSpaceType: (value: XRReferenceSpaceType) => void

getReferenceSpace

getReferenceSpace: () => null | XRReferenceSpace

setReferenceSpace

setReferenceSpace: (value: XRReferenceSpace) => void

getBaseLayer

getBaseLayer: () => XRWebGLLayer | XRProjectionLayer

getBinding

getBinding: () => XRWebGLBinding

getFrame

getFrame: () => XRFrame

getSession

getSession: () => null | XRSession

setSession

setSession: (value: null | XRSession) => Promise<void>

getEnvironmentBlendMode

getEnvironmentBlendMode: () => undefined | XREnvironmentBlendMode

getDepthTexture

getDepthTexture: () => null | Texture

updateCamera

updateCamera: (camera: PerspectiveCamera) => void

getCamera

getCamera: () => WebXRArrayCamera

getFoveation

getFoveation: () => undefined | number

setFoveation

setFoveation: (value: number) => void

hasDepthSensing

hasDepthSensing: () => boolean

getDepthSensingMesh

getDepthSensingMesh: () => null | Mesh

setAnimationLoop

setAnimationLoop: (callback: null | XRFrameRequestCallback) => void

dispose

dispose: () => void

Methods

addEventListener

hasEventListener

removeEventListener

dispatchEvent

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRAnchor.html b/docs/classes/XRAnchor.html deleted file mode 100644 index a7289ff..0000000 --- a/docs/classes/XRAnchor.html +++ /dev/null @@ -1,4 +0,0 @@ -XRAnchor | VFX-JS

Class XRAnchorAbstract

Implements

Implemented by

Constructors

constructor -

Properties

anchorSpace -

Methods

delete -

Constructors

constructor

Properties

anchorSpace

anchorSpace: XRSpace

Methods

delete

  • delete(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRBoundedReferenceSpace.html b/docs/classes/XRBoundedReferenceSpace.html deleted file mode 100644 index ac641af..0000000 --- a/docs/classes/XRBoundedReferenceSpace.html +++ /dev/null @@ -1,30 +0,0 @@ -XRBoundedReferenceSpace | VFX-JS

Class XRBoundedReferenceSpaceAbstract

Hierarchy (View Summary)

Implements

Implemented by

Constructors

constructor -

Properties

boundsGeometry -onreset -

Methods

getOffsetReferenceSpace -addEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

ReadonlyboundsGeometry

boundsGeometry: DOMPointReadOnly[]

onreset

onreset: XRReferenceSpaceEventHandler

Methods

getOffsetReferenceSpace

addEventListener

  • addEventListener<K extends "reset">(
        type: K,
        listener: (this: XRReferenceSpace, ev: XRReferenceSpaceEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Type Parameters

    • K extends "reset"

    Parameters

    Returns void

  • addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Parameters

    Returns void

removeEventListener

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    -

    MDN Reference

    -

    Parameters

    • event: Event

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRCompositionLayer.html b/docs/classes/XRCompositionLayer.html deleted file mode 100644 index 7e61bbf..0000000 --- a/docs/classes/XRCompositionLayer.html +++ /dev/null @@ -1,36 +0,0 @@ -XRCompositionLayer | VFX-JS

Class XRCompositionLayerAbstract

Hierarchy (View Summary)

Implements

Implemented by

Constructors

constructor -

Properties

layout -blendTextureSourceAlpha -chromaticAberrationCorrection? -mipLevels -quality -needsRedraw -space -onredraw -

Methods

destroy -addEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

Readonlylayout

layout: XRLayerLayout

blendTextureSourceAlpha

blendTextureSourceAlpha: boolean

OptionalchromaticAberrationCorrection

chromaticAberrationCorrection?: boolean

ReadonlymipLevels

mipLevels: number

quality

quality: XRLayerQuality

ReadonlyneedsRedraw

needsRedraw: boolean

space

space: XRSpace

onredraw

onredraw: (evt: XRLayerEvent) => any

Methods

destroy

  • destroy(): void

  • Returns void

addEventListener

  • addEventListener<K extends "redraw">(
        this: XRCompositionLayer,
        type: K,
        callback: (evt: XRCompositionLayerEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Type Parameters

    • K extends "redraw"

    Parameters

    Returns void

  • addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Parameters

    Returns void

removeEventListener

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    -

    MDN Reference

    -

    Parameters

    • event: Event

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRCubeLayer.html b/docs/classes/XRCubeLayer.html deleted file mode 100644 index 5c93d45..0000000 --- a/docs/classes/XRCubeLayer.html +++ /dev/null @@ -1,37 +0,0 @@ -XRCubeLayer | VFX-JS

Class XRCubeLayerAbstract

Hierarchy (View Summary)

Implements

Implemented by

Constructors

constructor -

Properties

orientation -layout -blendTextureSourceAlpha -chromaticAberrationCorrection? -mipLevels -quality -needsRedraw -space -onredraw -

Methods

destroy -addEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

orientation

orientation: DOMPointReadOnly

Readonlylayout

layout: XRLayerLayout

blendTextureSourceAlpha

blendTextureSourceAlpha: boolean

OptionalchromaticAberrationCorrection

chromaticAberrationCorrection?: boolean

ReadonlymipLevels

mipLevels: number

quality

quality: XRLayerQuality

ReadonlyneedsRedraw

needsRedraw: boolean

space

space: XRSpace

onredraw

onredraw: (evt: XRLayerEvent) => any

Methods

destroy

  • destroy(): void

  • Returns void

addEventListener

  • addEventListener<K extends "redraw">(
        this: XRCompositionLayer,
        type: K,
        callback: (evt: XRCompositionLayerEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Type Parameters

    • K extends "redraw"

    Parameters

    Returns void

  • addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Parameters

    Returns void

removeEventListener

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    -

    MDN Reference

    -

    Parameters

    • event: Event

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRCylinderLayer.html b/docs/classes/XRCylinderLayer.html deleted file mode 100644 index 59c4b4f..0000000 --- a/docs/classes/XRCylinderLayer.html +++ /dev/null @@ -1,40 +0,0 @@ -XRCylinderLayer | VFX-JS

Class XRCylinderLayerAbstract

Hierarchy (View Summary)

Implements

Implemented by

Constructors

constructor -

Properties

transform -radius -centralAngle -aspectRatio -layout -blendTextureSourceAlpha -chromaticAberrationCorrection? -mipLevels -quality -needsRedraw -space -onredraw -

Methods

destroy -addEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

transform

transform: XRRigidTransform

radius

radius: number

centralAngle

centralAngle: number

aspectRatio

aspectRatio: number

Readonlylayout

layout: XRLayerLayout

blendTextureSourceAlpha

blendTextureSourceAlpha: boolean

OptionalchromaticAberrationCorrection

chromaticAberrationCorrection?: boolean

ReadonlymipLevels

mipLevels: number

quality

quality: XRLayerQuality

ReadonlyneedsRedraw

needsRedraw: boolean

space

space: XRSpace

onredraw

onredraw: (evt: XRLayerEvent) => any

Methods

destroy

  • destroy(): void

  • Returns void

addEventListener

  • addEventListener<K extends "redraw">(
        this: XRCompositionLayer,
        type: K,
        callback: (evt: XRCompositionLayerEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Type Parameters

    • K extends "redraw"

    Parameters

    Returns void

  • addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Parameters

    Returns void

removeEventListener

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    -

    MDN Reference

    -

    Parameters

    • event: Event

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XREquirectLayer.html b/docs/classes/XREquirectLayer.html deleted file mode 100644 index e8c2463..0000000 --- a/docs/classes/XREquirectLayer.html +++ /dev/null @@ -1,41 +0,0 @@ -XREquirectLayer | VFX-JS

Class XREquirectLayerAbstract

Hierarchy (View Summary)

Implements

Implemented by

Constructors

constructor -

Properties

transform -radius -centralHorizontalAngle -upperVerticalAngle -lowerVerticalAngle -layout -blendTextureSourceAlpha -chromaticAberrationCorrection? -mipLevels -quality -needsRedraw -space -onredraw -

Methods

destroy -addEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

transform

transform: XRRigidTransform

radius

radius: number

centralHorizontalAngle

centralHorizontalAngle: number

upperVerticalAngle

upperVerticalAngle: number

lowerVerticalAngle

lowerVerticalAngle: number

Readonlylayout

layout: XRLayerLayout

blendTextureSourceAlpha

blendTextureSourceAlpha: boolean

OptionalchromaticAberrationCorrection

chromaticAberrationCorrection?: boolean

ReadonlymipLevels

mipLevels: number

quality

quality: XRLayerQuality

ReadonlyneedsRedraw

needsRedraw: boolean

space

space: XRSpace

onredraw

onredraw: (evt: XRLayerEvent) => any

Methods

destroy

  • destroy(): void

  • Returns void

addEventListener

  • addEventListener<K extends "redraw">(
        this: XRCompositionLayer,
        type: K,
        callback: (evt: XRCompositionLayerEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Type Parameters

    • K extends "redraw"

    Parameters

    Returns void

  • addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Parameters

    Returns void

removeEventListener

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    -

    MDN Reference

    -

    Parameters

    • event: Event

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRFrame.html b/docs/classes/XRFrame.html deleted file mode 100644 index 870b3b8..0000000 --- a/docs/classes/XRFrame.html +++ /dev/null @@ -1,30 +0,0 @@ -XRFrame | VFX-JS

Class XRFrameAbstract

Implements

Implemented by

Constructors

constructor -

Properties

session -predictedDisplayTime -trackedAnchors? -createAnchor? -detectedPlanes? -detectedMeshes? -getJointPose? -

Methods

getPose -getViewerPose -getHitTestResults -getHitTestResultsForTransientInput -getDepthInformation -

Constructors

constructor

Properties

Readonlysession

session: XRSession

ReadonlypredictedDisplayTime

predictedDisplayTime: number

OptionaltrackedAnchors

trackedAnchors?: XRAnchorSet

OptionalcreateAnchor

createAnchor?: (
    pose: XRRigidTransform,
    space: XRSpace,
) => undefined | Promise<XRAnchor>

Optional ReadonlydetectedPlanes

detectedPlanes?: XRPlaneSet

XRFrame is extended to contain detectedPlanes attribute which contains
-all planes that are still tracked in the frame.

-

The set is initially empty and will be populated by the update planes
-algorithm. If this attribute is accessed when the frame is not active,
-the user agent MUST throw InvalidStateError.

-

See

https://immersive-web.github.io/real-world-geometry/plane-detection.html#plane-set

-

Optional ReadonlydetectedMeshes

detectedMeshes?: XRMeshSet

XRFrame is extended to contain detectedMeshes attribute
-which contains all meshes that are still tracked in the frame.

-

The set is initially empty and will be populated by the update meshes algorithm.
-If this attribute is accessed when the frame is not active, the user agent
-MUST throw InvalidStateError.

-

See

https://immersive-web.github.io/real-world-meshing/#mesh-set

-

OptionalgetJointPose

getJointPose?: (
    joint: XRJointSpace,
    baseSpace: XRSpace,
) => undefined | XRJointPose

Methods

getPose

  • getPose(space: XRSpace, baseSpace: XRSpace): undefined | XRPose

  • Provides the pose of space relative to baseSpace as an XRPose, at the time represented by
    -the XRFrame.

    -

    Parameters

    Returns undefined | XRPose

getViewerPose

  • getViewerPose(referenceSpace: XRReferenceSpace): undefined | XRViewerPose

  • Provides the pose of the viewer relative to referenceSpace as an XRViewerPose, at the
    -XRFrame's time.

    -

    Parameters

    Returns undefined | XRViewerPose

getHitTestResults

getHitTestResultsForTransientInput

getDepthInformation

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRGripSpace.html b/docs/classes/XRGripSpace.html deleted file mode 100644 index b875e19..0000000 --- a/docs/classes/XRGripSpace.html +++ /dev/null @@ -1,338 +0,0 @@ -XRGripSpace | VFX-JS

Class XRGripSpace

Its purpose is to make working with groups of objects syntactically clearer.

-

Remarks

This is almost identical to an Object3D

-

Example

const geometry = new THREE.BoxGeometry(1, 1, 1);
const material = new THREE.MeshBasicMaterial({
    color: 0x00ff00
});
const cubeA = new THREE.Mesh(geometry, material);
cubeA.position.set(100, 100, 0);
const cubeB = new THREE.Mesh(geometry, material);
cubeB.position.set(-100, -100, 0);
//create a {@link Group} and add the two cubes
//These cubes can now be rotated / scaled etc as a {@link Group}  * const {@link Group} = new THREE.Group();
group.add(cubeA);
group.add(cubeB);
scene.add(group);
-
- -

See

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_UP -DEFAULT_MATRIX_AUTO_UPDATE -DEFAULT_MATRIX_WORLD_AUTO_UPDATE -hasLinearVelocity -linearVelocity -hasAngularVelocity -angularVelocity -isGroup -isObject3D -id -uuid -name -type -parent -children -up -position -rotation -quaternion -scale -modelViewMatrix -normalMatrix -matrix -matrixWorld -matrixAutoUpdate -matrixWorldAutoUpdate -matrixWorldNeedsUpdate -layers -visible -castShadow -receiveShadow -frustumCulled -renderOrder -animations -userData -customDepthMaterial? -customDistanceMaterial? -

Methods

onBeforeShadow -onAfterShadow -onBeforeRender -onAfterRender -applyMatrix4 -applyQuaternion -setRotationFromAxisAngle -setRotationFromEuler -setRotationFromMatrix -setRotationFromQuaternion -rotateOnAxis -rotateOnWorldAxis -rotateX -rotateY -rotateZ -translateOnAxis -translateX -translateY -translateZ -localToWorld -worldToLocal -lookAt -add -remove -removeFromParent -clear -attach -getObjectById -getObjectByName -getObjectByProperty -getObjectsByProperty -getWorldPosition -getWorldQuaternion -getWorldScale -getWorldDirection -raycast -traverse -traverseVisible -traverseAncestors -updateMatrix -updateMatrixWorld -updateWorldMatrix -toJSON -clone -copy -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

StaticDEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight,
-THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

-

Default Value

new THREE.Vector3( 0, 1, 0)

-

StaticDEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

StaticDEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

hasLinearVelocity

hasLinearVelocity: boolean

ReadonlylinearVelocity

linearVelocity: Vector3

hasAngularVelocity

hasAngularVelocity: boolean

ReadonlyangularVelocity

angularVelocity: Vector3

ReadonlyisGroup

isGroup: true

Read-only flag to check if a given object is of type Group.

-

Remarks

This is a constant value

-

Default Value

true

-

ReadonlyisObject3D

isObject3D: true

Flag to check if a given object is of type Object3D.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Object3D instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
-Expects a Integer

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

Readonlytype

type: string

A Read-only string to check this object type.

-

Remarks

This can be used to find a specific type of Object3D in a scene.
-Sub-classes will update this value.

-

Default Value

Object3D

-

parent

parent: null | Object3D

Object's parent in the scene graph.

-

Remarks

An object can have at most one parent.

-

Default Value

null

-

children

children: Object3D[]

Array with object's children.

-

See

THREE.Object3DGroup | Group for info on manually grouping objects.

-

Default Value

[]

-

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

-

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

-

Readonlyposition

position: Vector3

Object's local position.

-

Default Value

new THREE.Vector3() - that is (0, 0, 0).

-

Readonlyrotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

-

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

-

Readonlyquaternion

quaternion: Quaternion

Object's local rotation as a THREE.Quaternion | Quaternion.

-

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

-

Readonlyscale

scale: Vector3

The object's local scale.

-

Default Value

new THREE.Vector3( 1, 1, 1 )

-

ReadonlymodelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

-

ReadonlynormalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

-

matrix

matrix: Matrix4

The local transform matrix.

-

Default Value

new THREE.Matrix4()

-

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

-

Remarks

If the Object3D has no parent, then it's identical to the local transform THREE.Object3D.matrix | .matrix.

-

Default Value

new THREE.Matrix4()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and
-scale every frame and also recalculates the matrixWorld property.

-

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

-

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates.
-When it isn't, then you have to maintain all matrices in the object and its children yourself.

-

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

-

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

-

Default Value

false

-

layers

layers: Layers

The layer membership of the object.

-

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use.
-This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.

-

Default Value

new THREE.Layers()

-

visible

visible: boolean

Object gets rendered if true.

-

Default Value

true

-

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

-

Default Value

false

-

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

-

Default Value

false

-

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object.
-If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

-

Default Value

true

-

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph
-objects to be overridden although opaque and transparent objects remain sorted independently.

-

Remarks

When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.
-Sorting is from lowest to highest renderOrder.

-

Default Value

0

-

animations

animations: AnimationClip[]

Array with object's animation clips.

-

Default Value

[]

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the Object3D.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default

{}

-

OptionalcustomDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

-

Remarks

Can only be used in context of meshes.
-When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight,
-if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

-

Default Value

undefined

-

OptionalcustomDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

-

Default Value

undefined

-

Methods

onBeforeShadow

  • onBeforeShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterShadow

  • onAfterShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onBeforeRender

  • onBeforeRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterRender

  • onAfterRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

applyMatrix4

  • applyMatrix4(matrix: Matrix4): void

  • Applies the matrix transform to the object and updates the object's position, rotation and scale.

    -

    Parameters

    Returns void

applyQuaternion

  • applyQuaternion(quaternion: Quaternion): this

  • Applies the rotation represented by the quaternion to the object.

    -

    Parameters

    Returns this

setRotationFromAxisAngle

  • setRotationFromAxisAngle(axis: Vector3, angle: number): void

  • Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      Angle in radians. Expects a Float

      -

    Returns void

setRotationFromEuler

  • setRotationFromEuler(euler: Euler): void

  • Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.

    -

    Parameters

    • euler: Euler

      Euler angle specifying rotation amount.

      -

    Returns void

setRotationFromMatrix

  • setRotationFromMatrix(m: Matrix4): void

  • Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

    -

    Parameters

    • m: Matrix4

      Rotate the quaternion by the rotation component of the matrix.

      -

    Returns void

    Remarks

    Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

    -

setRotationFromQuaternion

rotateOnAxis

  • rotateOnAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in object space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

rotateOnWorldAxis

  • rotateOnWorldAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in world space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in world space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized
    -Method Assumes no rotated parent.

    -

rotateX

  • rotateX(angle: number): this

  • Rotates the object around x axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateY

  • rotateY(angle: number): this

  • Rotates the object around y axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateZ

  • rotateZ(angle: number): this

  • Rotates the object around z axis in local space.

    -

    Parameters

    • angle: number

    Returns this

translateOnAxis

  • translateOnAxis(axis: Vector3, distance: number): this

  • Translate an object by distance along an axis in object space

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • distance: number

      The distance to translate. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

translateX

  • translateX(distance: number): this

  • Translates object along x axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateY

  • translateY(distance: number): this

  • Translates object along y axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateZ

  • translateZ(distance: number): this

  • Translates object along z axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

localToWorld

  • localToWorld(vector: Vector3): Vector3

  • Converts the vector from this object's local space to world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in this object's local space.

      -

    Returns Vector3

worldToLocal

  • worldToLocal(vector: Vector3): Vector3

  • Converts the vector from world space to this object's local space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space.

      -

    Returns Vector3

lookAt

  • lookAt(vector: Vector3): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space to look at.

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -
  • lookAt(x: number, y: number, z: number): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -

add

  • add(...object: Object3D[]): this

  • Adds another Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be added
    -Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.

    -

    See

      -
    • attach
      • -
    • THREE.Group | Group for info on manually grouping objects.
      • -
    -

remove

  • remove(...object: Object3D[]): this

  • Removes a Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be removed.

    -

    See

    THREE.Group | Group for info on manually grouping objects.

    -

removeFromParent

  • removeFromParent(): this

  • Removes this object from its current parent.

    -

    Returns this

clear

  • clear(): this

  • Removes all child objects.

    -

    Returns this

attach

  • attach(object: Object3D): this

  • Adds a Object3D as a child of this, while maintaining the object's world transform.

    -

    Parameters

    Returns this

    Remarks

    Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

    -

    See

    add

    -

getObjectById

  • getObjectById(id: number): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    -

    Parameters

    • id: number

      Unique number of the object instance. Expects a Integer

      -

    Returns undefined | Object3D

    Remarks

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    -

    See

    id

    -

getObjectByName

  • getObjectByName(name: string): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

    -

    Parameters

    • name: string

      String to match to the children's Object3D.name property.

      -

    Returns undefined | Object3D

    Remarks

    Note that for most objects the name is an empty string by default
    -You will have to set it manually to make use of this method.

    -

getObjectByProperty

  • getObjectByProperty(name: string, value: any): undefined | Object3D

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      the property name to search for.

      -
    • value: any

      value of the given property.

      -

    Returns undefined | Object3D

getObjectsByProperty

  • getObjectsByProperty(
        name: string,
        value: any,
        optionalTarget?: Object3D[],
    ): Object3D[]

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      The property name to search for.

      -
    • value: any

      Value of the given property.

      -
    • OptionaloptionalTarget: Object3D[]

      target to set the result. Otherwise a new Array is instantiated. If set, you must clear
      -this array prior to each call (i.e., array.length = 0;).

      -

    Returns Object3D[]

getWorldPosition

  • getWorldPosition(target: Vector3): Vector3

  • Returns a vector representing the position of the object in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldQuaternion

  • getWorldQuaternion(target: Quaternion): Quaternion

  • Returns a quaternion representing the rotation of the object in world space.

    -

    Parameters

    • target: Quaternion

      The result will be copied into this Quaternion.

      -

    Returns Quaternion

getWorldScale

  • getWorldScale(target: Vector3): Vector3

  • Returns a vector of the scaling factors applied to the object for each axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldDirection

  • getWorldDirection(target: Vector3): Vector3

  • Returns a vector representing the direction of object's positive z-axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

raycast

  • raycast(raycaster: Raycaster, intersects: Intersection[]): void

  • Abstract (empty) method to get intersections between a casted ray and this object

    -

    Parameters

    Returns void

    Remarks

    Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

    -

    See

    THREE.Raycaster | Raycaster

    -

    Default Value

    () => {}

    -

traverse

  • traverse(callback: (object: Object3D) => any): void

  • Executes the callback on this object and all descendants.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseVisible

  • traverseVisible(callback: (object: Object3D) => any): void

  • Like traverse, but the callback will only be executed for visible objects

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Descendants of invisible objects are not traversed.
    -Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseAncestors

  • traverseAncestors(callback: (object: Object3D) => any): void

  • Executes the callback on all ancestors.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

updateMatrix

  • updateMatrix(): void

  • Updates local transform.

    -

    Returns void

updateMatrixWorld

  • updateMatrixWorld(force?: boolean): void

  • Updates the global transform of the object.
    -And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

    -

    Parameters

    • Optionalforce: boolean

      A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame.
      -Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

      -

    Returns void

updateWorldMatrix

  • updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void

  • Updates the global transform of the object.

    -

    Parameters

    • updateParents: boolean

      Recursively updates global transform of ancestors.

      -
    • updateChildren: boolean

      Recursively updates global transform of descendants.

      -

    Returns void

toJSON

clone

  • clone(recursive?: boolean): this

  • Returns a clone of this object and optionally all descendants.

    -

    Parameters

    • Optionalrecursive: boolean

      If true, descendants of the object are also cloned. Default true

      -

    Returns this

copy

  • copy(object: Object3D, recursive?: boolean): this

  • Copies the given object into this object.

    -

    Parameters

    • object: Object3D
    • Optionalrecursive: boolean

      If set to true, descendants of the object are copied next to the existing ones. If set to
      -false, descendants are left unchanged. Default is true.

      -

    Returns this

    Remarks

    Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

    -

addEventListener

hasEventListener

removeEventListener

dispatchEvent

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRHand.html b/docs/classes/XRHand.html deleted file mode 100644 index cf6ace6..0000000 --- a/docs/classes/XRHand.html +++ /dev/null @@ -1,50 +0,0 @@ -XRHand | VFX-JS

Class XRHandAbstract

Hierarchy

Implements

Implemented by

Constructors

constructor -

Properties

WRIST -THUMB_METACARPAL -THUMB_PHALANX_PROXIMAL -THUMB_PHALANX_DISTAL -THUMB_PHALANX_TIP -INDEX_METACARPAL -INDEX_PHALANX_PROXIMAL -INDEX_PHALANX_INTERMEDIATE -INDEX_PHALANX_DISTAL -INDEX_PHALANX_TIP -MIDDLE_METACARPAL -MIDDLE_PHALANX_PROXIMAL -MIDDLE_PHALANX_INTERMEDIATE -MIDDLE_PHALANX_DISTAL -MIDDLE_PHALANX_TIP -RING_METACARPAL -RING_PHALANX_PROXIMAL -RING_PHALANX_INTERMEDIATE -RING_PHALANX_DISTAL -RING_PHALANX_TIP -LITTLE_METACARPAL -LITTLE_PHALANX_PROXIMAL -LITTLE_PHALANX_INTERMEDIATE -LITTLE_PHALANX_DISTAL -LITTLE_PHALANX_TIP -size -[toStringTag] -

Methods

clear -delete -forEach -get -has -set -entries -keys -values -[iterator] -

Constructors

constructor

  • new XRHand(): XRHand

  • Returns XRHand

Properties

ReadonlyWRIST

WRIST: number

ReadonlyTHUMB_METACARPAL

THUMB_METACARPAL: number

ReadonlyTHUMB_PHALANX_PROXIMAL

THUMB_PHALANX_PROXIMAL: number

ReadonlyTHUMB_PHALANX_DISTAL

THUMB_PHALANX_DISTAL: number

ReadonlyTHUMB_PHALANX_TIP

THUMB_PHALANX_TIP: number

ReadonlyINDEX_METACARPAL

INDEX_METACARPAL: number

ReadonlyINDEX_PHALANX_PROXIMAL

INDEX_PHALANX_PROXIMAL: number

ReadonlyINDEX_PHALANX_INTERMEDIATE

INDEX_PHALANX_INTERMEDIATE: number

ReadonlyINDEX_PHALANX_DISTAL

INDEX_PHALANX_DISTAL: number

ReadonlyINDEX_PHALANX_TIP

INDEX_PHALANX_TIP: number

ReadonlyMIDDLE_METACARPAL

MIDDLE_METACARPAL: number

ReadonlyMIDDLE_PHALANX_PROXIMAL

MIDDLE_PHALANX_PROXIMAL: number

ReadonlyMIDDLE_PHALANX_INTERMEDIATE

MIDDLE_PHALANX_INTERMEDIATE: number

ReadonlyMIDDLE_PHALANX_DISTAL

MIDDLE_PHALANX_DISTAL: number

ReadonlyMIDDLE_PHALANX_TIP

MIDDLE_PHALANX_TIP: number

ReadonlyRING_METACARPAL

RING_METACARPAL: number

ReadonlyRING_PHALANX_PROXIMAL

RING_PHALANX_PROXIMAL: number

ReadonlyRING_PHALANX_INTERMEDIATE

RING_PHALANX_INTERMEDIATE: number

ReadonlyRING_PHALANX_DISTAL

RING_PHALANX_DISTAL: number

ReadonlyRING_PHALANX_TIP

RING_PHALANX_TIP: number

ReadonlyLITTLE_METACARPAL

LITTLE_METACARPAL: number

ReadonlyLITTLE_PHALANX_PROXIMAL

LITTLE_PHALANX_PROXIMAL: number

ReadonlyLITTLE_PHALANX_INTERMEDIATE

LITTLE_PHALANX_INTERMEDIATE: number

ReadonlyLITTLE_PHALANX_DISTAL

LITTLE_PHALANX_DISTAL: number

ReadonlyLITTLE_PHALANX_TIP

LITTLE_PHALANX_TIP: number

Readonlysize

size: number

Returns

the number of elements in the Map.

-

Readonly[toStringTag]

"[toStringTag]": string

Methods

clear

  • clear(): void

  • Returns void

delete

  • delete(key: XRHandJoint): boolean

  • Parameters

    Returns boolean

    true if an element in the Map existed and has been removed, or false if the element does not exist.

    -

forEach

  • forEach(
        callbackfn: (
            value: XRJointSpace,
            key: XRHandJoint,
            map: Map<XRHandJoint, XRJointSpace>,
        ) => void,
        thisArg?: any,
    ): void

  • Executes a provided function once per each key/value pair in the Map, in insertion order.

    -

    Parameters

    Returns void

get

  • get(key: XRHandJoint): undefined | XRJointSpace

  • Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

    -

    Parameters

    Returns undefined | XRJointSpace

    Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

    -

has

  • has(key: XRHandJoint): boolean

  • Parameters

    Returns boolean

    boolean indicating whether an element with the specified key exists or not.

    -

set

  • set(key: XRHandJoint, value: XRJointSpace): this

  • Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

    -

    Parameters

    Returns this

entries

keys

values

[iterator]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRHandSpace.html b/docs/classes/XRHandSpace.html deleted file mode 100644 index ff81b0e..0000000 --- a/docs/classes/XRHandSpace.html +++ /dev/null @@ -1,336 +0,0 @@ -XRHandSpace | VFX-JS

Class XRHandSpace

Its purpose is to make working with groups of objects syntactically clearer.

-

Remarks

This is almost identical to an Object3D

-

Example

const geometry = new THREE.BoxGeometry(1, 1, 1);
const material = new THREE.MeshBasicMaterial({
    color: 0x00ff00
});
const cubeA = new THREE.Mesh(geometry, material);
cubeA.position.set(100, 100, 0);
const cubeB = new THREE.Mesh(geometry, material);
cubeB.position.set(-100, -100, 0);
//create a {@link Group} and add the two cubes
//These cubes can now be rotated / scaled etc as a {@link Group}  * const {@link Group} = new THREE.Group();
group.add(cubeA);
group.add(cubeB);
scene.add(group);
-
- -

See

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_UP -DEFAULT_MATRIX_AUTO_UPDATE -DEFAULT_MATRIX_WORLD_AUTO_UPDATE -joints -inputState -isGroup -isObject3D -id -uuid -name -type -parent -children -up -position -rotation -quaternion -scale -modelViewMatrix -normalMatrix -matrix -matrixWorld -matrixAutoUpdate -matrixWorldAutoUpdate -matrixWorldNeedsUpdate -layers -visible -castShadow -receiveShadow -frustumCulled -renderOrder -animations -userData -customDepthMaterial? -customDistanceMaterial? -

Methods

onBeforeShadow -onAfterShadow -onBeforeRender -onAfterRender -applyMatrix4 -applyQuaternion -setRotationFromAxisAngle -setRotationFromEuler -setRotationFromMatrix -setRotationFromQuaternion -rotateOnAxis -rotateOnWorldAxis -rotateX -rotateY -rotateZ -translateOnAxis -translateX -translateY -translateZ -localToWorld -worldToLocal -lookAt -add -remove -removeFromParent -clear -attach -getObjectById -getObjectByName -getObjectByProperty -getObjectsByProperty -getWorldPosition -getWorldQuaternion -getWorldScale -getWorldDirection -raycast -traverse -traverseVisible -traverseAncestors -updateMatrix -updateMatrixWorld -updateWorldMatrix -toJSON -clone -copy -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

StaticDEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight,
-THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

-

Default Value

new THREE.Vector3( 0, 1, 0)

-

StaticDEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

StaticDEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

Readonlyjoints

joints: Partial<XRHandJoints>

ReadonlyinputState

inputState: XRHandInputState

ReadonlyisGroup

isGroup: true

Read-only flag to check if a given object is of type Group.

-

Remarks

This is a constant value

-

Default Value

true

-

ReadonlyisObject3D

isObject3D: true

Flag to check if a given object is of type Object3D.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Object3D instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
-Expects a Integer

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

Readonlytype

type: string

A Read-only string to check this object type.

-

Remarks

This can be used to find a specific type of Object3D in a scene.
-Sub-classes will update this value.

-

Default Value

Object3D

-

parent

parent: null | Object3D

Object's parent in the scene graph.

-

Remarks

An object can have at most one parent.

-

Default Value

null

-

children

children: Object3D[]

Array with object's children.

-

See

THREE.Object3DGroup | Group for info on manually grouping objects.

-

Default Value

[]

-

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

-

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

-

Readonlyposition

position: Vector3

Object's local position.

-

Default Value

new THREE.Vector3() - that is (0, 0, 0).

-

Readonlyrotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

-

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

-

Readonlyquaternion

quaternion: Quaternion

Object's local rotation as a THREE.Quaternion | Quaternion.

-

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

-

Readonlyscale

scale: Vector3

The object's local scale.

-

Default Value

new THREE.Vector3( 1, 1, 1 )

-

ReadonlymodelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

-

ReadonlynormalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

-

matrix

matrix: Matrix4

The local transform matrix.

-

Default Value

new THREE.Matrix4()

-

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

-

Remarks

If the Object3D has no parent, then it's identical to the local transform THREE.Object3D.matrix | .matrix.

-

Default Value

new THREE.Matrix4()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and
-scale every frame and also recalculates the matrixWorld property.

-

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

-

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates.
-When it isn't, then you have to maintain all matrices in the object and its children yourself.

-

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

-

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

-

Default Value

false

-

layers

layers: Layers

The layer membership of the object.

-

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use.
-This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.

-

Default Value

new THREE.Layers()

-

visible

visible: boolean

Object gets rendered if true.

-

Default Value

true

-

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

-

Default Value

false

-

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

-

Default Value

false

-

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object.
-If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

-

Default Value

true

-

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph
-objects to be overridden although opaque and transparent objects remain sorted independently.

-

Remarks

When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.
-Sorting is from lowest to highest renderOrder.

-

Default Value

0

-

animations

animations: AnimationClip[]

Array with object's animation clips.

-

Default Value

[]

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the Object3D.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default

{}

-

OptionalcustomDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

-

Remarks

Can only be used in context of meshes.
-When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight,
-if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

-

Default Value

undefined

-

OptionalcustomDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

-

Default Value

undefined

-

Methods

onBeforeShadow

  • onBeforeShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterShadow

  • onAfterShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onBeforeRender

  • onBeforeRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterRender

  • onAfterRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

applyMatrix4

  • applyMatrix4(matrix: Matrix4): void

  • Applies the matrix transform to the object and updates the object's position, rotation and scale.

    -

    Parameters

    Returns void

applyQuaternion

  • applyQuaternion(quaternion: Quaternion): this

  • Applies the rotation represented by the quaternion to the object.

    -

    Parameters

    Returns this

setRotationFromAxisAngle

  • setRotationFromAxisAngle(axis: Vector3, angle: number): void

  • Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      Angle in radians. Expects a Float

      -

    Returns void

setRotationFromEuler

  • setRotationFromEuler(euler: Euler): void

  • Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.

    -

    Parameters

    • euler: Euler

      Euler angle specifying rotation amount.

      -

    Returns void

setRotationFromMatrix

  • setRotationFromMatrix(m: Matrix4): void

  • Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

    -

    Parameters

    • m: Matrix4

      Rotate the quaternion by the rotation component of the matrix.

      -

    Returns void

    Remarks

    Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

    -

setRotationFromQuaternion

rotateOnAxis

  • rotateOnAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in object space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

rotateOnWorldAxis

  • rotateOnWorldAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in world space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in world space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized
    -Method Assumes no rotated parent.

    -

rotateX

  • rotateX(angle: number): this

  • Rotates the object around x axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateY

  • rotateY(angle: number): this

  • Rotates the object around y axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateZ

  • rotateZ(angle: number): this

  • Rotates the object around z axis in local space.

    -

    Parameters

    • angle: number

    Returns this

translateOnAxis

  • translateOnAxis(axis: Vector3, distance: number): this

  • Translate an object by distance along an axis in object space

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • distance: number

      The distance to translate. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

translateX

  • translateX(distance: number): this

  • Translates object along x axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateY

  • translateY(distance: number): this

  • Translates object along y axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateZ

  • translateZ(distance: number): this

  • Translates object along z axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

localToWorld

  • localToWorld(vector: Vector3): Vector3

  • Converts the vector from this object's local space to world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in this object's local space.

      -

    Returns Vector3

worldToLocal

  • worldToLocal(vector: Vector3): Vector3

  • Converts the vector from world space to this object's local space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space.

      -

    Returns Vector3

lookAt

  • lookAt(vector: Vector3): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space to look at.

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -
  • lookAt(x: number, y: number, z: number): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -

add

  • add(...object: Object3D[]): this

  • Adds another Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be added
    -Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.

    -

    See

      -
    • attach
      • -
    • THREE.Group | Group for info on manually grouping objects.
      • -
    -

remove

  • remove(...object: Object3D[]): this

  • Removes a Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be removed.

    -

    See

    THREE.Group | Group for info on manually grouping objects.

    -

removeFromParent

  • removeFromParent(): this

  • Removes this object from its current parent.

    -

    Returns this

clear

  • clear(): this

  • Removes all child objects.

    -

    Returns this

attach

  • attach(object: Object3D): this

  • Adds a Object3D as a child of this, while maintaining the object's world transform.

    -

    Parameters

    Returns this

    Remarks

    Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

    -

    See

    add

    -

getObjectById

  • getObjectById(id: number): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    -

    Parameters

    • id: number

      Unique number of the object instance. Expects a Integer

      -

    Returns undefined | Object3D

    Remarks

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    -

    See

    id

    -

getObjectByName

  • getObjectByName(name: string): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

    -

    Parameters

    • name: string

      String to match to the children's Object3D.name property.

      -

    Returns undefined | Object3D

    Remarks

    Note that for most objects the name is an empty string by default
    -You will have to set it manually to make use of this method.

    -

getObjectByProperty

  • getObjectByProperty(name: string, value: any): undefined | Object3D

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      the property name to search for.

      -
    • value: any

      value of the given property.

      -

    Returns undefined | Object3D

getObjectsByProperty

  • getObjectsByProperty(
        name: string,
        value: any,
        optionalTarget?: Object3D[],
    ): Object3D[]

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      The property name to search for.

      -
    • value: any

      Value of the given property.

      -
    • OptionaloptionalTarget: Object3D[]

      target to set the result. Otherwise a new Array is instantiated. If set, you must clear
      -this array prior to each call (i.e., array.length = 0;).

      -

    Returns Object3D[]

getWorldPosition

  • getWorldPosition(target: Vector3): Vector3

  • Returns a vector representing the position of the object in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldQuaternion

  • getWorldQuaternion(target: Quaternion): Quaternion

  • Returns a quaternion representing the rotation of the object in world space.

    -

    Parameters

    • target: Quaternion

      The result will be copied into this Quaternion.

      -

    Returns Quaternion

getWorldScale

  • getWorldScale(target: Vector3): Vector3

  • Returns a vector of the scaling factors applied to the object for each axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldDirection

  • getWorldDirection(target: Vector3): Vector3

  • Returns a vector representing the direction of object's positive z-axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

raycast

  • raycast(raycaster: Raycaster, intersects: Intersection[]): void

  • Abstract (empty) method to get intersections between a casted ray and this object

    -

    Parameters

    Returns void

    Remarks

    Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

    -

    See

    THREE.Raycaster | Raycaster

    -

    Default Value

    () => {}

    -

traverse

  • traverse(callback: (object: Object3D) => any): void

  • Executes the callback on this object and all descendants.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseVisible

  • traverseVisible(callback: (object: Object3D) => any): void

  • Like traverse, but the callback will only be executed for visible objects

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Descendants of invisible objects are not traversed.
    -Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseAncestors

  • traverseAncestors(callback: (object: Object3D) => any): void

  • Executes the callback on all ancestors.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

updateMatrix

  • updateMatrix(): void

  • Updates local transform.

    -

    Returns void

updateMatrixWorld

  • updateMatrixWorld(force?: boolean): void

  • Updates the global transform of the object.
    -And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

    -

    Parameters

    • Optionalforce: boolean

      A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame.
      -Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

      -

    Returns void

updateWorldMatrix

  • updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void

  • Updates the global transform of the object.

    -

    Parameters

    • updateParents: boolean

      Recursively updates global transform of ancestors.

      -
    • updateChildren: boolean

      Recursively updates global transform of descendants.

      -

    Returns void

toJSON

clone

  • clone(recursive?: boolean): this

  • Returns a clone of this object and optionally all descendants.

    -

    Parameters

    • Optionalrecursive: boolean

      If true, descendants of the object are also cloned. Default true

      -

    Returns this

copy

  • copy(object: Object3D, recursive?: boolean): this

  • Copies the given object into this object.

    -

    Parameters

    • object: Object3D
    • Optionalrecursive: boolean

      If set to true, descendants of the object are copied next to the existing ones. If set to
      -false, descendants are left unchanged. Default is true.

      -

    Returns this

    Remarks

    Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

    -

addEventListener

hasEventListener

removeEventListener

dispatchEvent

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRHitTestResult.html b/docs/classes/XRHitTestResult.html deleted file mode 100644 index 5a7c39a..0000000 --- a/docs/classes/XRHitTestResult.html +++ /dev/null @@ -1,4 +0,0 @@ -XRHitTestResult | VFX-JS

Class XRHitTestResultAbstract

Implements

Implemented by

Constructors

constructor -

Properties

createAnchor? -

Methods

getPose -

Constructors

constructor

Properties

OptionalcreateAnchor

createAnchor?: (pose: XRRigidTransform) => undefined | Promise<XRAnchor>

Methods

getPose

  • getPose(baseSpace: XRSpace): undefined | XRPose

  • Parameters

    Returns undefined | XRPose

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRHitTestSource.html b/docs/classes/XRHitTestSource.html deleted file mode 100644 index 41bb289..0000000 --- a/docs/classes/XRHitTestSource.html +++ /dev/null @@ -1,3 +0,0 @@ -XRHitTestSource | VFX-JS

Class XRHitTestSourceAbstract

Implements

Implemented by

Constructors

constructor -

Methods

cancel -

Constructors

constructor

Methods

cancel

  • cancel(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/XRInputSource.html b/docs/classes/XRInputSource.html deleted file mode 100644 index 8878f29..0000000 --- a/docs/classes/XRInputSource.html +++ /dev/null @@ -1,9 +0,0 @@ -XRInputSource | VFX-JS

Class XRInputSourceAbstract

Implements

Implemented by

Constructors

constructor -

Properties

handedness -targetRayMode -targetRaySpace -gripSpace? -gamepad? -profiles -hand? -

Constructors

constructor

Properties

Readonlyhandedness

handedness: XRHandedness

ReadonlytargetRayMode

targetRayMode: XRTargetRayMode

ReadonlytargetRaySpace

targetRaySpace: XRSpace

Optional ReadonlygripSpace

gripSpace?: XRSpace

Optional Readonlygamepad

gamepad?: Gamepad

Readonlyprofiles

profiles: string[]

Optional Readonlyhand

hand?: XRHand

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/XRInputSourceArray.html b/docs/classes/XRInputSourceArray.html deleted file mode 100644 index 78c0358..0000000 --- a/docs/classes/XRInputSourceArray.html +++ /dev/null @@ -1,8 +0,0 @@ -XRInputSourceArray | VFX-JS

Class XRInputSourceArrayAbstract

Implements

Implemented by

Indexable

Constructors

constructor -

Properties

length -

Methods

entries -keys -values -forEach -[iterator] -

Constructors

constructor

Properties

length

length: number

Methods

entries

keys

values

forEach

  • forEach(
        callbackfn: (
            value: XRInputSource,
            index: number,
            array: XRInputSource[],
        ) => void,
        thisArg?: any,
    ): void

  • Parameters

    Returns void

[iterator]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRInputSourceEvent.html b/docs/classes/XRInputSourceEvent.html deleted file mode 100644 index 7146c31..0000000 --- a/docs/classes/XRInputSourceEvent.html +++ /dev/null @@ -1,64 +0,0 @@ -XRInputSourceEvent | VFX-JS

Class XRInputSourceEvent

XRInputSourceEvents are fired to indicate changes to the state of an XRInputSource.
-ref: https://immersive-web.github.io/webxr/#xrinputsourceevent-interface

-

Hierarchy

  • Event
    • XRInputSourceEvent

Constructors

constructor -

Properties

NONE -CAPTURING_PHASE -AT_TARGET -BUBBLING_PHASE -type -frame -inputSource -bubbles -cancelBubble -cancelable -composed -currentTarget -defaultPrevented -eventPhase -isTrusted -returnValue -srcElement -target -timeStamp -NONE -CAPTURING_PHASE -AT_TARGET -BUBBLING_PHASE -

Methods

composedPath -initEvent -preventDefault -stopImmediatePropagation -stopPropagation -

Constructors

constructor

Properties

Static ReadonlyNONE

NONE: 0

Static ReadonlyCAPTURING_PHASE

CAPTURING_PHASE: 1

Static ReadonlyAT_TARGET

AT_TARGET: 2

Static ReadonlyBUBBLING_PHASE

BUBBLING_PHASE: 3

Readonlytype

type: XRInputSourceEventType

Returns the type of event, e.g. "click", "hashchange", or "submit".

-

MDN Reference

-

Readonlyframe

frame: XRFrame

ReadonlyinputSource

inputSource: XRInputSource

Readonlybubbles

bubbles: boolean

Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

-

MDN Reference

-

cancelBubble

cancelBubble: boolean

Deprecated

MDN Reference

-

Readonlycancelable

cancelable: boolean

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

-

MDN Reference

-

Readonlycomposed

composed: boolean

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

-

MDN Reference

-

ReadonlycurrentTarget

currentTarget: null | EventTarget

Returns the object whose event listener's callback is currently being invoked.

-

MDN Reference

-

ReadonlydefaultPrevented

defaultPrevented: boolean

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

-

MDN Reference

-

ReadonlyeventPhase

eventPhase: number

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

-

MDN Reference

-

ReadonlyisTrusted

isTrusted: boolean

Returns true if event was dispatched by the user agent, and false otherwise.

-

MDN Reference

-

returnValue

returnValue: boolean

Deprecated

MDN Reference

-

ReadonlysrcElement

srcElement: null | EventTarget

Deprecated

MDN Reference

-

Readonlytarget

target: null | EventTarget

Returns the object to which event is dispatched (its target).

-

MDN Reference

-

ReadonlytimeStamp

timeStamp: number

Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

-

MDN Reference

-

ReadonlyNONE

NONE: 0

ReadonlyCAPTURING_PHASE

CAPTURING_PHASE: 1

ReadonlyAT_TARGET

AT_TARGET: 2

ReadonlyBUBBLING_PHASE

BUBBLING_PHASE: 3

Methods

composedPath

  • composedPath(): EventTarget[]

  • Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

    -

    MDN Reference

    -

    Returns EventTarget[]

initEvent

  • initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void

  • Parameters

    • type: string
    • Optionalbubbles: boolean
    • Optionalcancelable: boolean

    Returns void

    Deprecated

    MDN Reference

    -

preventDefault

  • preventDefault(): void

  • If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

    -

    MDN Reference

    -

    Returns void

stopImmediatePropagation

  • stopImmediatePropagation(): void

  • Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

    -

    MDN Reference

    -

    Returns void

stopPropagation

  • stopPropagation(): void

  • When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

    -

    MDN Reference

    -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRJointPose.html b/docs/classes/XRJointPose.html deleted file mode 100644 index 2e106fb..0000000 --- a/docs/classes/XRJointPose.html +++ /dev/null @@ -1,7 +0,0 @@ -XRJointPose | VFX-JS

Class XRJointPoseAbstract

Hierarchy (View Summary)

Implements

Implemented by

Constructors

constructor -

Properties

radius -transform -linearVelocity? -angularVelocity? -emulatedPosition -

Constructors

constructor

Properties

Readonlyradius

radius: undefined | number

Readonlytransform

transform: XRRigidTransform

Optional ReadonlylinearVelocity

linearVelocity?: DOMPointReadOnly

Optional ReadonlyangularVelocity

angularVelocity?: DOMPointReadOnly

ReadonlyemulatedPosition

emulatedPosition: boolean

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/XRJointSpace-1.html b/docs/classes/XRJointSpace-1.html deleted file mode 100644 index 1acef1a..0000000 --- a/docs/classes/XRJointSpace-1.html +++ /dev/null @@ -1,335 +0,0 @@ -XRJointSpace | VFX-JS

Class XRJointSpace

Its purpose is to make working with groups of objects syntactically clearer.

-

Remarks

This is almost identical to an Object3D

-

Example

const geometry = new THREE.BoxGeometry(1, 1, 1);
const material = new THREE.MeshBasicMaterial({
    color: 0x00ff00
});
const cubeA = new THREE.Mesh(geometry, material);
cubeA.position.set(100, 100, 0);
const cubeB = new THREE.Mesh(geometry, material);
cubeB.position.set(-100, -100, 0);
//create a {@link Group} and add the two cubes
//These cubes can now be rotated / scaled etc as a {@link Group}  * const {@link Group} = new THREE.Group();
group.add(cubeA);
group.add(cubeB);
scene.add(group);
-
- -

See

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_UP -DEFAULT_MATRIX_AUTO_UPDATE -DEFAULT_MATRIX_WORLD_AUTO_UPDATE -jointRadius -isGroup -isObject3D -id -uuid -name -type -parent -children -up -position -rotation -quaternion -scale -modelViewMatrix -normalMatrix -matrix -matrixWorld -matrixAutoUpdate -matrixWorldAutoUpdate -matrixWorldNeedsUpdate -layers -visible -castShadow -receiveShadow -frustumCulled -renderOrder -animations -userData -customDepthMaterial? -customDistanceMaterial? -

Methods

onBeforeShadow -onAfterShadow -onBeforeRender -onAfterRender -applyMatrix4 -applyQuaternion -setRotationFromAxisAngle -setRotationFromEuler -setRotationFromMatrix -setRotationFromQuaternion -rotateOnAxis -rotateOnWorldAxis -rotateX -rotateY -rotateZ -translateOnAxis -translateX -translateY -translateZ -localToWorld -worldToLocal -lookAt -add -remove -removeFromParent -clear -attach -getObjectById -getObjectByName -getObjectByProperty -getObjectsByProperty -getWorldPosition -getWorldQuaternion -getWorldScale -getWorldDirection -raycast -traverse -traverseVisible -traverseAncestors -updateMatrix -updateMatrixWorld -updateWorldMatrix -toJSON -clone -copy -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

StaticDEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight,
-THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

-

Default Value

new THREE.Vector3( 0, 1, 0)

-

StaticDEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

StaticDEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

ReadonlyjointRadius

jointRadius: undefined | number

ReadonlyisGroup

isGroup: true

Read-only flag to check if a given object is of type Group.

-

Remarks

This is a constant value

-

Default Value

true

-

ReadonlyisObject3D

isObject3D: true

Flag to check if a given object is of type Object3D.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Object3D instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
-Expects a Integer

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

Readonlytype

type: string

A Read-only string to check this object type.

-

Remarks

This can be used to find a specific type of Object3D in a scene.
-Sub-classes will update this value.

-

Default Value

Object3D

-

parent

parent: null | Object3D

Object's parent in the scene graph.

-

Remarks

An object can have at most one parent.

-

Default Value

null

-

children

children: Object3D[]

Array with object's children.

-

See

THREE.Object3DGroup | Group for info on manually grouping objects.

-

Default Value

[]

-

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

-

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

-

Readonlyposition

position: Vector3

Object's local position.

-

Default Value

new THREE.Vector3() - that is (0, 0, 0).

-

Readonlyrotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

-

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

-

Readonlyquaternion

quaternion: Quaternion

Object's local rotation as a THREE.Quaternion | Quaternion.

-

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

-

Readonlyscale

scale: Vector3

The object's local scale.

-

Default Value

new THREE.Vector3( 1, 1, 1 )

-

ReadonlymodelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

-

ReadonlynormalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

-

matrix

matrix: Matrix4

The local transform matrix.

-

Default Value

new THREE.Matrix4()

-

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

-

Remarks

If the Object3D has no parent, then it's identical to the local transform THREE.Object3D.matrix | .matrix.

-

Default Value

new THREE.Matrix4()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and
-scale every frame and also recalculates the matrixWorld property.

-

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

-

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates.
-When it isn't, then you have to maintain all matrices in the object and its children yourself.

-

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

-

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

-

Default Value

false

-

layers

layers: Layers

The layer membership of the object.

-

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use.
-This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.

-

Default Value

new THREE.Layers()

-

visible

visible: boolean

Object gets rendered if true.

-

Default Value

true

-

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

-

Default Value

false

-

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

-

Default Value

false

-

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object.
-If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

-

Default Value

true

-

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph
-objects to be overridden although opaque and transparent objects remain sorted independently.

-

Remarks

When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.
-Sorting is from lowest to highest renderOrder.

-

Default Value

0

-

animations

animations: AnimationClip[]

Array with object's animation clips.

-

Default Value

[]

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the Object3D.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default

{}

-

OptionalcustomDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

-

Remarks

Can only be used in context of meshes.
-When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight,
-if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

-

Default Value

undefined

-

OptionalcustomDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

-

Default Value

undefined

-

Methods

onBeforeShadow

  • onBeforeShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterShadow

  • onAfterShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onBeforeRender

  • onBeforeRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterRender

  • onAfterRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

applyMatrix4

  • applyMatrix4(matrix: Matrix4): void

  • Applies the matrix transform to the object and updates the object's position, rotation and scale.

    -

    Parameters

    Returns void

applyQuaternion

  • applyQuaternion(quaternion: Quaternion): this

  • Applies the rotation represented by the quaternion to the object.

    -

    Parameters

    Returns this

setRotationFromAxisAngle

  • setRotationFromAxisAngle(axis: Vector3, angle: number): void

  • Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      Angle in radians. Expects a Float

      -

    Returns void

setRotationFromEuler

  • setRotationFromEuler(euler: Euler): void

  • Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.

    -

    Parameters

    • euler: Euler

      Euler angle specifying rotation amount.

      -

    Returns void

setRotationFromMatrix

  • setRotationFromMatrix(m: Matrix4): void

  • Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

    -

    Parameters

    • m: Matrix4

      Rotate the quaternion by the rotation component of the matrix.

      -

    Returns void

    Remarks

    Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

    -

setRotationFromQuaternion

rotateOnAxis

  • rotateOnAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in object space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

rotateOnWorldAxis

  • rotateOnWorldAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in world space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in world space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized
    -Method Assumes no rotated parent.

    -

rotateX

  • rotateX(angle: number): this

  • Rotates the object around x axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateY

  • rotateY(angle: number): this

  • Rotates the object around y axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateZ

  • rotateZ(angle: number): this

  • Rotates the object around z axis in local space.

    -

    Parameters

    • angle: number

    Returns this

translateOnAxis

  • translateOnAxis(axis: Vector3, distance: number): this

  • Translate an object by distance along an axis in object space

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • distance: number

      The distance to translate. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

translateX

  • translateX(distance: number): this

  • Translates object along x axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateY

  • translateY(distance: number): this

  • Translates object along y axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateZ

  • translateZ(distance: number): this

  • Translates object along z axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

localToWorld

  • localToWorld(vector: Vector3): Vector3

  • Converts the vector from this object's local space to world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in this object's local space.

      -

    Returns Vector3

worldToLocal

  • worldToLocal(vector: Vector3): Vector3

  • Converts the vector from world space to this object's local space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space.

      -

    Returns Vector3

lookAt

  • lookAt(vector: Vector3): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space to look at.

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -
  • lookAt(x: number, y: number, z: number): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -

add

  • add(...object: Object3D[]): this

  • Adds another Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be added
    -Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.

    -

    See

      -
    • attach
      • -
    • THREE.Group | Group for info on manually grouping objects.
      • -
    -

remove

  • remove(...object: Object3D[]): this

  • Removes a Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be removed.

    -

    See

    THREE.Group | Group for info on manually grouping objects.

    -

removeFromParent

  • removeFromParent(): this

  • Removes this object from its current parent.

    -

    Returns this

clear

  • clear(): this

  • Removes all child objects.

    -

    Returns this

attach

  • attach(object: Object3D): this

  • Adds a Object3D as a child of this, while maintaining the object's world transform.

    -

    Parameters

    Returns this

    Remarks

    Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

    -

    See

    add

    -

getObjectById

  • getObjectById(id: number): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    -

    Parameters

    • id: number

      Unique number of the object instance. Expects a Integer

      -

    Returns undefined | Object3D

    Remarks

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    -

    See

    id

    -

getObjectByName

  • getObjectByName(name: string): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

    -

    Parameters

    • name: string

      String to match to the children's Object3D.name property.

      -

    Returns undefined | Object3D

    Remarks

    Note that for most objects the name is an empty string by default
    -You will have to set it manually to make use of this method.

    -

getObjectByProperty

  • getObjectByProperty(name: string, value: any): undefined | Object3D

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      the property name to search for.

      -
    • value: any

      value of the given property.

      -

    Returns undefined | Object3D

getObjectsByProperty

  • getObjectsByProperty(
        name: string,
        value: any,
        optionalTarget?: Object3D[],
    ): Object3D[]

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      The property name to search for.

      -
    • value: any

      Value of the given property.

      -
    • OptionaloptionalTarget: Object3D[]

      target to set the result. Otherwise a new Array is instantiated. If set, you must clear
      -this array prior to each call (i.e., array.length = 0;).

      -

    Returns Object3D[]

getWorldPosition

  • getWorldPosition(target: Vector3): Vector3

  • Returns a vector representing the position of the object in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldQuaternion

  • getWorldQuaternion(target: Quaternion): Quaternion

  • Returns a quaternion representing the rotation of the object in world space.

    -

    Parameters

    • target: Quaternion

      The result will be copied into this Quaternion.

      -

    Returns Quaternion

getWorldScale

  • getWorldScale(target: Vector3): Vector3

  • Returns a vector of the scaling factors applied to the object for each axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldDirection

  • getWorldDirection(target: Vector3): Vector3

  • Returns a vector representing the direction of object's positive z-axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

raycast

  • raycast(raycaster: Raycaster, intersects: Intersection[]): void

  • Abstract (empty) method to get intersections between a casted ray and this object

    -

    Parameters

    Returns void

    Remarks

    Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

    -

    See

    THREE.Raycaster | Raycaster

    -

    Default Value

    () => {}

    -

traverse

  • traverse(callback: (object: Object3D) => any): void

  • Executes the callback on this object and all descendants.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseVisible

  • traverseVisible(callback: (object: Object3D) => any): void

  • Like traverse, but the callback will only be executed for visible objects

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Descendants of invisible objects are not traversed.
    -Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseAncestors

  • traverseAncestors(callback: (object: Object3D) => any): void

  • Executes the callback on all ancestors.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

updateMatrix

  • updateMatrix(): void

  • Updates local transform.

    -

    Returns void

updateMatrixWorld

  • updateMatrixWorld(force?: boolean): void

  • Updates the global transform of the object.
    -And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

    -

    Parameters

    • Optionalforce: boolean

      A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame.
      -Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

      -

    Returns void

updateWorldMatrix

  • updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void

  • Updates the global transform of the object.

    -

    Parameters

    • updateParents: boolean

      Recursively updates global transform of ancestors.

      -
    • updateChildren: boolean

      Recursively updates global transform of descendants.

      -

    Returns void

toJSON

clone

  • clone(recursive?: boolean): this

  • Returns a clone of this object and optionally all descendants.

    -

    Parameters

    • Optionalrecursive: boolean

      If true, descendants of the object are also cloned. Default true

      -

    Returns this

copy

  • copy(object: Object3D, recursive?: boolean): this

  • Copies the given object into this object.

    -

    Parameters

    • object: Object3D
    • Optionalrecursive: boolean

      If set to true, descendants of the object are copied next to the existing ones. If set to
      -false, descendants are left unchanged. Default is true.

      -

    Returns this

    Remarks

    Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

    -

addEventListener

hasEventListener

removeEventListener

dispatchEvent

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRJointSpace.html b/docs/classes/XRJointSpace.html deleted file mode 100644 index e392558..0000000 --- a/docs/classes/XRJointSpace.html +++ /dev/null @@ -1,18 +0,0 @@ -XRJointSpace | VFX-JS

Class XRJointSpaceAbstract

Hierarchy (View Summary)

Implements

Implemented by

Constructors

constructor -

Properties

jointName -

Methods

addEventListener -dispatchEvent -removeEventListener -

Constructors

constructor

Properties

ReadonlyjointName

jointName: XRHandJoint

Methods

addEventListener

  • addEventListener(
        type: string,
        callback: null | EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Parameters

    Returns void

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    -

    MDN Reference

    -

    Parameters

    • event: Event

    Returns boolean

removeEventListener

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRLayer.html b/docs/classes/XRLayer.html deleted file mode 100644 index 471bcca..0000000 --- a/docs/classes/XRLayer.html +++ /dev/null @@ -1,17 +0,0 @@ -XRLayer | VFX-JS

Class XRLayerAbstract

Hierarchy (View Summary)

Implements

Implemented by

Constructors

constructor -

Methods

addEventListener -dispatchEvent -removeEventListener -

Constructors

constructor

  • new XRLayer(): XRLayer

  • Returns XRLayer

Methods

addEventListener

  • addEventListener(
        type: string,
        callback: null | EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Parameters

    Returns void

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    -

    MDN Reference

    -

    Parameters

    • event: Event

    Returns boolean

removeEventListener

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/XRMesh.html b/docs/classes/XRMesh.html deleted file mode 100644 index 47f113a..0000000 --- a/docs/classes/XRMesh.html +++ /dev/null @@ -1,7 +0,0 @@ -XRMesh | VFX-JS

Class XRMeshAbstract

Implements

Implemented by

Constructors

constructor -

Properties

meshSpace -vertices -indices -lastChangedTime -semanticLabel? -

Constructors

constructor

Properties

meshSpace

meshSpace: XRSpace

vertices

vertices: Float32Array

indices

indices: Uint32Array

lastChangedTime

lastChangedTime: number

OptionalsemanticLabel

semanticLabel?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/XRPlane.html b/docs/classes/XRPlane.html deleted file mode 100644 index 39526b3..0000000 --- a/docs/classes/XRPlane.html +++ /dev/null @@ -1,7 +0,0 @@ -XRPlane | VFX-JS

Class XRPlaneAbstract

Implements

Implemented by

Constructors

constructor -

Properties

orientation -planeSpace -polygon -lastChangedTime -semanticLabel? -

Constructors

constructor

Properties

orientation

orientation: XRPlaneOrientation

planeSpace

planeSpace: XRSpace

polygon

polygon: DOMPointReadOnly[]

lastChangedTime

lastChangedTime: number

OptionalsemanticLabel

semanticLabel?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/XRPose.html b/docs/classes/XRPose.html deleted file mode 100644 index 47315f0..0000000 --- a/docs/classes/XRPose.html +++ /dev/null @@ -1,6 +0,0 @@ -XRPose | VFX-JS

Class XRPoseAbstract

Hierarchy (View Summary)

Implements

Implemented by

Constructors

constructor -

Properties

transform -linearVelocity? -angularVelocity? -emulatedPosition -

Constructors

constructor

Properties

Readonlytransform

transform: XRRigidTransform

Optional ReadonlylinearVelocity

linearVelocity?: DOMPointReadOnly

Optional ReadonlyangularVelocity

angularVelocity?: DOMPointReadOnly

ReadonlyemulatedPosition

emulatedPosition: boolean

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/XRProjectionLayer.html b/docs/classes/XRProjectionLayer.html deleted file mode 100644 index b03bc39..0000000 --- a/docs/classes/XRProjectionLayer.html +++ /dev/null @@ -1,41 +0,0 @@ -XRProjectionLayer | VFX-JS

Class XRProjectionLayerAbstract

Hierarchy (View Summary)

Implements

Implemented by

Constructors

constructor -

Properties

textureWidth -textureHeight -textureArrayLength -ignoreDepthValues -fixedFoveation -layout -blendTextureSourceAlpha -chromaticAberrationCorrection? -mipLevels -quality -needsRedraw -space -onredraw -

Methods

destroy -addEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

ReadonlytextureWidth

textureWidth: number

ReadonlytextureHeight

textureHeight: number

ReadonlytextureArrayLength

textureArrayLength: number

ReadonlyignoreDepthValues

ignoreDepthValues: number

fixedFoveation

fixedFoveation: number

Readonlylayout

layout: XRLayerLayout

blendTextureSourceAlpha

blendTextureSourceAlpha: boolean

OptionalchromaticAberrationCorrection

chromaticAberrationCorrection?: boolean

ReadonlymipLevels

mipLevels: number

quality

quality: XRLayerQuality

ReadonlyneedsRedraw

needsRedraw: boolean

space

space: XRSpace

onredraw

onredraw: (evt: XRLayerEvent) => any

Methods

destroy

  • destroy(): void

  • Returns void

addEventListener

  • addEventListener<K extends "redraw">(
        this: XRCompositionLayer,
        type: K,
        callback: (evt: XRCompositionLayerEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Type Parameters

    • K extends "redraw"

    Parameters

    Returns void

  • addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Parameters

    Returns void

removeEventListener

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    -

    MDN Reference

    -

    Parameters

    • event: Event

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRQuadLayer.html b/docs/classes/XRQuadLayer.html deleted file mode 100644 index 176f698..0000000 --- a/docs/classes/XRQuadLayer.html +++ /dev/null @@ -1,39 +0,0 @@ -XRQuadLayer | VFX-JS

Class XRQuadLayerAbstract

Hierarchy (View Summary)

Implements

Implemented by

Constructors

constructor -

Properties

transform -width -height -layout -blendTextureSourceAlpha -chromaticAberrationCorrection? -mipLevels -quality -needsRedraw -space -onredraw -

Methods

destroy -addEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

transform

transform: XRRigidTransform

width

width: number

height

height: number

Readonlylayout

layout: XRLayerLayout

blendTextureSourceAlpha

blendTextureSourceAlpha: boolean

OptionalchromaticAberrationCorrection

chromaticAberrationCorrection?: boolean

ReadonlymipLevels

mipLevels: number

quality

quality: XRLayerQuality

ReadonlyneedsRedraw

needsRedraw: boolean

space

space: XRSpace

onredraw

onredraw: (evt: XRLayerEvent) => any

Methods

destroy

  • destroy(): void

  • Returns void

addEventListener

  • addEventListener<K extends "redraw">(
        this: XRCompositionLayer,
        type: K,
        callback: (evt: XRCompositionLayerEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Type Parameters

    • K extends "redraw"

    Parameters

    Returns void

  • addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Parameters

    Returns void

removeEventListener

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    -

    MDN Reference

    -

    Parameters

    • event: Event

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRRay.html b/docs/classes/XRRay.html deleted file mode 100644 index ddc328c..0000000 --- a/docs/classes/XRRay.html +++ /dev/null @@ -1,5 +0,0 @@ -XRRay | VFX-JS

Class XRRay

Constructors

constructor -

Properties

origin -direction -matrix -

Constructors

constructor

Properties

Readonlyorigin

origin: DOMPointReadOnly

Readonlydirection

direction: DOMPointReadOnly

Readonlymatrix

matrix: Float32Array

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/XRReferenceSpace.html b/docs/classes/XRReferenceSpace.html deleted file mode 100644 index 8eef9c1..0000000 --- a/docs/classes/XRReferenceSpace.html +++ /dev/null @@ -1,29 +0,0 @@ -XRReferenceSpace | VFX-JS

Class XRReferenceSpaceAbstract

Hierarchy (View Summary)

Implements

Implemented by

Constructors

constructor -

Properties

onreset -

Methods

getOffsetReferenceSpace -addEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

onreset

onreset: XRReferenceSpaceEventHandler

Methods

getOffsetReferenceSpace

addEventListener

  • addEventListener<K extends "reset">(
        type: K,
        listener: (this: XRReferenceSpace, ev: XRReferenceSpaceEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Type Parameters

    • K extends "reset"

    Parameters

    Returns void

  • addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Parameters

    Returns void

removeEventListener

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    -

    MDN Reference

    -

    Parameters

    • event: Event

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRReferenceSpaceEvent.html b/docs/classes/XRReferenceSpaceEvent.html deleted file mode 100644 index bff9795..0000000 --- a/docs/classes/XRReferenceSpaceEvent.html +++ /dev/null @@ -1,58 +0,0 @@ -XRReferenceSpaceEvent | VFX-JS

Class XRReferenceSpaceEvent

Hierarchy

  • Event
    • XRReferenceSpaceEvent

Implements

Implemented by

Constructors

constructor -

Properties

type -referenceSpace -transform? -bubbles -cancelBubble -cancelable -composed -currentTarget -defaultPrevented -eventPhase -isTrusted -returnValue -srcElement -target -timeStamp -NONE -CAPTURING_PHASE -AT_TARGET -BUBBLING_PHASE -

Methods

composedPath -initEvent -preventDefault -stopImmediatePropagation -stopPropagation -

Constructors

constructor

Properties

Readonlytype

type: "reset"

Returns the type of event, e.g. "click", "hashchange", or "submit".

-

MDN Reference

-

ReadonlyreferenceSpace

referenceSpace: XRReferenceSpace

Optional Readonlytransform

transform?: XRRigidTransform

Readonlybubbles

bubbles: boolean

Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

-

MDN Reference

-

cancelBubble

cancelBubble: boolean

Deprecated

MDN Reference

-

Readonlycancelable

cancelable: boolean

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

-

MDN Reference

-

Readonlycomposed

composed: boolean

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

-

MDN Reference

-

ReadonlycurrentTarget

currentTarget: null | EventTarget

Returns the object whose event listener's callback is currently being invoked.

-

MDN Reference

-

ReadonlydefaultPrevented

defaultPrevented: boolean

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

-

MDN Reference

-

ReadonlyeventPhase

eventPhase: number

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

-

MDN Reference

-

ReadonlyisTrusted

isTrusted: boolean

Returns true if event was dispatched by the user agent, and false otherwise.

-

MDN Reference

-

returnValue

returnValue: boolean

Deprecated

MDN Reference

-

ReadonlysrcElement

srcElement: null | EventTarget

Deprecated

MDN Reference

-

Readonlytarget

target: null | EventTarget

Returns the object to which event is dispatched (its target).

-

MDN Reference

-

ReadonlytimeStamp

timeStamp: number

Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

-

MDN Reference

-

ReadonlyNONE

NONE: 0

ReadonlyCAPTURING_PHASE

CAPTURING_PHASE: 1

ReadonlyAT_TARGET

AT_TARGET: 2

ReadonlyBUBBLING_PHASE

BUBBLING_PHASE: 3

Methods

composedPath

  • composedPath(): EventTarget[]

  • Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

    -

    MDN Reference

    -

    Returns EventTarget[]

initEvent

  • initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void

  • Parameters

    • type: string
    • Optionalbubbles: boolean
    • Optionalcancelable: boolean

    Returns void

    Deprecated

    MDN Reference

    -

preventDefault

  • preventDefault(): void

  • If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

    -

    MDN Reference

    -

    Returns void

stopImmediatePropagation

  • stopImmediatePropagation(): void

  • Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

    -

    MDN Reference

    -

    Returns void

stopPropagation

  • stopPropagation(): void

  • When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

    -

    MDN Reference

    -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRRenderState.html b/docs/classes/XRRenderState.html deleted file mode 100644 index 910bb5c..0000000 --- a/docs/classes/XRRenderState.html +++ /dev/null @@ -1,7 +0,0 @@ -XRRenderState | VFX-JS

Class XRRenderStateAbstract

Implements

Implemented by

Constructors

constructor -

Properties

baseLayer? -depthFar -depthNear -inlineVerticalFieldOfView? -layers? -

Constructors

constructor

Properties

Optional ReadonlybaseLayer

baseLayer?: XRWebGLLayer

ReadonlydepthFar

depthFar: number

ReadonlydepthNear

depthNear: number

Optional ReadonlyinlineVerticalFieldOfView

inlineVerticalFieldOfView?: number

Optional Readonlylayers

layers?: XRLayer[]

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/XRRigidTransform.html b/docs/classes/XRRigidTransform.html deleted file mode 100644 index 3a21118..0000000 --- a/docs/classes/XRRigidTransform.html +++ /dev/null @@ -1,9 +0,0 @@ -XRRigidTransform | VFX-JS

Class XRRigidTransform

A transform described by a position and orientation. When interpreting an
-XRRigidTransform the orientation is always applied prior to the position.

-

ref: https://immersive-web.github.io/webxr/#xrrigidtransform-interface

-

Constructors

constructor -

Properties

position -orientation -matrix -inverse -

Constructors

constructor

Properties

Readonlyposition

position: DOMPointReadOnly

Readonlyorientation

orientation: DOMPointReadOnly

Readonlymatrix

matrix: Float32Array

Readonlyinverse

inverse: XRRigidTransform

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/XRSession.html b/docs/classes/XRSession.html deleted file mode 100644 index 997d072..0000000 --- a/docs/classes/XRSession.html +++ /dev/null @@ -1,83 +0,0 @@ -XRSession | VFX-JS

Class XRSessionAbstract

Hierarchy

  • EventTarget
    • XRSession

Implements

Implemented by

Constructors

constructor -

Properties

inputSources -renderState -environmentBlendMode -visibilityState -frameRate? -supportedFrameRates? -enabledFeatures? -isSystemKeyboardSupported -onend -oninputsourceschange -onselect -onselectstart -onselectend -onsqueeze -onsqueezestart -onsqueezeend -onvisibilitychange -onframeratechange -requestHitTestSource? -requestHitTestSourceForTransientInput? -requestHitTest? -domOverlayState? -depthUsage? -depthDataFormat? -

Methods

cancelAnimationFrame -end -requestAnimationFrame -requestReferenceSpace -updateRenderState -updateTargetFrameRate -addEventListener -removeEventListener -initiateRoomCapture? -dispatchEvent -

Constructors

constructor

Properties

ReadonlyinputSources

inputSources: XRInputSourceArray

Returns a list of this session's XRInputSources, each representing an input device
-used to control the camera and/or scene.

-

ReadonlyrenderState

renderState: XRRenderState

object which contains options affecting how the imagery is rendered.
-This includes things such as the near and far clipping planes

-

ReadonlyenvironmentBlendMode

environmentBlendMode: XREnvironmentBlendMode

ReadonlyvisibilityState

visibilityState: XRVisibilityState

Optional ReadonlyframeRate

frameRate?: number

Optional ReadonlysupportedFrameRates

supportedFrameRates?: Float32Array

Optional ReadonlyenabledFeatures

enabledFeatures?: string[]

ReadonlyisSystemKeyboardSupported

isSystemKeyboardSupported: boolean

onend

onend: XRSessionEventHandler

oninputsourceschange

oninputsourceschange: XRInputSourcesChangeEventHandler

onselect

onselect: XRInputSourceEventHandler

onselectstart

onselectstart: XRInputSourceEventHandler

onselectend

onselectend: XRInputSourceEventHandler

onsqueeze

onsqueeze: XRInputSourceEventHandler

onsqueezestart

onsqueezestart: XRInputSourceEventHandler

onsqueezeend

onsqueezeend: XRInputSourceEventHandler

onvisibilitychange

onvisibilitychange: XRSessionEventHandler

onframeratechange

onframeratechange: XRSessionEventHandler

OptionalrequestHitTestSource

requestHitTestSource?: (
    options: XRHitTestOptionsInit,
) => undefined | Promise<XRHitTestSource>

OptionalrequestHitTestSourceForTransientInput

requestHitTestSourceForTransientInput?: (
    options: XRTransientInputHitTestOptionsInit,
) => undefined | Promise<XRTransientInputHitTestSource>

OptionalrequestHitTest

requestHitTest?: (
    ray: XRRay,
    referenceSpace: XRReferenceSpace,
) => undefined | Promise<XRHitResult[]>

Optional ReadonlydomOverlayState

domOverlayState?: XRDOMOverlayState

Optional ReadonlydepthUsage

depthUsage?: XRDepthUsage

Optional ReadonlydepthDataFormat

depthDataFormat?: XRDepthDataFormat

Methods

cancelAnimationFrame

  • cancelAnimationFrame(id: number): void

  • Removes a callback from the animation frame painting callback from
    -XRSession's set of animation frame rendering callbacks, given the
    -identifying handle returned by a previous call to requestAnimationFrame().

    -

    Parameters

    • id: number

    Returns void

end

  • end(): Promise<void>

  • Ends the WebXR session. Returns a promise which resolves when the
    -session has been shut down.

    -

    Returns Promise<void>

requestAnimationFrame

  • requestAnimationFrame(callback: XRFrameRequestCallback): number

  • Schedules the specified method to be called the next time the user agent
    -is working on rendering an animation frame for the WebXR device. Returns an
    -integer value which can be used to identify the request for the purposes of
    -canceling the callback using cancelAnimationFrame(). This method is comparable
    -to the Window.requestAnimationFrame() method.

    -

    Parameters

    Returns number

requestReferenceSpace

updateRenderState

  • updateRenderState(renderStateInit?: XRRenderStateInit): Promise<void>

  • Parameters

    Returns Promise<void>

updateTargetFrameRate

  • updateTargetFrameRate(rate: number): Promise<void>

  • Parameters

    • rate: number

    Returns Promise<void>

addEventListener

  • addEventListener<K extends keyof XRSessionEventMap>(
        type: K,
        listener: (this: XRSession, ev: XRSessionEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Type Parameters

    Parameters

    Returns void

  • addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Parameters

    Returns void

removeEventListener

OptionalinitiateRoomCapture

  • initiateRoomCapture(): Promise<undefined>

  • XRSession is extended to contain the initiateRoomCapture method which,
    -if supported, will ask the XR Compositor to capture the current room layout.
    -It is up to the XRCompositor if this will replace or augment the set of tracked planes.
    -The user agent MAY also ignore this call, for instance if it doesn’t support a manual room
    -capture more or if it determines that the room is already set up.
    -The initiateRoomCapture method MUST only be able to be called once per XRSession.

    -

    Returns Promise<undefined>

    See

    https://immersive-web.github.io/real-world-geometry/plane-detection.html#plane-set

    -

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    -

    MDN Reference

    -

    Parameters

    • event: Event

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRSessionEvent.html b/docs/classes/XRSessionEvent.html deleted file mode 100644 index c38117f..0000000 --- a/docs/classes/XRSessionEvent.html +++ /dev/null @@ -1,63 +0,0 @@ -XRSessionEvent | VFX-JS

Class XRSessionEvent

XRSessionEvents are fired to indicate changes to the state of an XRSession.
-ref: https://immersive-web.github.io/webxr/#xrsessionevent-interface

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

NONE -CAPTURING_PHASE -AT_TARGET -BUBBLING_PHASE -session -bubbles -cancelBubble -cancelable -composed -currentTarget -defaultPrevented -eventPhase -isTrusted -returnValue -srcElement -target -timeStamp -type -NONE -CAPTURING_PHASE -AT_TARGET -BUBBLING_PHASE -

Methods

composedPath -initEvent -preventDefault -stopImmediatePropagation -stopPropagation -

Constructors

constructor

Properties

Static ReadonlyNONE

NONE: 0

Static ReadonlyCAPTURING_PHASE

CAPTURING_PHASE: 1

Static ReadonlyAT_TARGET

AT_TARGET: 2

Static ReadonlyBUBBLING_PHASE

BUBBLING_PHASE: 3

Readonlysession

session: XRSession

Readonlybubbles

bubbles: boolean

Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

-

MDN Reference

-

cancelBubble

cancelBubble: boolean

Deprecated

MDN Reference

-

Readonlycancelable

cancelable: boolean

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

-

MDN Reference

-

Readonlycomposed

composed: boolean

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

-

MDN Reference

-

ReadonlycurrentTarget

currentTarget: null | EventTarget

Returns the object whose event listener's callback is currently being invoked.

-

MDN Reference

-

ReadonlydefaultPrevented

defaultPrevented: boolean

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

-

MDN Reference

-

ReadonlyeventPhase

eventPhase: number

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

-

MDN Reference

-

ReadonlyisTrusted

isTrusted: boolean

Returns true if event was dispatched by the user agent, and false otherwise.

-

MDN Reference

-

returnValue

returnValue: boolean

Deprecated

MDN Reference

-

ReadonlysrcElement

srcElement: null | EventTarget

Deprecated

MDN Reference

-

Readonlytarget

target: null | EventTarget

Returns the object to which event is dispatched (its target).

-

MDN Reference

-

ReadonlytimeStamp

timeStamp: number

Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

-

MDN Reference

-

Readonlytype

type: string

Returns the type of event, e.g. "click", "hashchange", or "submit".

-

MDN Reference

-

ReadonlyNONE

NONE: 0

ReadonlyCAPTURING_PHASE

CAPTURING_PHASE: 1

ReadonlyAT_TARGET

AT_TARGET: 2

ReadonlyBUBBLING_PHASE

BUBBLING_PHASE: 3

Methods

composedPath

  • composedPath(): EventTarget[]

  • Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

    -

    MDN Reference

    -

    Returns EventTarget[]

initEvent

  • initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void

  • Parameters

    • type: string
    • Optionalbubbles: boolean
    • Optionalcancelable: boolean

    Returns void

    Deprecated

    MDN Reference

    -

preventDefault

  • preventDefault(): void

  • If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

    -

    MDN Reference

    -

    Returns void

stopImmediatePropagation

  • stopImmediatePropagation(): void

  • Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

    -

    MDN Reference

    -

    Returns void

stopPropagation

  • stopPropagation(): void

  • When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

    -

    MDN Reference

    -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRSpace.html b/docs/classes/XRSpace.html deleted file mode 100644 index 85a6871..0000000 --- a/docs/classes/XRSpace.html +++ /dev/null @@ -1,17 +0,0 @@ -XRSpace | VFX-JS

Class XRSpaceAbstract

Hierarchy (View Summary)

Implements

Implemented by

Constructors

constructor -

Methods

addEventListener -dispatchEvent -removeEventListener -

Constructors

constructor

  • new XRSpace(): XRSpace

  • Returns XRSpace

Methods

addEventListener

  • addEventListener(
        type: string,
        callback: null | EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Parameters

    Returns void

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    -

    MDN Reference

    -

    Parameters

    • event: Event

    Returns boolean

removeEventListener

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/XRSubImage.html b/docs/classes/XRSubImage.html deleted file mode 100644 index 4f5c4c8..0000000 --- a/docs/classes/XRSubImage.html +++ /dev/null @@ -1,3 +0,0 @@ -XRSubImage | VFX-JS

Class XRSubImageAbstract

Hierarchy (View Summary)

Implements

Implemented by

Constructors

constructor -

Properties

viewport -

Constructors

constructor

Properties

Readonlyviewport

viewport: XRViewport

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/XRTargetRaySpace.html b/docs/classes/XRTargetRaySpace.html deleted file mode 100644 index 09bf902..0000000 --- a/docs/classes/XRTargetRaySpace.html +++ /dev/null @@ -1,338 +0,0 @@ -XRTargetRaySpace | VFX-JS

Class XRTargetRaySpace

Its purpose is to make working with groups of objects syntactically clearer.

-

Remarks

This is almost identical to an Object3D

-

Example

const geometry = new THREE.BoxGeometry(1, 1, 1);
const material = new THREE.MeshBasicMaterial({
    color: 0x00ff00
});
const cubeA = new THREE.Mesh(geometry, material);
cubeA.position.set(100, 100, 0);
const cubeB = new THREE.Mesh(geometry, material);
cubeB.position.set(-100, -100, 0);
//create a {@link Group} and add the two cubes
//These cubes can now be rotated / scaled etc as a {@link Group}  * const {@link Group} = new THREE.Group();
group.add(cubeA);
group.add(cubeB);
scene.add(group);
-
- -

See

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

DEFAULT_UP -DEFAULT_MATRIX_AUTO_UPDATE -DEFAULT_MATRIX_WORLD_AUTO_UPDATE -hasLinearVelocity -linearVelocity -hasAngularVelocity -angularVelocity -isGroup -isObject3D -id -uuid -name -type -parent -children -up -position -rotation -quaternion -scale -modelViewMatrix -normalMatrix -matrix -matrixWorld -matrixAutoUpdate -matrixWorldAutoUpdate -matrixWorldNeedsUpdate -layers -visible -castShadow -receiveShadow -frustumCulled -renderOrder -animations -userData -customDepthMaterial? -customDistanceMaterial? -

Methods

onBeforeShadow -onAfterShadow -onBeforeRender -onAfterRender -applyMatrix4 -applyQuaternion -setRotationFromAxisAngle -setRotationFromEuler -setRotationFromMatrix -setRotationFromQuaternion -rotateOnAxis -rotateOnWorldAxis -rotateX -rotateY -rotateZ -translateOnAxis -translateX -translateY -translateZ -localToWorld -worldToLocal -lookAt -add -remove -removeFromParent -clear -attach -getObjectById -getObjectByName -getObjectByProperty -getObjectsByProperty -getWorldPosition -getWorldQuaternion -getWorldScale -getWorldDirection -raycast -traverse -traverseVisible -traverseAncestors -updateMatrix -updateMatrixWorld -updateWorldMatrix -toJSON -clone -copy -addEventListener -hasEventListener -removeEventListener -dispatchEvent -

Constructors

constructor

Properties

StaticDEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight,
-THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

-

Default Value

new THREE.Vector3( 0, 1, 0)

-

StaticDEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

StaticDEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

-

Default Value

true

-

hasLinearVelocity

hasLinearVelocity: boolean

ReadonlylinearVelocity

linearVelocity: Vector3

hasAngularVelocity

hasAngularVelocity: boolean

ReadonlyangularVelocity

angularVelocity: Vector3

ReadonlyisGroup

isGroup: true

Read-only flag to check if a given object is of type Group.

-

Remarks

This is a constant value

-

Default Value

true

-

ReadonlyisObject3D

isObject3D: true

Flag to check if a given object is of type Object3D.

-

Remarks

This is a constant value

-

Default Value

true

-

Readonlyid

id: number

Unique number for this Object3D instance.

-

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
-Expects a Integer

-

uuid

uuid: string

UUID of this object instance.

-

Remarks

This gets automatically assigned and shouldn't be edited.

-

name

name: string

Optional name of the object

-

Remarks

(doesn't need to be unique).

-

Default Value

""

-

Readonlytype

type: string

A Read-only string to check this object type.

-

Remarks

This can be used to find a specific type of Object3D in a scene.
-Sub-classes will update this value.

-

Default Value

Object3D

-

parent

parent: null | Object3D

Object's parent in the scene graph.

-

Remarks

An object can have at most one parent.

-

Default Value

null

-

children

children: Object3D[]

Array with object's children.

-

See

THREE.Object3DGroup | Group for info on manually grouping objects.

-

Default Value

[]

-

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

-

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

-

Readonlyposition

position: Vector3

Object's local position.

-

Default Value

new THREE.Vector3() - that is (0, 0, 0).

-

Readonlyrotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

-

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

-

Readonlyquaternion

quaternion: Quaternion

Object's local rotation as a THREE.Quaternion | Quaternion.

-

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

-

Readonlyscale

scale: Vector3

The object's local scale.

-

Default Value

new THREE.Vector3( 1, 1, 1 )

-

ReadonlymodelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

-

ReadonlynormalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

-

matrix

matrix: Matrix4

The local transform matrix.

-

Default Value

new THREE.Matrix4()

-

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

-

Remarks

If the Object3D has no parent, then it's identical to the local transform THREE.Object3D.matrix | .matrix.

-

Default Value

new THREE.Matrix4()

-

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and
-scale every frame and also recalculates the matrixWorld property.

-

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

-

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates.
-When it isn't, then you have to maintain all matrices in the object and its children yourself.

-

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

-

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

-

Default Value

false

-

layers

layers: Layers

The layer membership of the object.

-

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use.
-This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.

-

Default Value

new THREE.Layers()

-

visible

visible: boolean

Object gets rendered if true.

-

Default Value

true

-

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

-

Default Value

false

-

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

-

Default Value

false

-

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object.
-If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

-

Default Value

true

-

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph
-objects to be overridden although opaque and transparent objects remain sorted independently.

-

Remarks

When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.
-Sorting is from lowest to highest renderOrder.

-

Default Value

0

-

animations

animations: AnimationClip[]

Array with object's animation clips.

-

Default Value

[]

-

userData

userData: Record<string, any>

An object that can be used to store custom data about the Object3D.

-

Remarks

It should not hold references to functions as these will not be cloned.

-

Default

{}

-

OptionalcustomDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

-

Remarks

Can only be used in context of meshes.
-When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight,
-if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

-

Default Value

undefined

-

OptionalcustomDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

-

Default Value

undefined

-

Methods

onBeforeShadow

  • onBeforeShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterShadow

  • onAfterShadow(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        shadowCamera: Camera,
        geometry: BufferGeometry,
        depthMaterial: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry,
    -depthMaterial, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onBeforeRender

  • onBeforeRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately before a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

onAfterRender

  • onAfterRender(
        renderer: WebGLRenderer,
        scene: Scene,
        camera: Camera,
        geometry: BufferGeometry,
        material: Material,
        group: Group,
    ): void

  • An optional callback that is executed immediately after a 3D object is rendered.

    -

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
    -Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which
    -define their visual appearance with geometries and materials like instances of Mesh, Line,
    -Points or Sprite. Instances of Object3D, Group or Bone are not renderable
    -and thus this callback is not executed for such objects.

    -

applyMatrix4

  • applyMatrix4(matrix: Matrix4): void

  • Applies the matrix transform to the object and updates the object's position, rotation and scale.

    -

    Parameters

    Returns void

applyQuaternion

  • applyQuaternion(quaternion: Quaternion): this

  • Applies the rotation represented by the quaternion to the object.

    -

    Parameters

    Returns this

setRotationFromAxisAngle

  • setRotationFromAxisAngle(axis: Vector3, angle: number): void

  • Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      Angle in radians. Expects a Float

      -

    Returns void

setRotationFromEuler

  • setRotationFromEuler(euler: Euler): void

  • Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.

    -

    Parameters

    • euler: Euler

      Euler angle specifying rotation amount.

      -

    Returns void

setRotationFromMatrix

  • setRotationFromMatrix(m: Matrix4): void

  • Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

    -

    Parameters

    • m: Matrix4

      Rotate the quaternion by the rotation component of the matrix.

      -

    Returns void

    Remarks

    Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

    -

setRotationFromQuaternion

rotateOnAxis

  • rotateOnAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in object space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

rotateOnWorldAxis

  • rotateOnWorldAxis(axis: Vector3, angle: number): this

  • Rotate an object along an axis in world space.

    -

    Parameters

    • axis: Vector3

      A normalized vector in world space.

      -
    • angle: number

      The angle in radians. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized
    -Method Assumes no rotated parent.

    -

rotateX

  • rotateX(angle: number): this

  • Rotates the object around x axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateY

  • rotateY(angle: number): this

  • Rotates the object around y axis in local space.

    -

    Parameters

    • angle: number

    Returns this

rotateZ

  • rotateZ(angle: number): this

  • Rotates the object around z axis in local space.

    -

    Parameters

    • angle: number

    Returns this

translateOnAxis

  • translateOnAxis(axis: Vector3, distance: number): this

  • Translate an object by distance along an axis in object space

    -

    Parameters

    • axis: Vector3

      A normalized vector in object space.

      -
    • distance: number

      The distance to translate. Expects a Float

      -

    Returns this

    Remarks

    The axis is assumed to be normalized.

    -

translateX

  • translateX(distance: number): this

  • Translates object along x axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateY

  • translateY(distance: number): this

  • Translates object along y axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

translateZ

  • translateZ(distance: number): this

  • Translates object along z axis in object space by distance units.

    -

    Parameters

    • distance: number

      Expects a Float

      -

    Returns this

localToWorld

  • localToWorld(vector: Vector3): Vector3

  • Converts the vector from this object's local space to world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in this object's local space.

      -

    Returns Vector3

worldToLocal

  • worldToLocal(vector: Vector3): Vector3

  • Converts the vector from world space to this object's local space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space.

      -

    Returns Vector3

lookAt

  • lookAt(vector: Vector3): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • vector: Vector3

      A vector representing a position in world space to look at.

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -
  • lookAt(x: number, y: number, z: number): void

  • Rotates the object to face a point in world space.

    -

    Parameters

    • x: number

      Expects a Float

      -
    • y: number

      Expects a Float

      -
    • z: number

      Expects a Float

      -

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

    -

add

  • add(...object: Object3D[]): this

  • Adds another Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be added
    -Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.

    -

    See

      -
    • attach
      • -
    • THREE.Group | Group for info on manually grouping objects.
      • -
    -

remove

  • remove(...object: Object3D[]): this

  • Removes a Object3D as child of this Object3D.

    -

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be removed.

    -

    See

    THREE.Group | Group for info on manually grouping objects.

    -

removeFromParent

  • removeFromParent(): this

  • Removes this object from its current parent.

    -

    Returns this

clear

  • clear(): this

  • Removes all child objects.

    -

    Returns this

attach

  • attach(object: Object3D): this

  • Adds a Object3D as a child of this, while maintaining the object's world transform.

    -

    Parameters

    Returns this

    Remarks

    Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

    -

    See

    add

    -

getObjectById

  • getObjectById(id: number): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    -

    Parameters

    • id: number

      Unique number of the object instance. Expects a Integer

      -

    Returns undefined | Object3D

    Remarks

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    -

    See

    id

    -

getObjectByName

  • getObjectByName(name: string): undefined | Object3D

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

    -

    Parameters

    • name: string

      String to match to the children's Object3D.name property.

      -

    Returns undefined | Object3D

    Remarks

    Note that for most objects the name is an empty string by default
    -You will have to set it manually to make use of this method.

    -

getObjectByProperty

  • getObjectByProperty(name: string, value: any): undefined | Object3D

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      the property name to search for.

      -
    • value: any

      value of the given property.

      -

    Returns undefined | Object3D

getObjectsByProperty

  • getObjectsByProperty(
        name: string,
        value: any,
        optionalTarget?: Object3D[],
    ): Object3D[]

  • Searches through an object and its children, starting with the object itself,
    -and returns the first with a property that matches the value given.

    -

    Parameters

    • name: string

      The property name to search for.

      -
    • value: any

      Value of the given property.

      -
    • OptionaloptionalTarget: Object3D[]

      target to set the result. Otherwise a new Array is instantiated. If set, you must clear
      -this array prior to each call (i.e., array.length = 0;).

      -

    Returns Object3D[]

getWorldPosition

  • getWorldPosition(target: Vector3): Vector3

  • Returns a vector representing the position of the object in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldQuaternion

  • getWorldQuaternion(target: Quaternion): Quaternion

  • Returns a quaternion representing the rotation of the object in world space.

    -

    Parameters

    • target: Quaternion

      The result will be copied into this Quaternion.

      -

    Returns Quaternion

getWorldScale

  • getWorldScale(target: Vector3): Vector3

  • Returns a vector of the scaling factors applied to the object for each axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

getWorldDirection

  • getWorldDirection(target: Vector3): Vector3

  • Returns a vector representing the direction of object's positive z-axis in world space.

    -

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

      -

    Returns Vector3

raycast

  • raycast(raycaster: Raycaster, intersects: Intersection[]): void

  • Abstract (empty) method to get intersections between a casted ray and this object

    -

    Parameters

    Returns void

    Remarks

    Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

    -

    See

    THREE.Raycaster | Raycaster

    -

    Default Value

    () => {}

    -

traverse

  • traverse(callback: (object: Object3D) => any): void

  • Executes the callback on this object and all descendants.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseVisible

  • traverseVisible(callback: (object: Object3D) => any): void

  • Like traverse, but the callback will only be executed for visible objects

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Descendants of invisible objects are not traversed.
    -Note: Modifying the scene graph inside the callback is discouraged.

    -

traverseAncestors

  • traverseAncestors(callback: (object: Object3D) => any): void

  • Executes the callback on all ancestors.

    -

    Parameters

    • callback: (object: Object3D) => any

      A function with as first argument an Object3D object.

      -

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

    -

updateMatrix

  • updateMatrix(): void

  • Updates local transform.

    -

    Returns void

updateMatrixWorld

  • updateMatrixWorld(force?: boolean): void

  • Updates the global transform of the object.
    -And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

    -

    Parameters

    • Optionalforce: boolean

      A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame.
      -Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

      -

    Returns void

updateWorldMatrix

  • updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void

  • Updates the global transform of the object.

    -

    Parameters

    • updateParents: boolean

      Recursively updates global transform of ancestors.

      -
    • updateChildren: boolean

      Recursively updates global transform of descendants.

      -

    Returns void

toJSON

clone

  • clone(recursive?: boolean): this

  • Returns a clone of this object and optionally all descendants.

    -

    Parameters

    • Optionalrecursive: boolean

      If true, descendants of the object are also cloned. Default true

      -

    Returns this

copy

  • copy(object: Object3D, recursive?: boolean): this

  • Copies the given object into this object.

    -

    Parameters

    • object: Object3D
    • Optionalrecursive: boolean

      If set to true, descendants of the object are copied next to the existing ones. If set to
      -false, descendants are left unchanged. Default is true.

      -

    Returns this

    Remarks

    Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

    -

addEventListener

hasEventListener

removeEventListener

dispatchEvent

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRTransientInputHitTestResult.html b/docs/classes/XRTransientInputHitTestResult.html deleted file mode 100644 index 01cc899..0000000 --- a/docs/classes/XRTransientInputHitTestResult.html +++ /dev/null @@ -1,5 +0,0 @@ -XRTransientInputHitTestResult | VFX-JS

Class XRTransientInputHitTestResult

Constructors

constructor -

Properties

inputSource -results -prototype -

Constructors

constructor

Properties

ReadonlyinputSource

inputSource: XRInputSource

Readonlyresults

results: readonly XRHitTestResult[]

prototype

prototype: XRTransientInputHitTestResult

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/XRTransientInputHitTestSource.html b/docs/classes/XRTransientInputHitTestSource.html deleted file mode 100644 index b186e84..0000000 --- a/docs/classes/XRTransientInputHitTestSource.html +++ /dev/null @@ -1,3 +0,0 @@ -XRTransientInputHitTestSource | VFX-JS

Class XRTransientInputHitTestSourceAbstract

Implements

Implemented by

Constructors

constructor -

Methods

cancel -

Constructors

constructor

Methods

cancel

  • cancel(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/XRView.html b/docs/classes/XRView.html deleted file mode 100644 index ad3c9dc..0000000 --- a/docs/classes/XRView.html +++ /dev/null @@ -1,7 +0,0 @@ -XRView | VFX-JS

Class XRViewAbstract

Implements

Implemented by

Constructors

constructor -

Properties

eye -projectionMatrix -transform -recommendedViewportScale? -

Methods

requestViewportScale -

Constructors

constructor

Properties

Readonlyeye

eye: XREye

ReadonlyprojectionMatrix

projectionMatrix: Float32Array

Readonlytransform

transform: XRRigidTransform

Optional ReadonlyrecommendedViewportScale

recommendedViewportScale?: number

Methods

requestViewportScale

  • requestViewportScale(scale: number): void

  • Parameters

    • scale: number

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRViewerPose.html b/docs/classes/XRViewerPose.html deleted file mode 100644 index 42db370..0000000 --- a/docs/classes/XRViewerPose.html +++ /dev/null @@ -1,7 +0,0 @@ -XRViewerPose | VFX-JS

Class XRViewerPoseAbstract

Hierarchy (View Summary)

Implements

Implemented by

Constructors

constructor -

Properties

views -transform -linearVelocity? -angularVelocity? -emulatedPosition -

Constructors

constructor

Properties

Readonlyviews

views: readonly XRView[]

Readonlytransform

transform: XRRigidTransform

Optional ReadonlylinearVelocity

linearVelocity?: DOMPointReadOnly

Optional ReadonlyangularVelocity

angularVelocity?: DOMPointReadOnly

ReadonlyemulatedPosition

emulatedPosition: boolean

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/XRViewport.html b/docs/classes/XRViewport.html deleted file mode 100644 index 7c865c6..0000000 --- a/docs/classes/XRViewport.html +++ /dev/null @@ -1,6 +0,0 @@ -XRViewport | VFX-JS

Class XRViewportAbstract

Implements

Implemented by

Constructors

constructor -

Properties

x -y -width -height -

Constructors

constructor

Properties

Readonlyx

x: number

Readonlyy

y: number

Readonlywidth

width: number

Readonlyheight

height: number

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/XRWebGLBinding.html b/docs/classes/XRWebGLBinding.html deleted file mode 100644 index de5bf1f..0000000 --- a/docs/classes/XRWebGLBinding.html +++ /dev/null @@ -1,11 +0,0 @@ -XRWebGLBinding | VFX-JS

Class XRWebGLBinding

Constructors

constructor -

Properties

nativeProjectionScaleFactor -

Methods

createProjectionLayer -createQuadLayer -createCylinderLayer -createEquirectLayer -createCubeLayer -getSubImage -getViewSubImage -getDepthInformation -

Constructors

constructor

  • new XRWebGLBinding(
        session: XRSession,
        context: WebGLRenderingContext,
    ): XRWebGLBinding

  • Parameters

    • session: XRSession
    • context: WebGLRenderingContext

    Returns XRWebGLBinding

Properties

ReadonlynativeProjectionScaleFactor

nativeProjectionScaleFactor: number

Methods

createProjectionLayer

createQuadLayer

createCylinderLayer

createEquirectLayer

createCubeLayer

getSubImage

getViewSubImage

getDepthInformation

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRWebGLLayer.html b/docs/classes/XRWebGLLayer.html deleted file mode 100644 index 2e09c23..0000000 --- a/docs/classes/XRWebGLLayer.html +++ /dev/null @@ -1,28 +0,0 @@ -XRWebGLLayer | VFX-JS

Class XRWebGLLayer

A layer which provides a WebGL framebuffer to render into, enabling hardware accelerated
-rendering of 3D graphics to be presented on the XR device. *
-ref: https://immersive-web.github.io/webxr/#xrwebgllayer-interface

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

antialias -ignoreDepthValues -fixedFoveation? -framebuffer -framebufferWidth -framebufferHeight -

Methods

getNativeFramebufferScaleFactor -getViewport -addEventListener -dispatchEvent -removeEventListener -

Constructors

constructor

  • new XRWebGLLayer(
        session: XRSession,
        context: WebGLRenderingContext | WebGL2RenderingContext,
        layerInit?: XRWebGLLayerInit,
    ): XRWebGLLayer

  • Parameters

    Returns XRWebGLLayer

Properties

Readonlyantialias

antialias: boolean

ReadonlyignoreDepthValues

ignoreDepthValues: boolean

OptionalfixedFoveation

fixedFoveation?: number

Readonlyframebuffer

framebuffer: WebGLFramebuffer

ReadonlyframebufferWidth

framebufferWidth: number

ReadonlyframebufferHeight

framebufferHeight: number

Methods

StaticgetNativeFramebufferScaleFactor

  • getNativeFramebufferScaleFactor(session: XRSession): number

  • Parameters

    Returns number

getViewport

addEventListener

  • addEventListener(
        type: string,
        callback: null | EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Parameters

    Returns void

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    -

    MDN Reference

    -

    Parameters

    • event: Event

    Returns boolean

removeEventListener

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/XRWebGLSubImage.html b/docs/classes/XRWebGLSubImage.html deleted file mode 100644 index e03f861..0000000 --- a/docs/classes/XRWebGLSubImage.html +++ /dev/null @@ -1,8 +0,0 @@ -XRWebGLSubImage | VFX-JS

Class XRWebGLSubImageAbstract

Hierarchy (View Summary)

Implements

Implemented by

Constructors

constructor -

Properties

colorTexture -depthStencilTexture -imageIndex -textureWidth -textureHeight -viewport -

Constructors

constructor

Properties

ReadonlycolorTexture

colorTexture: WebGLTexture

ReadonlydepthStencilTexture

depthStencilTexture: WebGLTexture

ReadonlyimageIndex

imageIndex: number

ReadonlytextureWidth

textureWidth: number

ReadonlytextureHeight

textureHeight: number

Readonlyviewport

viewport: XRViewport

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/default.html b/docs/classes/default.html deleted file mode 100644 index 868d3cb..0000000 --- a/docs/classes/default.html +++ /dev/null @@ -1,149 +0,0 @@ -default | VFX-JS

Class default

This class stores data for an attribute (such as vertex positions, face indices, normals, colors, UVs, and any custom attributes )
-associated with a THREE.BufferGeometry | BufferGeometry, which allows for more efficient passing of data to the GPU

-

Remarks

When working with vector-like data, the .fromBufferAttribute( attribute, index ) helper methods on
-THREE.Vector2.fromBufferAttribute | Vector2,
-THREE.Vector3.fromBufferAttribute | Vector3,
-THREE.Vector4.fromBufferAttribute | Vector4, and
-THREE.Color.fromBufferAttribute | Color classes may be helpful.

-

See

-

Hierarchy (View Summary)

Constructors

constructor -

Properties

isStorageBufferAttribute -name -array -itemSize -usage -gpuType -updateRanges -version -normalized -count -isBufferAttribute -onUploadCallback -

Accessors

needsUpdate -

Methods

onUpload -setUsage -addUpdateRange -clearUpdateRanges -clone -copy -copyAt -copyArray -applyMatrix3 -applyMatrix4 -applyNormalMatrix -transformDirection -set -getComponent -setComponent -getX -setX -getY -setY -getZ -setZ -getW -setW -setXY -setXYZ -setXYZW -toJSON -

Constructors

constructor

Properties

ReadonlyisStorageBufferAttribute

isStorageBufferAttribute: true

name

name: string

Optional name for this attribute instance.

-

Default Value

''
-
- -

array

array: TypedArray

The TypedArray holding data stored in the buffer.

-

Returns

TypedArray

-

itemSize

itemSize: number

The length of vectors that are being stored in the array.

-

Remarks

Expects a Integer

-

usage

usage: Usage

Defines the intended usage pattern of the data store for optimization purposes.
-Corresponds to the usage parameter of
-WebGLRenderingContext.bufferData.

-

Remarks

After the initial use of a buffer, its usage cannot be changed. Instead, instantiate a new one and set the desired usage before the next render.

-

See

-

Default Value

THREE.StaticDrawUsage | THREE.StaticDrawUsage.

-

gpuType

gpuType: AttributeGPUType

Configures the bound GPU type for use in shaders. Either FloatType or IntType, default is FloatType.

-

Note: this only has an effect for integer arrays and is not configurable for float arrays. For lower precision
-float types, see https://threejs.org/docs/#api/en/core/bufferAttributeTypes/BufferAttributeTypes.

-

updateRanges

updateRanges: { start: number; count: number }[]

This can be used to only update some components of stored vectors (for example, just the component related to
-color). Use the .addUpdateRange function to add ranges to this array.

-

Type declaration

  • start: number

    Position at which to start update.

    -
  • count: number

    The number of components to update.

    -

version

version: number

A version number, incremented every time the needsUpdate property is set to true.

-

Remarks

Expects a Integer

-

Default Value

0

-

normalized

normalized: boolean

Indicates how the underlying data in the buffer maps to the values in the GLSL shader code.

-

See

constructor above for details.

-

Default Value

false

-

Readonlycount

count: number

Represents the number of items this buffer attribute stores. It is internally computed by dividing the
-array's length by the itemSize. Read-only
-property.

-

ReadonlyisBufferAttribute

isBufferAttribute: true

Read-only flag to check if a given object is of type BufferAttribute.

-

Remarks

This is a constant value

-

Default Value

true

-

onUploadCallback

onUploadCallback: () => void

A callback function that is executed after the Renderer has transferred the attribute array data to the GPU.

-

Accessors

needsUpdate

  • set needsUpdate(value: boolean): void

  • Flag to indicate that this attribute has changed and should be re-sent to the GPU.
    -Set this to true when you modify the value of the array.

    -

    Parameters

    • value: boolean

    Returns void

    Remarks

    Setting this to true also increments the version.

    -

Methods

onUpload

  • onUpload(callback: () => void): this

  • Sets the value of the onUploadCallback property.

    -

    Parameters

    • callback: () => void

      function that is executed after the Renderer has transferred the attribute array data to the GPU.

      -

    Returns this

    See

    -

setUsage

  • setUsage(usage: Usage): this

  • Set usage

    -

    Parameters

    Returns this

    Remarks

    After the initial use of a buffer, its usage cannot be changed. Instead, instantiate a new one and set the desired usage before the next render.

    -

    See

    -

addUpdateRange

  • addUpdateRange(start: number, count: number): void

  • Adds a range of data in the data array to be updated on the GPU. Adds an object describing the range to the
    -.updateRanges array.

    -

    Parameters

    • start: number
    • count: number

    Returns void

clearUpdateRanges

  • clearUpdateRanges(): void

  • Clears the .updateRanges array.

    -

    Returns void

clone

copy

copyAt

  • copyAt(index1: number, attribute: BufferAttribute, index2: number): this

  • Copy a vector from bufferAttribute[index2] to array[index1].

    -

    Parameters

    Returns this

copyArray

  • copyArray(array: ArrayLike<number>): this

  • Copy the array given here (which can be a normal array or TypedArray) into array.

    -

    Parameters

    Returns this

    See

    TypedArray.set for notes on requirements if copying a TypedArray.

    -

applyMatrix3

applyMatrix4

applyNormalMatrix

transformDirection

set

getComponent

  • getComponent(index: number, component: number): number

  • Returns the given component of the vector at the given index.

    -

    Parameters

    • index: number
    • component: number

    Returns number

setComponent

  • setComponent(index: number, component: number, value: number): void

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

    -

    Parameters

    • index: number
    • component: number
    • value: number

    Returns void

getX

  • getX(index: number): number

  • Returns the x component of the vector at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -

    Returns number

setX

  • setX(index: number, x: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • x: number

    Returns this

getY

  • getY(index: number): number

  • Returns the y component of the vector at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -

    Returns number

setY

  • setY(index: number, y: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • y: number

    Returns this

getZ

  • getZ(index: number): number

  • Returns the z component of the vector at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -

    Returns number

setZ

  • setZ(index: number, z: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • z: number

    Returns this

getW

  • getW(index: number): number

  • Returns the w component of the vector at the given index.

    -

    Parameters

    • index: number

      Expects a Integer

      -

    Returns number

setW

  • setW(index: number, z: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • z: number

    Returns this

setXY

  • setXY(index: number, x: number, y: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • x: number
    • y: number

    Returns this

setXYZ

  • setXYZ(index: number, x: number, y: number, z: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • x: number
    • y: number
    • z: number

    Returns this

setXYZW

  • setXYZW(index: number, x: number, y: number, z: number, w: number): this

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

    -

    Parameters

    • index: number

      Expects a Integer

      -
    • x: number
    • y: number
    • z: number
    • w: number

    Returns this

toJSON

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/hierarchy.html b/docs/hierarchy.html deleted file mode 100644 index 9dff51d..0000000 --- a/docs/hierarchy.html +++ /dev/null @@ -1 +0,0 @@ -VFX-JS

VFX-JS

Hierarchy Summary

Settings

Member Visibility
diff --git a/docs/index.html b/docs/index.html index 75f5289..4624611 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -VFX-JS

VFX-JS

VFX-JS API docs

VFX-JS

VFX-JS API docs

@@ -16,4 +16,4 @@

For more examples, visit the website:
https://amagi.dev/vfx-js/

-

Settings

Member Visibility

On This Page

VFX-JS API docs
+

Settings

Member Visibility

On This Page

VFX-JS API docs
diff --git a/docs/interfaces/AddEventListenerOptions.html b/docs/interfaces/AddEventListenerOptions.html deleted file mode 100644 index fe15e1f..0000000 --- a/docs/interfaces/AddEventListenerOptions.html +++ /dev/null @@ -1,5 +0,0 @@ -AddEventListenerOptions | VFX-JS

Interface AddEventListenerOptions

interface AddEventListenerOptions {
    once?: boolean;
    passive?: boolean;
    signal?: AbortSignal;
    capture?: boolean;
}

Hierarchy (View Summary)

Properties

once? -passive? -signal? -capture? -

Properties

Optionalonce

once?: boolean

Optionalpassive

passive?: boolean

Optionalsignal

signal?: AbortSignal

Optionalcapture

capture?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/AnimationClipJSON.html b/docs/interfaces/AnimationClipJSON.html deleted file mode 100644 index 0542c68..0000000 --- a/docs/interfaces/AnimationClipJSON.html +++ /dev/null @@ -1,6 +0,0 @@ -AnimationClipJSON | VFX-JS

Interface AnimationClipJSON

interface AnimationClipJSON {
    name: string;
    duration: number;
    tracks: KeyframeTrackJSON[];
    uuid: string;
    blendMode: AnimationBlendMode;
}

Properties

name -duration -tracks -uuid -blendMode -

Properties

name

name: string

duration

duration: number

tracks

tracks: KeyframeTrackJSON[]

uuid

uuid: string

blendMode

blendMode: AnimationBlendMode

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/ArrayBufferView.html b/docs/interfaces/ArrayBufferView.html deleted file mode 100644 index f7afea9..0000000 --- a/docs/interfaces/ArrayBufferView.html +++ /dev/null @@ -1,7 +0,0 @@ -ArrayBufferView | VFX-JS

Interface ArrayBufferView<TArrayBuffer>

interface ArrayBufferView<
    TArrayBuffer extends ArrayBufferLike = ArrayBufferLike,
> {
    buffer: TArrayBuffer;
    byteLength: number;
    byteOffset: number;
}

Type Parameters

Properties

buffer -byteLength -byteOffset -

Properties

Readonlybuffer

buffer: TArrayBuffer

The ArrayBuffer instance referenced by the array.

-

ReadonlybyteLength

byteLength: number

The length in bytes of the array.

-

ReadonlybyteOffset

byteOffset: number

The offset in bytes of the array.

-

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/ArrayLike.html b/docs/interfaces/ArrayLike.html deleted file mode 100644 index 78bc33a..0000000 --- a/docs/interfaces/ArrayLike.html +++ /dev/null @@ -1,2 +0,0 @@ -ArrayLike | VFX-JS

Interface ArrayLike<T>

interface ArrayLike<T> {
    length: number;
    readonly [n: number]: T;
}

Type Parameters

  • T

Indexable

  • readonly [n: number]: T

Properties

length -

Properties

Readonlylength

length: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/BaseEvent.html b/docs/interfaces/BaseEvent.html deleted file mode 100644 index 4bf948b..0000000 --- a/docs/interfaces/BaseEvent.html +++ /dev/null @@ -1,3 +0,0 @@ -BaseEvent | VFX-JS

Interface BaseEvent<TEventType>

The minimal basic Event that can be dispatched by a <>.

-
interface BaseEvent<TEventType extends string = string> {
    type: TEventType;
}

Type Parameters

  • TEventType extends string = string

Properties

type -

Properties

Readonlytype

type: TEventType

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/BufferAttributeJSON.html b/docs/interfaces/BufferAttributeJSON.html deleted file mode 100644 index 72603a8..0000000 --- a/docs/interfaces/BufferAttributeJSON.html +++ /dev/null @@ -1,7 +0,0 @@ -BufferAttributeJSON | VFX-JS

Interface BufferAttributeJSON

interface BufferAttributeJSON {
    itemSize: number;
    type: string;
    array: number[];
    normalized: boolean;
    name?: string;
    usage?: Usage;
}

Properties

itemSize -type -array -normalized -name? -usage? -

Properties

itemSize

itemSize: number

type

type: string

array

array: number[]

normalized

normalized: boolean

Optionalname

name?: string

Optionalusage

usage?: Usage

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/BufferGeometryJSON.html b/docs/interfaces/BufferGeometryJSON.html deleted file mode 100644 index 671b6d4..0000000 --- a/docs/interfaces/BufferGeometryJSON.html +++ /dev/null @@ -1,7 +0,0 @@ -BufferGeometryJSON | VFX-JS

Interface BufferGeometryJSON

interface BufferGeometryJSON {
    metadata?: { version: number; type: string; generator: string };
    uuid: string;
    type: string;
    name?: string;
    userData?: Record<string, unknown>;
    data?: {
        attributes: Record<string, BufferAttributeJSON>;
        index?: { type: string; array: number[] };
        morphAttributes?: Record<string, BufferAttributeJSON[]>;
        morphTargetsRelative?: boolean;
        groups?: GeometryGroup[];
        boundingSphere?: { center: Vector3Tuple; radius: number };
    };
}

Properties

metadata? -uuid -type -name? -userData? -data? -

Properties

Optionalmetadata

metadata?: { version: number; type: string; generator: string }

uuid

uuid: string

type

type: string

Optionalname

name?: string

OptionaluserData

userData?: Record<string, unknown>

Optionaldata

data?: {
    attributes: Record<string, BufferAttributeJSON>;
    index?: { type: string; array: number[] };
    morphAttributes?: Record<string, BufferAttributeJSON[]>;
    morphTargetsRelative?: boolean;
    groups?: GeometryGroup[];
    boundingSphere?: { center: Vector3Tuple; radius: number };
}

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/CompressedTextureMipmap.html b/docs/interfaces/CompressedTextureMipmap.html deleted file mode 100644 index 12f3d5b..0000000 --- a/docs/interfaces/CompressedTextureMipmap.html +++ /dev/null @@ -1,4 +0,0 @@ -CompressedTextureMipmap | VFX-JS

Interface CompressedTextureMipmap

interface CompressedTextureMipmap {
    data: TypedArray;
    width: number;
    height: number;
}

Properties

data -width -height -

Properties

data

data: TypedArray

width

width: number

height

height: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/CurveJSON.html b/docs/interfaces/CurveJSON.html deleted file mode 100644 index 3a81156..0000000 --- a/docs/interfaces/CurveJSON.html +++ /dev/null @@ -1,4 +0,0 @@ -CurveJSON | VFX-JS

Interface CurveJSON

interface CurveJSON {
    metadata: { version: number; type: string; generator: string };
    arcLengthDivisions: number;
    type: string;
}

Hierarchy (View Summary)

Properties

metadata -arcLengthDivisions -type -

Properties

metadata

metadata: { version: number; type: string; generator: string }

arcLengthDivisions

arcLengthDivisions: number

type

type: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/CurvePathJSON.html b/docs/interfaces/CurvePathJSON.html deleted file mode 100644 index 4cd3172..0000000 --- a/docs/interfaces/CurvePathJSON.html +++ /dev/null @@ -1,6 +0,0 @@ -CurvePathJSON | VFX-JS

Interface CurvePathJSON

interface CurvePathJSON {
    autoClose: boolean;
    curves: CurveJSON[];
    metadata: { version: number; type: string; generator: string };
    arcLengthDivisions: number;
    type: string;
}

Hierarchy (View Summary)

Properties

autoClose -curves -metadata -arcLengthDivisions -type -

Properties

autoClose

autoClose: boolean

curves

curves: CurveJSON[]

metadata

metadata: { version: number; type: string; generator: string }

arcLengthDivisions

arcLengthDivisions: number

type

type: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/DOMMatrix2DInit.html b/docs/interfaces/DOMMatrix2DInit.html deleted file mode 100644 index d4254dc..0000000 --- a/docs/interfaces/DOMMatrix2DInit.html +++ /dev/null @@ -1,13 +0,0 @@ -DOMMatrix2DInit | VFX-JS

Interface DOMMatrix2DInit

interface DOMMatrix2DInit {
    a?: number;
    b?: number;
    c?: number;
    d?: number;
    e?: number;
    f?: number;
    m11?: number;
    m12?: number;
    m21?: number;
    m22?: number;
    m41?: number;
    m42?: number;
}

Hierarchy (View Summary)

Properties

a? -b? -c? -d? -e? -f? -m11? -m12? -m21? -m22? -m41? -m42? -

Properties

Optionala

a?: number

Optionalb

b?: number

Optionalc

c?: number

Optionald

d?: number

Optionale

e?: number

Optionalf

f?: number

Optionalm11

m11?: number

Optionalm12

m12?: number

Optionalm21

m21?: number

Optionalm22

m22?: number

Optionalm41

m41?: number

Optionalm42

m42?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/DOMMatrixInit.html b/docs/interfaces/DOMMatrixInit.html deleted file mode 100644 index 878e54e..0000000 --- a/docs/interfaces/DOMMatrixInit.html +++ /dev/null @@ -1,24 +0,0 @@ -DOMMatrixInit | VFX-JS

Interface DOMMatrixInit

interface DOMMatrixInit {
    is2D?: boolean;
    m13?: number;
    m14?: number;
    m23?: number;
    m24?: number;
    m31?: number;
    m32?: number;
    m33?: number;
    m34?: number;
    m43?: number;
    m44?: number;
    a?: number;
    b?: number;
    c?: number;
    d?: number;
    e?: number;
    f?: number;
    m11?: number;
    m12?: number;
    m21?: number;
    m22?: number;
    m41?: number;
    m42?: number;
}

Hierarchy (View Summary)

Properties

is2D? -m13? -m14? -m23? -m24? -m31? -m32? -m33? -m34? -m43? -m44? -a? -b? -c? -d? -e? -f? -m11? -m12? -m21? -m22? -m41? -m42? -

Properties

Optionalis2D

is2D?: boolean

Optionalm13

m13?: number

Optionalm14

m14?: number

Optionalm23

m23?: number

Optionalm24

m24?: number

Optionalm31

m31?: number

Optionalm32

m32?: number

Optionalm33

m33?: number

Optionalm34

m34?: number

Optionalm43

m43?: number

Optionalm44

m44?: number

Optionala

a?: number

Optionalb

b?: number

Optionalc

c?: number

Optionald

d?: number

Optionale

e?: number

Optionalf

f?: number

Optionalm11

m11?: number

Optionalm12

m12?: number

Optionalm21

m21?: number

Optionalm22

m22?: number

Optionalm41

m41?: number

Optionalm42

m42?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/DOMPoint.html b/docs/interfaces/DOMPoint.html deleted file mode 100644 index 2c2b2ef..0000000 --- a/docs/interfaces/DOMPoint.html +++ /dev/null @@ -1,13 +0,0 @@ -DOMPoint | VFX-JS

Interface DOMPoint

MDN Reference

-
interface DOMPoint {
    w: number;
    x: number;
    y: number;
    z: number;
    matrixTransform(matrix?: DOMMatrixInit): DOMPoint;
    toJSON(): any;
}

Hierarchy (View Summary)

Properties

w -x -y -z -

Methods

matrixTransform -toJSON -

Properties

w

w: number

MDN Reference

-

x

x: number

MDN Reference

-

y

y: number

MDN Reference

-

z

z: number

MDN Reference

-

Methods

matrixTransform

toJSON

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/interfaces/DOMPointInit.html b/docs/interfaces/DOMPointInit.html deleted file mode 100644 index cf972e5..0000000 --- a/docs/interfaces/DOMPointInit.html +++ /dev/null @@ -1,5 +0,0 @@ -DOMPointInit | VFX-JS

Interface DOMPointInit

interface DOMPointInit {
    w?: number;
    x?: number;
    y?: number;
    z?: number;
}

Properties

w? -x? -y? -z? -

Properties

Optionalw

w?: number

Optionalx

x?: number

Optionaly

y?: number

Optionalz

z?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/DOMPointReadOnly.html b/docs/interfaces/DOMPointReadOnly.html deleted file mode 100644 index 7d6f387..0000000 --- a/docs/interfaces/DOMPointReadOnly.html +++ /dev/null @@ -1,13 +0,0 @@ -DOMPointReadOnly | VFX-JS

Interface DOMPointReadOnly

MDN Reference

-
interface DOMPointReadOnly {
    w: number;
    x: number;
    y: number;
    z: number;
    matrixTransform(matrix?: DOMMatrixInit): DOMPoint;
    toJSON(): any;
}

Hierarchy (View Summary)

Properties

w -x -y -z -

Methods

matrixTransform -toJSON -

Properties

Readonlyw

w: number

MDN Reference

-

Readonlyx

x: number

MDN Reference

-

Readonlyy

y: number

MDN Reference

-

Readonlyz

z: number

MDN Reference

-

Methods

matrixTransform

toJSON

  • toJSON(): any

  • MDN Reference

    -

    Returns any

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/interfaces/DOMRectInit.html b/docs/interfaces/DOMRectInit.html deleted file mode 100644 index a978e6a..0000000 --- a/docs/interfaces/DOMRectInit.html +++ /dev/null @@ -1,5 +0,0 @@ -DOMRectInit | VFX-JS

Interface DOMRectInit

interface DOMRectInit {
    height?: number;
    width?: number;
    x?: number;
    y?: number;
}

Properties

height? -width? -x? -y? -

Properties

Optionalheight

height?: number

Optionalwidth

width?: number

Optionalx

x?: number

Optionaly

y?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/DOMRectReadOnly.html b/docs/interfaces/DOMRectReadOnly.html deleted file mode 100644 index 4258b96..0000000 --- a/docs/interfaces/DOMRectReadOnly.html +++ /dev/null @@ -1,19 +0,0 @@ -DOMRectReadOnly | VFX-JS

Interface DOMRectReadOnly

MDN Reference

-
interface DOMRectReadOnly {
    bottom: number;
    height: number;
    left: number;
    right: number;
    top: number;
    width: number;
    x: number;
    y: number;
    toJSON(): any;
}

Properties

bottom -height -left -right -top -width -x -y -

Methods

toJSON -

Properties

Readonlybottom

bottom: number

MDN Reference

-

Readonlyheight

height: number

MDN Reference

-

Readonlyleft

left: number

MDN Reference

-

Readonlyright

right: number

MDN Reference

-

Readonlytop

top: number

MDN Reference

-

Readonlywidth

width: number

MDN Reference

-

Readonlyx

x: number

MDN Reference

-

Readonlyy

y: number

MDN Reference

-

Methods

toJSON

  • toJSON(): any

  • Returns any

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/interfaces/Event.html b/docs/interfaces/Event.html deleted file mode 100644 index 94b33c0..0000000 --- a/docs/interfaces/Event.html +++ /dev/null @@ -1,4 +0,0 @@ -Event | VFX-JS

Interface Event<TEventType, TTarget>

The minimal expected contract of a fired Event that was dispatched by a <>.

-
interface Event<TEventType extends string = string, TTarget = unknown> {
    type: TEventType;
    target: TTarget;
}

Type Parameters

  • TEventType extends string = string
  • TTarget = unknown

Properties

type -target -

Properties

Readonlytype

type: TEventType

Readonlytarget

target: TTarget

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/EventInit.html b/docs/interfaces/EventInit.html deleted file mode 100644 index 89eb78f..0000000 --- a/docs/interfaces/EventInit.html +++ /dev/null @@ -1,4 +0,0 @@ -EventInit | VFX-JS

Interface EventInit

interface EventInit {
    bubbles?: boolean;
    cancelable?: boolean;
    composed?: boolean;
}

Hierarchy (View Summary)

Properties

bubbles? -cancelable? -composed? -

Properties

Optionalbubbles

bubbles?: boolean

Optionalcancelable

cancelable?: boolean

Optionalcomposed

composed?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/EventListener.html b/docs/interfaces/EventListener.html deleted file mode 100644 index ce56f67..0000000 --- a/docs/interfaces/EventListener.html +++ /dev/null @@ -1 +0,0 @@ -EventListener | VFX-JS

Interface EventListener

  • EventListener(evt: Event): void

  • Parameters

    • evt: Event

    Returns void

Settings

Member Visibility
diff --git a/docs/interfaces/EventListenerObject.html b/docs/interfaces/EventListenerObject.html deleted file mode 100644 index 8763af3..0000000 --- a/docs/interfaces/EventListenerObject.html +++ /dev/null @@ -1,2 +0,0 @@ -EventListenerObject | VFX-JS

Interface EventListenerObject

interface EventListenerObject {
    handleEvent(object: Event): void;
}

Methods

handleEvent -

Methods

handleEvent

  • handleEvent(object: Event): void

  • Parameters

    • object: Event

    Returns void

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/interfaces/EventListenerOptions.html b/docs/interfaces/EventListenerOptions.html deleted file mode 100644 index bb49976..0000000 --- a/docs/interfaces/EventListenerOptions.html +++ /dev/null @@ -1,2 +0,0 @@ -EventListenerOptions | VFX-JS

Interface EventListenerOptions

interface EventListenerOptions {
    capture?: boolean;
}

Hierarchy (View Summary)

Properties

capture? -

Properties

Optionalcapture

capture?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Face.html b/docs/interfaces/Face.html deleted file mode 100644 index dd1a167..0000000 --- a/docs/interfaces/Face.html +++ /dev/null @@ -1,6 +0,0 @@ -Face | VFX-JS

Interface Face

interface Face {
    a: number;
    b: number;
    c: number;
    normal: Vector3;
    materialIndex: number;
}

Properties

a -b -c -normal -materialIndex -

Properties

a

a: number

b

b: number

c

c: number

normal

normal: Vector3

materialIndex

materialIndex: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/FogExp2JSON.html b/docs/interfaces/FogExp2JSON.html deleted file mode 100644 index 396e264..0000000 --- a/docs/interfaces/FogExp2JSON.html +++ /dev/null @@ -1,5 +0,0 @@ -FogExp2JSON | VFX-JS

Interface FogExp2JSON

interface FogExp2JSON {
    type: string;
    name: string;
    color: number;
    density: number;
}

Properties

type -name -color -density -

Properties

type

type: string

name

name: string

color

color: number

density

density: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/FogJSON.html b/docs/interfaces/FogJSON.html deleted file mode 100644 index a265e2d..0000000 --- a/docs/interfaces/FogJSON.html +++ /dev/null @@ -1,6 +0,0 @@ -FogJSON | VFX-JS

Interface FogJSON

interface FogJSON {
    type: string;
    name: string;
    color: number;
    near: number;
    far: number;
}

Properties

type -name -color -near -far -

Properties

type

type: string

name

name: string

color

color: number

near

near: number

far

far: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Generator.html b/docs/interfaces/Generator.html deleted file mode 100644 index c18eec5..0000000 --- a/docs/interfaces/Generator.html +++ /dev/null @@ -1,5 +0,0 @@ -Generator | VFX-JS

Interface Generator<T, TReturn, TNext>

interface Generator<T = unknown, TReturn = any, TNext = any> {
    next(...__namedParameters: [] | [TNext]): IteratorResult<T, TReturn>;
    return(value: TReturn): IteratorResult<T, TReturn>;
    throw(e: any): IteratorResult<T, TReturn>;
    "[iterator]"(): Generator<T, TReturn, TNext>;
}

Type Parameters

  • T = unknown
  • TReturn = any
  • TNext = any

Hierarchy

Methods

next -return -throw -[iterator] -

Methods

next

return

throw

[iterator]

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/interfaces/GeometryGroup.html b/docs/interfaces/GeometryGroup.html deleted file mode 100644 index f278e19..0000000 --- a/docs/interfaces/GeometryGroup.html +++ /dev/null @@ -1,10 +0,0 @@ -GeometryGroup | VFX-JS

Interface GeometryGroup

interface GeometryGroup {
    start: number;
    count: number;
    materialIndex?: number;
}

Properties

start -count -materialIndex? -

Properties

start

start: number

Specifies the first element in this draw call – the first vertex for non-indexed geometry, otherwise the first triangle index.

-

Remarks

Expects a Integer

-

count

count: number

Specifies how many vertices (or indices) are included.

-

Remarks

Expects a Integer

-

OptionalmaterialIndex

materialIndex?: number

Specifies the material array index to use.

-

Remarks

Expects a Integer

-

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/HSL.html b/docs/interfaces/HSL.html deleted file mode 100644 index 5908deb..0000000 --- a/docs/interfaces/HSL.html +++ /dev/null @@ -1,4 +0,0 @@ -HSL | VFX-JS

Interface HSL

interface HSL {
    h: number;
    s: number;
    l: number;
}

Properties

h -s -l -

Properties

h

h: number

s

s: number

l

l: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/IUniform.html b/docs/interfaces/IUniform.html deleted file mode 100644 index c9a607f..0000000 --- a/docs/interfaces/IUniform.html +++ /dev/null @@ -1,2 +0,0 @@ -IUniform | VFX-JS

Interface IUniform<TValue>

interface IUniform<TValue = any> {
    value: TValue;
}

Type Parameters

  • TValue = any

Properties

value -

Properties

value

value: TValue

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/ImageBitmap.html b/docs/interfaces/ImageBitmap.html deleted file mode 100644 index dd83164..0000000 --- a/docs/interfaces/ImageBitmap.html +++ /dev/null @@ -1,11 +0,0 @@ -ImageBitmap | VFX-JS

Interface ImageBitmap

MDN Reference

-
interface ImageBitmap {
    height: number;
    width: number;
    close(): void;
}

Properties

height -width -

Methods

close -

Properties

Readonlyheight

height: number

Returns the intrinsic height of the image, in CSS pixels.

-

MDN Reference

-

Readonlywidth

width: number

Returns the intrinsic width of the image, in CSS pixels.

-

MDN Reference

-

Methods

close

  • close(): void

  • Releases imageBitmap's underlying bitmap data.

    -

    MDN Reference

    -

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/interfaces/ImageData.html b/docs/interfaces/ImageData.html deleted file mode 100644 index 9514f16..0000000 --- a/docs/interfaces/ImageData.html +++ /dev/null @@ -1,14 +0,0 @@ -ImageData | VFX-JS

Interface ImageData

The underlying pixel data of an area of a element. It is created using the ImageData() constructor or creator methods on the CanvasRenderingContext2D object associated with a canvas: createImageData() and getImageData(). It can also be used to set a part of the canvas by using putImageData().

-

MDN Reference

-
interface ImageData {
    colorSpace: PredefinedColorSpace;
    data: Uint8ClampedArray;
    height: number;
    width: number;
}

Properties

colorSpace -data -height -width -

Properties

ReadonlycolorSpace

colorSpace: PredefinedColorSpace

MDN Reference

-

Readonlydata

data: Uint8ClampedArray

Returns the one-dimensional array containing the data in RGBA order, as integers in the range 0 to 255.

-

MDN Reference

-

Readonlyheight

height: number

Returns the actual dimensions of the data in the ImageData object, in pixels.

-

MDN Reference

-

Readonlywidth

width: number

Returns the actual dimensions of the data in the ImageData object, in pixels.

-

MDN Reference

-

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/ImageDataSettings.html b/docs/interfaces/ImageDataSettings.html deleted file mode 100644 index e905493..0000000 --- a/docs/interfaces/ImageDataSettings.html +++ /dev/null @@ -1,2 +0,0 @@ -ImageDataSettings | VFX-JS

Interface ImageDataSettings

interface ImageDataSettings {
    colorSpace?: PredefinedColorSpace;
}

Properties

colorSpace? -

Properties

OptionalcolorSpace

colorSpace?: PredefinedColorSpace

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Intersection.html b/docs/interfaces/Intersection.html deleted file mode 100644 index 1bf33b9..0000000 --- a/docs/interfaces/Intersection.html +++ /dev/null @@ -1,21 +0,0 @@ -Intersection | VFX-JS

Interface Intersection<TIntersected>

interface Intersection<TIntersected extends Object3D = Object3D> {
    distance: number;
    distanceToRay?: number;
    point: Vector3;
    index?: number;
    face?: null | Face;
    faceIndex?: null | number;
    barycoord?: null | Vector3;
    object: TIntersected;
    uv?: Vector2;
    uv1?: Vector2;
    normal?: Vector3;
    instanceId?: number;
    pointOnLine?: Vector3;
    batchId?: number;
}

Type Parameters

Properties

distance -distanceToRay? -point -index? -face? -faceIndex? -barycoord? -object -uv? -uv1? -normal? -instanceId? -pointOnLine? -batchId? -

Properties

distance

distance: number

Distance between the origin of the ray and the intersection

-

OptionaldistanceToRay

distanceToRay?: number

point

point: Vector3

Point of intersection, in world coordinates

-

Optionalindex

index?: number

Optionalface

face?: null | Face

Intersected face

-

OptionalfaceIndex

faceIndex?: null | number

Index of the intersected face

-

Optionalbarycoord

barycoord?: null | Vector3

object

object: TIntersected

The intersected object

-

Optionaluv

uv?: Vector2

Optionaluv1

uv1?: Vector2

Optionalnormal

normal?: Vector3

OptionalinstanceId

instanceId?: number

The index number of the instance where the ray intersects the THREE.InstancedMesh | InstancedMesh

-

OptionalpointOnLine

pointOnLine?: Vector3

OptionalbatchId

batchId?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/IterableIterator.html b/docs/interfaces/IterableIterator.html deleted file mode 100644 index 2a9ff1d..0000000 --- a/docs/interfaces/IterableIterator.html +++ /dev/null @@ -1,6 +0,0 @@ -IterableIterator | VFX-JS

Interface IterableIterator<T, TReturn, TNext>

Describes a user-defined Iterator that is also iterable.

-
interface IterableIterator<T, TReturn = any, TNext = any> {
    "[iterator]"(): IterableIterator<T, TReturn, TNext>;
    next(...__namedParameters: [] | [TNext]): IteratorResult<T, TReturn>;
    return(value?: TReturn): IteratorResult<T, TReturn>;
    throw(e?: any): IteratorResult<T, TReturn>;
}

Type Parameters

  • T
  • TReturn = any
  • TNext = any

Hierarchy (View Summary)

Methods

[iterator] -next -return? -throw? -

Methods

[iterator]

next

Optionalreturn

Optionalthrow

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/interfaces/Iterator.html b/docs/interfaces/Iterator.html deleted file mode 100644 index 829f340..0000000 --- a/docs/interfaces/Iterator.html +++ /dev/null @@ -1,4 +0,0 @@ -Iterator | VFX-JS

Interface Iterator<T, TReturn, TNext>

interface Iterator<T, TReturn = any, TNext = any> {
    next(...__namedParameters: [] | [TNext]): IteratorResult<T, TReturn>;
    return(value?: TReturn): IteratorResult<T, TReturn>;
    throw(e?: any): IteratorResult<T, TReturn>;
}

Type Parameters

  • T
  • TReturn = any
  • TNext = any

Hierarchy (View Summary)

Methods

next -return? -throw? -

Methods

next

Optionalreturn

Optionalthrow

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/interfaces/IteratorReturnResult.html b/docs/interfaces/IteratorReturnResult.html deleted file mode 100644 index 5b34ac1..0000000 --- a/docs/interfaces/IteratorReturnResult.html +++ /dev/null @@ -1,3 +0,0 @@ -IteratorReturnResult | VFX-JS

Interface IteratorReturnResult<TReturn>

interface IteratorReturnResult<TReturn> {
    done: true;
    value: TReturn;
}

Type Parameters

  • TReturn

Properties

done -value -

Properties

done

done: true

value

value: TReturn

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/IteratorYieldResult.html b/docs/interfaces/IteratorYieldResult.html deleted file mode 100644 index 5358c91..0000000 --- a/docs/interfaces/IteratorYieldResult.html +++ /dev/null @@ -1,3 +0,0 @@ -IteratorYieldResult | VFX-JS

Interface IteratorYieldResult<TYield>

interface IteratorYieldResult<TYield> {
    done?: false;
    value: TYield;
}

Type Parameters

  • TYield

Properties

done? -value -

Properties

Optionaldone

done?: false

value

value: TYield

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/JSONMeta.html b/docs/interfaces/JSONMeta.html deleted file mode 100644 index 06cecaf..0000000 --- a/docs/interfaces/JSONMeta.html +++ /dev/null @@ -1,9 +0,0 @@ -JSONMeta | VFX-JS

Interface JSONMeta

interface JSONMeta {
    geometries: Record<string, BufferGeometryJSON>;
    materials: Record<string, MaterialJSON>;
    textures: Record<string, TextureJSON>;
    images: Record<string, SourceJSON>;
    shapes: Record<string, ShapeJSON>;
    skeletons: Record<string, SkeletonJSON>;
    animations: Record<string, AnimationClipJSON>;
    nodes: Record<string, unknown>;
}

Properties

geometries -materials -textures -images -shapes -skeletons -animations -nodes -

Properties

geometries

geometries: Record<string, BufferGeometryJSON>

materials

materials: Record<string, MaterialJSON>

textures

textures: Record<string, TextureJSON>

images

images: Record<string, SourceJSON>

shapes

shapes: Record<string, ShapeJSON>

skeletons

skeletons: Record<string, SkeletonJSON>

animations

animations: Record<string, AnimationClipJSON>

nodes

nodes: Record<string, unknown>

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/KeyframeTrackJSON.html b/docs/interfaces/KeyframeTrackJSON.html deleted file mode 100644 index ec93b6e..0000000 --- a/docs/interfaces/KeyframeTrackJSON.html +++ /dev/null @@ -1,6 +0,0 @@ -KeyframeTrackJSON | VFX-JS

Interface KeyframeTrackJSON

interface KeyframeTrackJSON {
    name: string;
    times: number[];
    values: number[];
    interpolation?: InterpolationModes;
    type: string;
}

Properties

name -times -values -interpolation? -type -

Properties

name

name: string

times

times: number[]

values

values: number[]

Optionalinterpolation

interpolation?: InterpolationModes

type

type: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/LightJSON.html b/docs/interfaces/LightJSON.html deleted file mode 100644 index 0971151..0000000 --- a/docs/interfaces/LightJSON.html +++ /dev/null @@ -1,12 +0,0 @@ -LightJSON | VFX-JS

Interface LightJSON

interface LightJSON {
    color: number;
    intensity: number;
    groundColor?: number;
    distance?: number;
    angle?: number;
    decay?: number;
    penumbra?: number;
    shadow?: LightShadowJSON;
    target?: string;
    metadata?: { version: number; type: string; generator: string };
    object: Object3DJSONObject;
}

Hierarchy (View Summary)

Properties

color -intensity -groundColor? -distance? -angle? -decay? -penumbra? -shadow? -target? -metadata? -object -

Properties

color

color: number

intensity

intensity: number

OptionalgroundColor

groundColor?: number

Optionaldistance

distance?: number

Optionalangle

angle?: number

Optionaldecay

decay?: number

Optionalpenumbra

penumbra?: number

Optionalshadow

shadow?: LightShadowJSON

Optionaltarget

target?: string

Optionalmetadata

metadata?: { version: number; type: string; generator: string }

object

object: Object3DJSONObject

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/LightShadowJSON.html b/docs/interfaces/LightShadowJSON.html deleted file mode 100644 index 4c74f7f..0000000 --- a/docs/interfaces/LightShadowJSON.html +++ /dev/null @@ -1,7 +0,0 @@ -LightShadowJSON | VFX-JS

Interface LightShadowJSON

interface LightShadowJSON {
    intensity?: number;
    bias?: number;
    normalBias?: number;
    radius?: number;
    mapSize?: Vector2Tuple;
    camera: Omit<Object3DJSONObject, "matrix">;
}

Properties

intensity? -bias? -normalBias? -radius? -mapSize? -camera -

Properties

Optionalintensity

intensity?: number

Optionalbias

bias?: number

OptionalnormalBias

normalBias?: number

Optionalradius

radius?: number

OptionalmapSize

mapSize?: Vector2Tuple

camera

camera: Omit<Object3DJSONObject, "matrix">

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/MapIterator.html b/docs/interfaces/MapIterator.html deleted file mode 100644 index e07ff7c..0000000 --- a/docs/interfaces/MapIterator.html +++ /dev/null @@ -1,5 +0,0 @@ -MapIterator | VFX-JS

Interface MapIterator<T>

interface MapIterator<T> {
    "[iterator]"(): MapIterator<T>;
    next(...__namedParameters: [] | [unknown]): IteratorResult<T, undefined>;
    return(value?: undefined): IteratorResult<T, undefined>;
    throw(e?: any): IteratorResult<T, undefined>;
}

Type Parameters

  • T

Hierarchy

Methods

[iterator] -next -return? -throw? -

Methods

[iterator]

  • "[iterator]"(): MapIterator<T>

  • Returns MapIterator<T>

next

  • next(...__namedParameters: [] | [unknown]): IteratorResult<T, undefined>

  • Parameters

    • ...__namedParameters: [] | [unknown]

    Returns IteratorResult<T, undefined>

Optionalreturn

  • return(value?: undefined): IteratorResult<T, undefined>

  • Parameters

    • Optionalvalue: undefined

    Returns IteratorResult<T, undefined>

Optionalthrow

  • throw(e?: any): IteratorResult<T, undefined>

  • Parameters

    • Optionale: any

    Returns IteratorResult<T, undefined>

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/interfaces/MaterialJSON.html b/docs/interfaces/MaterialJSON.html deleted file mode 100644 index 4b1fa14..0000000 --- a/docs/interfaces/MaterialJSON.html +++ /dev/null @@ -1,119 +0,0 @@ -MaterialJSON | VFX-JS

Interface MaterialJSON

interface MaterialJSON {
    metadata: { version: number; type: string; generator: string };
    uuid: string;
    type: string;
    name?: string;
    color?: number;
    roughness?: number;
    metalness?: number;
    sheen?: number;
    sheenColor?: number;
    sheenRoughness?: number;
    emissive?: number;
    emissiveIntensity?: number;
    specular?: number;
    specularIntensity?: number;
    specularColor?: number;
    shininess?: number;
    clearcoat?: number;
    clearcoatRoughness?: number;
    clearcoatMap?: string;
    clearcoatRoughnessMap?: string;
    clearcoatNormalMap?: string;
    clearcoatNormalScale?: Vector2Tuple;
    dispersion?: number;
    iridescence?: number;
    iridescenceIOR?: number;
    iridescenceThicknessRange?: number;
    iridescenceMap?: string;
    iridescenceThicknessMap?: string;
    anisotropy?: number;
    anisotropyRotation?: number;
    anisotropyMap?: string;
    map?: string;
    matcap?: string;
    alphaMap?: string;
    lightMap?: string;
    lightMapIntensity?: number;
    aoMap?: string;
    aoMapIntensity?: number;
    bumpMap?: string;
    bumpScale?: number;
    normalMap?: string;
    normalMapType?: NormalMapTypes;
    normalScale?: Vector2Tuple;
    displacementMap?: string;
    displacementScale?: number;
    displacementBias?: number;
    roughnessMap?: string;
    metalnessMap?: string;
    emissiveMap?: string;
    specularMap?: string;
    specularIntensityMap?: string;
    specularColorMap?: string;
    envMap?: string;
    combine?: Combine;
    envMapRotation?: EulerTuple;
    envMapIntensity?: number;
    reflectivity?: number;
    refractionRatio?: number;
    gradientMap?: string;
    transmission?: number;
    transmissionMap?: string;
    thickness?: number;
    thicknessMap?: string;
    attenuationDistance?: number;
    attenuationColor?: number;
    size?: number;
    shadowSide?: number;
    sizeAttenuation?: boolean;
    blending?: Blending;
    side?: Side;
    vertexColors?: boolean;
    opacity?: number;
    transparent?: boolean;
    blendSrc?: BlendingSrcFactor;
    blendDst?: BlendingDstFactor;
    blendEquation?: BlendingEquation;
    blendSrcAlpha?: null | number;
    blendDstAlpha?: null | number;
    blendEquationAlpha?: null | number;
    blendColor?: number;
    blendAlpha?: number;
    depthFunc?: DepthModes;
    depthTest?: boolean;
    depthWrite?: boolean;
    colorWrite?: boolean;
    stencilWriteMask?: number;
    stencilFunc?: StencilFunc;
    stencilRef?: number;
    stencilFuncMask?: number;
    stencilFail?: StencilOp;
    stencilZFail?: StencilOp;
    stencilZPass?: StencilOp;
    stencilWrite?: boolean;
    rotation?: number;
    polygonOffset?: boolean;
    polygonOffsetFactor?: number;
    polygonOffsetUnits?: number;
    linewidth?: number;
    dashSize?: number;
    gapSize?: number;
    scale?: number;
    dithering?: boolean;
    alphaTest?: number;
    alphaHash?: boolean;
    alphaToCoverage?: boolean;
    premultipliedAlpha?: boolean;
    forceSinglePass?: boolean;
    wireframe?: boolean;
    wireframeLinewidth?: number;
    wireframeLinecap?: string;
    wireframeLinejoin?: string;
    flatShading?: boolean;
    visible?: boolean;
    toneMapped?: boolean;
    fog?: boolean;
    userData?: Record<string, unknown>;
    textures?: Omit<TextureJSON, "metadata">[];
    images?: SourceJSON[];
}

Properties

metadata -uuid -type -name? -color? -roughness? -metalness? -sheen? -sheenColor? -sheenRoughness? -emissive? -emissiveIntensity? -specular? -specularIntensity? -specularColor? -shininess? -clearcoat? -clearcoatRoughness? -clearcoatMap? -clearcoatRoughnessMap? -clearcoatNormalMap? -clearcoatNormalScale? -dispersion? -iridescence? -iridescenceIOR? -iridescenceThicknessRange? -iridescenceMap? -iridescenceThicknessMap? -anisotropy? -anisotropyRotation? -anisotropyMap? -map? -matcap? -alphaMap? -lightMap? -lightMapIntensity? -aoMap? -aoMapIntensity? -bumpMap? -bumpScale? -normalMap? -normalMapType? -normalScale? -displacementMap? -displacementScale? -displacementBias? -roughnessMap? -metalnessMap? -emissiveMap? -specularMap? -specularIntensityMap? -specularColorMap? -envMap? -combine? -envMapRotation? -envMapIntensity? -reflectivity? -refractionRatio? -gradientMap? -transmission? -transmissionMap? -thickness? -thicknessMap? -attenuationDistance? -attenuationColor? -size? -shadowSide? -sizeAttenuation? -blending? -side? -vertexColors? -opacity? -transparent? -blendSrc? -blendDst? -blendEquation? -blendSrcAlpha? -blendDstAlpha? -blendEquationAlpha? -blendColor? -blendAlpha? -depthFunc? -depthTest? -depthWrite? -colorWrite? -stencilWriteMask? -stencilFunc? -stencilRef? -stencilFuncMask? -stencilFail? -stencilZFail? -stencilZPass? -stencilWrite? -rotation? -polygonOffset? -polygonOffsetFactor? -polygonOffsetUnits? -linewidth? -dashSize? -gapSize? -scale? -dithering? -alphaTest? -alphaHash? -alphaToCoverage? -premultipliedAlpha? -forceSinglePass? -wireframe? -wireframeLinewidth? -wireframeLinecap? -wireframeLinejoin? -flatShading? -visible? -toneMapped? -fog? -userData? -textures? -images? -

Properties

metadata

metadata: { version: number; type: string; generator: string }

uuid

uuid: string

type

type: string

Optionalname

name?: string

Optionalcolor

color?: number

Optionalroughness

roughness?: number

Optionalmetalness

metalness?: number

Optionalsheen

sheen?: number

OptionalsheenColor

sheenColor?: number

OptionalsheenRoughness

sheenRoughness?: number

Optionalemissive

emissive?: number

OptionalemissiveIntensity

emissiveIntensity?: number

Optionalspecular

specular?: number

OptionalspecularIntensity

specularIntensity?: number

OptionalspecularColor

specularColor?: number

Optionalshininess

shininess?: number

Optionalclearcoat

clearcoat?: number

OptionalclearcoatRoughness

clearcoatRoughness?: number

OptionalclearcoatMap

clearcoatMap?: string

OptionalclearcoatRoughnessMap

clearcoatRoughnessMap?: string

OptionalclearcoatNormalMap

clearcoatNormalMap?: string

OptionalclearcoatNormalScale

clearcoatNormalScale?: Vector2Tuple

Optionaldispersion

dispersion?: number

Optionaliridescence

iridescence?: number

OptionaliridescenceIOR

iridescenceIOR?: number

OptionaliridescenceThicknessRange

iridescenceThicknessRange?: number

OptionaliridescenceMap

iridescenceMap?: string

OptionaliridescenceThicknessMap

iridescenceThicknessMap?: string

Optionalanisotropy

anisotropy?: number

OptionalanisotropyRotation

anisotropyRotation?: number

OptionalanisotropyMap

anisotropyMap?: string

Optionalmap

map?: string

Optionalmatcap

matcap?: string

OptionalalphaMap

alphaMap?: string

OptionallightMap

lightMap?: string

OptionallightMapIntensity

lightMapIntensity?: number

OptionalaoMap

aoMap?: string

OptionalaoMapIntensity

aoMapIntensity?: number

OptionalbumpMap

bumpMap?: string

OptionalbumpScale

bumpScale?: number

OptionalnormalMap

normalMap?: string

OptionalnormalMapType

normalMapType?: NormalMapTypes

OptionalnormalScale

normalScale?: Vector2Tuple

OptionaldisplacementMap

displacementMap?: string

OptionaldisplacementScale

displacementScale?: number

OptionaldisplacementBias

displacementBias?: number

OptionalroughnessMap

roughnessMap?: string

OptionalmetalnessMap

metalnessMap?: string

OptionalemissiveMap

emissiveMap?: string

OptionalspecularMap

specularMap?: string

OptionalspecularIntensityMap

specularIntensityMap?: string

OptionalspecularColorMap

specularColorMap?: string

OptionalenvMap

envMap?: string

Optionalcombine

combine?: Combine

OptionalenvMapRotation

envMapRotation?: EulerTuple

OptionalenvMapIntensity

envMapIntensity?: number

Optionalreflectivity

reflectivity?: number

OptionalrefractionRatio

refractionRatio?: number

OptionalgradientMap

gradientMap?: string

Optionaltransmission

transmission?: number

OptionaltransmissionMap

transmissionMap?: string

Optionalthickness

thickness?: number

OptionalthicknessMap

thicknessMap?: string

OptionalattenuationDistance

attenuationDistance?: number

OptionalattenuationColor

attenuationColor?: number

Optionalsize

size?: number

OptionalshadowSide

shadowSide?: number

OptionalsizeAttenuation

sizeAttenuation?: boolean

Optionalblending

blending?: Blending

Optionalside

side?: Side

OptionalvertexColors

vertexColors?: boolean

Optionalopacity

opacity?: number

Optionaltransparent

transparent?: boolean

OptionalblendSrc

blendSrc?: BlendingSrcFactor

OptionalblendDst

blendDst?: BlendingDstFactor

OptionalblendEquation

blendEquation?: BlendingEquation

OptionalblendSrcAlpha

blendSrcAlpha?: null | number

OptionalblendDstAlpha

blendDstAlpha?: null | number

OptionalblendEquationAlpha

blendEquationAlpha?: null | number

OptionalblendColor

blendColor?: number

OptionalblendAlpha

blendAlpha?: number

OptionaldepthFunc

depthFunc?: DepthModes

OptionaldepthTest

depthTest?: boolean

OptionaldepthWrite

depthWrite?: boolean

OptionalcolorWrite

colorWrite?: boolean

OptionalstencilWriteMask

stencilWriteMask?: number

OptionalstencilFunc

stencilFunc?: StencilFunc

OptionalstencilRef

stencilRef?: number

OptionalstencilFuncMask

stencilFuncMask?: number

OptionalstencilFail

stencilFail?: StencilOp

OptionalstencilZFail

stencilZFail?: StencilOp

OptionalstencilZPass

stencilZPass?: StencilOp

OptionalstencilWrite

stencilWrite?: boolean

Optionalrotation

rotation?: number

OptionalpolygonOffset

polygonOffset?: boolean

OptionalpolygonOffsetFactor

polygonOffsetFactor?: number

OptionalpolygonOffsetUnits

polygonOffsetUnits?: number

Optionallinewidth

linewidth?: number

OptionaldashSize

dashSize?: number

OptionalgapSize

gapSize?: number

Optionalscale

scale?: number

Optionaldithering

dithering?: boolean

OptionalalphaTest

alphaTest?: number

OptionalalphaHash

alphaHash?: boolean

OptionalalphaToCoverage

alphaToCoverage?: boolean

OptionalpremultipliedAlpha

premultipliedAlpha?: boolean

OptionalforceSinglePass

forceSinglePass?: boolean

Optionalwireframe

wireframe?: boolean

OptionalwireframeLinewidth

wireframeLinewidth?: number

OptionalwireframeLinecap

wireframeLinecap?: string

OptionalwireframeLinejoin

wireframeLinejoin?: string

OptionalflatShading

flatShading?: boolean

Optionalvisible

visible?: boolean

OptionaltoneMapped

toneMapped?: boolean

Optionalfog

fog?: boolean

OptionaluserData

userData?: Record<string, unknown>

Optionaltextures

textures?: Omit<TextureJSON, "metadata">[]

Optionalimages

images?: SourceJSON[]

Settings

Member Visibility

On This Page

Properties
metadatauuidtypenamecolorroughnessmetalnesssheensheenColorsheenRoughnessemissiveemissiveIntensityspecularspecularIntensityspecularColorshininessclearcoatclearcoatRoughnessclearcoatMapclearcoatRoughnessMapclearcoatNormalMapclearcoatNormalScaledispersioniridescenceiridescenceIORiridescenceThicknessRangeiridescenceMapiridescenceThicknessMapanisotropyanisotropyRotationanisotropyMapmapmatcapalphaMaplightMaplightMapIntensityaoMapaoMapIntensitybumpMapbumpScalenormalMapnormalMapTypenormalScaledisplacementMapdisplacementScaledisplacementBiasroughnessMapmetalnessMapemissiveMapspecularMapspecularIntensityMapspecularColorMapenvMapcombineenvMapRotationenvMapIntensityreflectivityrefractionRatiogradientMaptransmissiontransmissionMapthicknessthicknessMapattenuationDistanceattenuationColorsizeshadowSidesizeAttenuationblendingsidevertexColorsopacitytransparentblendSrcblendDstblendEquationblendSrcAlphablendDstAlphablendEquationAlphablendColorblendAlphadepthFuncdepthTestdepthWritecolorWritestencilWriteMaskstencilFuncstencilRefstencilFuncMaskstencilFailstencilZFailstencilZPassstencilWriterotationpolygonOffsetpolygonOffsetFactorpolygonOffsetUnitslinewidthdashSizegapSizescaleditheringalphaTestalphaHashalphaToCoveragepremultipliedAlphaforceSinglePasswireframewireframeLinewidthwireframeLinecapwireframeLinejoinflatShadingvisibletoneMappedfoguserDatatexturesimages
diff --git a/docs/interfaces/MaterialParameters.html b/docs/interfaces/MaterialParameters.html deleted file mode 100644 index 140b192..0000000 --- a/docs/interfaces/MaterialParameters.html +++ /dev/null @@ -1,46 +0,0 @@ -MaterialParameters | VFX-JS

Interface MaterialParameters

interface MaterialParameters {
    alphaHash?: boolean;
    alphaTest?: number;
    alphaToCoverage?: boolean;
    blendAlpha?: number;
    blendColor?: ColorRepresentation;
    blendDst?: BlendingDstFactor;
    blendDstAlpha?: number;
    blendEquation?: BlendingEquation;
    blendEquationAlpha?: number;
    blending?: Blending;
    blendSrc?:
        | 200
        | 201
        | 202
        | 203
        | 204
        | 205
        | 206
        | 207
        | 208
        | 209
        | 211
        | 212
        | 213
        | 214
        | 210;
    blendSrcAlpha?: number;
    clipIntersection?: boolean;
    clippingPlanes?: Plane[];
    clipShadows?: boolean;
    colorWrite?: boolean;
    defines?: any;
    depthFunc?: DepthModes;
    depthTest?: boolean;
    depthWrite?: boolean;
    name?: string;
    opacity?: number;
    polygonOffset?: boolean;
    polygonOffsetFactor?: number;
    polygonOffsetUnits?: number;
    precision?: null
    | "highp"
    | "mediump"
    | "lowp";
    premultipliedAlpha?: boolean;
    forceSinglePass?: boolean;
    dithering?: boolean;
    side?: Side;
    shadowSide?: Side;
    toneMapped?: boolean;
    transparent?: boolean;
    vertexColors?: boolean;
    visible?: boolean;
    format?: PixelFormat;
    stencilWrite?: boolean;
    stencilFunc?: StencilFunc;
    stencilRef?: number;
    stencilWriteMask?: number;
    stencilFuncMask?: number;
    stencilFail?: StencilOp;
    stencilZFail?: StencilOp;
    stencilZPass?: StencilOp;
    userData?: Record<string, any>;
}

Hierarchy (View Summary)

Properties

alphaHash? -alphaTest? -alphaToCoverage? -blendAlpha? -blendColor? -blendDst? -blendDstAlpha? -blendEquation? -blendEquationAlpha? -blending? -blendSrc? -blendSrcAlpha? -clipIntersection? -clippingPlanes? -clipShadows? -colorWrite? -defines? -depthFunc? -depthTest? -depthWrite? -name? -opacity? -polygonOffset? -polygonOffsetFactor? -polygonOffsetUnits? -precision? -premultipliedAlpha? -forceSinglePass? -dithering? -side? -shadowSide? -toneMapped? -transparent? -vertexColors? -visible? -format? -stencilWrite? -stencilFunc? -stencilRef? -stencilWriteMask? -stencilFuncMask? -stencilFail? -stencilZFail? -stencilZPass? -userData? -

Properties

OptionalalphaHash

alphaHash?: boolean

OptionalalphaTest

alphaTest?: number

OptionalalphaToCoverage

alphaToCoverage?: boolean

OptionalblendAlpha

blendAlpha?: number

OptionalblendColor

blendColor?: ColorRepresentation

OptionalblendDst

blendDst?: BlendingDstFactor

OptionalblendDstAlpha

blendDstAlpha?: number

OptionalblendEquation

blendEquation?: BlendingEquation

OptionalblendEquationAlpha

blendEquationAlpha?: number

Optionalblending

blending?: Blending

OptionalblendSrc

blendSrc?:
    | 200
    | 201
    | 202
    | 203
    | 204
    | 205
    | 206
    | 207
    | 208
    | 209
    | 211
    | 212
    | 213
    | 214
    | 210

OptionalblendSrcAlpha

blendSrcAlpha?: number

OptionalclipIntersection

clipIntersection?: boolean

OptionalclippingPlanes

clippingPlanes?: Plane[]

OptionalclipShadows

clipShadows?: boolean

OptionalcolorWrite

colorWrite?: boolean

Optionaldefines

defines?: any

OptionaldepthFunc

depthFunc?: DepthModes

OptionaldepthTest

depthTest?: boolean

OptionaldepthWrite

depthWrite?: boolean

Optionalname

name?: string

Optionalopacity

opacity?: number

OptionalpolygonOffset

polygonOffset?: boolean

OptionalpolygonOffsetFactor

polygonOffsetFactor?: number

OptionalpolygonOffsetUnits

polygonOffsetUnits?: number

Optionalprecision

precision?: null | "highp" | "mediump" | "lowp"

OptionalpremultipliedAlpha

premultipliedAlpha?: boolean

OptionalforceSinglePass

forceSinglePass?: boolean

Optionaldithering

dithering?: boolean

Optionalside

side?: Side

OptionalshadowSide

shadowSide?: Side

OptionaltoneMapped

toneMapped?: boolean

Optionaltransparent

transparent?: boolean

OptionalvertexColors

vertexColors?: boolean

Optionalvisible

visible?: boolean

Optionalformat

format?: PixelFormat

OptionalstencilWrite

stencilWrite?: boolean

OptionalstencilFunc

stencilFunc?: StencilFunc

OptionalstencilRef

stencilRef?: number

OptionalstencilWriteMask

stencilWriteMask?: number

OptionalstencilFuncMask

stencilFuncMask?: number

OptionalstencilFail

stencilFail?: StencilOp

OptionalstencilZFail

stencilZFail?: StencilOp

OptionalstencilZPass

stencilZPass?: StencilOp

OptionaluserData

userData?: Record<string, any>

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/MeshJSON.html b/docs/interfaces/MeshJSON.html deleted file mode 100644 index ca5dd38..0000000 --- a/docs/interfaces/MeshJSON.html +++ /dev/null @@ -1,3 +0,0 @@ -MeshJSON | VFX-JS

Interface MeshJSON

interface MeshJSON {
    object: MeshJSONObject;
    metadata?: { version: number; type: string; generator: string };
}

Hierarchy (View Summary)

Properties

object -metadata? -

Properties

object

object: MeshJSONObject

Optionalmetadata

metadata?: { version: number; type: string; generator: string }

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/MeshJSONObject.html b/docs/interfaces/MeshJSONObject.html deleted file mode 100644 index ed3fa17..0000000 --- a/docs/interfaces/MeshJSONObject.html +++ /dev/null @@ -1,18 +0,0 @@ -MeshJSONObject | VFX-JS

Interface MeshJSONObject

interface MeshJSONObject {
    geometry: string;
    uuid: string;
    type: string;
    name?: string;
    castShadow?: boolean;
    receiveShadow?: boolean;
    visible?: boolean;
    frustumCulled?: boolean;
    renderOrder?: number;
    userData?: Record<string, unknown>;
    layers: number;
    matrix: Matrix4Tuple;
    up: Vector3Tuple;
    matrixAutoUpdate?: boolean;
    material?: string | string[];
    children?: string[];
    animations?: string[];
}

Hierarchy (View Summary)

Properties

geometry -uuid -type -name? -castShadow? -receiveShadow? -visible? -frustumCulled? -renderOrder? -userData? -layers -matrix -up -matrixAutoUpdate? -material? -children? -animations? -

Properties

geometry

geometry: string

uuid

uuid: string

type

type: string

Optionalname

name?: string

OptionalcastShadow

castShadow?: boolean

OptionalreceiveShadow

receiveShadow?: boolean

Optionalvisible

visible?: boolean

OptionalfrustumCulled

frustumCulled?: boolean

OptionalrenderOrder

renderOrder?: number

OptionaluserData

userData?: Record<string, unknown>

layers

layers: number

matrix

matrix: Matrix4Tuple

up

up: Vector3Tuple

OptionalmatrixAutoUpdate

matrixAutoUpdate?: boolean

Optionalmaterial

material?: string | string[]

Optionalchildren

children?: string[]

Optionalanimations

animations?: string[]

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/MorphTarget.html b/docs/interfaces/MorphTarget.html deleted file mode 100644 index 5c4f457..0000000 --- a/docs/interfaces/MorphTarget.html +++ /dev/null @@ -1,3 +0,0 @@ -MorphTarget | VFX-JS

Interface MorphTarget

interface MorphTarget {
    name: string;
    vertices: Vector3[];
}

Properties

name -vertices -

Properties

name

name: string

vertices

vertices: Vector3[]

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Object3DEventMap.html b/docs/interfaces/Object3DEventMap.html deleted file mode 100644 index 753c680..0000000 --- a/docs/interfaces/Object3DEventMap.html +++ /dev/null @@ -1,9 +0,0 @@ -Object3DEventMap | VFX-JS

Interface Object3DEventMap

interface Object3DEventMap {
    added: {};
    removed: {};
    childadded: { child: Object3D };
    childremoved: { child: Object3D };
}

Hierarchy (View Summary)

Properties

added -removed -childadded -childremoved -

Properties

added

added: {}

Fires when the object has been added to its parent object.

-

removed

removed: {}

Fires when the object has been removed from its parent object.

-

childadded

childadded: { child: Object3D }

Fires when a new child object has been added.

-

childremoved

childremoved: { child: Object3D }

Fires when a new child object has been removed.

-

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Object3DJSON.html b/docs/interfaces/Object3DJSON.html deleted file mode 100644 index 1b5139e..0000000 --- a/docs/interfaces/Object3DJSON.html +++ /dev/null @@ -1,3 +0,0 @@ -Object3DJSON | VFX-JS

Interface Object3DJSON

interface Object3DJSON {
    metadata?: { version: number; type: string; generator: string };
    object: Object3DJSONObject;
}

Hierarchy (View Summary)

Properties

metadata? -object -

Properties

Optionalmetadata

metadata?: { version: number; type: string; generator: string }

object

object: Object3DJSONObject

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Object3DJSONObject.html b/docs/interfaces/Object3DJSONObject.html deleted file mode 100644 index 911dd3a..0000000 --- a/docs/interfaces/Object3DJSONObject.html +++ /dev/null @@ -1,17 +0,0 @@ -Object3DJSONObject | VFX-JS

Interface Object3DJSONObject

interface Object3DJSONObject {
    uuid: string;
    type: string;
    name?: string;
    castShadow?: boolean;
    receiveShadow?: boolean;
    visible?: boolean;
    frustumCulled?: boolean;
    renderOrder?: number;
    userData?: Record<string, unknown>;
    layers: number;
    matrix: Matrix4Tuple;
    up: Vector3Tuple;
    matrixAutoUpdate?: boolean;
    material?: string | string[];
    children?: string[];
    animations?: string[];
}

Hierarchy (View Summary)

Properties

uuid -type -name? -castShadow? -receiveShadow? -visible? -frustumCulled? -renderOrder? -userData? -layers -matrix -up -matrixAutoUpdate? -material? -children? -animations? -

Properties

uuid

uuid: string

type

type: string

Optionalname

name?: string

OptionalcastShadow

castShadow?: boolean

OptionalreceiveShadow

receiveShadow?: boolean

Optionalvisible

visible?: boolean

OptionalfrustumCulled

frustumCulled?: boolean

OptionalrenderOrder

renderOrder?: number

OptionaluserData

userData?: Record<string, unknown>

layers

layers: number

matrix

matrix: Matrix4Tuple

up

up: Vector3Tuple

OptionalmatrixAutoUpdate

matrixAutoUpdate?: boolean

Optionalmaterial

material?: string | string[]

Optionalchildren

children?: string[]

Optionalanimations

animations?: string[]

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/OffscreenCanvas.html b/docs/interfaces/OffscreenCanvas.html deleted file mode 100644 index 7c28e5f..0000000 --- a/docs/interfaces/OffscreenCanvas.html +++ /dev/null @@ -1,17 +0,0 @@ -OffscreenCanvas | VFX-JS

Interface OffscreenCanvas

Shim for OffscreenCanvas.

-
interface OffscreenCanvas {
    addEventListener(
        type: string,
        callback: null | EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    dispatchEvent(event: Event): boolean;
    removeEventListener(
        type: string,
        callback: null | EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
}

Hierarchy

  • EventTarget
    • OffscreenCanvas

Methods

addEventListener -dispatchEvent -removeEventListener -

Methods

addEventListener

  • addEventListener(
        type: string,
        callback: null | EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    -

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    -

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    -

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    -

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    -

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    -

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    -

    MDN Reference

    -

    Parameters

    Returns void

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    -

    MDN Reference

    -

    Parameters

    • event: Event

    Returns boolean

removeEventListener

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/interfaces/PathJSON.html b/docs/interfaces/PathJSON.html deleted file mode 100644 index 8b105a0..0000000 --- a/docs/interfaces/PathJSON.html +++ /dev/null @@ -1,7 +0,0 @@ -PathJSON | VFX-JS

Interface PathJSON

interface PathJSON {
    currentPoint: Vector2Tuple;
    autoClose: boolean;
    curves: CurveJSON[];
    metadata: { version: number; type: string; generator: string };
    arcLengthDivisions: number;
    type: string;
}

Hierarchy (View Summary)

Properties

currentPoint -autoClose -curves -metadata -arcLengthDivisions -type -

Properties

currentPoint

currentPoint: Vector2Tuple

autoClose

autoClose: boolean

curves

curves: CurveJSON[]

metadata

metadata: { version: number; type: string; generator: string }

arcLengthDivisions

arcLengthDivisions: number

type

type: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/PerspectiveCameraJSON.html b/docs/interfaces/PerspectiveCameraJSON.html deleted file mode 100644 index ebf809e..0000000 --- a/docs/interfaces/PerspectiveCameraJSON.html +++ /dev/null @@ -1,3 +0,0 @@ -PerspectiveCameraJSON | VFX-JS

Interface PerspectiveCameraJSON

interface PerspectiveCameraJSON {
    object: PerspectiveCameraJSONObject;
    metadata?: { version: number; type: string; generator: string };
}

Hierarchy (View Summary)

Properties

object -metadata? -

Properties

object

object: PerspectiveCameraJSONObject

Optionalmetadata

metadata?: { version: number; type: string; generator: string }

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/PerspectiveCameraJSONObject.html b/docs/interfaces/PerspectiveCameraJSONObject.html deleted file mode 100644 index d808a24..0000000 --- a/docs/interfaces/PerspectiveCameraJSONObject.html +++ /dev/null @@ -1,26 +0,0 @@ -PerspectiveCameraJSONObject | VFX-JS

Interface PerspectiveCameraJSONObject

interface PerspectiveCameraJSONObject {
    fov: number;
    zoom: number;
    near: number;
    far: number;
    focus: number;
    aspect: number;
    view?: {
        enabled: boolean;
        fullWidth: number;
        fullHeight: number;
        offsetX: number;
        offsetY: number;
        width: number;
        height: number;
    };
    filmGauge: number;
    filmOffset: number;
    uuid: string;
    type: string;
    name?: string;
    castShadow?: boolean;
    receiveShadow?: boolean;
    visible?: boolean;
    frustumCulled?: boolean;
    renderOrder?: number;
    userData?: Record<string, unknown>;
    layers: number;
    matrix: Matrix4Tuple;
    up: Vector3Tuple;
    matrixAutoUpdate?: boolean;
    material?: string | string[];
    children?: string[];
    animations?: string[];
}

Hierarchy (View Summary)

Properties

fov -zoom -near -far -focus -aspect -view? -filmGauge -filmOffset -uuid -type -name? -castShadow? -receiveShadow? -visible? -frustumCulled? -renderOrder? -userData? -layers -matrix -up -matrixAutoUpdate? -material? -children? -animations? -

Properties

fov

fov: number

zoom

zoom: number

near

near: number

far

far: number

focus

focus: number

aspect

aspect: number

Optionalview

view?: {
    enabled: boolean;
    fullWidth: number;
    fullHeight: number;
    offsetX: number;
    offsetY: number;
    width: number;
    height: number;
}

filmGauge

filmGauge: number

filmOffset

filmOffset: number

uuid

uuid: string

type

type: string

Optionalname

name?: string

OptionalcastShadow

castShadow?: boolean

OptionalreceiveShadow

receiveShadow?: boolean

Optionalvisible

visible?: boolean

OptionalfrustumCulled

frustumCulled?: boolean

OptionalrenderOrder

renderOrder?: number

OptionaluserData

userData?: Record<string, unknown>

layers

layers: number

matrix

matrix: Matrix4Tuple

up

up: Vector3Tuple

OptionalmatrixAutoUpdate

matrixAutoUpdate?: boolean

Optionalmaterial

material?: string | string[]

Optionalchildren

children?: string[]

Optionalanimations

animations?: string[]

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/PlaneLayout.html b/docs/interfaces/PlaneLayout.html deleted file mode 100644 index 5d7ec6b..0000000 --- a/docs/interfaces/PlaneLayout.html +++ /dev/null @@ -1,3 +0,0 @@ -PlaneLayout | VFX-JS

Interface PlaneLayout

interface PlaneLayout {
    offset: number;
    stride: number;
}

Properties

offset -stride -

Properties

offset

offset: number

stride

stride: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/ProgressEvent.html b/docs/interfaces/ProgressEvent.html deleted file mode 100644 index 1456b6f..0000000 --- a/docs/interfaces/ProgressEvent.html +++ /dev/null @@ -1,63 +0,0 @@ -ProgressEvent | VFX-JS

Interface ProgressEvent<T>

Events measuring progress of an underlying process, like an HTTP request (for an XMLHttpRequest, or the loading of the underlying resource of an ,