BezierCurve

Description:

  A Bézier curve object that can evaluate and render Bézier curves of arbitrary degree.

type

Type: Function.

Description:

  Gets the type of the object as a string.

Signature:

type: function(self: BezierCurve): string

Returns:

Return Type	Description
string	The type as a string.

Of

Type: Function.

Description:

  Checks whether an object is of a certain type. If the object has the type with the specified name in its hierarchy, this function will return true.

Signature:

typeOf: function(self: BezierCurve, type_name: string): boolean

Parameters:

Parameter	Type	Description
type_name	string	The name of the type to check for.

Returns:

Return Type	Description
boolean	True if the object is of the specified type, false otherwise.

release

Type: Function.

Description:

  Destroys the object's Lua reference. The object will be completely deleted if it's not referenced by any other LÖVE object or thread. This method can be used to immediately clean up resources without waiting for Lua's garbage collector.

Signature:

release: function(self: BezierCurve): boolean

Returns:

Return Type	Description
boolean	True if the object was released by this call, false if it had been previously released.

getDegree

Type: Function.

Description:

  Get degree of the Bézier curve. The degree is equal to number-of-control-points - 1.

Signature:

getDegree: function(self: BezierCurve): integer

Returns:

Return Type	Description
integer	Degree of the Bézier curve.

getDerivative

Type: Function.

Description:

  Get the derivative of the Bézier curve. This function can be used to rotate sprites moving along a curve in the direction of the movement and compute the direction perpendicular to the curve at some parameter t.

Signature:

getDerivative: function(self: BezierCurve): BezierCurve

Returns:

Return Type	Description
BezierCurve	The derivative curve.

getControlPoint

Type: Function.

Description:

  Get coordinates of the i-th control point. Indices start with 1.

Signature:

getControlPoint: function(self: BezierCurve, index: integer): number, number

Parameters:

Parameter	Type	Description
index	integer	Index of the control point.

Returns:

Return Type	Description
number	Position of the control point along the x axis.
number	Position of the control point along the y axis.

setControlPoint

Type: Function.

Description:

  Set coordinates of the i-th control point. Indices start with 1.

Signature:

setControlPoint: function(self: BezierCurve, index: integer, x: number, y: number)

Parameters:

Parameter	Type	Description
index	integer	Index of the control point.
x	number	Position of the control point along the x axis.
y	number	Position of the control point along the y axis.

insertControlPoint

Type: Function.

Description:

  Insert control point as the new i-th control point. Existing control points from i onwards are pushed back by 1. Indices start with 1. Negative indices wrap around: -1 is the last control point, -2 the one before the last, etc.

Signature:

insertControlPoint: function(self: BezierCurve, x: number, y: number, index?: integer)

Parameters:

Parameter	Type	Description
x	number	Position of the control point along the x axis.
y	number	Position of the control point along the y axis.
index	integer	Index of the control point. (Default: -1.)

removeControlPoint

Type: Function.

Description:

  Removes the specified control point.

Signature:

removeControlPoint: function(self: BezierCurve, index: integer)

Parameters:

Parameter	Type	Description
index	integer	The index of the control point to remove.

getControlPointCount

Type: Function.

Description:

  Get the number of control points in the Bézier curve.

Signature:

getControlPointCount: function(self: BezierCurve): integer

Returns:

Return Type	Description
integer	The number of control points.

translate

Type: Function.

Description:

  Move the Bézier curve by an offset.

Signature:

translate: function(self: BezierCurve, x: number, y: number)

Parameters:

Parameter	Type	Description
x	number	Offset along the x axis.
y	number	Offset along the y axis.

rotate

Type: Function.

Description:

  Rotate the Bézier curve by an angle.

Signature:

rotate: function(self: BezierCurve, angle: number, origin_x?: number, origin_y?: number)

Parameters:

Parameter	Type	Description
angle	number	Rotation angle in radians.
origin_x	number	X coordinate of the rotation center. (Default: 0.)
origin_y	number	Y coordinate of the rotation center. (Default: 0.)

scale

Type: Function.

Description:

  Scale the Bézier curve by a factor.

Signature:

scale: function(self: BezierCurve, scale: number, origin_x?: number, origin_y?: number)

Parameters:

Parameter	Type	Description
scale	number	Scale factor.
origin_x	number	X coordinate of the scaling center. (Default: 0.)
origin_y	number	Y coordinate of the scaling center. (Default: 0.)

evaluate

Type: Function.

Description:

  Evaluate Bézier curve at parameter t. The parameter must be between 0 and 1 (inclusive). This function can be used to move objects along paths or tween parameters. However it should not be used to render the curve, see BezierCurve:render for that purpose.

Signature:

evaluate: function(self: BezierCurve, time: number): number, number

Parameters:

Parameter	Type	Description
time	number	Where to evaluate the curve.

Returns:

Return Type	Description
number	x coordinate of the curve at parameter t.
number	y coordinate of the curve at parameter t.

getSegment

Type: Function.

Description:

  Gets a BezierCurve that corresponds to the specified segment of this BezierCurve.

Signature:

getSegment: function(self: BezierCurve, start: number, finish: number): BezierCurve

Parameters:

Parameter	Type	Description
start	number	The starting point along the curve. Must be between 0 and 1.
finish	number	The end of the segment. Must be between 0 and 1.

Returns:

Return Type	Description
BezierCurve	A BezierCurve that corresponds to the specified segment.

render

Type: Function.

Description:

  Get a list of coordinates to be used with love.graphics.line. This function samples the Bézier curve using recursive subdivision. You can control the recursion depth using the depth parameter. If you are just interested to know the position on the curve given a parameter, use BezierCurve:evaluate.

Signature:

render: function(self: BezierCurve, accuracy?: integer): {number}

Parameters:

Parameter	Type	Description
accuracy	integer	Number of recursive subdivision steps. (Default: 5.)

Returns:

Return Type	Description
{number}	List of x,y-coordinate pairs of points on the curve.

renderSegment

Type: Function.

Description:

  Get a list of coordinates on a specific part of the curve, to be used with love.graphics.line. This function samples the Bézier curve using recursive subdivision. You can control the recursion depth using the depth parameter. If you are just need to know the position on the curve given a parameter, use BezierCurve:evaluate.

Signature:

renderSegment: function(self: BezierCurve, start: number, finish: number, accuracy?: integer): {number}

Parameters:

Parameter	Type	Description
start	number	The starting point along the curve. Must be between 0 and 1.
finish	number	The end of the segment to render. Must be between 0 and 1.
accuracy	integer	Number of recursive subdivision steps. (Default: 5.)

Returns:

Return Type	Description
{number}	List of x,y-coordinate pairs of points on the specified part of the curve.