@react-three/drei 9.83.5 → 9.83.7

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 CHANGED
@@ -1409,6 +1409,8 @@ An ornamental component that extracts the geometry from its parent and displays
1409
1409
  type OutlinesProps = JSX.IntrinsicElements['group'] & {
1410
1410
  /** Outline color, default: black */
1411
1411
  color: ReactThreeFiber.Color
1412
+ /** Line thickness is independent of zoom, default: false */
1413
+ screenspace: boolean
1412
1414
  /** Outline opacity, default: 1 */
1413
1415
  opacity: number
1414
1416
  /** Outline transparency, default: false */
@@ -1 +1 @@
1
- "use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("@babel/runtime/helpers/extends"),n=require("three"),t=require("react"),r=require("./shaderMaterial.cjs.js"),i=require("@react-three/fiber"),o=require("three-stdlib");function a(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}function c(e){if(e&&e.__esModule)return e;var n=Object.create(null);return e&&Object.keys(e).forEach((function(t){if("default"!==t){var r=Object.getOwnPropertyDescriptor(e,t);Object.defineProperty(n,t,r.get?r:{enumerable:!0,get:function(){return e[t]}})}})),n.default=e,Object.freeze(n)}var l=a(e),s=c(n),u=c(t);const d=r.shaderMaterial({color:new s.Color("black"),opacity:1,thickness:.05},"#include <common>\n #include <morphtarget_pars_vertex>\n #include <skinning_pars_vertex>\n uniform float thickness;\n void main() {\n #if defined (USE_SKINNING)\n\t #include <beginnormal_vertex>\n #include <morphnormal_vertex>\n #include <skinbase_vertex>\n #include <skinnormal_vertex>\n #include <defaultnormal_vertex>\n #endif\n #include <begin_vertex>\n\t #include <morphtarget_vertex>\n\t #include <skinning_vertex>\n #include <project_vertex>\n vec4 tNormal = vec4(normal, 0.0);\n vec4 tPosition = vec4(transformed, 1.0);\n #ifdef USE_INSTANCING\n tNormal = instanceMatrix * tNormal;\n tPosition = instanceMatrix * tPosition;\n #endif\n vec3 newPosition = tPosition.xyz + tNormal.xyz * thickness;\n gl_Position = projectionMatrix * modelViewMatrix * vec4(newPosition, 1.0); \n }",`uniform vec3 color;\n uniform float opacity;\n void main(){\n gl_FragColor = vec4(color, opacity);\n #include <tonemapping_fragment>\n #include <${parseInt(s.REVISION.replace(/\D+/g,""))>=154?"colorspace_fragment":"encodings_fragment"}>\n }`);exports.Outlines=function({color:e="black",opacity:n=1,transparent:t=!1,thickness:r=.05,angle:a=Math.PI,...c}){var f,m;const p=u.useRef(null),[v]=u.useState((()=>new d({side:s.BackSide})));return u.useMemo((()=>i.extend({OutlinesMaterial:d})),[]),u.useLayoutEffect((()=>{const e=p.current,n=e.parent;if(n&&n.geometry){let t;return n.skeleton?(t=new s.SkinnedMesh,t.material=v,t.bind(n.skeleton,n.bindMatrix),e.add(t)):n.isInstancedMesh?(t=new s.InstancedMesh(n.geometry,v,n.count),t.instanceMatrix=n.instanceMatrix,e.add(t)):(t=new s.Mesh,t.material=v,e.add(t)),t.geometry=a?o.toCreasedNormals(n.geometry,a):n.geometry,()=>{a&&t.geometry.dispose(),e.remove(t)}}}),[a,null==(f=p.current)||null==(m=f.parent)?void 0:m.geometry]),u.useLayoutEffect((()=>{const o=p.current.children[0];o&&i.applyProps(o.material,{transparent:t,thickness:r,color:e,opacity:n})}),[a,t,r,e,n]),u.createElement("group",l.default({ref:p},c))};
1
+ "use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("@babel/runtime/helpers/extends"),n=require("three"),t=require("react"),r=require("./shaderMaterial.cjs.js"),i=require("@react-three/fiber"),o=require("three-stdlib");function a(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}function c(e){if(e&&e.__esModule)return e;var n=Object.create(null);return e&&Object.keys(e).forEach((function(t){if("default"!==t){var r=Object.getOwnPropertyDescriptor(e,t);Object.defineProperty(n,t,r.get?r:{enumerable:!0,get:function(){return e[t]}})}})),n.default=e,Object.freeze(n)}var s=a(e),l=c(n),u=c(t);const d=r.shaderMaterial({screenspace:!1,color:new l.Color("black"),opacity:1,thickness:.05,size:new l.Vector2},"#include <common>\n #include <morphtarget_pars_vertex>\n #include <skinning_pars_vertex>\n uniform float thickness;\n uniform float screenspace;\n uniform vec2 size;\n void main() {\n #if defined (USE_SKINNING)\n\t #include <beginnormal_vertex>\n #include <morphnormal_vertex>\n #include <skinbase_vertex>\n #include <skinnormal_vertex>\n #include <defaultnormal_vertex>\n #endif\n #include <begin_vertex>\n\t #include <morphtarget_vertex>\n\t #include <skinning_vertex>\n #include <project_vertex>\n vec4 tNormal = vec4(normal, 0.0);\n vec4 tPosition = vec4(transformed, 1.0);\n #ifdef USE_INSTANCING\n tNormal = instanceMatrix * tNormal;\n tPosition = instanceMatrix * tPosition;\n #endif\n if (screenspace == 0.0) {\n vec3 newPosition = tPosition.xyz + tNormal.xyz * thickness;\n gl_Position = projectionMatrix * modelViewMatrix * vec4(newPosition, 1.0); \n } else {\n vec4 clipPosition = projectionMatrix * modelViewMatrix * tPosition;\n vec4 clipNormal = projectionMatrix * modelViewMatrix * tNormal;\n vec2 offset = normalize(clipNormal.xy) * thickness / size * clipPosition.w * 2.0;\n clipPosition.xy += offset;\n gl_Position = clipPosition;\n }\n }",`uniform vec3 color;\n uniform float opacity;\n void main(){\n gl_FragColor = vec4(color, opacity);\n #include <tonemapping_fragment>\n #include <${parseInt(l.REVISION.replace(/\D+/g,""))>=154?"colorspace_fragment":"encodings_fragment"}>\n }`);exports.Outlines=function({color:e="black",opacity:n=1,transparent:t=!1,screenspace:r=!1,toneMapped:a=!0,polygonOffset:c=!1,polygonOffsetFactor:f=0,thickness:p=.05,angle:m=Math.PI,...g}){var v,x;const y=u.useRef(null),[_]=u.useState((()=>new d({side:l.BackSide}))),{gl:M}=i.useThree(),h=M.getDrawingBufferSize(new l.Vector2);return u.useMemo((()=>i.extend({OutlinesMaterial:d})),[]),u.useLayoutEffect((()=>{const e=y.current,n=e.parent;if(n&&n.geometry){let t;return n.skeleton?(t=new l.SkinnedMesh,t.material=_,t.bind(n.skeleton,n.bindMatrix),e.add(t)):n.isInstancedMesh?(t=new l.InstancedMesh(n.geometry,_,n.count),t.instanceMatrix=n.instanceMatrix,e.add(t)):(t=new l.Mesh,t.material=_,e.add(t)),t.geometry=m?o.toCreasedNormals(n.geometry,m):n.geometry,()=>{m&&t.geometry.dispose(),e.remove(t)}}}),[m,null==(v=y.current)||null==(x=v.parent)?void 0:x.geometry]),u.useLayoutEffect((()=>{const o=y.current.children[0];o&&i.applyProps(o.material,{transparent:t,thickness:p,color:e,opacity:n,size:h,screenspace:r,toneMapped:a,polygonOffset:c,polygonOffsetFactor:f})}),[m,t,p,e,n,r,a,c,f]),u.createElement("group",s.default({ref:y},g))};
@@ -2,10 +2,14 @@
2
2
  import { ReactThreeFiber } from '@react-three/fiber';
3
3
  declare type OutlinesProps = JSX.IntrinsicElements['group'] & {
4
4
  color: ReactThreeFiber.Color;
5
+ screenspace: boolean;
5
6
  opacity: number;
6
7
  transparent: boolean;
7
8
  thickness: number;
8
9
  angle: number;
10
+ toneMapped?: boolean;
11
+ polygonOffset?: boolean;
12
+ polygonOffsetFactor?: number;
9
13
  };
10
- export declare function Outlines({ color, opacity, transparent, thickness, angle, ...props }: OutlinesProps): JSX.Element;
14
+ export declare function Outlines({ color, opacity, transparent, screenspace, toneMapped, polygonOffset, polygonOffsetFactor, thickness, angle, ...props }: OutlinesProps): JSX.Element;
11
15
  export {};
package/core/Outlines.js CHANGED
@@ -2,17 +2,21 @@ import _extends from '@babel/runtime/helpers/esm/extends';
2
2
  import * as THREE from 'three';
3
3
  import * as React from 'react';
4
4
  import { shaderMaterial } from './shaderMaterial.js';
5
- import { extend, applyProps } from '@react-three/fiber';
5
+ import { useThree, extend, applyProps } from '@react-three/fiber';
6
6
  import { toCreasedNormals } from 'three-stdlib';
7
7
 
8
8
  const OutlinesMaterial = shaderMaterial({
9
+ screenspace: false,
9
10
  color: new THREE.Color('black'),
10
11
  opacity: 1,
11
- thickness: 0.05
12
+ thickness: 0.05,
13
+ size: new THREE.Vector2()
12
14
  }, `#include <common>
13
15
  #include <morphtarget_pars_vertex>
14
16
  #include <skinning_pars_vertex>
15
17
  uniform float thickness;
18
+ uniform float screenspace;
19
+ uniform vec2 size;
16
20
  void main() {
17
21
  #if defined (USE_SKINNING)
18
22
  #include <beginnormal_vertex>
@@ -31,8 +35,16 @@ const OutlinesMaterial = shaderMaterial({
31
35
  tNormal = instanceMatrix * tNormal;
32
36
  tPosition = instanceMatrix * tPosition;
33
37
  #endif
34
- vec3 newPosition = tPosition.xyz + tNormal.xyz * thickness;
35
- gl_Position = projectionMatrix * modelViewMatrix * vec4(newPosition, 1.0);
38
+ if (screenspace == 0.0) {
39
+ vec3 newPosition = tPosition.xyz + tNormal.xyz * thickness;
40
+ gl_Position = projectionMatrix * modelViewMatrix * vec4(newPosition, 1.0);
41
+ } else {
42
+ vec4 clipPosition = projectionMatrix * modelViewMatrix * tPosition;
43
+ vec4 clipNormal = projectionMatrix * modelViewMatrix * tNormal;
44
+ vec2 offset = normalize(clipNormal.xy) * thickness / size * clipPosition.w * 2.0;
45
+ clipPosition.xy += offset;
46
+ gl_Position = clipPosition;
47
+ }
36
48
  }`, `uniform vec3 color;
37
49
  uniform float opacity;
38
50
  void main(){
@@ -44,6 +56,10 @@ function Outlines({
44
56
  color = 'black',
45
57
  opacity = 1,
46
58
  transparent = false,
59
+ screenspace = false,
60
+ toneMapped = true,
61
+ polygonOffset = false,
62
+ polygonOffsetFactor = 0,
47
63
  thickness = 0.05,
48
64
  angle = Math.PI,
49
65
  ...props
@@ -54,6 +70,10 @@ function Outlines({
54
70
  const [material] = React.useState(() => new OutlinesMaterial({
55
71
  side: THREE.BackSide
56
72
  }));
73
+ const {
74
+ gl
75
+ } = useThree();
76
+ const contextSize = gl.getDrawingBufferSize(new THREE.Vector2());
57
77
  React.useMemo(() => extend({
58
78
  OutlinesMaterial
59
79
  }), []);
@@ -95,10 +115,15 @@ function Outlines({
95
115
  transparent,
96
116
  thickness,
97
117
  color,
98
- opacity
118
+ opacity,
119
+ size: contextSize,
120
+ screenspace,
121
+ toneMapped,
122
+ polygonOffset,
123
+ polygonOffsetFactor
99
124
  });
100
125
  }
101
- }, [angle, transparent, thickness, color, opacity]);
126
+ }, [angle, transparent, thickness, color, opacity, screenspace, toneMapped, polygonOffset, polygonOffsetFactor]);
102
127
  return /*#__PURE__*/React.createElement("group", _extends({
103
128
  ref: ref
104
129
  }, props));