three-render-objects 1.39.3 → 1.40.0

package/README.md

@@ -20,7 +20,7 @@ import ThreeRenderObjects from 'three-render-objects';
 ```
 or using a *script* tag
 ```html
-<script src="//unpkg.com/three-render-objects"></script>
+<script src="//cdn.jsdelivr.net/npm/three-render-objects"></script>
 ```
 then
 ```js
@@ -90,6 +90,7 @@ new ThreeRenderObjects(<domElement>, { configOptions })
 | <b>pointsHoverPrecision</b>([<i>int</i>]) | Getter/setter for the precision to use when detecting hover events over [Points](https://threejs.org/docs/#api/objects/Points) objects. | 1 |
 | <b>tooltipContent</b>([<i>str</i> or <i>fn</i>]) | Object accessor function or attribute for label (shown in tooltip). Supports plain text, HTML string content, an [HTML element](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) or [React JSX](https://react.dev/learn/writing-markup-with-jsx). ||
 | <b>enablePointerInteraction([<i>boolean</i>]) | Getter/setter for whether to enable the mouse tracking events. This activates an internal tracker of the canvas mouse position and enables the functionality of object hover/click and tooltip labels, at the cost of performance. If you're looking for maximum gain in your render performance it's recommended to switch off this property. | `true` |
+| <b>pointerRaycasterThrottleMs([<i>int</i>]) | Getter/setter for the minimum amount of time (in ms) to wait between raycaster checks for the pointer tracker. Increasing this value will improve render performance at the cost of potential lag in pointer interactions. | `50` |
 | <b>hoverDuringDrag([<i>boolean</i>]) | Getter/setter for whether to trigger hover events while using the controls via pointer dragging.| `false` |
 | <b>clickAfterDrag([<i>boolean</i>]) | Getter/setter for whether to trigger a click event after dragging using the controls.| `false` |
 | <b>getPointerPos() | Getter for the current position of the pointer relative to the viewport, in `{ x, y }` px coordinates. ||

package/dist/three-render-objects.d.ts

@@ -74,6 +74,8 @@ declare class ThreeRenderObjectsGeneric<ChainableInstance> {
   pointsHoverPrecision(precision: number): ChainableInstance;
   tooltipContent(): Obj3DAccessor<string | HTMLElement | ReactHTMLElement<HTMLElement> | boolean>;
   tooltipContent(contentAccessor: Obj3DAccessor<string | HTMLElement | ReactHTMLElement<HTMLElement> | boolean>): ChainableInstance;
+  pointerRaycasterThrottleMs(): number;
+  pointerRaycasterThrottleMs(ms: number): ChainableInstance;
   enablePointerInteraction(): boolean;
   enablePointerInteraction(enable: boolean): ChainableInstance;
   hoverDuringDrag(): boolean;
@@ -91,4 +93,5 @@ declare class ThreeRenderObjectsGeneric<ChainableInstance> {
 
 declare class ThreeRenderObjects extends ThreeRenderObjectsGeneric<ThreeRenderObjects> {}
 
-export { type ConfigOptions, ThreeRenderObjectsGeneric, ThreeRenderObjects as default };
+export { ThreeRenderObjectsGeneric, ThreeRenderObjects as default };
+export type { ConfigOptions };