angular-three-soba 2.0.0-beta.2 → 2.0.0-beta.21

package/misc/caustics/caustics.d.ts

@@ -0,0 +1,87 @@
+import { ElementRef } from '@angular/core';
+import { type NgtGroup } from 'angular-three';
+import * as THREE from 'three';
+import * as i0 from "@angular/core";
+export type NgtsCausticsState = {
+    /** How many frames it will render, set it to Infinity for runtime, default: 1 */
+    frames: number;
+    /** Enables visual cues to help you stage your scene, default: false */
+    debug: boolean;
+    /** Will display caustics only and skip the models, default: false */
+    causticsOnly: boolean;
+    /** Will include back faces and enable the backsideIOR prop, default: false */
+    backside: boolean;
+    /** The IOR refraction index, default: 1.1 */
+    ior: number;
+    /** The IOR refraction index for back faces (only available when backside is enabled), default: 1.1 */
+    backsideIOR: number;
+    /** The texel size, default: 0.3125 */
+    worldRadius: number;
+    /** Intensity of the prjected caustics, default: 0.05 */
+    intensity: number;
+    /** Caustics color, default: white */
+    color: THREE.ColorRepresentation;
+    /** Buffer resolution, default: 2048 */
+    resolution: number;
+    /** Camera position, it will point towards the contents bounds center, default: [5, 5, 5] */
+    lightSource: [x: number, y: number, z: number] | ElementRef<THREE.Object3D>;
+};
+declare global {
+    interface HTMLElementTagNameMap {
+        /**
+         * @extends ngt-group
+         */
+        'ngts-caustics': NgtsCausticsState & NgtGroup;
+    }
+}
+export declare class NgtsCaustics {
+    CustomBlending: 5;
+    OneFactor: 201;
+    SrcAlphaFactor: 204;
+    Math: Math;
+    private inputs;
+    causticsRef: import("angular-three").NgtInjectedRef<THREE.Group>;
+    /** How many frames it will render, set it to Infinity for runtime, default: 1 */
+    set _frames(frames: number);
+    /** Enables visual cues to help you stage your scene, default: false */
+    set _debug(debug: boolean);
+    /** Will display caustics only and skip the models, default: false */
+    set _causticsOnly(causticsOnly: boolean);
+    /** Will include back faces and enable the backsideIOR prop, default: false */
+    set _backside(backside: boolean);
+    /** The IOR refraction index, default: 1.1 */
+    set _ior(ior: number);
+    /** The IOR refraction index for back faces (only available when backside is enabled), default: 1.1 */
+    set _backsideIOR(backsideIOR: number);
+    /** The texel size, default: 0.3125 */
+    set _worldRadius(worldRadius: number);
+    /** Intensity of the prjected caustics, default: 0.05 */
+    set _intensity(intensity: number);
+    /** Caustics color, default: white */
+    set _color(color: THREE.ColorRepresentation);
+    /** Buffer resolution, default: 2048 */
+    set _resolution(resolution: number);
+    /** Camera position, it will point towards the contents bounds center, default: [5, 5, 5] */
+    set _lightSource(lightSource: [x: number, y: number, z: number] | ElementRef<THREE.Object3D>);
+    private resolution;
+    private normalTargetSettings;
+    private causticsTargetSettings;
+    private normalTargetFbo;
+    private normalTargetBFbo;
+    causticsTargetFbo: import("angular-three").NgtInjectedRef<THREE.WebGLRenderTarget<THREE.Texture> | null>;
+    causticsTargetBFbo: import("angular-three").NgtInjectedRef<THREE.WebGLRenderTarget<THREE.Texture> | null>;
+    private store;
+    color: import("@angular/core").Signal<THREE.ColorRepresentation>;
+    debug: import("@angular/core").Signal<boolean>;
+    planeRef: import("angular-three").NgtInjectedRef<THREE.Mesh<THREE.BufferGeometry<THREE.NormalBufferAttributes>, THREE.Material | THREE.Material[]>>;
+    sceneRef: import("angular-three").NgtInjectedRef<THREE.Scene>;
+    cameraRef: import("angular-three").NgtInjectedRef<THREE.OrthographicCamera>;
+    private sceneChildren;
+    private planeChildren;
+    private causticsChildren;
+    constructor();
+    private updateWorldMatrix;
+    private setBeforeRender;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgtsCaustics, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<NgtsCaustics, "ngts-caustics", never, { "causticsRef": { "alias": "causticsRef"; "required": false; }; "_frames": { "alias": "frames"; "required": false; }; "_debug": { "alias": "debug"; "required": false; }; "_causticsOnly": { "alias": "causticsOnly"; "required": false; }; "_backside": { "alias": "backside"; "required": false; }; "_ior": { "alias": "ior"; "required": false; }; "_backsideIOR": { "alias": "backsideIOR"; "required": false; }; "_worldRadius": { "alias": "worldRadius"; "required": false; }; "_intensity": { "alias": "intensity"; "required": false; }; "_color": { "alias": "color"; "required": false; }; "_resolution": { "alias": "resolution"; "required": false; }; "_lightSource": { "alias": "lightSource"; "required": false; }; }, {}, never, ["*"], true, never>;
+}

package/misc/decal/decal.d.ts

@@ -0,0 +1,49 @@
+import { type NgtEuler, type NgtMesh, type NgtRef, type NgtVector3 } from 'angular-three';
+import * as THREE from 'three';
+import * as i0 from "@angular/core";
+export type NgtsDecalState = {
+    debug: boolean;
+    mesh?: NgtRef<THREE.Mesh>;
+    position: NgtVector3;
+    rotation: NgtEuler | number;
+    scale: NgtVector3;
+    map?: THREE.Texture;
+    polygonOffsetFactor: number;
+    depthTest: boolean;
+};
+declare global {
+    interface HTMLElementTagNameMap {
+        /**
+         * @extends ngt-mesh
+         */
+        'ngts-decal': NgtsDecalState & NgtMesh;
+    }
+}
+export declare class NgtsDecal {
+    private inputs;
+    decalRef: import("angular-three").NgtInjectedRef<THREE.Mesh<THREE.BufferGeometry<THREE.NormalBufferAttributes>, THREE.Material | THREE.Material[]>>;
+    set _debug(debug: boolean);
+    set _mesh(mesh: NgtRef<THREE.Mesh>);
+    set _position(position: NgtVector3);
+    set _rotation(rotation: NgtEuler | number);
+    set _scale(scale: NgtVector3);
+    set _map(map: THREE.Texture);
+    set _polygonOffsetFactor(polygonOffsetFactor: number);
+    set _depthTest(depthTest: boolean);
+    private mesh;
+    private __position;
+    private __rotation;
+    private __scale;
+    private position;
+    private rotation;
+    private scale;
+    helperRef: import("angular-three").NgtInjectedRef<THREE.Mesh<THREE.BufferGeometry<THREE.NormalBufferAttributes>, THREE.Material | THREE.Material[]>>;
+    debug: import("@angular/core").Signal<boolean>;
+    depthTest: import("@angular/core").Signal<boolean>;
+    polygonOffsetFactor: import("@angular/core").Signal<number>;
+    map: import("@angular/core").Signal<THREE.Texture | undefined>;
+    constructor();
+    private processDecal;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgtsDecal, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<NgtsDecal, "ngts-decal", never, { "decalRef": { "alias": "decalRef"; "required": false; }; "_debug": { "alias": "debug"; "required": false; }; "_mesh": { "alias": "mesh"; "required": false; }; "_position": { "alias": "position"; "required": false; }; "_rotation": { "alias": "rotation"; "required": false; }; "_scale": { "alias": "scale"; "required": false; }; "_map": { "alias": "map"; "required": false; }; "_polygonOffsetFactor": { "alias": "polygonOffsetFactor"; "required": false; }; "_depthTest": { "alias": "depthTest"; "required": false; }; }, {}, never, ["*"], true, never>;
+}

package/misc/depth-buffer/depth-buffer.d.ts

@@ -1,4 +1,4 @@
-import { Injector } from '@angular/core';
+import { type Injector } from '@angular/core';
 import * as THREE from 'three';
 export interface NgtsDepthBufferParams {
     size: number;
@@ -6,4 +6,4 @@ export interface NgtsDepthBufferParams {
 }
 export declare function injectNgtsDepthBuffer(paramsFactory?: () => Partial<NgtsDepthBufferParams>, { injector }?: {
     injector?: Injector;
-}): import("@angular/core").Signal<THREE.DepthTexture>;
+}): import("angular-three").NgtInjectedRef<THREE.DepthTexture | null>;

package/misc/example/example.d.ts

@@ -0,0 +1,81 @@
+import { Group } from 'three';
+import * as i0 from "@angular/core";
+/**
+ * define states of a component. usually acts for inputs signalStore
+ */
+export type NgtsExampleState = {
+    font: string;
+    color: THREE.ColorRepresentation;
+    debug: boolean;
+    bevelSize: number;
+};
+/**
+ * We can setup public API for this soba component with createInjectionToken + forwardRef
+ * the `example.api` is **usually** a computed property in the component class
+ *
+ * @see Bounds for example
+ */
+export declare const injectNgtsExampleApi: {
+    (): import("@angular/core").Signal<{
+        bevelSize: number;
+        increment: () => void;
+        decrement: () => void;
+    }>;
+    (injectOptions: import("@angular/core").InjectOptions & {
+        optional?: false | undefined;
+    }): import("@angular/core").Signal<{
+        bevelSize: number;
+        increment: () => void;
+        decrement: () => void;
+    }>;
+    (injectOptions: import("@angular/core").InjectOptions): import("@angular/core").Signal<{
+        bevelSize: number;
+        increment: () => void;
+        decrement: () => void;
+    }> | null;
+}, provideNgtsExampleApi: (value?: import("@angular/core").Signal<{
+    bevelSize: number;
+    increment: () => void;
+    decrement: () => void;
+}> | undefined) => import("@angular/core").Provider;
+export declare class NgtsExample {
+    /**
+     * use signalStore to store inputs with default inputs
+     */
+    private inputs;
+    /**
+     * a soba component usually has a Input for the component ref and this Input always has a default value with injectNgtRef
+     */
+    exampleRef: import("angular-three").NgtInjectedRef<Group>;
+    /**
+     * setup Input for the Inputs state. Use alias to have an easier time to setup computed
+     *
+     * @example: this way "private font" and "set _font" won't conflict
+     * private font = this.inputs.select('font');
+     */
+    set _font(font: string);
+    set _color(color: THREE.ColorRepresentation);
+    set _debug(debug: boolean);
+    set _bevelSize(bevelSize: number);
+    /**
+     * exposes signals from inputs
+     */
+    bevelSize: import("@angular/core").Signal<number>;
+    font: import("@angular/core").Signal<string>;
+    debug: import("@angular/core").Signal<boolean>;
+    color: import("@angular/core").Signal<import("three").ColorRepresentation>;
+    /**
+     * can have internal state
+     */
+    count: import("@angular/core").WritableSignal<number>;
+    /**
+     * Expose the public API for this soba component
+     */
+    api: import("@angular/core").Signal<{
+        bevelSize: number;
+        increment: () => void;
+        decrement: () => void;
+    }>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgtsExample, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<NgtsExample, "ngts-example", never, { "exampleRef": { "alias": "exampleRef"; "required": false; }; "_font": { "alias": "font"; "required": true; }; "_color": { "alias": "color"; "required": false; }; "_debug": { "alias": "debug"; "required": false; }; "_bevelSize": { "alias": "bevelSize"; "required": false; }; }, {}, never, ["*"], true, never>;
+}

package/misc/fbo/fbo.d.ts

@@ -1,4 +1,4 @@
-import { Injector } from '@angular/core';
+import { type Injector } from '@angular/core';
 import * as THREE from 'three';
 interface FBOSettings extends THREE.WebGLRenderTargetOptions {
     /** Defines the count of MSAA samples. Can only be used with WebGL 2. Default: 0 */
@@ -13,5 +13,5 @@ export interface NgtsFBOParams {
 }
 export declare function injectNgtsFBO(fboParams: () => NgtsFBOParams, { injector }?: {
     injector?: Injector;
-}): import("@angular/core").Signal<THREE.WebGLRenderTarget>;
+}): import("angular-three").NgtInjectedRef<THREE.WebGLRenderTarget<THREE.Texture> | null>;
 export {};