@tresjs/core 5.1.0 → 5.1.1

package/dist/src/utils/is/three.d.ts

@@ -1,162 +0,0 @@
-import { BufferGeometry, Camera, Color, ColorRepresentation, Fog, Group, Light, Material, Mesh, Object3D, OrthographicCamera, PerspectiveCamera, Scene, Layers } from 'three';
-/**
- * Type guard to check if a value is a Three.js Object3D
- * @param value - The value to check
- * @returns True if the value is a Three.js Object3D instance, false otherwise
- * @example
- * ```ts
- * const value = new THREE.Object3D()
- * if (isObject3D(value)) {
- *   // TypeScript knows value is Object3D here
- *   value.position // OK
- *   value.rotation // OK
- *   value.scale // OK
- * }
- * ```
- */
-export declare const isObject3D: (value: unknown) => value is Object3D<import('three').Object3DEventMap>;
-/**
- * Type guard to check if a value is a Three.js Mesh
- * @param value - The value to check
- * @returns True if the value is a Three.js Mesh instance, false otherwise
- * @example
- * ```ts
- * const value = new THREE.Mesh()
- * if (isMesh(value)) {
- *   // TypeScript knows value is Mesh here
- *   value.geometry // OK
- */
-export declare const isMesh: (value: unknown) => value is Mesh<BufferGeometry<import('three').NormalBufferAttributes, import('three').BufferGeometryEventMap>, Material | Material[], import('three').Object3DEventMap>;
-/**
- * Type guard to check if a value is a Three.js Camera
- * @param value - The value to check
- * @returns True if the value is a Three.js Camera instance, false otherwise
- * @example
- * ```ts
- * const value = new THREE.PerspectiveCamera()
- * if (isCamera(value)) {
- *   // TypeScript knows value is Camera here
- *   value.fov // OK
- *   value.near // OK
- *   value.far // OK
- * }
- * ```
- */
-export declare const isCamera: (value: unknown) => value is Camera;
-/**
- * Type guard to check if a value is a Three.js OrthographicCamera
- * @param value - The value to check
- * @returns True if the value is a Three.js OrthographicCamera instance, false otherwise
- */
-export declare const isOrthographicCamera: (value: unknown) => value is OrthographicCamera;
-/**
- * Type guard to check if a value is a Three.js PerspectiveCamera
- * @param value - The value to check
- * @returns True if the value is a Three.js PerspectiveCamera instance, false otherwise
- */
-export declare const isPerspectiveCamera: (value: unknown) => value is PerspectiveCamera;
-/**
- * Type guard to check if a value is a Three.js Color
- * @param value - The value to check
- * @returns True if the value is a Three.js Color instance, false otherwise
- */
-export declare const isColor: (value: unknown) => value is Color;
-/**
- * Type guard to check if a value is a Three.js ColorRepresentation
- * @param value - The value to check
- * @returns True if the value is a Three.js ColorRepresentation instance, false otherwise
- */
-export declare const isColorRepresentation: (value: unknown) => value is ColorRepresentation;
-/**
- * Type guard to check if a value is a Three.js Layers
- * @param value - The value to check
- * @returns True if the value is a Three.js Layers instance, false otherwise
- */
-export declare const isLayers: (value: unknown) => value is Layers;
-/**
- * Type guard to check if a value is a Three.js BufferGeometry
- * @param value - The value to check
- * @returns True if the value is a Three.js BufferGeometry instance, false otherwise
- * @example
- * ```ts
- * const value = new THREE.BufferGeometry()
- * if (isBufferGeometry(value)) {
- *   // TypeScript knows value is BufferGeometry here
- *   value.attributes // OK
- *   value.index // OK
- *   value.computeVertexNormals() // OK
- * }
- * ```
- */
-export declare const isBufferGeometry: (value: unknown) => value is BufferGeometry<import('three').NormalBufferAttributes, import('three').BufferGeometryEventMap>;
-/**
- * Type guard to check if a value is a Three.js Material
- * @param value - The value to check
- * @returns True if the value is a Three.js Material instance, false otherwise
- * @example
- * ```ts
- * const value = new THREE.MeshStandardMaterial()
- * if (isMaterial(value)) {
- *   // TypeScript knows value is Material here
- *   value.color // OK
- *   value.metalness // OK
- *   value.roughness // OK
- * }
- * ```
- */
-export declare const isMaterial: (value: unknown) => value is Material;
-/**
- * Type guard to check if a value is a Three.js Light
- * @param value - The value to check
- * @returns True if the value is a Three.js Light instance, false otherwise
- * @example
- * ```ts
- * const value = new THREE.DirectionalLight()
- * if (isLight(value)) {
- *   // TypeScript knows value is Light here
- *   value.intensity // OK
- *   value.color // OK
- *   value.position // OK
- * }
- * ```
- */
-export declare const isLight: (value: unknown) => value is Light<import('three').LightShadow<Camera> | undefined>;
-/**
- * Type guard to check if a value is a Three.js Fog
- * @param value - The value to check
- * @returns True if the value is a Three.js Fog instance, false otherwise
- * @example
- * ```ts
- * const value = new THREE.Fog(0x000000, 1, 1000)
- * if (isFog(value)) {
- *   // TypeScript knows value is Fog here
- *   value.color // OK
- *   value.near // OK
- *   value.far // OK
- * }
- * ```
- */
-export declare const isFog: (value: unknown) => value is Fog;
-/**
- * Type guard to check if a value is a Three.js Scene
- * @param value - The value to check
- * @returns True if the value is a Three.js Scene instance, false otherwise
- * @example
- * ```ts
- * const value = new THREE.Scene()
- * if (isScene(value)) {
- *   // TypeScript knows value is Scene here
- *   value.children // OK
- *   value.add(new THREE.Object3D()) // OK
- *   value.remove(new THREE.Object3D()) // OK
- * }
- * ```
- */
-export declare const isScene: (value: unknown) => value is Scene;
-/**
- * Type guard to check if a value is a Three.js Group
- * @param value - The value to check
- * @returns True if the value is a Three.js Group instance, false otherwise
- * ```
- */
-export declare const isGroup: (value: unknown) => value is Group<import('three').Object3DEventMap>;

package/dist/src/utils/is/tres.d.ts

@@ -1,70 +0,0 @@
-import { TresCamera, TresInstance, TresObject, TresPrimitive } from '../../types';
-interface VectorLike {
-    set: (...args: any[]) => void;
-    constructor?: (...args: any[]) => any;
-}
-export declare const isVectorLike: (value: unknown) => value is VectorLike;
-interface Copyable {
-    copy: (...args: any[]) => void;
-    constructor?: (...args: any[]) => any;
-}
-export declare const isCopyable: (value: unknown) => value is Copyable;
-interface ClassInstance {
-    constructor?: (...args: any[]) => any;
-}
-export declare const isClassInstance: (object: unknown) => object is ClassInstance;
-/**
- * Type guard to check if a value is a TresCamera
- * @param value - The value to check
- * @returns True if the value is a TresCamera instance, false otherwise
- */
-export declare const isTresCamera: (value: unknown) => value is TresCamera;
-/**
- * Type guard to check if a value is a TresObject
- * @param value - The value to check
- * @returns True if the value is a TresObject (Object3D | BufferGeometry | Material | Fog), false otherwise
- * @example
- * ```ts
- * const value = new THREE.Mesh()
- * if (isTresObject(value)) {
- *   // TypeScript knows value is TresObject here
- *   // You can use common properties and methods shared by all TresObjects
- * }
- * ```
- * @remarks
- * TresObject is a union type that represents the core Three.js objects that can be used in TresJS.
- * This includes Object3D, BufferGeometry, Material, and Fog instances.
- */
-export declare const isTresObject: (value: unknown) => value is TresObject;
-/**
- * Type guard to check if a value is a TresPrimitive
- * @param value - The value to check
- * @returns True if the value is a TresPrimitive instance, false otherwise
- * @example
- * ```ts
- * const value = { isPrimitive: true }
- * if (isTresPrimitive(value)) {
- *   // TypeScript knows value is TresPrimitive here
- *   // You can use properties and methods specific to TresPrimitives
- * }
- * ```
- * @remarks
- * TresPrimitive is a special type in TresJS that represents primitive objects
- * that can be used directly in the scene without needing to be wrapped in a Three.js object.
- */
-export declare const isTresPrimitive: (value: unknown) => value is TresPrimitive;
-/**
- * Type guard to check if a value is a TresInstance (has __tres property)
- * @param value - The value to check
- * @returns True if the value is a TresInstance (has __tres property), false otherwise
- * @example
- * ```ts
- * const value = new THREE.Mesh()
- * if (isTresInstance(value)) {
- *   // TypeScript knows value is TresInstance here
- *   // You can safely access value.__tres
- * }
- * ```
- */
-export declare const isTresInstance: (value: unknown) => value is TresInstance;
-export {};

package/dist/src/utils/is/typed.d.ts

@@ -1 +0,0 @@
-export { isBoolean, isEqual, isFunction, isNumber, isObject, isString, isUndefined } from 'radashi';

package/dist/src/utils/is/util.d.ts

@@ -1 +0,0 @@
-export declare const createTypeGuard: <T>(property: keyof T) => (value: unknown) => value is T;

package/dist/src/utils/logger.d.ts

@@ -1,25 +0,0 @@
-/**
- * Logger utility for TresJS
- * @module logger
- */
-export declare const isProd: boolean;
-type OneOrMore<T> = {
-    0: T;
-} & Array<T>;
-/**
- * Logs an error message with the TresJS prefix
- * @param args - Arguments to log
- */
-export declare function logError(...args: OneOrMore<any>): void;
-/**
- * Logs a warning message with the TresJS prefix
- * @param args - Arguments to log
- */
-export declare function logWarning(...args: OneOrMore<any>): void;
-/**
- * Logs a message with the TresJS prefix (only in development mode)
- * @param name - Name of the message
- * @param value - Value to log
- */
-export declare function logMessage(name: string, value: any): void;
-export {};

package/dist/src/utils/makeMap.d.ts

@@ -1,9 +0,0 @@
-/**
- * Make a map and return a function for checking if a key
- * is in that map.
- * IMPORTANT: all calls of this function must be prefixed with
- * \/\*#\_\_PURE\_\_\*\/
- * So that rollup can tree-shake them if necessary.
- */
-/*! #__NO_SIDE_EFFECTS__ */
-export declare function makeMap(str: string): (key: string) => boolean;

package/dist/src/utils/normalize.d.ts

@@ -1,17 +0,0 @@
-import { ColorRepresentation, Color, Vector3 } from 'three';
-export type SizeFlexibleParams = number[] | {
-    width: number;
-    height: number;
-};
-export interface Vector2PropInterface {
-    x?: number;
-    y?: number;
-    width?: number;
-    height?: number;
-}
-export interface Vector3PropInterface extends Vector2PropInterface {
-    z?: number;
-}
-export type VectorFlexibleParams = Vector3 | number[] | Vector3PropInterface | number;
-export declare function normalizeVectorFlexibleParam(value: VectorFlexibleParams): Array<number>;
-export declare function normalizeColor(value: Color | Array<number> | string | number | ColorRepresentation): Color;

package/dist/src/utils/perf.d.ts

@@ -1,7 +0,0 @@
-import { Scene } from 'three';
-import { TresObject } from './../types';
-export declare function calculateMemoryUsage(object: TresObject | Scene): number;
-export declare function boundedPush<T>(arr: T[], value: T, max: number): void;
-export declare function bytesToKB(bytes: number): string;
-export declare function bytesToMB(bytes: number): string;
-export declare function bytesToGB(bytes: number): string;

package/dist/src/utils/pointerEvents.d.ts

@@ -1,10 +0,0 @@
-import { PointerEvent } from '@pmndrs/pointer-events';
-export declare const supportedPointerEvents: readonly ["onClick", "onContextmenu", "onPointermove", "onPointerenter", "onPointerleave", "onPointerover", "onPointerout", "onDblclick", "onPointerdown", "onPointerup", "onPointercancel", "onLostpointercapture", "onWheel"];
-export type SupportedVuePointerEvent = typeof supportedPointerEvents[number];
-export type TresPointerEventName = 'click' | 'contextmenu' | 'pointermove' | 'pointerenter' | 'pointerleave' | 'pointerover' | 'pointerout' | 'dblclick' | 'pointerdown' | 'pointerup' | 'pointercancel' | 'lostpointercapture' | 'wheel';
-export declare const pointerEventsMapVueToThree: Record<SupportedVuePointerEvent, TresPointerEventName>;
-export declare const isSupportedPointerEvent: (event: string) => event is SupportedVuePointerEvent;
-export type TresPointerEvent = PointerEvent<MouseEvent>;
-export type PointerEventHandlers = {
-    [key in SupportedVuePointerEvent]: (event: TresPointerEvent) => void;
-};

package/dist/src/utils/primitive/createRetargetingProxy.d.ts

@@ -1 +0,0 @@
-export declare function createRetargetingProxy<T extends Record<string | number | symbol, any>, K extends keyof T & string & symbol>(target: T, getters?: Record<string | number | symbol, (t: T) => unknown>, setters?: Record<K, (val: T[K], t: T, proxy: T, setTarget: (newTarget: T) => void) => boolean>): T;

package/dist/src/utils/string.d.ts

@@ -1 +0,0 @@
-export { camel } from 'radashi';

package/dist/src/utils/template-compiler-options.d.ts

@@ -1,8 +0,0 @@
-declare const templateCompilerOptions: {
-    template: {
-        compilerOptions: {
-            isCustomElement: (tag: string) => boolean;
-        };
-    };
-};
-export default templateCompilerOptions;

package/dist/src/utils/test-utils.d.ts

@@ -1,2 +0,0 @@
-import { Fn } from '@vueuse/core';
-export declare function withSetup(composable: Fn): (import('vue').App<Element> | undefined)[];

package/dist/src/utils/three.d.ts

@@ -1,9 +0,0 @@
-import { Object3D } from 'three';
-/**
- * Recursively searches for an Object3D with the specified UUID within a Three.js scene graph.
- *
- * @param node - The root Object3D to start searching from
- * @param uuid - The unique identifier of the object to find
- * @returns The Object3D with the matching UUID, or undefined if not found
- */
-export declare const getObjectByUuid: (node: Object3D, uuid: string) => Object3D | undefined;

package/types.d.ts

@@ -1 +0,0 @@
-export * from '../../dist/src/types/index.js'

package/utils.d.ts

@@ -1 +0,0 @@
-export * from '../../dist/src/utils/index.js'