@davi-ai/react-bodyengine-three 1.0.0

package/README.md

@@ -0,0 +1,15 @@
+# React-bodyengine-three
+
+![types](https://img.shields.io/npm/types/scrub-js.svg)
+![licence](https://badges.frapsoft.com/os/mit/mit.png)
+
+## Description
+
+This package is based on [React Js](https://react.dev/). It creates an overlay over the package `@davi-ai/bodyengine-three` to use this one in React environment with tools to use every feature of the basic package.
+
+## Installation
+
+From npm :
+```bash
+  npm install @davi-ai/react-bodyengine-three
+```

package/dist/components/Character.d.ts

@@ -0,0 +1,3 @@
+import { CharacterProps } from '../models/types';
+declare const Character: ({ url, type, animationsUrl, gender, speechSynthesis, camera, onLoadingCompleted, autoLookAt, breathing, disableAnimations, debug, enableBml, animationWeights, license, detectGpuData }: CharacterProps) => JSX.Element;
+export default Character;

package/dist/components/Controllers/AnimationController.d.ts

@@ -0,0 +1,6 @@
+interface AnimationControllerProps {
+    animationsLoaded: boolean;
+    disableAnimations: boolean;
+}
+declare const AnimationController: ({ animationsLoaded, disableAnimations }: AnimationControllerProps) => null;
+export default AnimationController;

package/dist/components/Controllers/BmlController.d.ts

@@ -0,0 +1 @@
+declare const testString = "<bml id=\"bml1\" characterId=\"Sara\">\n<speech id=\"speech1\" start=\"0\">\n  <text>Hello, my name is Sara.</text>\n</speech>\n\n<gesture id=\"gesture1\" start=\"0\"/>\n\n<gaze id=\"gaze1\" target=\"Cube\" start=\"4.5\" end=\"6\"/>\n<gaze id=\"gaze2\" target=\"Sphere\" start=\"gaze1:end+1\" end=\"gaze1:end+2.3\"/>\t\t\n<gaze id=\"gaze3\" target=\"Capsule\" start=\"gaze2:end+1\" end=\"gaze2:end+4\"/>\t\t\n\n<speech id=\"speech2\" start=\"gaze1:start+1\">\n  <text>I can look at at cube</text>\n</speech>\n\n<posture id=\"posture1\" start=\"speech1:end\" end=\"speech2:end\">\n  <stance type=\"\" />\n  <pose part=\"\" lexeme=\"\" />\n</posture>\n\n<speech id=\"speech3\" start=\"gaze2:start+1\">\n  <text>sphere</text>\n</speech>\n\n<speech id=\"speech4\" start=\"gaze3:start+1\">\n  <text>or a capsule</text>\n</speech>\n</bml>";

package/dist/components/Controllers/CharacterController.d.ts

@@ -0,0 +1,7 @@
+import { Character } from '../../../node_modules/@davi-ai/bodyengine-three/dist';
+interface CharacterControllerProps {
+    character: Character;
+    autoLookAt: boolean;
+}
+declare const CharacterController: ({ character, autoLookAt }: CharacterControllerProps) => null;
+export default CharacterController;

package/dist/components/Controllers/EmotionController.d.ts

@@ -0,0 +1,5 @@
+interface EmotionControllerProps {
+    animationsLoaded: boolean;
+}
+declare const EmotionController: ({ animationsLoaded }: EmotionControllerProps) => null;
+export default EmotionController;

package/dist/components/Scene.d.ts

@@ -0,0 +1,7 @@
+interface SceneProps {
+    parentGpuTier?: any;
+    setIsGpuAvailable: (v: boolean) => void;
+    children: any;
+}
+declare const Scene: ({ parentGpuTier, setIsGpuAvailable, children }: SceneProps) => JSX.Element;
+export default Scene;

package/dist/components/SpeechManager.d.ts

@@ -0,0 +1,2 @@
+declare const SpeechManager: () => null;
+export default SpeechManager;

package/dist/contexts/animationStore.d.ts

@@ -0,0 +1,16 @@
+import * as THREE from "three";
+interface AnimationStore {
+    animationsNames: Array<string>;
+    animations: Map<string, THREE.AnimationClip>;
+    currentAnimation: string | null;
+    autoPlay: boolean;
+}
+export declare const useAnimationStore: import('zustand').UseBoundStore<import('zustand').StoreApi<AnimationStore>>;
+export declare const setAnimationsNames: (value: Array<string>) => void;
+export declare const setAnimations: (value: Map<string, THREE.AnimationClip>) => void;
+export declare const getAnimationsMap: () => Map<string, THREE.AnimationClip>;
+export declare const addAnimation: (value: THREE.AnimationClip) => void;
+export declare const setCurrentAnimation: (value: string | null) => void;
+export declare const setAutoPlay: (value: boolean) => void;
+export declare const playAnimationByName: (value: string) => void;
+export {};

package/dist/contexts/cameraStore.d.ts

@@ -0,0 +1,28 @@
+import { DefaultDistances, DefaultPositions } from '../models/types';
+import { Vector3 } from 'three';
+import * as THREE from "three";
+/**
+ * Default data for a medium-shot character :
+ * - camera position : head
+ * - camera distance : medium
+ * - camera lookAt : torso
+ * - camera rotation : face
+ */
+interface CameraStore {
+    cameraRef: THREE.Camera | null;
+    cameraPosition: Vector3;
+    bodyCenter: Vector3 | null;
+    defaultPositions: DefaultPositions | null;
+    defaultDistances: DefaultDistances | null;
+    lookAt: Vector3 | null;
+    movable: boolean;
+}
+export declare const useCameraStore: import('zustand').UseBoundStore<import('zustand').StoreApi<CameraStore>>;
+export declare const setCameraRef: (value: THREE.Camera | null) => void;
+export declare const setCameraPosition: (value: Vector3) => void;
+export declare const setBodyCenter: (value: Vector3 | null) => void;
+export declare const setDefaultPositions: (value: DefaultPositions | null) => void;
+export declare const setDefaultDistances: (value: DefaultDistances | null) => void;
+export declare const setLookAt: (value: Vector3 | null) => void;
+export declare const setMovable: (value: boolean) => void;
+export {};

package/dist/contexts/characterStore.d.ts

@@ -0,0 +1,46 @@
+import { Character, GlobalManager, LipSyncManager, EyeBlinkManager, AnimationManager, FACSManager, HeadPoseManager, GazeManager, BmlManager, CharacterState } from '../../node_modules/@davi-ai/bodyengine-three/dist';
+interface Managers {
+    lipSyncManager?: LipSyncManager | null;
+    eyeBlinkManager?: EyeBlinkManager | null;
+    animationManager?: AnimationManager | null;
+    FACSManager?: FACSManager | null;
+    headPoseManager?: HeadPoseManager | null;
+    gazeManager?: GazeManager | null;
+    bmlManager?: BmlManager | null;
+}
+interface CharacterStore {
+    character: Character | null;
+    globalManager: GlobalManager;
+    managers: Managers;
+    lipSyncManager: LipSyncManager | null;
+    eyeBlinkManager: EyeBlinkManager | null;
+    animationManager?: AnimationManager | null;
+    FACSManager?: FACSManager | null;
+    headPoseManager?: HeadPoseManager | null;
+    gazeManager?: GazeManager | null;
+    bmlManager?: BmlManager | null;
+    animationsLoaded: boolean;
+    characterWidth: number;
+    characterHeight: number;
+    characterDepth: number;
+    characterState: CharacterState;
+}
+export declare const useCharacterStore: import('zustand').UseBoundStore<import('zustand').StoreApi<CharacterStore>>;
+export declare const setCharacter: (value: Character | null) => void;
+export declare const setManagers: (value: Managers) => void;
+export declare const setGlobalSyncManager: (value: GlobalManager | null) => void;
+export declare const setLipSyncManager: (value: LipSyncManager | null) => void;
+export declare const setEyeBlinkManager: (value: EyeBlinkManager | null) => void;
+export declare const setAnimationManager: (value: AnimationManager | null) => void;
+export declare const setFACSManager: (value: FACSManager | null) => void;
+export declare const setHeadPoseManager: (value: HeadPoseManager | null) => void;
+export declare const setGazeManager: (value: GazeManager | null) => void;
+export declare const setBmlManager: (value: BmlManager | null) => void;
+export declare const setAnimationsLoaded: (value: boolean) => void;
+export declare const setCharacterDimensions: (value: {
+    x: number;
+    y: number;
+    z: number;
+}) => void;
+export declare const setCharacterState: (value: CharacterState) => void;
+export {};

package/dist/contexts/emotionStore.d.ts

@@ -0,0 +1,16 @@
+import { Emotions } from '../models/enums';
+import { EmotionData } from '../models/types';
+import { FacialAnimationData } from '../../node_modules/@davi-ai/bodyengine-three/dist';
+interface EmotionStore {
+    emotions: Array<EmotionData>;
+    currentTopEmotion: Emotions;
+    useTopEmotionOnly: boolean;
+    autoDecay: boolean;
+}
+export declare const useEmotionStore: import('zustand').UseBoundStore<import('zustand').StoreApi<EmotionStore>>;
+export declare const setEmotions: (value: Array<EmotionData> | undefined | null) => void;
+export declare const setUseTopEmotionOnly: (value: boolean) => void;
+export declare const setAutoDecay: (value: boolean) => void;
+export declare const playFacialAnimation: (value: FacialAnimationData) => void;
+export declare const resetEmotionStore: () => void;
+export {};

package/dist/contexts/headStore.d.ts

@@ -0,0 +1,16 @@
+import { ActionUnitData, GazeData, HeadPoseData } from '../../node_modules/@davi-ai/bodyengine-three/dist';
+import * as THREE from "three";
+interface HeadStore {
+    currentAUs: Array<ActionUnitData> | null;
+    currentGaze: GazeData | null;
+    currentHeadPose: HeadPoseData | null;
+    lookAtCamera: boolean;
+}
+export declare const useHeadStore: import('zustand').UseBoundStore<import('zustand').StoreApi<HeadStore>>;
+export declare const setCurrentAUs: (value: Array<ActionUnitData> | null) => void;
+export declare const setCurrentGaze: (value: GazeData | null) => void;
+export declare const setCurrentHeadPose: (value: HeadPoseData | null) => void;
+export declare const setLookAtCamera: (value: boolean) => void;
+export declare const lookAtAndKeep: (target?: THREE.Camera) => void;
+export declare const releaseLookAt: () => void;
+export {};

package/dist/contexts/postProcessStore.d.ts

@@ -0,0 +1,8 @@
+import * as THREE from "three";
+interface PostProcessStore {
+    lut: THREE.Texture | THREE.Data3DTexture | null | undefined;
+}
+export declare const usePostProcessStore: import('zustand').UseBoundStore<import('zustand').StoreApi<PostProcessStore>>;
+export declare const setLut: (value: string | undefined | null) => void;
+export declare const resetPostProcessStore: () => void;
+export {};

package/dist/contexts/speechStore.d.ts

@@ -0,0 +1,33 @@
+import { SpeechSynthesisCredentials } from '../models/types';
+import { SpeechSynthesisUtterance, SpeechSynthesisEventProps } from '@davi-ai/web-speech-cognitive-services-davi';
+interface speechStore {
+    credentials?: SpeechSynthesisCredentials;
+    currentUtterance: SpeechSynthesisUtterance | null;
+    boundaries: Array<SpeechSynthesisEventProps>;
+    visemes: Array<SpeechSynthesisEventProps>;
+    currentVisemeIndex: number;
+    voice: SpeechSynthesisVoice | null;
+    voices: Array<SpeechSynthesisVoice>;
+    textToSpeak: string | null;
+    visemeIntensity: number;
+}
+export declare const useSpeechStore: import('zustand').UseBoundStore<import('zustand').StoreApi<speechStore>>;
+export declare const setCredentials: (value: SpeechSynthesisCredentials) => void;
+export declare const setCurrentUtterance: (value: SpeechSynthesisUtterance | null) => void;
+export declare const setBoundaries: (value: Array<SpeechSynthesisEventProps>) => void;
+export declare const setVisemes: (value: Array<SpeechSynthesisEventProps>) => void;
+export declare const addViseme: (value: SpeechSynthesisEventProps) => void;
+/**
+ * Add viseme data extracted in SPPAS format that will be converted to ArKit viseme and played at the right moment.
+ * @param {SpeechSynthesisEventProps} value viseme data (id, elapsedTime = time at which the viseme shall begin, duration can be set to 0 because we override it later).
+ * @param {number} factorToSecond (facultative) we use tenth of microsecond as base unit of time for elapsedTime / duration. If another unit is used as entry, set this ratio to convert it to milliseconds (ratio * durationinotherunit = durationintenthofmicrosecond).
+ */
+export declare const addSPPASViseme: (value: SpeechSynthesisEventProps, factorToTenthOfMicroSecond?: number) => void;
+export declare const setCurrentVisemeIndex: (value: number) => void;
+export declare const flushLipSyncData: () => void;
+export declare const setVoice: (value: SpeechSynthesisVoice | null) => void;
+export declare const setVoices: (value: Array<SpeechSynthesisVoice>) => void;
+export declare const setTextToSpeak: (value: string | null) => void;
+export declare const getVoices: () => Array<SpeechSynthesisVoice>;
+export declare const setVisemeIntensity: (value: number) => void;
+export {};

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+export { default as Character } from './components/Character';
+export { useCharacterStore, setCharacterState } from './contexts/characterStore';
+export { setTextToSpeak, setCurrentUtterance, setVisemes, addViseme, addSPPASViseme, flushLipSyncData, setVoice, getVoices, setVisemeIntensity } from './contexts/speechStore';
+export { setCameraPosition, setMovable } from './contexts/cameraStore';
+export { setCurrentAUs, setCurrentGaze, setCurrentHeadPose, setLookAtCamera, lookAtAndKeep, releaseLookAt, } from './contexts/headStore';
+export { setEmotions, setUseTopEmotionOnly, setAutoDecay, playFacialAnimation } from './contexts/emotionStore';
+export { setAutoPlay, getAnimationsMap, playAnimationByName } from './contexts/animationStore';
+export { setLut } from './contexts/postProcessStore';
+export { emotionList, CharacterState, CreationTool, bmlTags } from '../node_modules/@davi-ai/bodyengine-three/dist';
+export type { FacialAnimationData } from '../node_modules/@davi-ai/bodyengine-three/dist';
+export { Positions, Distances, Rotations } from './models/enums';
+export { presets } from './models/constants';