immersivity_core

Immersivity Core Library 🚀

Immersivity's core library enables you to create interactive web experiences using your camera. Transform ordinary websites into dynamic 3D environments by responding to head movements. 🎥🌐

Features ✨

• Real-time Face Detection: Utilize TensorFlow.js and MediaPipe to detect faces and track head movements. 🕵️‍♂️
• Parallax Effect: Apply 3D rotation effects to elements based on head movements. 🔄
• Event Emitter: Subscribe and unsubscribe to face movement events. 🔔

Installation 📦

To install the library, use npm or yarn:

npm install immersivity-core
# or
yarn add immersivity-core

Usage 📘

Setting Up the Video Element 📹

First, set up the video element that will be used for face detection:

import { setVideoElement } from 'immersivity-core';

async function setupVideo() {
  const videoElement = await setVideoElement();
  // Do something with the video element if needed
}
setupVideo();

Starting Face Parallax 🎛️

Once the video element is set, start the face parallax effect:

import { startFaceParallax } from 'immersivity-core';

async function startParallax() {
  const videoElement = await setVideoElement();
  startFaceParallax(videoElement);
}
startParallax();

Wrapping Elements for Parallax 🌀

Wrap the elements you want to apply the parallax effect to:

import { wrapParallax } from 'immersivity-core';

const element = document.getElementById('myElement');
wrapParallax(element);

Subscribing to Face Movement Events 🔔

You can subscribe to face movement events to perform custom actions:

import { subscribeToEventEmitter } from 'immersivity-core';

function handleFaceMovement({ centerX, centerY, rotationX, rotationY }) {
  console.log(`Center X: ${centerX}, Center Y: ${centerY}`);
  console.log(`Rotation X: ${rotationX}°, Rotation Y: ${rotationY}°`);
}

subscribeToEventEmitter(handleFaceMovement);

Unsubscribing from Face Movement Events 🚫

To unsubscribe from the events:

import { unsubscribeFromEventEmitter } from 'immersivity-core';

unsubscribeFromEventEmitter(handleFaceMovement);

Get Parallax Container Class Name 🏷️

Retrieve the class name used for the parallax container:

import { getParallaxContainerClassName } from 'immersivity-core';

const className = getParallaxContainerClassName();
console.log(`Use this class for parallax container: ${className}`);

API 📖

setVideoElement()

Sets up and returns a video element for face detection. 🎥

startFaceParallax(videoRef: HTMLVideoElement)

Starts the face parallax effect using the provided video element. 🔄

wrapParallax(el: HTMLElement)

Wraps the specified element with a parallax container. 🌀

subscribeToEventEmitter(callback: EventCallback)

Subscribes to face movement events. 🔔

unsubscribeFromEventEmitter(callback: EventCallback)

Unsubscribes from face movement events. 🚫

getParallaxContainerClassName()

Returns the class name used for the parallax container. 🏷️

License 📜

MIT License

Copyright (c) 2024 Ivan Husarov.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.