Class ScyllaShapeTweenExtensions

Provides extension methods for animating the parameters of every Scylla 3D shape via ScyllaTween. Each helper drives a single shape property over the requested duration; the property setter triggers Rebuild() internally, so the mesh updates every tween tick.

Inheritance
object
ScyllaShapeTweenExtensions
Inherited Members
Namespace: Scylla.Core.Util.Tween
Assembly: ScyllaCore.dll
Syntax
public static class ScyllaShapeTweenExtensions
Remarks

All methods return a pre-configured tween instance sourced from TweenPool. The tween is not started automatically - call Play() or PlayManaged(ITween) on the returned instance to begin playback. The start value is captured lazily from the shape at the moment playback begins.

Per-frame mesh rebuilds are inexpensive for box / quad / plane shapes and acceptable for sphere / cylinder / cone / capsule / torus / ring at typical animation rates. Avoid tweening over many seconds at high frame rates if the host scene has dozens of shape instances animating simultaneously; if needed, use TweenExtensions.SetUpdateRate on the returned tween to throttle the setter invocations.

For shape parameters that are integers (segments, subdivisions, base-side counts), no tween helper is provided: those values change topology discontinuously and are not meaningful to animate. Set them directly.

Methods

TweenCornerRadius(ScyllaRoundedBoxShape, float, float)

Animates CornerRadius.

Declaration
public static TweenFloat TweenCornerRadius(this ScyllaRoundedBoxShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaRoundedBoxShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenDepth(ScyllaBoxShape, float, float)

Animates Depth.

Declaration
public static TweenFloat TweenDepth(this ScyllaBoxShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaBoxShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenDepth(ScyllaPlaneShape, float, float)

Animates Depth.

Declaration
public static TweenFloat TweenDepth(this ScyllaPlaneShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaPlaneShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenDepth(ScyllaRoundedBoxShape, float, float)

Animates Depth.

Declaration
public static TweenFloat TweenDepth(this ScyllaRoundedBoxShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaRoundedBoxShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenHeight(ScyllaBoxShape, float, float)

Animates Height.

Declaration
public static TweenFloat TweenHeight(this ScyllaBoxShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaBoxShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenHeight(ScyllaCapsuleShape, float, float)

Animates Height.

Declaration
public static TweenFloat TweenHeight(this ScyllaCapsuleShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaCapsuleShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenHeight(ScyllaConeShape, float, float)

Animates Height.

Declaration
public static TweenFloat TweenHeight(this ScyllaConeShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaConeShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenHeight(ScyllaCylinderShape, float, float)

Animates Height.

Declaration
public static TweenFloat TweenHeight(this ScyllaCylinderShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaCylinderShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenHeight(ScyllaPyramidShape, float, float)

Animates Height.

Declaration
public static TweenFloat TweenHeight(this ScyllaPyramidShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaPyramidShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenHeight(ScyllaQuadShape, float, float)

Animates Height.

Declaration
public static TweenFloat TweenHeight(this ScyllaQuadShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaQuadShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenHeight(ScyllaRingShape, float, float)

Animates Height.

Declaration
public static TweenFloat TweenHeight(this ScyllaRingShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaRingShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenHeight(ScyllaRoundedBoxShape, float, float)

Animates Height.

Declaration
public static TweenFloat TweenHeight(this ScyllaRoundedBoxShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaRoundedBoxShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenHeight(ScyllaTriangularPrismShape, float, float)

Animates Height.

Declaration
public static TweenFloat TweenHeight(this ScyllaTriangularPrismShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaTriangularPrismShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenInnerRadius(ScyllaRingShape, float, float)

Animates InnerRadius.

Declaration
public static TweenFloat TweenInnerRadius(this ScyllaRingShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaRingShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenMajorRadius(ScyllaTorusShape, float, float)

Animates MajorRadius.

Declaration
public static TweenFloat TweenMajorRadius(this ScyllaTorusShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaTorusShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenMinorRadius(ScyllaTorusShape, float, float)

Animates MinorRadius.

Declaration
public static TweenFloat TweenMinorRadius(this ScyllaTorusShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaTorusShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenOuterRadius(ScyllaRingShape, float, float)

Animates OuterRadius.

Declaration
public static TweenFloat TweenOuterRadius(this ScyllaRingShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaRingShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenRadius(ScyllaCapsuleShape, float, float)

Animates Radius.

Declaration
public static TweenFloat TweenRadius(this ScyllaCapsuleShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaCapsuleShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenRadius(ScyllaConeShape, float, float)

Animates Radius.

Declaration
public static TweenFloat TweenRadius(this ScyllaConeShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaConeShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenRadius(ScyllaCylinderShape, float, float)

Animates Radius.

Declaration
public static TweenFloat TweenRadius(this ScyllaCylinderShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaCylinderShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenRadius(ScyllaIcoSphereShape, float, float)

Animates Radius.

Declaration
public static TweenFloat TweenRadius(this ScyllaIcoSphereShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaIcoSphereShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenRadius(ScyllaOctahedronShape, float, float)

Animates Radius.

Declaration
public static TweenFloat TweenRadius(this ScyllaOctahedronShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaOctahedronShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenRadius(ScyllaPyramidShape, float, float)

Animates Radius.

Declaration
public static TweenFloat TweenRadius(this ScyllaPyramidShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaPyramidShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenRadius(ScyllaSphereShape, float, float)

Animates Radius.

Declaration
public static TweenFloat TweenRadius(this ScyllaSphereShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaSphereShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenRadius(ScyllaTriangularPrismShape, float, float)

Animates Radius.

Declaration
public static TweenFloat TweenRadius(this ScyllaTriangularPrismShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaTriangularPrismShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenSize(ScyllaBoxShape, Size3D, float)

Animates Size to a new Size3D target.

Declaration
public static TweenVector3 TweenSize(this ScyllaBoxShape shape, Size3D target, float duration)
Parameters
Type Name Description
ScyllaBoxShape shape
Size3D target
float duration
Returns
Type Description
TweenVector3

TweenSize(ScyllaPlaneShape, Size2D, float)

Animates Size to a new Size2D target.

Declaration
public static TweenVector2 TweenSize(this ScyllaPlaneShape shape, Size2D target, float duration)
Parameters
Type Name Description
ScyllaPlaneShape shape
Size2D target
float duration
Returns
Type Description
TweenVector2

TweenSize(ScyllaQuadShape, Size2D, float)

Animates Size to a new Size2D target.

Declaration
public static TweenVector2 TweenSize(this ScyllaQuadShape shape, Size2D target, float duration)
Parameters
Type Name Description
ScyllaQuadShape shape
Size2D target
float duration
Returns
Type Description
TweenVector2

TweenSize(ScyllaRoundedBoxShape, Size3D, float)

Animates Size to a new Size3D target.

Declaration
public static TweenVector3 TweenSize(this ScyllaRoundedBoxShape shape, Size3D target, float duration)
Parameters
Type Name Description
ScyllaRoundedBoxShape shape
Size3D target
float duration
Returns
Type Description
TweenVector3

TweenTint(ScyllaShapeBase3D, Color, float)

Animates the shape's Tint from its current value to target over duration seconds. The tint is applied via UnityEngine.MaterialPropertyBlock; no material instance is allocated.

Declaration
public static TweenColor TweenTint(this ScyllaShapeBase3D shape, Color target, float duration)
Parameters
Type Name Description
ScyllaShapeBase3D shape
Color target
float duration
Returns
Type Description
TweenColor

TweenWidth(ScyllaBoxShape, float, float)

Animates Width.

Declaration
public static TweenFloat TweenWidth(this ScyllaBoxShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaBoxShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenWidth(ScyllaPlaneShape, float, float)

Animates Width.

Declaration
public static TweenFloat TweenWidth(this ScyllaPlaneShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaPlaneShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenWidth(ScyllaQuadShape, float, float)

Animates Width.

Declaration
public static TweenFloat TweenWidth(this ScyllaQuadShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaQuadShape shape
float target
float duration
Returns
Type Description
TweenFloat

TweenWidth(ScyllaRoundedBoxShape, float, float)

Animates Width.

Declaration
public static TweenFloat TweenWidth(this ScyllaRoundedBoxShape shape, float target, float duration)
Parameters
Type Name Description
ScyllaRoundedBoxShape shape
float target
float duration
Returns
Type Description
TweenFloat

See Also