@needle-tools/engine 5.0.0 → 5.1.0-experimental.1

package/dist/needle-engine.d.ts

@@ -7,6 +7,7 @@ import { BatchedMesh } from 'three';
 import { BloomEffect as BloomEffect_2 } from 'postprocessing';
 import { Box3 } from 'three';
 import { BufferGeometry } from 'three';
+import { BufferGeometryEventMap } from 'three';
 import { Camera as Camera_2 } from 'three';
 import { Collider as Collider_2 } from '@dimforge/rapier3d-compat';
 import { ColliderDesc } from '@dimforge/rapier3d-compat';
@@ -6432,7 +6433,7 @@ declare enum FogMode {
     ExponentialSquared = 3
 }
 
-declare enum FontStyle {
+export declare enum FontStyle {
     Normal = 0,
     Bold = 1,
     Italic = 2,
@@ -7280,7 +7281,8 @@ export declare class Gradient {
 export declare class Graphic extends BaseUIComponent implements IGraphic, IRectTransformChangedReceiver {
     get isGraphic(): boolean;
     get color(): RGBAColor;
-    set color(col: RGBAColor);
+    set color(col: RGBAColor | Color);
+    private _color;
     private _alphaFactor;
     setAlphaFactor(factor: number): void;
     get alphaFactor(): number;
@@ -7289,7 +7291,6 @@ export declare class Graphic extends BaseUIComponent implements IGraphic, IRectT
     private get m_Color();
     raycastTarget: boolean;
     protected uiObject: ThreeMeshUI.Block | null;
-    private _color;
     private _rect;
     private _stateManager;
     protected get rectTransform(): RectTransform;
@@ -7631,7 +7632,7 @@ declare abstract class HorizontalOrVerticalLayoutGroup extends LayoutGroup {
     protected onCalculateLayout(rect: RectTransform): void;
 }
 
-declare enum HorizontalWrapMode {
+export declare enum HorizontalWrapMode {
     Wrap = 0,
     Overflow = 1
 }
@@ -9580,7 +9581,7 @@ declare abstract class LayoutGroup extends Component implements ILayoutGroup {
     get isDirty(): boolean;
     get isLayoutGroup(): boolean;
     updateLayout(): void;
-    childAlignment: TextAnchor;
+    childAlignment: TextAnchor_2;
     reverseArrangement: boolean;
     spacing: number;
     padding: Padding;
@@ -9754,6 +9755,9 @@ export declare class Light extends Component implements ILight {
      * The underlying three.js {@link ThreeLight} instance
      */
     private light;
+    /** Access the light as a shadow-casting light (DirectionalLight, SpotLight, PointLight).
+     * In r183 types, the `shadow` property is only on specific light subclasses. */
+    private get shadowLight();
     /**
      * Gets the world position of the light
      * @param vec Vector3 to store the result
@@ -19193,7 +19197,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
          /**
           * The geometry of the sprite that can be used to create a mesh
           */
-         getGeometry(): BufferGeometry<NormalBufferAttributes>;
+         getGeometry(): BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>;
      }
 
      declare class Sprite_3 {
@@ -19796,19 +19800,75 @@ export declare class OrbitControls extends Component implements ICameraControlle
       * @see {@link FontStyle} for bold/italic styles
       */
      declare class Text_2 extends Graphic implements IHasAlphaFactor, ICanvasEventReceiver {
-         alignment: TextAnchor_2;
-         verticalOverflow: VerticalWrapMode;
-         horizontalOverflow: HorizontalWrapMode;
-         lineSpacing: number;
-         supportRichText: boolean;
-         font?: string;
-         fontStyle: FontStyle;
+         /**
+          * The alignment of the text within its container. This determines how the text is anchored and positioned relative to its RectTransform. For example, `UpperLeft` will anchor the text to the upper left corner of the container, while `MiddleCenter` will center the text both horizontally and vertically. Changing this property will update the underlying three-mesh-ui options and mark the UI as dirty to trigger a re-render.
+          */
+         set alignment(val: TextAnchor);
+         get alignment(): TextAnchor;
+         private _alignment;
+         /**
+          * Determines how text that exceeds the vertical bounds of the container is handled. If set to `Truncate`, any text that goes beyond the vertical limits of the container will be cut off and not visible. If set to `Overflow`, the text will continue to render outside the container bounds, which may result in it being partially or fully visible depending on the layout and parent containers.
+          * @default VerticalWrapMode.Truncate
+          */
+         set verticalOverflow(val: VerticalWrapMode);
+         get verticalOverflow(): VerticalWrapMode;
+         private _verticalOverflow;
+         /**
+          * Determines how text that exceeds the horizontal bounds of the container is handled. If set to `Wrap`, the text will automatically wrap to the next line when it reaches the edge of the container. If set to `Overflow`, the text will continue on a single line and may overflow outside the container bounds.
+          * @default HorizontalWrapMode.Wrap
+          */
+         set horizontalOverflow(val: HorizontalWrapMode);
+         get horizontalOverflow(): HorizontalWrapMode;
+         private _horizontalOverflow;
+         /**
+          * The line spacing multiplier for the text. A value of 1 means normal spacing, 1.5 means 50% more spacing, and 0.5 means 50% less spacing.
+          * @default 1
+          */
+         set lineSpacing(val: number);
+         get lineSpacing(): number;
+         private _lineSpacing;
+         /**
+          * The style of the font, which can be normal, bold, italic, or bold and italic.
+          *
+          * This is used to determine the correct font variant to use based on the provided `font` property. For example, if you set `font` to "Arial" and `fontStyle` to `FontStyle.Bold`, it will look for a font variant named "Arial-Bold" (or "arial-bold") in the font library. If such a variant exists, it will be used to render the text with the specified style.
+          *
+          * @default FontStyle.Normal
+          */
+         set fontStyle(val: FontStyle);
+         get fontStyle(): FontStyle;
+         private _fontStyle;
+         /**
+          * The font to use for the text, specified as a URL to a font file.
+          *
+          * The font file must be in MSDF format. You can generate MSDF fonts using tools like [msdf-bmfont-xml](https://github.com/Chlumsky/msdf-bmfont-xml) or by using Needle Engine for Unity where the Needle Engine integration automatically generates MSDF fonts for used font assets.
+          *
+          * @default "https://cdn.needle.tools/static/fonts/msdf/arial/arial"
+          */
+         set font(val: string | null);
+         get font(): string | null;
+         private _font;
+         /**
+          * Whether to support basic rich text tags in the `text` property. Supported tags include `<b>`, `<i>`, and `<color=hex>`. For example: `Hello <b>World</b>` or `Score: <color=#ff0000>100</color>`
+          * @default false
+          */
+         set supportRichText(val: boolean);
+         get supportRichText(): boolean;
+         private _supportRichText;
+         /**
+          * Set the alpha factor for the text, which multiplies with the color's alpha to determine overall transparency.
+          */
          setAlphaFactor(factor: number): void;
+         /**
+          * The text content to display. Supports basic rich text tags like `<b>`, `<i>`, and `<color=hex>` if `supportRichText` is enabled.
+          * @default ""
+          */
          get text(): string;
          set text(val: string);
+         private _text;
          private set_text;
          get fontSize(): number;
          set fontSize(val: number);
+         private _fontSize;
          private sRGBTextColor;
          protected onColorChanged(): void;
          onParentRectTransformChanged(): void;
@@ -19816,8 +19876,6 @@ export declare class OrbitControls extends Component implements ICameraControlle
          private updateOverflow;
          protected onCreate(_opts: any): void;
          onAfterAddedToScene(): void;
-         private _text;
-         private _fontSize;
          private _textMeshUi;
          private getTextOpts;
          onEnable(): void;
@@ -19844,7 +19902,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
      }
      export { Text_2 as Text }
 
-     declare enum TextAnchor {
+     export declare enum TextAnchor {
          UpperLeft = 0,
          UpperCenter = 1,
          UpperRight = 2,
@@ -19853,8 +19911,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
          MiddleRight = 5,
          LowerLeft = 6,
          LowerCenter = 7,
-         LowerRight = 8,
-         Custom = 9
+         LowerRight = 8
      }
 
      declare enum TextAnchor_2 {
@@ -19866,7 +19923,8 @@ export declare class OrbitControls extends Component implements ICameraControlle
          MiddleRight = 5,
          LowerLeft = 6,
          LowerCenter = 7,
-         LowerRight = 8
+         LowerRight = 8,
+         Custom = 9
      }
 
      export declare class TextBuilder {
@@ -20975,7 +21033,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
          protected get primaryAxis(): Axis;
      }
 
-     declare enum VerticalWrapMode {
+     export declare enum VerticalWrapMode {
          Truncate = 0,
          Overflow = 1
      }
@@ -21080,7 +21138,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
          /**
           * the video texture that is used to render the video
           */
-         get videoTexture(): VideoTexture | null;
+         get videoTexture(): VideoTexture<HTMLVideoElement> | null;
          /**
           * the HTMLVideoElement that is used to play the video
           */
@@ -21672,7 +21730,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
           * The tint color of the camera feed
           */
          backgroundTint: RGBAColor;
-         get background(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap> | undefined;
+         get background(): Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material | Material[], Object3DEventMap> | undefined;
          private backgroundPlane?;
          private threeTexture?;
          private forceTextureInitialization;
@@ -22819,6 +22877,28 @@ export declare class OrbitControls extends Component implements ICameraControlle
      export { }
 
 
+declare module 'three' {
+    interface SkinnedMesh {
+        staticGenerator?: StaticGeometryGenerator;
+        staticGeometry?: BufferGeometry;
+        staticGeometryLastUpdate?: number;
+    }
+    interface Mesh {
+        acceleratedRaycast?: any;
+    }
+    interface SkinnedMesh {
+        /** @deprecated use autoUpdateMeshBvhInterval */
+        autoUpdateMeshBVH?: boolean;
+        /**
+         * Interval in milliseconds to automatically update the mesh BVH. When set to >= 0 the BVH will be updated every x milliseconds.
+         * @default undefined (disabled)
+         */
+        autoUpdateMeshBvhInterval?: number;
+        bvhNeedsUpdate?: boolean;
+    }
+}
+
+
 declare module 'three' {
     interface Object3D {
         get guid(): string | undefined;
@@ -22964,25 +23044,3 @@ declare module 'three' {
         slerp(end: Vector3, t: number): Vector3;
     }
 }
-
-
-declare module 'three' {
-    interface SkinnedMesh {
-        staticGenerator?: StaticGeometryGenerator;
-        staticGeometry?: BufferGeometry;
-        staticGeometryLastUpdate?: number;
-    }
-    interface Mesh {
-        acceleratedRaycast?: any;
-    }
-    interface SkinnedMesh {
-        /** @deprecated use autoUpdateMeshBvhInterval */
-        autoUpdateMeshBVH?: boolean;
-        /**
-         * Interval in milliseconds to automatically update the mesh BVH. When set to >= 0 the BVH will be updated every x milliseconds.
-         * @default undefined (disabled)
-         */
-        autoUpdateMeshBvhInterval?: number;
-        bvhNeedsUpdate?: boolean;
-    }
-}