Animation

class Communicator.Animation.Animation()

Structure encapsulating a specific animation

Constructors

• constructor()

Properties

• cameraChannels

• name

• nodeChannels

• pivotPoints

Methods

• createCameraChannel()

• createNodeChannel()

• deleteChannel()

---

Constructors

Animation.constructor(name)

Creates a new, empty Animation

Arguments

• name (string()) –

Return type

Animation()

Properties

Animation.cameraChannels

Type

[CameraChannel()]

Animation.name

Type

string

Animation.nodeChannels

Type

[NodeChannel()]

Animation.pivotPoints

Type

Map <number, Point3()>

Methods

createCameraChannel

Animation.createCameraChannel(name, property, sampler)

Creates a new camera animation channel.

Arguments

• name (string()) – friendly name for the channel.

• property (CameraProperty) – the property that will be animated by this channel.

• sampler (Sampler()) – sampler describing the buffer and interpolation type used.

Return type

CameraChannel()

createNodeChannel

Animation.createNodeChannel(name, target, property, sampler)

Creates a new node animation channel.

Arguments

• name (string()) – friendly name for the channel.

• target (NodeId) – id of node that will receive interpolated values.

• property (NodeProperty) – the node property that will be animated.

• sampler (Sampler()) – sampler describing the buffer and interpolation type.

Return type

NodeChannel()

deleteChannel

Animation.deleteChannel(channel)

Removes a channel from this animation.

Call Player.reload on any players that are referencing this animation.

Arguments

• channel (NodeChannel() | CameraChannel()) –

Return type

void

Call Player.reload on any players that are referencing this animation.