Class LSTween

Constructors

`Private`constructor

new LSTween(): LSTween
Returns LSTween

Properties

`Private` `Static` `Readonly`instance

instance: LSTween = ...

Methods

`Static`alphaFromTo

alphaFromTo(
    material: Material,
    from: number,
    to: number,
    time: number,
): Tween<{ a: number }>
Parameters
- material: Material
  Material that you wish to change alpha
- from: number
  Initial value of your alpha
- to: number
  Destination value you want your alpha to reach
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ a: number }>
Example
```
LSTween.alphaFromTo(material, 0.0, 0.5, 1000.0).start();
```

`Static`alphaTo

alphaTo(material: Material, to: number, time: number): Tween<{ a: number }>
Parameters
- material: Material
  Material that you wish to change alpha
- to: number
  Destination value you want your alpha to reach
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ a: number }>
Example
```
LSTween.alphaTo(material, 0.25, 1000.0).start();
```

`Static`colorFromTo

colorFromTo(
    material: Material,
    from: vec4,
    to: vec4,
    time: number,
): Tween<{ t: number }>
Parameters
- material: Material
  Material that you wish to change color
- from: vec4
  Initial value of your color
- to: vec4
  Destination value you want your color to reach
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ t: number }>
Example
```
LSTween.colorFromTo(material, new vec4(0,0,0,1), new vec4(0,1,0,1), 1000.0).start();
```

`Static`colorTextFromTo

colorTextFromTo(
    text: Text,
    from: vec4,
    to: vec4,
    time: number,
): Tween<{ t: number }>
Parameters
- text: Text
  Text that you wish to change color
- from: vec4
  Initial value of your color
- to: vec4
  Destination value you want your color to reach
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ t: number }>
Example
```
LSTween.colorTextFromTo(text, new vec4(0,0,0,1), new vec4(0,1,0,1), 1000.0).start();
```

`Static`colorTextTo

colorTextTo(text: Text, to: vec4, time: number): Tween<{ t: number }>
Parameters
- text: Text
  Text that you wish to change color
- to: vec4
  Destination value you want your color to reach
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ t: number }>
Example
```
LSTween.colorTextTo(text, new vec4(0,1,0,1), 1000.0).start();
```

`Static`colorTo

colorTo(material: Material, to: vec4, time: number): Tween<{ t: number }>
Parameters
- material: Material
  Material that you wish to change color
- to: vec4
  Destination value you want your color to reach
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ t: number }>
Example
```
LSTween.colorTo(material, new vec4(0,1,0,1), 1000.0).start();
```

`Static`enableChange

enableChange(
    sceneObject: SceneObject,
    endValue: boolean,
    time: number,
): Tween<any>
Parameters
- sceneObject: SceneObject
  SceneObject you want to change enabled state
- endValue: boolean
  End value of enabled state
- time: number
  Duration of Tween in miliseconds
Returns Tween<any>
Example
```
LSTween.enableChange(sceneObject, false, 1000.0).start();
```

`Static`moveFromToLocal

moveFromToLocal(
    transform: Transform,
    from: vec3,
    to: vec3,
    time: number,
): Tween<{ t: number }>
Parameters
- transform: Transform
  Transform object you want to change position
- from: vec3
  Initial position you want your object to start from
- to: vec3
  Destination position you want your object to go to
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ t: number }>
Example
```
LSTween.moveFromToLocal(transform, new vec3(0,0,0), new vec3(0,5,0), 1000.0).start();
```

`Static`moveFromToWorld

moveFromToWorld(
    transform: Transform,
    from: vec3,
    to: vec3,
    time: number,
): Tween<{ t: number }>
Parameters
- transform: Transform
  Transform object you want to change position
- from: vec3
  Initial position you want your object to start from
- to: vec3
  Destination position you want your object to go to
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ t: number }>
Example
```
LSTween.moveFromToWorld(transform, new vec3(0,0,0), new vec3(0,5,0), 1000.0).start();
```

`Static`moveOffset

moveOffset(
    transform: Transform,
    offset: vec3,
    time: number,
): Tween<{ t: number }>
Parameters
- transform: Transform
  Transform object you want to change position
- offset: vec3
  This is an addition operation in local space. For example, passing new vec3(1,0,0) will make object move 1 unit in X from its start position
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ t: number }>
Example
```
LSTween.moveOffset(transform, new vec3(0,5,0), 1000.0).start();
```

`Static`moveToLocal

moveToLocal(transform: Transform, to: vec3, time: number): Tween<{ t: number }>
Parameters
- transform: Transform
  Transform object you want to change position
- to: vec3
  Destination position you want your object to go to
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ t: number }>
Example
```
LSTween.moveToLocal(transform, new vec3(0,5,0), 1000.0).start();
```

`Static`moveToWorld

moveToWorld(transform: Transform, to: vec3, time: number): Tween<{ t: number }>
Parameters
- transform: Transform
  Transform object you want to change position
- to: vec3
  Destination position you want your object to go to
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ t: number }>
Example
```
LSTween.moveToWorld(transform, new vec3(0,5,0), 1000.0).start();
```

`Static`rawTween

rawTween(time: number): Tween
Parameters
- time: number
  Duration of Tween in miliseconds
Returns Tween
Example
```
LSTween.rawTween(1000)
  .onUpdate(function (o) {
    print(o.t);
  })
  .start();
```

`Static`rotateFromToLocal

rotateFromToLocal(
    transform: Transform,
    from: quat,
    to: quat,
    time: number,
    interpolationType?: RotationInterpolationType,
): Tween<{ t: number }>
Parameters
- transform: Transform
  Transform object you want to change rotation
- from: quat
  Initial quaternion you want your object to start from
- to: quat
  Destination quaternion you want your object to go to
- time: number
  Duration of Tween in miliseconds
- interpolationType: RotationInterpolationType = RotationInterpolationType.SLERP
  The interpolation type, lerp vs slerp. If no value is passed, it defaults to slerp
Returns Tween<{ t: number }>
Example
```
LSTween.rotateFromToLocal(transform, quat.angleAxis(startRadian, axis), quat.angleAxis(destRadian, axis), 1000.0).start();
```

`Static`rotateFromToWorld

rotateFromToWorld(
    transform: Transform,
    from: quat,
    to: quat,
    time: number,
    interpolationType?: RotationInterpolationType,
): Tween<{ t: number }>
Parameters
- transform: Transform
  Transform object you want to change rotation
- from: quat
  Initial quaternion you want your object to start from
- to: quat
  Destination quaternion you want your object to go to
- time: number
  Duration of Tween in miliseconds
- interpolationType: RotationInterpolationType = RotationInterpolationType.SLERP
  The interpolation type, lerp vs slerp. If no value is passed, it defaults to slerp
Returns Tween<{ t: number }>
Example
```
LSTween.rotateFromToWorld(transform, quat.angleAxis(startRadian, axis), quat.angleAxis(destRadian, axis), 1000.0).start();
```

`Static`rotateOffset

rotateOffset(
    transform: Transform,
    offset: quat,
    time: number,
    interpolationType?: RotationInterpolationType,
): Tween<{ t: number }>
Parameters
- transform: Transform
  Transform object you want to change rotation
- offset: quat
  Multiplies the offset value from current rotation
- time: number
  Duration of Tween in miliseconds
- interpolationType: RotationInterpolationType = RotationInterpolationType.SLERP
  The interpolation type, lerp vs slerp. If no value is passed, it defaults to slerp
Returns Tween<{ t: number }>
Example
```
LSTween.rotateOffset(transform, quat.angleAxis(radians, axis), 1000.0).start();
```

`Static`rotateToLocal

rotateToLocal(
    transform: Transform,
    to: quat,
    time: number,
    interpolationType?: RotationInterpolationType,
): Tween<{ t: number }>
Parameters
- transform: Transform
  Transform object you want to change rotation
- to: quat
  Destination quaternion you want your object to go to
- time: number
  Duration of Tween in miliseconds
- interpolationType: RotationInterpolationType = RotationInterpolationType.SLERP
  The interpolation type, lerp vs slerp. If no value is passed, it defaults to slerp
Returns Tween<{ t: number }>
Example
```
LSTween.rotateToLocal(transform, quat.angleAxis(radians, axis), 1000.0).start();
```

`Static`rotateToWorld

rotateToWorld(
    transform: Transform,
    to: quat,
    time: number,
    interpolationType?: RotationInterpolationType,
): Tween<{ t: number }>
Parameters
- transform: Transform
  Transform object you want to change rotation
- to: quat
  Destination quaternion you want your object to go to
- time: number
  Duration of Tween in miliseconds
- interpolationType: RotationInterpolationType = RotationInterpolationType.SLERP
  The interpolation type, lerp vs slerp. If no value is passed, it defaults to slerp
Returns Tween<{ t: number }>
Example
```
LSTween.rotateToWorld(transform, quat.angleAxis(radians, axis), 1000.0).start();
```

`Static`scaleFromToLocal

scaleFromToLocal(
    transform: Transform,
    from: vec3,
    to: vec3,
    time: number,
): Tween<{ t: number }>
Parameters
- transform: Transform
  Transform object you want to change scale
- from: vec3
  Initial scale you want your object to start from
- to: vec3
  Destination scale you want your object to go to
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ t: number }>
Example
```
LSTween.scaleFromToLocal(transform, new vec3(1,1,1), new vec3(2,2,2), 1000.0).start();
```

`Static`scaleFromToWorld

scaleFromToWorld(
    transform: Transform,
    from: vec3,
    to: vec3,
    time: number,
): Tween<{ t: number }>
Parameters
- transform: Transform
  Transform object you want to change scale
- from: vec3
  Initial scale you want your object to start from
- to: vec3
  Destination scale you want your object to go to
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ t: number }>
Example
```
LSTween.scaleFromToWorld(transform, new vec3(1,1,1), new vec3(2,2,2), 1000.0).start();
```

`Static`scaleOffset

scaleOffset(
    transform: Transform,
    offset: vec3,
    time: number,
): Tween<{ t: number }>
Parameters
- transform: Transform
  Transform object you want to change scale
- offset: vec3
  Multiplies the offset value from current scale
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ t: number }>
Example
```
LSTween.scaleOffset(transform, new vec3(2,2,2), 1000.0).start();
```

`Static`scaleToLocal

scaleToLocal(transform: Transform, to: vec3, time: number): Tween<{ t: number }>
Parameters
- transform: Transform
  Transform object you want to change scale
- to: vec3
  Destination scale you want your object to go to
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ t: number }>
Example
```
LSTween.scaleToLocal(transform, new vec3(2,2,2), 1000.0).start();
```

`Static`scaleToWorld

scaleToWorld(transform: Transform, to: vec3, time: number): Tween<{ t: number }>
Parameters
- transform: Transform
  Transform object you want to change scale
- to: vec3
  Destination scale you want your object to go to
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ t: number }>
Example
```
LSTween.scaleToWorld(transform, new vec3(2,2,2), 1000.0).start();
```

`Static`shaderColorPropertyFromTo

shaderColorPropertyFromTo(
    pass: Pass,
    property: string,
    from: vec4,
    to: vec4,
    time: number,
): Tween<{ t: number }>
Parameters
- pass: Pass
  The pass you want to change the property of
- property: string
  The property name in the pass you want to change
- from: vec4
  Initial value of your property
- to: vec4
  Destination value you want your property to reach
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ t: number }>
Example
```
LSTween.shaderColorPropertyFromTo(pass, "tintColor", new vec4(0,0,0,1), new vec4(1,1,1,1), 1000.0).start();
```

`Static`shaderFloatPropertyFromTo

shaderFloatPropertyFromTo(
    pass: Pass,
    property: string,
    from: number,
    to: number,
    time: number,
): Tween<{ t: number }>
Parameters
- pass: Pass
  The pass you want to change the property of
- property: string
  The property name in the pass you want to change
- from: number
  Initial value of your property
- to: number
  Destination value you want your property to reach
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ t: number }>
Example
```
LSTween.shaderFloatPropertyFromTo(pass, "opacity", 0.0, 1.0, 1000.0).start();
```

`Static`textAlphaFromTo

textAlphaFromTo(
    text: Text,
    from: number,
    to: number,
    time: number,
): Tween<{ a: number }>
Parameters
- text: Text
  Text that you wish to change alpha
- from: number
  Initial value of your alpha
- to: number
  Destination value you want your alpha to reach
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ a: number }>
Example
```
LSTween.textAlphaFromTo(text, 0.0, 0.5, 1000.0).start();
```

`Static`textAlphaTo

textAlphaTo(text: Text, to: number, time: number): Tween<{ a: number }>
Parameters
- text: Text
  Text that you wish to change alpha
- to: number
  Destination value you want your alpha to reach
- time: number
  Duration of Tween in miliseconds
Returns Tween<{ a: number }>
Example
```
LSTween.textAlphaTo(text, 0.25, 1000.0).start();
```

Class LSTween

Index

Constructors

Properties

Methods

Constructors

Privateconstructor

Returns LSTween

Properties

Private Static Readonlyinstance

Methods

StaticalphaFromTo

Parameters

Returns Tween<{ a: number }>

Example

StaticalphaTo

Parameters

Returns Tween<{ a: number }>

Example

StaticcolorFromTo

Parameters

Returns Tween<{ t: number }>

Example

StaticcolorTextFromTo

Parameters

Returns Tween<{ t: number }>

Example

StaticcolorTextTo

Parameters

Returns Tween<{ t: number }>

Example

StaticcolorTo

Parameters

Returns Tween<{ t: number }>

Example

StaticenableChange

Parameters

Returns Tween<any>

Example

StaticmoveFromToLocal

Parameters

Returns Tween<{ t: number }>

Example

StaticmoveFromToWorld

Parameters

Returns Tween<{ t: number }>

Example

StaticmoveOffset

Parameters

Returns Tween<{ t: number }>

Example

StaticmoveToLocal

Parameters

Returns Tween<{ t: number }>

Example

StaticmoveToWorld

Parameters

Returns Tween<{ t: number }>

Example

StaticrawTween

Parameters

Returns Tween

Example

StaticrotateFromToLocal

Parameters

Returns Tween<{ t: number }>

Example

StaticrotateFromToWorld

Parameters

Returns Tween<{ t: number }>

Example

StaticrotateOffset

Parameters

Returns Tween<{ t: number }>

Example

StaticrotateToLocal

Parameters

Returns Tween<{ t: number }>

Example

StaticrotateToWorld

`Private`constructor

`Private` `Static` `Readonly`instance

`Static`alphaFromTo

`Static`alphaTo

`Static`colorFromTo

`Static`colorTextFromTo

`Static`colorTextTo

`Static`colorTo

`Static`enableChange

`Static`moveFromToLocal

`Static`moveFromToWorld

`Static`moveOffset

`Static`moveToLocal

`Static`moveToWorld

`Static`rawTween

`Static`rotateFromToLocal

`Static`rotateFromToWorld

`Static`rotateOffset

`Static`rotateToLocal

`Static`rotateToWorld

`Static`scaleFromToLocal

`Static`scaleFromToWorld

`Static`scaleOffset

`Static`scaleToLocal

`Static`scaleToWorld

`Static`shaderColorPropertyFromTo

`Static`shaderFloatPropertyFromTo

`Static`textAlphaFromTo

`Static`textAlphaTo