Skip to main content
Version: Next

Class: Keyframe

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

Constructors

new Keyframe()

new Keyframe(model, date): Keyframe

Parameters

model: CogniteCadModel

date: Date

Returns

Keyframe

Defined in

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

Methods

activate()

activate(): void

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

Returns

void

Defined in

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


assignStyledNodeCollection()

assignStyledNodeCollection(nodeCollection, nodeAppearance): void

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

Defined in

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


deactivate()

deactivate(): void

Removes the style for the model

Returns

void

Defined in

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


getKeyframeDate()

getKeyframeDate(): Date

Get date of the Keyframe

Returns

Date

date

Defined in

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


unassignStyledNodeCollection()

unassignStyledNodeCollection(nodeCollection): void

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

Parameters

nodeCollection: NodeCollection

Nodes to be unassign from node collection

Returns

void

Defined in

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