Skip to content

Latest commit

 

History

History
55 lines (31 loc) · 1.81 KB

README.md

File metadata and controls

55 lines (31 loc) · 1.81 KB

deformer

A library for editing shapes, providing a powerful and flexible way to edit any shape you need. Deformer allows you to control shapes through control points and offers a range of functionality including rotation, movement, and more. With the use of a custom DeformerLimitator, you can control the size, area and other constraints of your shape to your exact specifications.

Features 🚀

  • Edit any shape through control points.
  • Rotate and move shapes
  • Constrain the size, position and other parameters of the shapes through the `DeformerLimitator·.
  • Flexible, simple and efficient API

Getting Started 🏁

Installation 🔧

You can install deformer via npm:

npm i -S @vgerbot/deformer

Usage 💻

Using deformer is straightforward, Here is an example of how to use it to edit a simple shape:

import {} from '@vgerbot/deformer';
// 未完待续

You can also specify custom constraints for your shape by passing a DeformerLimitator to the XXX method:

// 未完待续

Contributing 🤝

If you're interested in contributing to this library, we welcome your contributions! Simply fork the repository and submit a pull request with your changes. We'll review your changes and merge them into the main codebase if they look good.

License 📜

This library is released under the MIT License, which means that you can use it for any purpose, including commercial projects, whithout any restrictions. So go ahead and start creating amazing shapes today.