Element

• Index

Contents

• Attributes
• Methods
• Class Methods

Classes

• el.AudioBuffer
• el.Bounds
• el.Commands
• el.Content
• el.Context
• el.Desktop
• el.Graph
• el.GraphEditor
• el.Graphics
• el.MidiBuffer
• el.MidiMessage
• el.MouseEvent
• el.Node
• el.Point
• el.Range
• el.Rectangle
• el.Session
• el.Slider
• el.TextButton
• el.View
• el.Widget
• el.MidiPipe

Modules

• el.bytes
• el.command
• el.midi
• el.object
• el.round
• el.script
• el.strings

Examples

• amp.lua
• ampui.lua
• channelize.lua

Class el.Rectangle

A rectangle.

The value type for this is a 64 bit float.

Attributes

Rectangle.x
Rectangle.y
Rectangle.width
Rectangle.height
Rectangle.left
Rectangle.right
Rectangle.top
Rectangle.bottom

Methods

Rectangle:center ()	Returns the center point of this rect.
Rectangle:centerX ()
Rectangle:centerY ()
Rectangle:empty ()	Is empty.
Rectangle:isFinite ()	Is finite.
Rectangle:translate (dx, dy)	Translate the rectangle.
Rectangle:translated (dx, dy)	Returns a translated retctangle.
Rectangle:expand (dx, dy)	Expand the rectangle in size.
Rectangle:expanded (dx, dy)	Returns expanded rectangle.
Rectangle:expanded (dxy)	Returns expanded rectangle.
Rectangle:reduce (dx, dy)	Reduce the rectangle in size.
Rectangle:reduced (dx, dy)	Returns reduced rectangle.
Rectangle:reduced (dxy)	Returns reduced rectangle.
Rectangle:sliceTop (amt)	Slice top.
Rectangle:sliceLeft (amt)	Slice left.
Rectangle:sliceRight (amt)	Slice right.
Rectangle:sliceBottom (amt)	Slice bottom.
Rectangle:toInt ()	Convert to integer.
Rectangle:toEdges ()	Convert to rounded integer.
Rectangle:toNumber ()	Convert to number.

Class Methods

Rectangle.new ()	Create a new empty rectangle.
Rectangle.new (x, y, width, height)	Create a new rectangle.
Rectangle.new (width, height)	Create a new rectangle.
Rectangle.new (p1, p2)	Create a new rectangle from two points.
Rectangle.fromcoords (x1, y1, x2, y2)	Create a new rectangle from a set of coordinates.

Attributes

Rectangle.x

Rectangle.y

Rectangle.width

Rectangle.height

Rectangle.left

Rectangle.right

Rectangle.top

Rectangle.bottom

Methods

Rectangle:center ()

Returns the center point of this rect.

Returns:

el.Point

Rectangle:centerX ()

Rectangle:centerY ()

Rectangle:empty ()

Is empty.

Returns:

True if a 0,0,0,0 rectangle

Rectangle:isFinite ()

Is finite.

Returns:

True if finite

Rectangle:translate (dx, dy)

Translate the rectangle.

Parameters:

• dx
• dy

Rectangle:translated (dx, dy)

Returns a translated retctangle.

Parameters:

• dx
• dy

Returns:

A translated rectangle

Rectangle:expand (dx, dy)

Expand the rectangle in size.

Parameters:

• dx
• dy

Rectangle:expanded (dx, dy)

Returns expanded rectangle.

Parameters:

• dx
• dy

Rectangle:expanded (dxy)

Returns expanded rectangle.

Parameters:

• dxy Delta X and Y

Rectangle:reduce (dx, dy)

Reduce the rectangle in size.

Parameters:

• dx
• dy

Rectangle:reduced (dx, dy)

Returns reduced rectangle.

Parameters:

• dx
• dy

Rectangle:reduced (dxy)

Returns reduced rectangle.

Parameters:

• dxy Delta X and Y

Rectangle:sliceTop (amt)

Slice top. Remomve and return a portion of this rectangle.

Parameters:

• amt Amount to remove

Rectangle:sliceLeft (amt)

Slice left. Remomve and return a portion of this rectangle.

Parameters:

• amt Amount to remove

Rectangle:sliceRight (amt)

Slice right. Remomve and return a portion of this rectangle.

Parameters:

• amt Amount to remove

Rectangle:sliceBottom (amt)

Slice bottom. Remomve and return a portion of this rectangle.

Parameters:

• amt Amount to remove

Rectangle:toInt ()

Convert to integer.

Returns:

el.Bounds Converted rectangle

Rectangle:toEdges ()

Convert to rounded integer.

Returns:

el.Bounds Converted rectangle

Rectangle:toNumber ()

Convert to number.

Returns:

Converted rectangle

Class Methods

Rectangle.new ()

Create a new empty rectangle.

Returns:

el.Rectangle

Rectangle.new (x, y, width, height)

Create a new rectangle.

Parameters:

• x
• y
• width
• height

Returns:

el.Rectangle

Rectangle.new (width, height)

Create a new rectangle.

Parameters:

• width
• height

Returns:

el.Rectangle

Rectangle.new (p1, p2)

Create a new rectangle from two points.

Parameters:

• p1 el.Point
• p2 el.Point

Returns:

el.Rectangle

Rectangle.fromcoords (x1, y1, x2, y2)

Create a new rectangle from a set of coordinates.

Parameters:

• x1 integer Left
• y1 integer Top
• x2 integer Right
• y2 integer Bottom

Returns:

el.Rectangle New rectangle