core/com.pico.spatial.core.ecs.animation/TweenAnimation

TweenAnimation

Represents a type of animation for "from-to-by" behavior.

PICO Spatial SDK supports four combinations of TweenAnimation: FromTo, FromBy, To, and By. If any other combinations are constructed, they will not function as intended because the system cannot perform interpolation calculations with the given data.

Additionally, a corresponding BindTarget is required for applying an animation to an entity. For instance, to change an entity's position, use bindTarget = AnimationBindTarget.bindPosition() to indicate that the animation should modify the entity's position values. In this case, the type of input parameter for fromValue, toValue, and byValue should be Vector3. Refer to the documentation of the static functions in AnimationBindTarget for the types of input parameter required by different types of bindTarget.

Code sample:

// Create a position animation for an entity.
val animation = TweenAnimation.createTweenAnimation(
    bindTarget = AnimationBindTarget.bindPosition(),
    to = Vector3(-7F, 5.5F, -11F),
    repeatMode = RepeatMode.RESTART,
    repeatCount = 100,
    duration = 2F
)
val animationResource = AnimationResource.generateWithTweenAnimation(animation)
val entity = Entity()
entity.playAnimation(animationResource)

// Create a base color animation for an entity.
val colorAnimation = TweenAnimation.createTweenAnimation(
    bindTarget = AnimationBindTarget.bindMaterial(0, MaterialTarget.BASE_COLOR_TINT),
    from = Color4.fromLinearHex("5CCF6BFF"), // Starting color
    to = Color4.BLUE,                        // Ending color
    repeatMode = RepeatMode.RESTART,
    repeatCount = 100,
    duration = 2F
)
val colorAnimationResource = AnimationResource.generateWithTweenAnimation(colorAnimation)
entity.playAnimation(colorAnimationResource)

Types

Companion

object Companion

The companion of TweenAnimation.

Properties

easeType

var easeType: EaseType

The EaseType of the animation. This defines the rate of change of the animation over time, allowing for effects such as acceleration, deceleration, or linear motion. It affects the smoothness, style, and realism of the animation.