@react-three/drei 9.54.3 → 9.55.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -7
- package/core/PointerLockControls.d.ts +1 -1
- package/core/Reflector.js +4 -0
- package/core/index.cjs.js +1 -1
- package/core/index.js +1 -1
- package/core/useBVH.cjs.js +1 -1
- package/core/useBVH.d.ts +27 -1
- package/core/useBVH.js +62 -1
- package/index.cjs.js +1 -1
- package/index.js +1 -1
- package/native/index.cjs.js +1 -1
- package/native/index.js +1 -1
- package/package.json +5 -5
- package/web/index.cjs.js +1 -1
- package/web/index.js +1 -1
package/README.md
CHANGED
|
@@ -139,7 +139,7 @@ The `native` route of the library **does not** export `Html` or `Loader`. The de
|
|
|
139
139
|
<li><a href="#meshbounds">meshBounds</a></li>
|
|
140
140
|
<li><a href="#adaptivedpr">AdaptiveDpr</a></li>
|
|
141
141
|
<li><a href="#adaptiveevents">AdaptiveEvents</a></li>
|
|
142
|
-
<li><a href="#
|
|
142
|
+
<li><a href="#bvh">Bvh</a></li>
|
|
143
143
|
<li><a href="#performancemonitor">PerformanceMonitor</a></li>
|
|
144
144
|
</ul>
|
|
145
145
|
<li><a href="#portals">Portals</a></li>
|
|
@@ -2552,17 +2552,41 @@ Drop this component into your scene and it will switch off the raycaster while t
|
|
|
2552
2552
|
<AdaptiveEvents />
|
|
2553
2553
|
```
|
|
2554
2554
|
|
|
2555
|
-
####
|
|
2555
|
+
#### Bvh
|
|
2556
2556
|
|
|
2557
2557
|
[](https://drei.vercel.app/?path=/story/performance-usebvh--default-story)
|
|
2558
2558
|
|
|
2559
|
-
|
|
2559
|
+
An abstraction around [gkjohnson/three-mesh-bvh](https://github.com/gkjohnson/three-mesh-bvh) to speed up raycasting exponentially. Use this component to wrap your scene, a sub-graph, a model or single mesh, and it will automatically compute boundsTree and assign acceleratedRaycast. This component is side-effect free, once unmounted or disabled it will revert to the original raycast.
|
|
2560
2560
|
|
|
2561
|
-
```
|
|
2562
|
-
|
|
2563
|
-
|
|
2561
|
+
```tsx
|
|
2562
|
+
export interface BVHOptions {
|
|
2563
|
+
/** Split strategy, default: SAH (slowest to construct, fastest runtime, least memory) */
|
|
2564
|
+
splitStrategy?: 'CENTER' | 'AVERAGE' | 'SAH'
|
|
2565
|
+
/** Print out warnings encountered during tree construction, default: false */
|
|
2566
|
+
verbose?: boolean
|
|
2567
|
+
/** If true then the bounding box for the geometry is set once the BVH has been constructed, default: true */
|
|
2568
|
+
setBoundingBox?: boolean
|
|
2569
|
+
/** The maximum depth to allow the tree to build to, default: 40 */
|
|
2570
|
+
maxDepth?: number
|
|
2571
|
+
/** The number of triangles to aim for in a leaf node, default: 10 */
|
|
2572
|
+
maxLeafTris?: number
|
|
2573
|
+
}
|
|
2564
2574
|
|
|
2565
|
-
|
|
2575
|
+
export type BvhProps = BVHOptions &
|
|
2576
|
+
JSX.IntrinsicElements['group'] & {
|
|
2577
|
+
/**Enabled, default: true */
|
|
2578
|
+
enabled?: boolean
|
|
2579
|
+
/** Use .raycastFirst to retrieve hits which is generally faster, default: false */
|
|
2580
|
+
firstHitOnly?: boolean
|
|
2581
|
+
}
|
|
2582
|
+
```
|
|
2583
|
+
|
|
2584
|
+
```jsx
|
|
2585
|
+
<Canvas>
|
|
2586
|
+
<Bvh firstHitOnly>
|
|
2587
|
+
<Scene />
|
|
2588
|
+
</Bvh>
|
|
2589
|
+
</Canvas>
|
|
2566
2590
|
```
|
|
2567
2591
|
|
|
2568
2592
|
#### PerformanceMonitor
|
|
@@ -12,4 +12,4 @@ export declare type PointerLockControlsProps = ReactThreeFiber.Object3DNode<Poin
|
|
|
12
12
|
onUnlock?: (e?: THREE.Event) => void;
|
|
13
13
|
makeDefault?: boolean;
|
|
14
14
|
};
|
|
15
|
-
export declare const PointerLockControls: React.ForwardRefExoticComponent<Pick<PointerLockControlsProps, "attach" | "args" | "children" | "key" | "onUpdate" | "position" | "up" | "scale" | "rotation" | "matrix" | "quaternion" | "layers" | "dispose" | "addEventListener" | "hasEventListener" | "removeEventListener" | "dispatchEvent" | "onChange" | keyof import("@react-three/fiber/dist/declarations/src/core/events").EventHandlers | "camera" | "enabled" | "connect" | "disconnect" | "domElement" | "makeDefault" | "minPolarAngle" | "maxPolarAngle" | "isLocked" | "getDirection" | "moveForward" | "moveRight" | "lock" | "unlock" | "selector" | "onLock" | "onUnlock"> & React.RefAttributes<PointerLockControlsImpl>>;
|
|
15
|
+
export declare const PointerLockControls: React.ForwardRefExoticComponent<Pick<PointerLockControlsProps, "attach" | "args" | "children" | "key" | "onUpdate" | "position" | "up" | "scale" | "rotation" | "matrix" | "quaternion" | "layers" | "dispose" | "addEventListener" | "hasEventListener" | "removeEventListener" | "dispatchEvent" | "onChange" | keyof import("@react-three/fiber/dist/declarations/src/core/events").EventHandlers | "camera" | "enabled" | "connect" | "disconnect" | "domElement" | "makeDefault" | "minPolarAngle" | "maxPolarAngle" | "isLocked" | "pointerSpeed" | "getObject" | "getDirection" | "moveForward" | "moveRight" | "lock" | "unlock" | "selector" | "onLock" | "onUnlock"> & React.RefAttributes<PointerLockControlsImpl>>;
|
package/core/Reflector.js
CHANGED
|
@@ -9,6 +9,10 @@ import { MeshReflectorMaterial } from '../materials/MeshReflectorMaterial.js';
|
|
|
9
9
|
extend({
|
|
10
10
|
MeshReflectorMaterial
|
|
11
11
|
});
|
|
12
|
+
/**
|
|
13
|
+
* @deprecated Use MeshReflectorMaterial instead
|
|
14
|
+
*/
|
|
15
|
+
|
|
12
16
|
const Reflector = /*#__PURE__*/React.forwardRef(({
|
|
13
17
|
mixBlur = 0,
|
|
14
18
|
mixStrength = 0.5,
|
package/core/index.cjs.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("./Billboard.cjs.js"),r=require("./ScreenSpace.cjs.js"),s=require("./QuadraticBezierLine.cjs.js"),t=require("./CubicBezierLine.cjs.js"),o=require("./CatmullRomLine.cjs.js"),i=require("./Line.cjs.js"),a=require("./PositionalAudio.cjs.js"),u=require("./Text.cjs.js"),c=require("./Text3D.cjs.js"),n=require("./Effects.cjs.js"),j=require("./GradientTexture.cjs.js"),p=require("./Image.cjs.js"),x=require("./Edges.cjs.js"),l=require("./Trail.cjs.js"),d=require("./Sampler.cjs.js"),q=require("./ComputedAttribute.cjs.js"),m=require("./Clone.cjs.js"),
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("./Billboard.cjs.js"),r=require("./ScreenSpace.cjs.js"),s=require("./QuadraticBezierLine.cjs.js"),t=require("./CubicBezierLine.cjs.js"),o=require("./CatmullRomLine.cjs.js"),i=require("./Line.cjs.js"),a=require("./PositionalAudio.cjs.js"),u=require("./Text.cjs.js"),c=require("./Text3D.cjs.js"),n=require("./Effects.cjs.js"),j=require("./GradientTexture.cjs.js"),p=require("./Image.cjs.js"),x=require("./Edges.cjs.js"),l=require("./Trail.cjs.js"),d=require("./Sampler.cjs.js"),q=require("./ComputedAttribute.cjs.js"),m=require("./Clone.cjs.js"),h=require("./MarchingCubes.cjs.js"),C=require("./Decal.cjs.js"),M=require("./Svg.cjs.js"),S=require("./Gltf.cjs.js"),T=require("./AsciiRenderer.cjs.js"),f=require("./OrthographicCamera.cjs.js"),B=require("./PerspectiveCamera.cjs.js"),P=require("./CubeCamera.cjs.js"),b=require("./DeviceOrientationControls.cjs.js"),g=require("./FlyControls.cjs.js"),v=require("./MapControls.cjs.js"),A=require("./OrbitControls.cjs.js"),L=require("./TrackballControls.cjs.js"),k=require("./ArcballControls.cjs.js"),G=require("./TransformControls.cjs.js"),D=require("./PointerLockControls.cjs.js"),R=require("./FirstPersonControls.cjs.js"),E=require("./CameraControls.cjs.js"),w=require("./GizmoHelper.cjs.js"),z=require("./GizmoViewcube.cjs.js"),F=require("./GizmoViewport.cjs.js"),O=require("./Grid.cjs.js"),I=require("./useCubeTexture.cjs.js"),H=require("./useFBX.cjs.js"),V=require("./useGLTF.cjs.js"),y=require("./useKTX2.cjs.js"),Q=require("./useProgress.cjs.js"),X=require("./useTexture.cjs.js"),K=require("./useVideoTexture.cjs.js"),W=require("./Stats.cjs.js"),N=require("./useDepthBuffer.cjs.js"),U=require("./useAspect.cjs.js"),_=require("./useCamera.cjs.js"),J=require("./useDetectGPU.cjs.js"),Y=require("./useHelper.cjs.js"),Z=require("./useBVH.cjs.js"),$=require("./useContextBridge.cjs.js"),ee=require("./useAnimations.cjs.js"),re=require("./useFBO.cjs.js"),se=require("./useIntersect.cjs.js"),te=require("./useBoxProjectedEnv.cjs.js"),oe=require("./BBAnchor.cjs.js"),ie=require("./useTrailTexture.cjs.js"),ae=require("./CurveModifier.cjs.js"),ue=require("./MeshDistortMaterial.cjs.js"),ce=require("./MeshWobbleMaterial.cjs.js"),ne=require("./MeshReflectorMaterial.cjs.js"),je=require("./MeshRefractionMaterial.cjs.js"),pe=require("./MeshTransmissionMaterial.cjs.js"),xe=require("./PointMaterial.cjs.js"),le=require("./shaderMaterial.cjs.js"),de=require("./softShadows.cjs.js"),qe=require("./shapes.cjs.js"),me=require("./RoundedBox.cjs.js"),he=require("./ScreenQuad.cjs.js"),Ce=require("./Center.cjs.js"),Me=require("./Bounds.cjs.js"),Se=require("./CameraShake.cjs.js"),Te=require("./Float.cjs.js"),fe=require("./Stage.cjs.js"),Be=require("./Backdrop.cjs.js"),Pe=require("./Shadow.cjs.js"),be=require("./Caustics.cjs.js"),ge=require("./ContactShadows.cjs.js"),ve=require("./AccumulativeShadows.cjs.js"),Ae=require("./Reflector.cjs.js"),Le=require("./SpotLight.cjs.js"),ke=require("./Environment.cjs.js"),Ge=require("./Lightformer.cjs.js"),De=require("./Sky.cjs.js"),Re=require("./Stars.cjs.js"),Ee=require("./Cloud.cjs.js"),we=require("./Sparkles.cjs.js"),ze=require("./useMatcapTexture.cjs.js"),Fe=require("./useNormalTexture.cjs.js"),Oe=require("./Points.cjs.js"),Ie=require("./Instances.cjs.js"),He=require("./Segments.cjs.js"),Ve=require("./Detailed.cjs.js"),ye=require("./Preload.cjs.js"),Qe=require("./BakeShadows.cjs.js"),Xe=require("./meshBounds.cjs.js"),Ke=require("./AdaptiveDpr.cjs.js"),We=require("./AdaptiveEvents.cjs.js"),Ne=require("./PerformanceMonitor.cjs.js"),Ue=require("./RenderTexture.cjs.js"),_e=require("./Mask.cjs.js"),Je=require("./Hud.cjs.js");require("@babel/runtime/helpers/extends"),require("react"),require("@react-three/fiber"),require("react-merge-refs"),require("three"),require("three-stdlib"),require("troika-three-text"),require("suspend-react"),require("meshline"),require("lodash.pick"),require("lodash.omit"),require("camera-controls"),require("zustand"),require("stats.js"),require("../helpers/useEffectfulState.cjs.js"),require("detect-gpu"),require("three-mesh-bvh"),require("../materials/BlurPass.cjs.js"),require("../materials/ConvolutionMaterial.cjs.js"),require("../materials/MeshReflectorMaterial.cjs.js"),require("../materials/MeshRefractionMaterial.cjs.js"),require("../materials/DiscardMaterial.cjs.js"),require("../helpers/environment-assets.cjs.js"),require("../materials/SpotLightMaterial.cjs.js"),require("react-composer"),exports.Billboard=e.Billboard,exports.ScreenSpace=r.ScreenSpace,exports.QuadraticBezierLine=s.QuadraticBezierLine,exports.CubicBezierLine=t.CubicBezierLine,exports.CatmullRomLine=o.CatmullRomLine,exports.Line=i.Line,exports.PositionalAudio=a.PositionalAudio,exports.Text=u.Text,exports.Text3D=c.Text3D,exports.Effects=n.Effects,exports.isWebGL2Available=n.isWebGL2Available,exports.GradientTexture=j.GradientTexture,exports.Image=p.Image,exports.Edges=x.Edges,exports.Trail=l.Trail,exports.useTrail=l.useTrail,exports.Sampler=d.Sampler,exports.useSurfaceSampler=d.useSurfaceSampler,exports.ComputedAttribute=q.ComputedAttribute,exports.Clone=m.Clone,exports.MarchingCube=h.MarchingCube,exports.MarchingCubes=h.MarchingCubes,exports.MarchingPlane=h.MarchingPlane,exports.Decal=C.Decal,exports.Svg=M.Svg,exports.Gltf=S.Gltf,exports.AsciiRenderer=T.AsciiRenderer,exports.OrthographicCamera=f.OrthographicCamera,exports.PerspectiveCamera=B.PerspectiveCamera,exports.CubeCamera=P.CubeCamera,exports.DeviceOrientationControls=b.DeviceOrientationControls,exports.FlyControls=g.FlyControls,exports.MapControls=v.MapControls,exports.OrbitControls=A.OrbitControls,exports.TrackballControls=L.TrackballControls,exports.ArcballControls=k.ArcballControls,exports.TransformControls=G.TransformControls,exports.PointerLockControls=D.PointerLockControls,exports.FirstPersonControls=R.FirstPersonControls,exports.CameraControls=E.CameraControls,exports.GizmoHelper=w.GizmoHelper,exports.useGizmoContext=w.useGizmoContext,exports.GizmoViewcube=z.GizmoViewcube,exports.GizmoViewport=F.GizmoViewport,exports.Grid=O.Grid,exports.useCubeTexture=I.useCubeTexture,exports.useFBX=H.useFBX,exports.useGLTF=V.useGLTF,exports.useKTX2=y.useKTX2,exports.useProgress=Q.useProgress,exports.IsObject=X.IsObject,exports.useTexture=X.useTexture,exports.useVideoTexture=K.useVideoTexture,exports.Stats=W.Stats,exports.useDepthBuffer=N.useDepthBuffer,exports.useAspect=U.useAspect,exports.useCamera=_.useCamera,exports.useDetectGPU=J.useDetectGPU,exports.useHelper=Y.useHelper,exports.Bvh=Z.Bvh,exports.useBVH=Z.useBVH,exports.useContextBridge=$.useContextBridge,exports.useAnimations=ee.useAnimations,exports.useFBO=re.useFBO,exports.useIntersect=se.useIntersect,exports.useBoxProjectedEnv=te.useBoxProjectedEnv,exports.BBAnchor=oe.BBAnchor,exports.useTrailTexture=ie.useTrailTexture,exports.CurveModifier=ae.CurveModifier,exports.MeshDistortMaterial=ue.MeshDistortMaterial,exports.MeshWobbleMaterial=ce.MeshWobbleMaterial,exports.MeshReflectorMaterial=ne.MeshReflectorMaterial,exports.MeshRefractionMaterial=je.MeshRefractionMaterial,exports.MeshTransmissionMaterial=pe.MeshTransmissionMaterial,exports.PointMaterial=xe.PointMaterial,exports.PointMaterialImpl=xe.PointMaterialImpl,exports.shaderMaterial=le.shaderMaterial,exports.SoftShadows=de.SoftShadows,exports.softShadows=de.softShadows,exports.Box=qe.Box,exports.Capsule=qe.Capsule,exports.Circle=qe.Circle,exports.Cone=qe.Cone,exports.Cylinder=qe.Cylinder,exports.Dodecahedron=qe.Dodecahedron,exports.Extrude=qe.Extrude,exports.Icosahedron=qe.Icosahedron,exports.Lathe=qe.Lathe,exports.Octahedron=qe.Octahedron,exports.Plane=qe.Plane,exports.Polyhedron=qe.Polyhedron,exports.Ring=qe.Ring,exports.Sphere=qe.Sphere,exports.Tetrahedron=qe.Tetrahedron,exports.Torus=qe.Torus,exports.TorusKnot=qe.TorusKnot,exports.Tube=qe.Tube,exports.RoundedBox=me.RoundedBox,exports.ScreenQuad=he.ScreenQuad,exports.Center=Ce.Center,exports.Bounds=Me.Bounds,exports.useBounds=Me.useBounds,exports.CameraShake=Se.CameraShake,exports.Float=Te.Float,exports.Stage=fe.Stage,exports.Backdrop=Be.Backdrop,exports.Shadow=Pe.Shadow,exports.Caustics=be.Caustics,exports.ContactShadows=ge.ContactShadows,exports.AccumulativeShadows=ve.AccumulativeShadows,exports.RandomizedLight=ve.RandomizedLight,exports.accumulativeContext=ve.accumulativeContext,exports.Reflector=Ae.Reflector,exports.SpotLight=Le.SpotLight,exports.SpotLightShadow=Le.SpotLightShadow,exports.Environment=ke.Environment,exports.EnvironmentCube=ke.EnvironmentCube,exports.EnvironmentMap=ke.EnvironmentMap,exports.EnvironmentPortal=ke.EnvironmentPortal,exports.useEnvironment=ke.useEnvironment,exports.Lightformer=Ge.Lightformer,exports.Sky=De.Sky,exports.calcPosFromAngles=De.calcPosFromAngles,exports.Stars=Re.Stars,exports.Cloud=Ee.Cloud,exports.Sparkles=we.Sparkles,exports.useMatcapTexture=ze.useMatcapTexture,exports.useNormalTexture=Fe.useNormalTexture,exports.Point=Oe.Point,exports.Points=Oe.Points,exports.PointsBuffer=Oe.PointsBuffer,exports.PositionPoint=Oe.PositionPoint,exports.Instance=Ie.Instance,exports.Instances=Ie.Instances,exports.Merged=Ie.Merged,exports.Segment=He.Segment,exports.SegmentObject=He.SegmentObject,exports.Segments=He.Segments,exports.Detailed=Ve.Detailed,exports.Preload=ye.Preload,exports.BakeShadows=Qe.BakeShadows,exports.meshBounds=Xe.meshBounds,exports.AdaptiveDpr=Ke.AdaptiveDpr,exports.AdaptiveEvents=We.AdaptiveEvents,exports.PerformanceMonitor=Ne.PerformanceMonitor,exports.usePerformanceMonitor=Ne.usePerformanceMonitor,exports.RenderTexture=Ue.RenderTexture,exports.Mask=_e.Mask,exports.useMask=_e.useMask,exports.Hud=Je.Hud;
|
package/core/index.js
CHANGED
|
@@ -50,7 +50,7 @@ export { useAspect } from './useAspect.js';
|
|
|
50
50
|
export { useCamera } from './useCamera.js';
|
|
51
51
|
export { useDetectGPU } from './useDetectGPU.js';
|
|
52
52
|
export { useHelper } from './useHelper.js';
|
|
53
|
-
export { useBVH } from './useBVH.js';
|
|
53
|
+
export { Bvh, useBVH } from './useBVH.js';
|
|
54
54
|
export { useContextBridge } from './useContextBridge.js';
|
|
55
55
|
export { useAnimations } from './useAnimations.js';
|
|
56
56
|
export { useFBO } from './useFBO.js';
|
package/core/useBVH.cjs.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("@babel/runtime/helpers/extends"),r=require("@react-three/fiber"),t=require("react"),s=require("three"),o=require("three-mesh-bvh");function u(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}function n(e){if(e&&e.__esModule)return e;var r=Object.create(null);return e&&Object.keys(e).forEach((function(t){if("default"!==t){var s=Object.getOwnPropertyDescriptor(e,t);Object.defineProperty(r,t,s.get?s:{enumerable:!0,get:function(){return e[t]}})}})),r.default=e,Object.freeze(r)}var a=u(e),c=n(t);const i=e=>e.isMesh;const d=c.forwardRef((({enabled:e=!0,firstHitOnly:t=!1,children:u,splitStrategy:n="SAH",verbose:d=!1,setBoundingBox:f=!0,maxDepth:p=40,maxLeafTris:y=10,...l},m)=>{const B=c.useRef(null),b=r.useThree((e=>e.raycaster));return c.useImperativeHandle(m,(()=>B.current),[]),c.useEffect((()=>{if(e){const e={splitStrategy:n,verbose:d,setBoundingBox:f,maxDepth:p,maxLeafTris:y},r=B.current;return b.firstHitOnly=t,r.traverse((r=>{i(r)&&!r.geometry.boundsTree&&r.raycast===s.Mesh.prototype.raycast&&(r.raycast=o.acceleratedRaycast,r.geometry.computeBoundsTree=o.computeBoundsTree,r.geometry.disposeBoundsTree=o.disposeBoundsTree,r.geometry.computeBoundsTree(e))})),()=>{delete b.firstHitOnly,r.traverse((e=>{i(e)&&e.geometry.boundsTree&&(e.geometry.disposeBoundsTree(),e.raycast=s.Mesh.prototype.raycast)}))}}})),c.createElement("group",a.default({ref:B},l),u)}));exports.Bvh=d,exports.useBVH=function(e,r){r={splitStrategy:"SAH",verbose:!1,setBoundingBox:!0,maxDepth:40,maxLeafTris:10,...r},c.useEffect((()=>{if(e.current){e.current.raycast=o.acceleratedRaycast;const t=e.current.geometry;return t.computeBoundsTree=o.computeBoundsTree,t.disposeBoundsTree=o.disposeBoundsTree,t.computeBoundsTree(r),()=>{t.boundsTree&&t.disposeBoundsTree()}}}),[e,JSON.stringify(r)])};
|
package/core/useBVH.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
|
-
import { Mesh } from 'three';
|
|
2
|
+
import { Mesh, Group } from 'three';
|
|
3
3
|
export interface BVHOptions {
|
|
4
4
|
splitStrategy?: 'CENTER' | 'AVERAGE' | 'SAH';
|
|
5
5
|
verbose?: boolean;
|
|
@@ -7,4 +7,30 @@ export interface BVHOptions {
|
|
|
7
7
|
maxDepth?: number;
|
|
8
8
|
maxLeafTris?: number;
|
|
9
9
|
}
|
|
10
|
+
export declare type BvhProps = BVHOptions & JSX.IntrinsicElements['group'] & {
|
|
11
|
+
enabled?: boolean;
|
|
12
|
+
firstHitOnly?: boolean;
|
|
13
|
+
};
|
|
10
14
|
export declare function useBVH(mesh: React.MutableRefObject<Mesh | undefined>, options?: BVHOptions): void;
|
|
15
|
+
export declare const Bvh: React.ForwardRefExoticComponent<Pick<BVHOptions & Omit<import("@react-three/fiber").ExtendedColors<import("@react-three/fiber").Overwrite<Partial<Group>, import("@react-three/fiber").NodeProps<Group, typeof Group>>>, import("@react-three/fiber").NonFunctionKeys<{
|
|
16
|
+
position?: import("@react-three/fiber").Vector3 | undefined;
|
|
17
|
+
up?: import("@react-three/fiber").Vector3 | undefined;
|
|
18
|
+
scale?: import("@react-three/fiber").Vector3 | undefined;
|
|
19
|
+
rotation?: import("@react-three/fiber").Euler | undefined;
|
|
20
|
+
matrix?: import("@react-three/fiber").Matrix4 | undefined;
|
|
21
|
+
quaternion?: import("@react-three/fiber").Quaternion | undefined;
|
|
22
|
+
layers?: import("@react-three/fiber").Layers | undefined;
|
|
23
|
+
dispose?: (() => void) | null | undefined;
|
|
24
|
+
}>> & {
|
|
25
|
+
position?: import("@react-three/fiber").Vector3 | undefined;
|
|
26
|
+
up?: import("@react-three/fiber").Vector3 | undefined;
|
|
27
|
+
scale?: import("@react-three/fiber").Vector3 | undefined;
|
|
28
|
+
rotation?: import("@react-three/fiber").Euler | undefined;
|
|
29
|
+
matrix?: import("@react-three/fiber").Matrix4 | undefined;
|
|
30
|
+
quaternion?: import("@react-three/fiber").Quaternion | undefined;
|
|
31
|
+
layers?: import("@react-three/fiber").Layers | undefined;
|
|
32
|
+
dispose?: (() => void) | null | undefined;
|
|
33
|
+
} & import("@react-three/fiber/dist/declarations/src/core/events").EventHandlers & {
|
|
34
|
+
enabled?: boolean | undefined;
|
|
35
|
+
firstHitOnly?: boolean | undefined;
|
|
36
|
+
}, "visible" | "attach" | "args" | "children" | "key" | "onUpdate" | "position" | "up" | "scale" | "rotation" | "matrix" | "quaternion" | "layers" | "dispose" | "type" | "isGroup" | "id" | "uuid" | "name" | "parent" | "modelViewMatrix" | "normalMatrix" | "matrixWorld" | "matrixAutoUpdate" | "matrixWorldNeedsUpdate" | "castShadow" | "receiveShadow" | "frustumCulled" | "renderOrder" | "animations" | "userData" | "customDepthMaterial" | "customDistanceMaterial" | "isObject3D" | "onBeforeRender" | "onAfterRender" | "applyMatrix4" | "applyQuaternion" | "setRotationFromAxisAngle" | "setRotationFromEuler" | "setRotationFromMatrix" | "setRotationFromQuaternion" | "rotateOnAxis" | "rotateOnWorldAxis" | "rotateX" | "rotateY" | "rotateZ" | "translateOnAxis" | "translateX" | "translateY" | "translateZ" | "localToWorld" | "worldToLocal" | "lookAt" | "add" | "remove" | "removeFromParent" | "clear" | "getObjectById" | "getObjectByName" | "getObjectByProperty" | "getWorldPosition" | "getWorldQuaternion" | "getWorldScale" | "getWorldDirection" | "raycast" | "traverse" | "traverseVisible" | "traverseAncestors" | "updateMatrix" | "updateMatrixWorld" | "updateWorldMatrix" | "toJSON" | "clone" | "copy" | "addEventListener" | "hasEventListener" | "removeEventListener" | "dispatchEvent" | keyof import("@react-three/fiber/dist/declarations/src/core/events").EventHandlers | "enabled" | "firstHitOnly" | keyof BVHOptions> & React.RefAttributes<unknown>>;
|
package/core/useBVH.js
CHANGED
|
@@ -1,6 +1,15 @@
|
|
|
1
|
+
import _extends from '@babel/runtime/helpers/esm/extends';
|
|
2
|
+
import { useThree } from '@react-three/fiber';
|
|
1
3
|
import * as React from 'react';
|
|
4
|
+
import { Mesh } from 'three';
|
|
2
5
|
import { acceleratedRaycast, computeBoundsTree, disposeBoundsTree } from 'three-mesh-bvh';
|
|
3
6
|
|
|
7
|
+
const isMesh = child => child.isMesh;
|
|
8
|
+
/**
|
|
9
|
+
* @deprecated Use the Bvh component instead
|
|
10
|
+
*/
|
|
11
|
+
|
|
12
|
+
|
|
4
13
|
function useBVH(mesh, options) {
|
|
5
14
|
options = {
|
|
6
15
|
splitStrategy: 'SAH',
|
|
@@ -25,5 +34,57 @@ function useBVH(mesh, options) {
|
|
|
25
34
|
}
|
|
26
35
|
}, [mesh, JSON.stringify(options)]);
|
|
27
36
|
}
|
|
37
|
+
const Bvh = /*#__PURE__*/React.forwardRef(({
|
|
38
|
+
enabled = true,
|
|
39
|
+
firstHitOnly = false,
|
|
40
|
+
children,
|
|
41
|
+
splitStrategy = 'SAH',
|
|
42
|
+
verbose = false,
|
|
43
|
+
setBoundingBox = true,
|
|
44
|
+
maxDepth = 40,
|
|
45
|
+
maxLeafTris = 10,
|
|
46
|
+
...props
|
|
47
|
+
}, fref) => {
|
|
48
|
+
const ref = React.useRef(null);
|
|
49
|
+
const raycaster = useThree(state => state.raycaster);
|
|
50
|
+
React.useImperativeHandle(fref, () => ref.current, []);
|
|
51
|
+
React.useEffect(() => {
|
|
52
|
+
if (enabled) {
|
|
53
|
+
const options = {
|
|
54
|
+
splitStrategy,
|
|
55
|
+
verbose,
|
|
56
|
+
setBoundingBox,
|
|
57
|
+
maxDepth,
|
|
58
|
+
maxLeafTris
|
|
59
|
+
};
|
|
60
|
+
const group = ref.current; // This can only safely work if the component is used once, but there is no alternative.
|
|
61
|
+
// Hijacking the raycast method to do it for individual meshes is not an option as it would
|
|
62
|
+
// cost too much memory ...
|
|
63
|
+
|
|
64
|
+
raycaster.firstHitOnly = firstHitOnly;
|
|
65
|
+
group.traverse(child => {
|
|
66
|
+
// Only include meshes that do not yet have a boundsTree and whose raycast is standard issue
|
|
67
|
+
if (isMesh(child) && !child.geometry.boundsTree && child.raycast === Mesh.prototype.raycast) {
|
|
68
|
+
child.raycast = acceleratedRaycast;
|
|
69
|
+
child.geometry.computeBoundsTree = computeBoundsTree;
|
|
70
|
+
child.geometry.disposeBoundsTree = disposeBoundsTree;
|
|
71
|
+
child.geometry.computeBoundsTree(options);
|
|
72
|
+
}
|
|
73
|
+
});
|
|
74
|
+
return () => {
|
|
75
|
+
delete raycaster.firstHitOnly;
|
|
76
|
+
group.traverse(child => {
|
|
77
|
+
if (isMesh(child) && child.geometry.boundsTree) {
|
|
78
|
+
child.geometry.disposeBoundsTree();
|
|
79
|
+
child.raycast = Mesh.prototype.raycast;
|
|
80
|
+
}
|
|
81
|
+
});
|
|
82
|
+
};
|
|
83
|
+
}
|
|
84
|
+
});
|
|
85
|
+
return /*#__PURE__*/React.createElement("group", _extends({
|
|
86
|
+
ref: ref
|
|
87
|
+
}, props), children);
|
|
88
|
+
});
|
|
28
89
|
|
|
29
|
-
export { useBVH };
|
|
90
|
+
export { Bvh, useBVH };
|