Class: SnapshotService<T>
Type parameters
| Name | Type |
|---|---|
T | any |
Table of contents
Accessors
Constructors
Methods
Accessors
list
• get list(): SDKAnnotationSnapshot<T>[]
Returns
initSnapshot
• get initSnapshot(): SDKAnnotationSnapshot<any>
Returns
Constructors
constructor
• new SnapshotService<T>(annotation)
Type parameters
| Name | Type |
|---|---|
T | any |
Parameters
| Name | Type |
|---|---|
annotation | SDKAnnotation<any> |
Methods
delete
▸ delete(t): void
Parameters
| Name | Type |
|---|---|
t | SDKAnnotationSnapshot<any> |
Returns
void
get
▸ get(frame): SDKAnnotationSnapshot<T>
Parameters
| Name | Type |
|---|---|
frame | number |
Returns
generateTransformation
▸ generateTransformation(frame, interpolate): void
Generate transformation for a range between previous and next fixed frames. The interpolation function is called on each frame that needs to be transformed in the fixed range.
Parameters
| Name | Type | Description |
|---|---|---|
frame | number | a frame in the fixed range |
interpolate | (from: IAnnotationSnapshot<T>, to: IAnnotationSnapshot<T>, progress: number) => Required<Partial<IAnnotationSnapshot<T>>, "data"> | the interpolation function to transform by |
Returns
void
create
▸ create(params): SDKAnnotationSnapshot<T>
Parameters
| Name | Type |
|---|---|
params | IAnnotationSnapshot<any> |
Returns
update
▸ update(params): Promise<void>
Parameters
| Name | Type |
|---|---|
params | Object |
params.namedAttributes? | Object |
params.namedAttributes.key | string |
params.namedAttributes.value? | string | number | boolean | string[] |
params.label? | string |
params.frame | number |
params.untilSpecificFrame? | number |
params.objectVisible? | boolean |
params.data? | T |
Returns
Promise<void>