Skip to main content
Version: Next

Class: Keyframe

Defined in: packages/tools/src/Timeline/Keyframe.ts:12

Timeline Key Frames contains parameters to access Nodes, Styles for the Timeline

Constructors​

Constructor​

new Keyframe(model, date): Keyframe

Defined in: packages/tools/src/Timeline/Keyframe.ts:17

Parameters​

model​

CogniteCadModel

date​

Date

Returns​

Keyframe

Methods​

activate()​

activate(): void

Defined in: packages/tools/src/Timeline/Keyframe.ts:33

Assigns the styles for the node set for the model for this Keyframe

Returns​

void


assignStyledNodeCollection()​

assignStyledNodeCollection(nodeCollection, nodeAppearance): void

Defined in: packages/tools/src/Timeline/Keyframe.ts:54

Add node & style to the collection. If the collection has been added, the style is updated to the appearance provided.

Parameters​

nodeCollection​

NodeCollection

Node set to apply the Styles

nodeAppearance​

NodeAppearance

Style to assign to the node collection

Returns​

void


deactivate()​

deactivate(): void

Defined in: packages/tools/src/Timeline/Keyframe.ts:42

Removes the style for the model

Returns​

void


getKeyframeDate()​

getKeyframeDate(): Date

Defined in: packages/tools/src/Timeline/Keyframe.ts:26

Get date of the Keyframe

Returns​

Date

date


unassignStyledNodeCollection()​

unassignStyledNodeCollection(nodeCollection): void

Defined in: packages/tools/src/Timeline/Keyframe.ts:69

Remove Node & Style for this keyframe's nodeCollection and nodeAppearance

Parameters​

nodeCollection​

NodeCollection

Nodes to be unassign from node collection

Returns​

void