- Developed by Dented Pixel
API Docs for: LeanTween 2.14

Support LeanTween!
Show:

LTSpline Class

Defined in: LeanTween.cs:1107

Animate along a set of points that need to be in the format: controlPoint, point1, point2.... pointLast, endControlPoint

Constructor

LTSpline

(
  • pts
)

Defined in LeanTween.cs:1107

Parameters:

  • pts Vector3 Array

    A set of points that define the points the path will pass through (starting with starting control point, and ending with a control point)

Example:

LTSpline ltSpline = new LTSpline( new Vector3[] { new Vector3(0f,0f,0f),new Vector3(0f,0f,0f), new Vector3(0f,0.5f,0f), new Vector3(1f,1f,0f), new Vector3(1f,1f,0f)} );

LeanTween.moveSpline(lt, ltSpline.vec3, 4.0f).setOrientToPath(true).setDelay(1f).setEase(LeanTweenType.easeInOutQuad); // animate
Vector3 pt = ltSpline.point( 0.6f ); // retrieve a point along the path

Item Index

Methods

Methods

place

(
  • transform:Transform
  • ratio:float
)

Defined in LeanTween.cs:1215

Place an object along a certain point on the path (facing the direction perpendicular to the path)

Parameters:

  • transform:Transform Transform

    the transform of the object you wish to place along the path

  • ratio:float Float

    ratio of the point along the path you wish to receive (0-1)

Example:

ltPath.place( transform, 0.6f );

place

(
  • transform:Transform
  • ratio:float
  • rotation:Vector3
)

Defined in LeanTween.cs:1228

Place an object along a certain point on the path, with it facing a certain direction perpendicular to the path

Parameters:

  • transform:Transform Transform

    the transform of the object you wish to place along the path

  • ratio:float Float

    ratio of the point along the path you wish to receive (0-1)

  • rotation:Vector3 Vector3

    the direction in which to place the transform ex: Vector3.up

Example:

ltPath.place( transform, 0.6f, Vector3.left );

placeLocal

(
  • transform:Transform
  • ratio:float
)

Defined in LeanTween.cs:1245

Place an object along a certain point on the path (facing the direction perpendicular to the path) - Local Space, not world-space

Parameters:

  • transform:Transform Transform

    the transform of the object you wish to place along the path

  • ratio:float Float

    ratio of the point along the path you wish to receive (0-1)

Example:

ltPath.placeLocal( transform, 0.6f );

placeLocal

(
  • transform:Transform
  • ratio:float
  • rotation:Vector3
)

Defined in LeanTween.cs:1258

Place an object along a certain point on the path, with it facing a certain direction perpendicular to the path - Local Space, not world-space

Parameters:

  • transform:Transform Transform

    the transform of the object you wish to place along the path

  • ratio:float Float

    ratio of the point along the path you wish to receive (0-1)

  • rotation:Vector3 Vector3

    the direction in which to place the transform ex: Vector3.up

Example:

ltPath.placeLocal( transform, 0.6f, Vector3.left );

point

(
  • ratio:float
)
Vector3

Defined in LeanTween.cs:1199

Retrieve a point along a path

Parameters:

  • ratio:float Float

    ratio of the point along the path you wish to receive (0-1)

Returns:

Vector3:

Vector3 position of the point along the path

Example:

transform.position = ltSpline.point( 0.6f );