Animation

class Communicator.Animation.Animation()

Structure encapsulating a specific animation

Constructors


Constructors

constructor

Communicator.Animation.Animation.constructor(name)

Creates a new, empty Animation

Arguments
  • name (string()) –

Return type

Communicator.Animation.Animation

Properties

Communicator.Animation.Animation.cameraChannels
Communicator.Animation.Animation.name
Communicator.Animation.Animation.nodeChannels
Communicator.Animation.Animation.pivotPoints

Methods

createCameraChannel

Communicator.Animation.Animation.createCameraChannel(name, property, sampler)

Creates a new camera animation channel.

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

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

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

Return type

Communicator.Animation.CameraChannel

createNodeChannel

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

Creates a new node animation channel.

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

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

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

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

Return type

Communicator.Animation.NodeChannel

deleteChannel

Communicator.Animation.Animation.deleteChannel(channel)

Removes a channel from this animation.

Arguments
  • channel ({  }()) –

Return type

void

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