Class FloatRectArray

Implements

FloatRectArrayType

Index

Constructors

Properties

Methods

add append copy destroy find getAt getSize getUpperBound insertAt removeAll removeAt setAt setSize create

Constructors

constructor

new FloatRectArray(options?: Options): FloatRectArray
Create a FloatRectArray instance. Instead of creating an instance in new mode, use create to create an instance.
Parameters
- Optionaloptions: Options
  The options to create a FloatRectArray instance.
Returns FloatRectArray
Example
```
 const floatRectArr = await FloatRectArray.create();
```

Properties

options

options: Options

Methods

add

add(newItem: Rect): Promise<number>
Add an Rect object to the array.
Parameters
- newItem: Rect
  The Rect object to add.
Returns Promise<number>
The index of the added element.
Example
```
const rect = {
   top: 0,
   right: 100,
   bottom: 100,
   left: 0
};
const floatRectArr = await FloatRectArray.create();
const index = await floatRectArr.add(rect
```
Implementation of FloatRectArrayType.add

append

append(arr: FloatRectArrayType): Promise<number>
Append an array to the current array.
Parameters
- arr: FloatRectArrayType
  The array to append.
Returns Promise<number>
1 if successful, otherwise an error code.

Implementation of FloatRectArrayType.append

copy

copy(arr: FloatRectArrayType): Promise<void>
Copy from an array.
Parameters
- arr: FloatRectArrayType
  The array to copy from.
Returns Promise<void>
Implementation of FloatRectArrayType.copy

destroy

destroy(): Promise<void>
Destroy the current object.

Returns Promise<void>
Implementation of FloatRectArrayType.destroy

find

find(rect: Rect, startIndex?: number): Promise<number>
Find the index of the element.
Parameters
- rect: Rect
  The element to find.
- startIndex: number = 0
  The start index to find.
Returns Promise<number>
Implementation of FloatRectArrayType.find

getAt

getAt(index: number): Promise<null | Rect>
Get the Rect object at the specified index.
Parameters
- index: number
  The index of the element to get.
Returns Promise<null | Rect>
Return the Rect object at the specified index.

Implementation of FloatRectArrayType.getAt

getSize

getSize(): Promise<number>
Get the number of elements in the array.

Returns Promise<number>
Return the number of elements in the array.

Implementation of FloatRectArrayType.getSize

getUpperBound

getUpperBound(): Promise<number>
Gets the upper bound in the array, actually the maximum valid index.

Returns Promise<number>
Return the upper bound in the array.

Implementation of FloatRectArrayType.getUpperBound

insertAt

insertAt(index: number, newItem: Rect, count: number): Promise<void>
Insert an element.
Parameters
- index: number
  The index to insert.
- newItem: Rect
  The element to insert.
- count: number
  The number of elements to insert.
Returns Promise<void>
Implementation of FloatRectArrayType.insertAt

removeAll

removeAll(): Promise<void>
Remove all elements from the array.

Returns Promise<void>
Implementation of FloatRectArrayType.removeAll

removeAt

removeAt(index: number, count: number): Promise<void>
Remove an element by specified index.
Parameters
- index: number
  The index of the element to remove.
- count: number
  The number of elements to remove.
Returns Promise<void>
Implementation of FloatRectArrayType.removeAt

setAt

setAt(index: number, newItem: Rect): Promise<void>
Set the Rect object at the specified index.
Parameters
- index: number
  Set the Rect object at the specified index.
- newItem: Rect
  The Rect object to set.
Returns Promise<void>
Implementation of FloatRectArrayType.setAt

setSize

setSize(size: number, growBy: number): Promise<void>
Changes the allocated size and the growing amount.
Parameters
- size: number
  The new size in elements expected.
- growBy: number
  The number of elements to grow by.
Returns Promise<void>
Implementation of FloatRectArrayType.setSize

`Static`create

create(options?: Options): Promise<FloatRectArrayType>
Create a FloatRectArray instance.
Parameters
- Optionaloptions: Options
  Create a FloatRectArray instance with the specified options.
Returns Promise<FloatRectArrayType>
Return a FloatRectArray instance.
Example
```
 const floatRectArr = await FloatRectArray.create();
```