# aframe-curve-component
**Repository Path**: wavef/aframe-curve-component
## Basic Information
- **Project Name**: aframe-curve-component
- **Description**: A curve component to draw curves in AFrameVR 1.x
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://wavef.gitee.io/aframe-curve-component/
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-09-26
- **Last Updated**: 2023-08-06
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
## aframe-curve-component
[](https://npmjs.org/package/aframe-curve-component)
[](https://npmjs.org/package/aframe-curve-component)
A Curve component to draw curves in A-Frame. The component consists of multiple components:
* curve: Draws a certain type of a curve and consists of multiple "curve-points"
* curve-point: Defines the curve based on it's position. Multiple entities are added as children of the curve-entity.
* draw-curve: Add's a Mesh to the curve to visualize it
* clone-along-curve: Clones an Entity along the curve (e.g. to build a race track based on track parts)
For [A-Frame](https://aframe.io).
Credits: Initial concept and development has been done by [AdaRoseEdwards](https://github.com/SamsungInternet/a-frame-components/blob/master/dist/curve.js).
### API (curve)
| Property | Description | Default Value |
|----------|-------------------------------------------------------------------------------------------------------|---------------|
| type | Type of the Curve to draw. One of: 'CatmullRom', 'CubicBezier', 'QuadraticBezier', 'Line' | CatmullRom |
| closed | Whether or not the curve should be drawn closed (connect the end and start point automatically) | false |
| fps | frequence to detect point position changed, will update the curve when points position changed if > 0 | 0 |
### API (curve-point)
| Property | Description | Default Value |
|----------|--------------------------------------------|---------------|
| fps | frequence to detect point position changed | 0 |
### API (draw-curve)
| Property | Description | Default Value |
|----------|------------------------------------------------|---------------|
| curve | A Selector to identify the corresponding curve | '' |
### API (clone-along-curve)
| Property | Description | Default Value |
|----------|------------------------------------------------|---------------|
| curve | A Selector to identify the corresponding curve | '' |
| spacing | Spacing between the cloned entities in Meters | 1 |
| rotation | Rotation of the cloned Entities | '0 0 0' |
| scale | Scale of the cloned entities | '1 1 1' |
| tangent | Children angle follow the path | false |
### Installation
#### Browser
Install and use by directly including the [browser files](dist):
```html
My A-Frame Scene
```