# three-js-transform-handler

> 3D object to draw a transformation handler. This lib is only the 3D object to be renderered, and its highlights. No transformation controls is implemented.

Latest version **2.130.1** (published 2022-06-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install three-js-transform-handler
pnpm add three-js-transform-handler
yarn add three-js-transform-handler
bun add three-js-transform-handler
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.130.1 |
| Published | 2022-06-02 |
| First published | 2020-08-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 221.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Maxime Quiblier |
| Maintainers | maximequiblier |

## Links

- npm: https://www.npmjs.com/package/three-js-transform-handler
- npm.io page: https://npm.io/package/three-js-transform-handler

## Dependencies (2)

- [three](https://npm.io/package/three.md) 0.130.x
- [three-js-checker](https://npm.io/package/three-js-checker.md) 1.0.x

## Recent versions

- 2.130.1 (latest) — 2022-06-02
- 2.130.0 — 2022-05-27
- 1.1.2 — 2021-02-26
- 1.1.1 — 2020-08-31
- 1.1.0 — 2020-08-26
- 1.0.2 — 2020-08-16
- 1.0.1 — 2020-08-16
- 1.0.0 — 2020-08-13

## README

# three-js-transform-handler
This class is a 3D representation of a transformation handler. It does not handle events on it, only the 3D drawing.

### Setup ###

Assuming that npm and node are already installed.

Clone the current repository. Then in the repository folder :
````
npm install
````
This should install all required dependencies for build and development.

Then to launch the example :
````
npm run build
npm start
````

#### Usage ####

The class is just a special THREE.Object3D with a hierarchy to create a set of handles.
The setActiveHandle function will change the style of the given handle.
The setFromObject will set the handle according to the given object transformation.

This class is not connected to any event handler, so to implement an actual Transform widget, you need to pick on the object and act depending on the element under the mouse.

#### Distribution ####

Distribution files can be found in ./dist/browser, to be included in your HTML :

````
<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="UTF-8">
        <title>THREE TransformObject3D</title>
    </head>
    <body>
        <!-- Don't forget to include THREE, its is not shipped with the lib -->
        <script src="three.js"></script>
        <script src="dist/browser/three-js-view-cube.js"></script>
        <script>
            alert('Checking definition of TransformObject3D : ' + THREE.TransformObject3D !== undefined);
            var t = new THREE.TransformObject3D();
        </script>
    </body>
</html>
````

### Repository Commands ###

Build:
````
npm run build
````
Will update the browser build in dist.

#### Browser Dependencies ####
In browser, only THREE is required.

---
_Source: https://npm.io/package/three-js-transform-handler · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
