Class WebaniMeshAnimation

A class representing an animation that interpolates between two states of a mesh object. This extends from WebaniInterpolatedAnimation and is designed to animate WebaniMesh objects.

Hierarchy (View Summary)

WebaniInterpolatedAnimation<WebaniMesh>
- WebaniMeshAnimation

Index

Constructors

constructor

new WebaniMeshAnimation(
options: WebaniInterpolatedAnimationOptions<WebaniMesh>,
): WebaniMeshAnimation
Creates an instance of WebaniInterpolatedAnimation.
Parameters
- options: WebaniInterpolatedAnimationOptions<WebaniMesh>
  Configuration options for the animation.
Returns WebaniMeshAnimation
Inherited from WebaniInterpolatedAnimation.constructor
- Defined in renderer/animation/webani-interpolated-animation.class.ts:63

Properties

backwards

backwards: boolean

Whether the animation plays in reverse.

duration

duration: number

Duration of the animation in milliseconds.

interpolationFunction

interpolationFunction: (before: number, after: number, t: number) => number

The interpolation function used for the animation.

Accessors

after

get after(): T
Getter for the unresolved after state of the object.

Returns T
Inherited from WebaniInterpolatedAnimation.after
- Defined in renderer/animation/webani-interpolated-animation.class.ts:158
set after(value: T): void
Setter for the unresolved after state of the object.
Parameters
- value: T
Returns void
Inherited from WebaniInterpolatedAnimation.after
- Defined in renderer/animation/webani-interpolated-animation.class.ts:163

before

get before(): T
Getter for the unresolved before state of the object.

Returns T
Inherited from WebaniInterpolatedAnimation.before
- Defined in renderer/animation/webani-interpolated-animation.class.ts:147
set before(value: T): void
Setter for the unresolved before state of the object.
Parameters
- value: T
Returns void
Inherited from WebaniInterpolatedAnimation.before
- Defined in renderer/animation/webani-interpolated-animation.class.ts:152

Methods

done

done(t: number): boolean
Checks if the animation has completed based on the current time t.
Parameters
- t: number
  The current time in the animation.
Returns boolean
true if the animation is done (i.e., t exceeds or equals the duration of the animation), false otherwise.
Overrides WebaniInterpolatedAnimation.done
- Defined in renderer/scene/meshes/webani-mesh-animation.class.ts:25

frame

frame(t: number): WebaniMesh
Calculates and returns the transformed object at the current frame of the animation.
Parameters
- t: number
  The time or progress of the animation, typically between 0 and 1.
Returns WebaniMesh
The current state of the animated object.
Inherited from WebaniInterpolatedAnimation.frame
- Defined in renderer/animation/webani-interpolated-animation.class.ts:86

progress

progress(t: number): number
Interpolates the progress of the animation based on the time t.
Parameters
- t: number
  The time or progress of the animation, typically between 0 and 1.
Returns number
A normalized value between 0 and 1 representing the progress of the animation.
Inherited from WebaniInterpolatedAnimation.progress
- Defined in renderer/animation/webani-interpolated-animation.class.ts:131

resolveAnimation

resolveAnimation(): void
Resolves the animation by creating shallow copies of the objects before and after the animation. The current object is also initialized as a shallow copy of the object before the animation.

Returns void
Overrides WebaniInterpolatedAnimation.resolveAnimation
- Defined in renderer/scene/meshes/webani-mesh-animation.class.ts:14

resolveTransforms

resolveTransforms(): void
Resolves the transforms of the before and after objects to ensure they have the same number of extra transforms. This function ensures that the animation has a consistent structure when resolving the transforms.

Returns void
Inherited from WebaniInterpolatedAnimation.resolveTransforms
- Defined in renderer/animation/webani-interpolated-animation.class.ts:103

setFrame

setFrame(t: number): WebaniMesh
Sets the frame of the animation at time t, updating the transforms and material of the mesh.
Parameters
- t: number
  The current time in the animation.
Returns WebaniMesh
The current WebaniMesh object after the frame has been set.
Overrides WebaniInterpolatedAnimation.setFrame
- Defined in renderer/scene/meshes/webani-mesh-animation.class.ts:34

`Static`cubic

cubic(before: number, after: number, t: number): number
Cubic interpolation function.
Parameters
- before: number
  The start value.
- after: number
  The end value.
- t: number
  The progress of the interpolation.
Returns number
The interpolated value with cubic easing.
Inherited from WebaniInterpolatedAnimation.cubic
- Defined in renderer/animation/webani-interpolated-animation.class.ts:286

`Static`easeInOut

easeInOut(before: number, after: number, t: number): number
Ease-in-out interpolation function.
Parameters
- before: number
  The start value.
- after: number
  The end value.
- t: number
  The progress of the interpolation.
Returns number
The interpolated value with ease-in-out easing.
Inherited from WebaniInterpolatedAnimation.easeInOut
- Defined in renderer/animation/webani-interpolated-animation.class.ts:298

`Static`lerp

lerp(before: number, after: number, t: number): number
Linear interpolation function.
Parameters
- before: number
  The start value.
- after: number
  The end value.
- t: number
  The progress of the interpolation.
Returns number
The interpolated value.
Inherited from WebaniInterpolatedAnimation.lerp
- Defined in renderer/animation/webani-interpolated-animation.class.ts:274

Class WebaniMeshAnimation

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebaniMeshAnimation

Properties

backwards

duration

interpolationFunction

Accessors

after

Returns T

Parameters

Returns void

before

Returns T

Parameters

Returns void

Methods

done

Parameters

Returns boolean

frame

Parameters

Returns WebaniMesh

progress

Parameters

Returns number

resolveAnimation

Returns void

resolveTransforms

Returns void

setFrame

Parameters

Returns WebaniMesh

Staticcubic

Parameters

Returns number

StaticeaseInOut

Parameters

Returns number

Staticlerp

Parameters

Returns number

Settings

On This Page

`Static`cubic

`Static`easeInOut

`Static`lerp