@reactvision/react-viro 2.42.0 → 2.43.1

package/dist/fabric-interop/components/Types/ViroEvents.js

@@ -0,0 +1,53 @@
+"use strict";
+/**
+ * ViroEvents
+ *
+ * Type definitions for Viro event handling.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViroRecordingErrorConstants = exports.ViroARTrackingReasonConstants = exports.ViroTrackingStateConstants = exports.ViroRotateStateTypes = exports.ViroPinchStateTypes = exports.ViroClickStateTypes = void 0;
+// Click state types
+var ViroClickStateTypes;
+(function (ViroClickStateTypes) {
+    ViroClickStateTypes[ViroClickStateTypes["CLICK_DOWN"] = 1] = "CLICK_DOWN";
+    ViroClickStateTypes[ViroClickStateTypes["CLICK_UP"] = 2] = "CLICK_UP";
+    ViroClickStateTypes[ViroClickStateTypes["CLICKED"] = 3] = "CLICKED";
+})(ViroClickStateTypes || (exports.ViroClickStateTypes = ViroClickStateTypes = {}));
+// Pinch state types
+var ViroPinchStateTypes;
+(function (ViroPinchStateTypes) {
+    ViroPinchStateTypes[ViroPinchStateTypes["PINCH_START"] = 1] = "PINCH_START";
+    ViroPinchStateTypes[ViroPinchStateTypes["PINCH_MOVE"] = 2] = "PINCH_MOVE";
+    ViroPinchStateTypes[ViroPinchStateTypes["PINCH_END"] = 3] = "PINCH_END";
+})(ViroPinchStateTypes || (exports.ViroPinchStateTypes = ViroPinchStateTypes = {}));
+// Rotate state types
+var ViroRotateStateTypes;
+(function (ViroRotateStateTypes) {
+    ViroRotateStateTypes[ViroRotateStateTypes["ROTATE_START"] = 1] = "ROTATE_START";
+    ViroRotateStateTypes[ViroRotateStateTypes["ROTATE_MOVE"] = 2] = "ROTATE_MOVE";
+    ViroRotateStateTypes[ViroRotateStateTypes["ROTATE_END"] = 3] = "ROTATE_END";
+})(ViroRotateStateTypes || (exports.ViroRotateStateTypes = ViroRotateStateTypes = {}));
+// Tracking state constants
+var ViroTrackingStateConstants;
+(function (ViroTrackingStateConstants) {
+    ViroTrackingStateConstants[ViroTrackingStateConstants["TRACKING_NORMAL"] = 0] = "TRACKING_NORMAL";
+    ViroTrackingStateConstants[ViroTrackingStateConstants["TRACKING_LIMITED"] = 1] = "TRACKING_LIMITED";
+    ViroTrackingStateConstants[ViroTrackingStateConstants["TRACKING_UNAVAILABLE"] = 2] = "TRACKING_UNAVAILABLE";
+})(ViroTrackingStateConstants || (exports.ViroTrackingStateConstants = ViroTrackingStateConstants = {}));
+var ViroARTrackingReasonConstants;
+(function (ViroARTrackingReasonConstants) {
+    ViroARTrackingReasonConstants[ViroARTrackingReasonConstants["TRACKING_REASON_NONE"] = 0] = "TRACKING_REASON_NONE";
+    ViroARTrackingReasonConstants[ViroARTrackingReasonConstants["TRACKING_REASON_EXCESSIVE_MOTION"] = 1] = "TRACKING_REASON_EXCESSIVE_MOTION";
+    ViroARTrackingReasonConstants[ViroARTrackingReasonConstants["TRACKING_REASON_INSUFFICIENT_FEATURES"] = 2] = "TRACKING_REASON_INSUFFICIENT_FEATURES";
+})(ViroARTrackingReasonConstants || (exports.ViroARTrackingReasonConstants = ViroARTrackingReasonConstants = {}));
+// Recording constants
+var ViroRecordingErrorConstants;
+(function (ViroRecordingErrorConstants) {
+    ViroRecordingErrorConstants[ViroRecordingErrorConstants["RECORD_ERROR_NONE"] = 0] = "RECORD_ERROR_NONE";
+    ViroRecordingErrorConstants[ViroRecordingErrorConstants["RECORD_ERROR_UNKNOWN"] = 1] = "RECORD_ERROR_UNKNOWN";
+    ViroRecordingErrorConstants[ViroRecordingErrorConstants["RECORD_ERROR_NO_PERMISSION"] = 2] = "RECORD_ERROR_NO_PERMISSION";
+    ViroRecordingErrorConstants[ViroRecordingErrorConstants["RECORD_ERROR_INITIALIZATION"] = 3] = "RECORD_ERROR_INITIALIZATION";
+    ViroRecordingErrorConstants[ViroRecordingErrorConstants["RECORD_ERROR_WRITE_TO_FILE"] = 4] = "RECORD_ERROR_WRITE_TO_FILE";
+    ViroRecordingErrorConstants[ViroRecordingErrorConstants["RECORD_ERROR_ALREADY_RUNNING"] = 5] = "RECORD_ERROR_ALREADY_RUNNING";
+    ViroRecordingErrorConstants[ViroRecordingErrorConstants["RECORD_ERROR_ALREADY_STOPPED"] = 6] = "RECORD_ERROR_ALREADY_STOPPED";
+})(ViroRecordingErrorConstants || (exports.ViroRecordingErrorConstants = ViroRecordingErrorConstants = {}));

package/dist/fabric-interop/components/Types/ViroUtils.d.ts

@@ -0,0 +1,137 @@
+/**
+ * ViroUtils
+ *
+ * Type definitions for Viro utility types.
+ */
+import { ImageSourcePropType, NativeMethods } from "react-native";
+/**
+ * Cartesian position in 3D space, stored as [x, y, z].
+ */
+export type Viro3DPoint = [
+    number,
+    number,
+    number
+];
+/**
+ * The rotation of the container around it's local axis specified as Euler angles [x, y, z].
+ * Units for each angle are specified in degrees.
+ */
+export type ViroRotation = [
+    number,
+    number,
+    number
+];
+/**
+ * The scale of the container in 3D space, specified as [x,y,z]. A scale of
+ * 1 represents the current size of the container. A scale value of < 1
+ * will make the container proportionally smaller while a value >1 will make
+ * the container proportionally bigger along the specified axis.
+ */
+export type ViroScale = [
+    number,
+    number,
+    number
+];
+export type ViroNativeRef = (React.Component<unknown, {}, any> & Readonly<NativeMethods>) | null;
+export type ViroPhysicsBody = {
+    /**
+     * The type of this rigid body.
+     */
+    type: ViroPhysicsBodyType;
+    /**
+     * The mass of this physics body in kg.
+     */
+    mass?: number;
+    /**
+     * Describes the shape that represents this physics body.
+     */
+    shape?: ViroPhysicsBodyShape;
+    /**
+     * The bounciness of an object. Value of 0.0 will not bounce.
+     * Value of 1.0 will bounce without any loss of energy.
+     */
+    restitution?: number;
+    /**
+     * Determines the force of resistance an object or surface encounters when moving
+     * across another. Value of 0.0 implies no friction. Value of 1.0 implies high friction.
+     */
+    friction?: number;
+    /**
+     * If false, this physics object will ignore all gravitational forces that are
+     * applied on this object.
+     */
+    useGravity?: boolean;
+    /**
+     * If false, disables all physics properties on the Viro control (as if there
+     * were no physics bodies applied).
+     */
+    enabled?: boolean;
+    /**
+     * A single force vector or an array of force vectors applied to the physics body.
+     * If an array of forces is provided, the corresponding net force will be applied.
+     * Force units are in newtons.
+     */
+    force?: number[];
+    /**
+     * A single torque vector or an array of torque vectors applied to the physics body.
+     * If an array of torque is provided, the corresponding net torque will be applied.
+     * Torque units are in newton meters.
+     */
+    torque?: number[];
+    /**
+     * Used to directly move an object without applying a force.
+     * Units are m/s. Doing so will override any forces that are already
+     * applied on this physics body.
+     */
+    velocity?: number[];
+};
+export type ViroPhysicsBodyType = "Dynamic" | "Kinematic" | "Static";
+export type ViroPhysicsBodyShape = {
+    type: ViroPhysicsBodyShapeType;
+    params: number[];
+};
+export type ViroPhysicsBodyShapeType = "Box" | "Sphere" | "Compound";
+/**
+ * A single force vector or an array of force vectors applied to the physics body.
+ * If an array of forces is provided, the corresponding net force will be applied.
+ * Force units are in newtons.
+ */
+export type ViroForce = {
+    value: Array<number>;
+    position: Array<number>;
+};
+export type ViroSource = ImageSourcePropType;
+export type ViroARPlaneType = any;
+export type ViroSoundRoom = {
+    size: ViroScale;
+    wallMaterial: string;
+    ceilingMaterial: string;
+    floorMaterial: string;
+};
+export type ViroPhysicsWorld = {
+    gravity: number;
+    drawBounds?: boolean;
+};
+export type ViroRay = any;
+export type ViroTorque = any;
+export type ViroVelocity = any;
+export type Viro2DPoint = [number, number];
+export type ViroUVCoordinate = [number, number, number, number];
+export type ViroSoundMap = {
+    [key: string]: ViroSound;
+};
+export type ViroSound = string;
+export type ViroSoundPreloadResult = {
+    [key: string]: {
+        result: any;
+        msg: any;
+    };
+};
+export type ViroScene = {
+    tag: string;
+    referenceCount: number;
+    sceneClass: any;
+};
+export type ViroSceneDictionary = {
+    [key: string]: ViroScene;
+};

package/dist/fabric-interop/components/Types/ViroUtils.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * ViroUtils
+ *
+ * Type definitions for Viro utility types.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/fabric-interop/components/Viro360Image.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Viro360Image
+ *
+ * A component for displaying 360-degree images.
+ */
+import React from "react";
+import { ViroCommonProps } from "./ViroUtils";
+export interface Viro360ImageProps extends ViroCommonProps {
+    source: {
+        uri: string;
+    } | number;
+    stereoMode?: "LeftRight" | "RightLeft" | "TopBottom" | "BottomTop" | "None";
+    format?: "RGBA8" | "RGB565";
+    isHdr?: boolean;
+    onLoadStart?: () => void;
+    onLoadEnd?: () => void;
+    onError?: (error: string) => void;
+}
+/**
+ * Viro360Image is a component for displaying 360-degree images.
+ * It creates an immersive environment using spherical panoramic images.
+ */
+export declare const Viro360Image: React.FC<Viro360ImageProps>;

package/dist/fabric-interop/components/Viro360Image.js

@@ -0,0 +1,45 @@
+"use strict";
+/**
+ * Viro360Image
+ *
+ * A component for displaying 360-degree images.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Viro360Image = void 0;
+const ViroUtils_1 = require("./ViroUtils");
+/**
+ * Viro360Image is a component for displaying 360-degree images.
+ * It creates an immersive environment using spherical panoramic images.
+ */
+const Viro360Image = (props) => {
+    // Convert common props to the format expected by the native code
+    const nativeProps = {
+        ...(0, ViroUtils_1.convertCommonProps)(props),
+        source: props.source,
+        stereoMode: props.stereoMode,
+        format: props.format,
+        isHdr: props.isHdr,
+    };
+    // Create the node (parent will be determined by context)
+    const nodeId = (0, ViroUtils_1.useViroNode)("360Image", nativeProps);
+    // Register event handlers using our new event system
+    (0, ViroUtils_1.useViroEventListeners)(nodeId, {
+        onHover: props.onHover,
+        onClick: props.onClick,
+        onClickState: props.onClickState,
+        onTouch: props.onTouch,
+        onScroll: props.onScroll,
+        onSwipe: props.onSwipe,
+        onDrag: props.onDrag,
+        onPinch: props.onPinch,
+        onRotate: props.onRotate,
+        onFuse: typeof props.onFuse === "function"
+            ? props.onFuse
+            : props.onFuse?.callback,
+        onCollision: props.onCollision,
+        onTransformUpdate: props.onTransformUpdate,
+    });
+    // Component doesn't have children, so just return null
+    return null;
+};
+exports.Viro360Image = Viro360Image;

package/dist/fabric-interop/components/Viro360Video.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Viro360Video
+ *
+ * A component for displaying 360-degree videos.
+ */
+import React from "react";
+import { ViroCommonProps } from "./ViroUtils";
+export interface Viro360VideoProps extends ViroCommonProps {
+    source: {
+        uri: string;
+    } | number;
+    paused?: boolean;
+    loop?: boolean;
+    muted?: boolean;
+    volume?: number;
+    stereoMode?: "LeftRight" | "RightLeft" | "TopBottom" | "BottomTop" | "None";
+    onLoadStart?: () => void;
+    onLoadEnd?: () => void;
+    onBufferStart?: () => void;
+    onBufferEnd?: () => void;
+    onFinish?: () => void;
+    onUpdateTime?: (currentTime: number, totalTime: number) => void;
+    onError?: (error: string) => void;
+}
+/**
+ * Viro360Video is a component for displaying 360-degree videos.
+ * It creates an immersive environment using spherical panoramic videos.
+ */
+export declare const Viro360Video: React.FC<Viro360VideoProps>;

package/dist/fabric-interop/components/Viro360Video.js

@@ -0,0 +1,47 @@
+"use strict";
+/**
+ * Viro360Video
+ *
+ * A component for displaying 360-degree videos.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Viro360Video = void 0;
+const ViroUtils_1 = require("./ViroUtils");
+/**
+ * Viro360Video is a component for displaying 360-degree videos.
+ * It creates an immersive environment using spherical panoramic videos.
+ */
+const Viro360Video = (props) => {
+    // Convert common props to the format expected by the native code
+    const nativeProps = {
+        ...(0, ViroUtils_1.convertCommonProps)(props),
+        source: props.source,
+        paused: props.paused,
+        loop: props.loop,
+        muted: props.muted,
+        volume: props.volume,
+        stereoMode: props.stereoMode,
+    };
+    // Create the node (parent will be determined by context)
+    const nodeId = (0, ViroUtils_1.useViroNode)("360Video", nativeProps);
+    // Register event handlers using our new event system
+    (0, ViroUtils_1.useViroEventListeners)(nodeId, {
+        onHover: props.onHover,
+        onClick: props.onClick,
+        onClickState: props.onClickState,
+        onTouch: props.onTouch,
+        onScroll: props.onScroll,
+        onSwipe: props.onSwipe,
+        onDrag: props.onDrag,
+        onPinch: props.onPinch,
+        onRotate: props.onRotate,
+        onFuse: typeof props.onFuse === "function"
+            ? props.onFuse
+            : props.onFuse?.callback,
+        onCollision: props.onCollision,
+        onTransformUpdate: props.onTransformUpdate,
+    });
+    // Component doesn't have children, so just return null
+    return null;
+};
+exports.Viro360Video = Viro360Video;

package/dist/fabric-interop/components/Viro3DObject.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Viro3DObject
+ *
+ * A component for loading and displaying 3D models in various formats.
+ */
+import React from "react";
+import { ViroCommonProps } from "./ViroUtils";
+export interface Viro3DObjectProps extends ViroCommonProps {
+    source: {
+        uri: string;
+    } | number;
+    resources?: ({
+        uri: string;
+    } | number)[];
+    type: "OBJ" | "VRX" | "GLTF" | "GLB" | "FBX";
+    position?: [number, number, number];
+    scale?: [number, number, number] | number;
+    rotation?: [number, number, number];
+    materials?: string | string[];
+    morphTargets?: {
+        [key: string]: number;
+    };
+    animation?: {
+        name?: string;
+        delay?: number;
+        loop?: boolean;
+        onStart?: () => void;
+        onFinish?: () => void;
+        run?: boolean;
+        interruptible?: boolean;
+    };
+    lightReceivingBitMask?: number;
+    shadowCastingBitMask?: number;
+    highAccuracyEvents?: boolean;
+    physicsBody?: {
+        type: "Dynamic" | "Kinematic" | "Static";
+        mass?: number;
+        restitution?: number;
+        shape?: {
+            type: "Box" | "Sphere" | "Compound";
+            params?: number[];
+        };
+        friction?: number;
+        useGravity?: boolean;
+        enabled?: boolean;
+        velocity?: [number, number, number];
+        force?: {
+            value: [number, number, number];
+            position: [number, number, number];
+        };
+        torque?: [number, number, number];
+    };
+    onLoadStart?: () => void;
+    onLoadEnd?: () => void;
+    onError?: (error: string) => void;
+}
+/**
+ * Viro3DObject is a component for loading and displaying 3D models in various formats.
+ */
+export declare const Viro3DObject: React.FC<Viro3DObjectProps>;

package/dist/fabric-interop/components/Viro3DObject.js

@@ -0,0 +1,49 @@
+"use strict";
+/**
+ * Viro3DObject
+ *
+ * A component for loading and displaying 3D models in various formats.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Viro3DObject = void 0;
+const ViroUtils_1 = require("./ViroUtils");
+/**
+ * Viro3DObject is a component for loading and displaying 3D models in various formats.
+ */
+const Viro3DObject = (props) => {
+    // Convert common props to the format expected by the native code
+    const nativeProps = {
+        ...(0, ViroUtils_1.convertCommonProps)(props),
+        source: props.source,
+        resources: props.resources,
+        type: props.type,
+        materials: props.materials,
+        morphTargets: props.morphTargets,
+        lightReceivingBitMask: props.lightReceivingBitMask,
+        shadowCastingBitMask: props.shadowCastingBitMask,
+        highAccuracyEvents: props.highAccuracyEvents,
+        physicsBody: props.physicsBody,
+    };
+    // Create the node (parent will be determined by context)
+    const nodeId = (0, ViroUtils_1.useViroNode)("object", nativeProps);
+    // Register event handlers using our new event system
+    (0, ViroUtils_1.useViroEventListeners)(nodeId, {
+        onHover: props.onHover,
+        onClick: props.onClick,
+        onClickState: props.onClickState,
+        onTouch: props.onTouch,
+        onScroll: props.onScroll,
+        onSwipe: props.onSwipe,
+        onDrag: props.onDrag,
+        onPinch: props.onPinch,
+        onRotate: props.onRotate,
+        onFuse: typeof props.onFuse === "function"
+            ? props.onFuse
+            : props.onFuse?.callback,
+        onCollision: props.onCollision,
+        onTransformUpdate: props.onTransformUpdate,
+    });
+    // Component doesn't have children, so just return null
+    return null;
+};
+exports.Viro3DObject = Viro3DObject;

package/dist/fabric-interop/components/Viro3DSceneNavigator.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Viro3DSceneNavigator
+ *
+ * Component for transitioning between multiple scenes in a 3D environment.
+ */
+import * as React from "react";
+import { ViewProps } from "react-native";
+import { ViroScene } from "./ViroScene";
+type Props = ViewProps & {
+    /**
+     * initial scene key
+     */
+    initialSceneKey?: string;
+    /**
+     * A flag to enable/disable some debug features
+     */
+    debug?: boolean;
+    viroAppProps?: any;
+    /**
+     * ViroSceneNavigator uses "scene" objects like the following to
+     * describe a scene.
+     */
+    initialScene: {
+        /**
+         * The React Component to render for this scene.
+         */
+        scene: typeof ViroScene;
+        passProps?: any;
+    };
+    /**
+     * Called when either the user physically decides to exit vr (hits
+     * the "X" button).
+     */
+    onExitViro?: () => void;
+    /**
+     * Renderer settings that can be used to enable or disable various
+     * renderer capabilities and algorithms.
+     */
+    hdrEnabled?: boolean;
+    pbrEnabled?: boolean;
+    bloomEnabled?: boolean;
+    shadowsEnabled?: boolean;
+    multisamplingEnabled?: boolean;
+};
+/**
+ * Viro3DSceneNavigator is used to transition between multiple scenes.
+ */
+export declare function Viro3DSceneNavigator(props: Props): React.ReactElement;
+export {};