0.0.2 • Published 2 years ago
shared-effects v0.0.2
shared-effects
Shared effects for the text and effects team
Warps file (JSON)
Json file values
| Value | Type | Description | Details |
|---|---|---|---|
| warpId | integer | The id for the warp | This id should be unique across all warps (even disabled ones). Also it is saved on the Canvas api to reference and know which warp is to be used |
| version | integer | The version of the warp file the warp was initially released in | When creating a new version, increment the current version in this readme, and then add the new version to the new contours |
| name | string | The name of the warp | This name should not be used in the clients. Each client will need to map strings from the |
| enabled | boolean | Whether or not the warp is enabled | When we modify a warp, we will need to disable the current warp, and add the new warp. This is so previously saved warped objects will look the same even if the contours that were used to warp them have been changed |
| sortOrder | integer | The order that warps appear in the list | This number should be sorted ASC |
| defaultTValue | number (0-1) | The default value to be used for contours/warps if the tValue is not changed | If the default value is used, this is the basic look and feel of the warp. It is the value that should be used to when initially a warp is selected, before tValue is manipulated |
| minYControlContours | string (svg path) | The contours that define the warps bottom path | |
| maxYControlContours | string (svg path) | The contours that define the warps top path |
Current version: 1
When editing the warps.json 1. Make you changes 2. Go to https://www.jsonschemavalidator.net/ 3. Paste warps-schema.json and changes to warps.json 4. Validate
0.0.2
2 years ago