VortexFX Documentation

Welcome to the VortexFX Physics Engine documentation. This guide will help you get started with implementing advanced physics simulation in your projects.

Installation

VortexFX can be installed through multiple methods depending on your development environment.

Package Manager

npm install vortexfx-engine
# or
pip install vortexfx

Direct Download

Download the latest release from our official repository and include the library files in your project.

Quick Start

Get up and running with VortexFX in just a few lines of code:

import VortexFX from 'vortexfx-engine';

// Initialize physics world
const world = new VortexFX.PhysicsWorld();

// Create a rigid body
const body = world.createRigidBody({
    mass: 1.0,
    position: [0, 10, 0],
    shape: 'box',
    dimensions: [1, 1, 1]
});

// Start simulation
world.start();

Basic Setup

Setting up a basic physics simulation involves creating a physics world, adding objects, and running the simulation loop.

Creating a Physics World

The physics world is the container for all physics objects and simulations:

const world = new VortexFX.PhysicsWorld({
    gravity: [0, -9.81, 0],
    timestep: 1/60
});

Physics Simulation

VortexFX provides comprehensive physics simulation capabilities for realistic object interactions.

Trajectory Forces

Apply directional forces to objects for dynamic movement and environmental effects.

Animation Tracks

Timeline-based animation system for creating smooth character movements and object animations.

FBX Import

Native support for FBX file format importing from popular 3D modeling software.

Ragdoll Motion

Realistic character physics with active ragdoll systems that react to impacts and forces.

Physics World

The main container for all physics objects and simulation settings.

Rigid Body

Physics objects that can be affected by forces, gravity, and collisions.

Collision Shapes

Define the collision boundaries for physics objects.

Constraints

Connect and limit the movement of physics objects relative to each other.

Unity Integration

VortexFX integrates seamlessly with Unity's development environment.

Unreal Engine Integration

VortexFX works alongside Unreal Engine's physics and rendering systems.

Blender Integration

VortexFX physics engine is compatible with Blender's simulation workflow.

Maya Integration

VortexFX is compatible with Maya's animation and simulation pipeline.

Creating a Physics World

The physics world is the container for all physics objects and simulations:

const world = new VortexFX.PhysicsWorld({
    gravity: [0, -9.81, 0],
    timeStep: 1/60
});

Physics Simulation

VortexFX provides comprehensive physics simulation capabilities including:

• Rigid body dynamics
• Collision detection and response
• Gravity and environmental forces
• Material properties (friction, restitution)

Trajectory Forces

Apply directional forces to objects for realistic movement and environmental effects:

// Apply wind force
body.applyForce([10, 0, 0]);

// Apply impulse for instant velocity change
body.applyImpulse([0, 5, 0]);

Animation Tracks

Create smooth animations using the timeline-based animation system:

const animation = new VortexFX.AnimationTrack();
animation.addKeyframe(0, { position: [0, 0, 0] });
animation.addKeyframe(1, { position: [10, 0, 0] });
body.setAnimation(animation);

FBX Import

Import 3D models and animations directly from FBX files:

const model = await VortexFX.loadFBX('path/to/model.fbx');
world.addModel(model);

Active Ragdoll Motion

Implement realistic character physics with active ragdoll systems:

const ragdoll = new VortexFX.Ragdoll(characterMesh);
ragdoll.enablePhysics();
world.addRagdoll(ragdoll);