roavatar-renderer 1.5.19 → 1.6.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { EffectComposer } from 'three/examples/jsm/Addons.js';
+import { EffectComposer } from 'postprocessing';
 import { OrbitControls } from 'three/examples/jsm/Addons.js';
 import * as THREE from 'three';
 
@@ -683,6 +683,71 @@ export declare function awaitTimeout<T>(promise: Promise<T>, time?: number): Pro
  */
 export declare function awaitTimeoutThrows<T>(promise: Promise<T>, time?: number): Promise<T>;
 
+declare class BackgroundRenderer {
+    auth: Authentication;
+    avatarCyclorama?: Instance;
+    backgroundData?: Instance;
+    backgroundId?: number;
+    lastLoadedBackgroundId?: number;
+    currentlyUpdating: boolean;
+    hasNewUpdate: boolean;
+    affectSceneAppearance: boolean;
+    cameraAffectsTransparency: boolean;
+    lastFrameTime: number;
+    animationInterval?: NodeJS.Timeout;
+    animationFPS: number;
+    renderScene: RBXRendererScene;
+    private _renderSceneCompiledConnection?;
+    private _renderSceneFailedConnection?;
+    hasFiredFullyRendered: boolean;
+    /**Event is fired if a new outfit failed to load (specifically the Instance tree, not the rendering part)
+     *
+     * Simple: Fired when, Instance tree = fail
+     * @returns BackgroundRendererErrorType
+     */
+    onError: Event_2;
+    /**Event is fired if a new outfit successfully loaded (specifically the Instance tree, not the rendering part)
+     *
+     * Simple: Fired when, Instance tree = done
+     * @returns void
+     */
+    onSuccess: Event_2;
+    /**Event is fired when all the renderDescs have been compiled, if any renderDescs fail to render this wil never be fired (can only be fired after Instance tree is done)
+     *
+     * Simple: Fired when, Instance tree = done & Rendering = done (AKA everything)
+     * @returns void
+     */
+    onRenderSuccess: Event_2;
+    /**Event is fired if a renderDesc fails to compile, it can be fired multiple times
+     *
+     * Simple: Fired when, Rendering = fail
+     * @returns void
+     */
+    onRenderError: Event_2;
+    constructor(auth: Authentication, backgroundId?: number, renderScene?: RBXRendererScene);
+    /**Updates background to match the set id */
+    setBackground(id?: number): void;
+    _updateBackground(): Promise<void>;
+    _loadBackgroundData(): Promise<void>;
+    _loadAvatarCyclorama(): Promise<void>;
+    _applyBackgroundData(): void;
+    /**
+     * Starts updating the animation of the background per frame
+     */
+    startAnimating(): void;
+    /**
+     * Updates the animation once
+     */
+    animateOnce(): void;
+    /**
+     * Stops updating the animation of the background per frame
+     */
+    stopAnimating(): void;
+    fireFullyRenderedIfNeeded(): void;
+    /**Calls destroy on the background, stops animating and disconnects connections. The OutfitRenderer should not be interacted with after this */
+    destroy(): void;
+}
+
 /**
  * @category Mesh
  */
@@ -1010,6 +1075,7 @@ export declare class Color3 {
     clone(): Color3;
     isSame(other: Color3): boolean;
     toColor3uint8(): Color3uint8;
+    toArray(): Vec3;
     multiply(vec3: Color3): Color3;
     divide(vec3: Color3): Color3;
     add(vec3: Color3): Color3;
@@ -1026,6 +1092,7 @@ export declare class Color3uint8 {
     constructor(R?: number, G?: number, B?: number);
     clone(): Color3uint8;
     toColor3(): Color3;
+    toArray(): Vec3;
 }
 
 /**
@@ -2041,6 +2108,7 @@ export declare class Instance {
     FindFirstChildOfClass(className: string): Instance | undefined;
     FindLastChildOfClass(className: string): Instance | undefined;
     IsA(className: string): boolean;
+    IsDescendantOf(instance: Instance): boolean;
     preRender(): void;
 }
 
@@ -2894,6 +2962,7 @@ export declare const OutfitOrigin: {
  */
 export declare class OutfitRenderer {
     auth: Authentication;
+    outfitModel?: OutfitModel;
     outfit: Outfit;
     currentRig?: Instance; /**Instance for the Model of the current outfit */
     currentRigType: AvatarType;
@@ -2901,6 +2970,7 @@ export declare class OutfitRenderer {
     doCameraUpdate: boolean; /**Does camera update every frame */
     doAddInstance: boolean; /**If outfitRenderer should call RBXRenderer.addInstance() */
     forceAnimationLoop: boolean; /**If future loaded animations should be set to loop */
+    backgroundRenderer: BackgroundRenderer;
     currentlyChangingRig: boolean;
     currentlyUpdating: boolean;
     hasNewUpdate: boolean;
@@ -2912,6 +2982,7 @@ export declare class OutfitRenderer {
     renderScene: RBXRendererScene;
     private _renderSceneCompiledConnection?;
     private _renderSceneFailedConnection?;
+    hasFiredFullyRendered: boolean;
     /**Event is fired if a new outfit failed to load (specifically the Instance tree, not the rendering part)
      *
      * Simple: Fired when, Instance tree = fail
@@ -2944,7 +3015,7 @@ export declare class OutfitRenderer {
      * @param outfit The outfit you want to render, it can be updated later by calling setOutfit()
      * @param renderScene The scene the outfit should be rendered in
      */
-    constructor(auth: Authentication, outfit: Outfit, renderScene?: RBXRendererScene);
+    constructor(auth: Authentication, outfit: Outfit | OutfitModel, renderScene?: RBXRendererScene);
     /**
      * Updates the current rig, called internally by _updateOutfit()
      */
@@ -2957,6 +3028,10 @@ export declare class OutfitRenderer {
      * Updates the current outfit being rendered
      */
     setOutfit(outfit: Outfit): void;
+    /**
+     * Updates the current outfitModel being rendered
+     */
+    setOutfitModel(outfitModel: OutfitModel): void;
     /**
      * Centers camera on avatar
      */
@@ -3261,23 +3336,27 @@ export declare class RBXRenderer {
     static scenes: RBXRendererScene[];
     static get firstScene(): RBXRendererScene;
     /**@deprecated This can only get the first renderScene's scene */
-    static get scene(): THREE.Scene;
+    static get scene(): THREE.Scene<THREE.Object3DEventMap>;
     /**@deprecated This can only get the first renderScene's camera */
     static get camera(): THREE.PerspectiveCamera;
     /**@deprecated This can only get the first renderScene's controls */
-    static get controls(): OrbitControls | undefined;
+    static get controls(): OrbitControls<THREE.Camera> | undefined;
     static renderer?: THREE.WebGLRenderer;
     static resolution: [number, number];
-    static backgroundColorHex: number;
+    static backgroundColor: THREE.ColorRepresentation;
+    /**@deprecated Use backgroundColor instead */
+    static get backgroundColorHex(): number;
+    /**@deprecated Use backgroundColor instead */
+    static set backgroundColorHex(val: number);
     static backgroundTransparent: boolean;
     static createLoadingIcon: boolean;
     static canvasContainer: HTMLDivElement;
     static loadingIcon?: HTMLSpanElement;
     static loadingIconStyle?: HTMLStyleElement;
     /**@deprecated This can only get the first renderScene's plane */
-    static get plane(): THREE.Mesh<THREE.BufferGeometry<THREE.NormalBufferAttributes, THREE.BufferGeometryEventMap>, THREE.Material | THREE.Material[], THREE.Object3DEventMap> | undefined;
+    static get plane(): THREE.Mesh<THREE.BufferGeometry<THREE.NormalBufferAttributes, THREE.BufferGeometryEventMap>, THREE.Material<THREE.MaterialEventMap> | THREE.Material<THREE.MaterialEventMap>[], THREE.Object3DEventMap> | undefined;
     /**@deprecated This can only get the first renderScene's shadowPlane */
-    static get shadowPlane(): THREE.Mesh<THREE.BufferGeometry<THREE.NormalBufferAttributes, THREE.BufferGeometryEventMap>, THREE.Material | THREE.Material[], THREE.Object3DEventMap> | undefined;
+    static get shadowPlane(): THREE.Mesh<THREE.BufferGeometry<THREE.NormalBufferAttributes, THREE.BufferGeometryEventMap>, THREE.Material<THREE.MaterialEventMap> | THREE.Material<THREE.MaterialEventMap>[], THREE.Object3DEventMap> | undefined;
     /**@deprecated This can only get the first renderScene's ambientLight */
     static get ambientLight(): THREE.AmbientLight | undefined;
     /**@deprecated This can only get the first renderScene's directionalLight */
@@ -3305,15 +3384,15 @@ export declare class RBXRenderer {
     static setupLostContextHandler(): void;
     /**Sets up a basic scene with lighting
      * @param lightingType "WellLit" is the default lighting for RoAvatar, "Thumbnail" tries to match the Roblox thumbnail lighting
-     * @param backgroundColorHex is the hex code for the background color, for example 0x2b2d33
+     * @param backgroundColor is the color code for the background color, for example 0x2b2d33
      */
-    static setupScene(lightingType?: "WellLit" | "Thumbnail", backgroundColorHex?: number, renderScene?: RBXRendererScene): void;
+    static setupScene(lightingType?: "WellLit" | "Thumbnail", backgroundColorVal?: THREE.ColorRepresentation, renderScene?: RBXRendererScene): void;
     /**Sets up orbit controls */
     static setupControls(renderScene?: RBXRendererScene): void;
     /**
-     * @param colorHex example: 0x2b2d33 which is the default
+     * @param color example: 0x2b2d33 which is the default
      */
-    static setBackgroundColor(colorHex: number): void;
+    static setBackgroundColor(color: THREE.ColorRepresentation): void;
     /**
      * Sets the background and ground's visibility, but not the shadowPlane
      * @param transparent If the background and ground should be transparent
@@ -3352,7 +3431,7 @@ export declare class RBXRenderer {
      */
     static getRenderer(): THREE.WebGLRenderer | undefined;
     /**@deprecated This can only get the first renderScene's scene */
-    static getScene(): THREE.Scene;
+    static getScene(): THREE.Scene<THREE.Object3DEventMap>;
     /**
      * @deprecated Superseded by RBXRendererScene.exportGLTF()
      * This function is unstable and can throw errors, but might work