aframe-skeletor's Introduction

aframe-skeletor

Inverse Kinematics for aframe.io using three-skeletor.

WARNING

There is going to be some breaking API changes for bit until things settle down.

Install

npm install aframe-skeletor

or use one of the /dst/ builds

API

	schema: {
		// ball joint constraint
		ball: {
			type: 'number',
			default: undefined,
		},

		// hinge joint constraint
		hinge: {
			type: 'number',
			default: undefined,
		},

	  // what the end of the joint chain should be affected by
		target: {
			type: 'selector',
		},

		// set as the base of a joint chain
		root: {
			type: 'bool',
			default: false,
		},

		// shows debug visuals around joints
		debug: {
			type: 'bool',
			default: true,
		},
	},

Quick Start

<html>
	<head>
		<script src="https://aframe.io/releases/1.0.4/aframe.min.js"></script>
	</head>
	<body>
		<a-scene>
			<!-- this hand is the mover or effector -->
			<a-entity
				id="hand"
				animation="property: position; from: 0 0 -1; to: 0 0 1; loop: true; dir: alternate;"
			/>

			<!-- this is the root of the joint chain with a ball joint-->
			<a-entity skeletor="root: true; ball: 180">
				<!-- this is the cap of the joint chain with a hinge joint to the target
				-->
				<a-entity skeletor="target: #hand; hinge: 90; debug: true" />
			</a-entity>
		</a-scene>
	</body>
</html>