Class Rectangle

Defines a rectangle with position and size and add comfortable methods to it

Author

Jirka Dell'Oro-Friedl, HFU, 2019

Hierarchy (View Summary)

Mutable
- Rectangle

Implements

Recycable

Constructors

constructor

new Rectangle(
    _x?: number,
    _y?: number,
    _width?: number,
    _height?: number,
    _origin?: ORIGIN2D,
): Rectangle
Parameters
- _x: number = 0
- _y: number = 0
- _width: number = 1
- _height: number = 1
- _origin: ORIGIN2D = ORIGIN2D.TOPLEFT
Returns Rectangle
Overrides Mutable.constructor
- Defined in Source/Core/Math/Rectangle.ts:28

Properties

position

position: Vector2 = ...

size

size: Vector2 = ...

Accessors

bottom

get bottom(): number
Get/set the lowest expansion, respecting also negative values of height

Returns number
- Defined in Source/Core/Math/Rectangle.ts:117
set bottom(_value: number): void
Parameters
- _value: number
Returns void
- Defined in Source/Core/Math/Rectangle.ts:123

clone

get clone(): Rectangle
Returns Rectangle
- Defined in Source/Core/Math/Rectangle.ts:127

height

get height(): number
Returns number
- Defined in Source/Core/Math/Rectangle.ts:65
set height(_height: number): void
Parameters
- _height: number
Returns void
- Defined in Source/Core/Math/Rectangle.ts:69

left

get left(): number
Get/set the leftmost expansion, respecting also negative values of width

Returns number
- Defined in Source/Core/Math/Rectangle.ts:76
set left(_value: number): void
Parameters
- _value: number
Returns void
- Defined in Source/Core/Math/Rectangle.ts:82

right

get right(): number
Get/set the rightmost expansion, respecting also negative values of width

Returns number
- Defined in Source/Core/Math/Rectangle.ts:104
set right(_value: number): void
Parameters
- _value: number
Returns void
- Defined in Source/Core/Math/Rectangle.ts:110

top

get top(): number
Get/set the topmost expansion, respecting also negative values of height

Returns number
- Defined in Source/Core/Math/Rectangle.ts:90
set top(_value: number): void
Parameters
- _value: number
Returns void
- Defined in Source/Core/Math/Rectangle.ts:96

type

get type(): string
Retrieves the type of this mutable subclass as the name of the runtime class

Returns string
The type of the mutable
Inherited from Mutable.type
- Defined in Source/Core/Serialization/Mutable.ts:193

width

get width(): number
Returns number
- Defined in Source/Core/Math/Rectangle.ts:57
set width(_width: number): void
Parameters
- _width: number
Returns void
- Defined in Source/Core/Math/Rectangle.ts:61

x

get x(): number
Returns number
- Defined in Source/Core/Math/Rectangle.ts:41
set x(_x: number): void
Parameters
- _x: number
Returns void
- Defined in Source/Core/Math/Rectangle.ts:45

y

get y(): number
Returns number
- Defined in Source/Core/Math/Rectangle.ts:49
set y(_y: number): void
Parameters
- _y: number
Returns void
- Defined in Source/Core/Math/Rectangle.ts:53

Methods

addEventListener

addEventListener(
    _type: string,
    _handler: EventListenerUnified,
    _options?: boolean | AddEventListenerOptions,
): void
See EventTarget.addEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional_options: boolean | AddEventListenerOptions
Returns void
Inherited from Mutable.addEventListener
- Defined in Source/Core/Event/Event.ts:91

animate

animate(_mutator: AnimationMutator): void
Updates the property values of the instance according to the state of the animation mutator. Override to implement custom animation behavior.
Parameters
- _mutator: AnimationMutator
Returns void
Inherited from Mutable.animate
- Defined in Source/Core/Serialization/Mutable.ts:329

collides

collides(_rect: Rectangle): boolean
Returns true if this rectangle collides with the given rectangle.
Parameters
- _rect: Rectangle
Returns boolean
- Defined in Source/Core/Math/Rectangle.ts:206

copy

copy(_rect: Rectangle): Rectangle
Set this rectangle to the values given by the rectangle provided.
Parameters
- _rect: Rectangle
Returns Rectangle
A reference to this rectangle.
- Defined in Source/Core/Math/Rectangle.ts:149

covers

covers(_rect: Rectangle): boolean
Returns true if this rectangle completely encloses the given rectangle.
Parameters
- _rect: Rectangle
Returns boolean
- Defined in Source/Core/Math/Rectangle.ts:217

dispatchEvent

dispatchEvent(_event: EventUnified): boolean
See EventTarget.dispatchEvent for reference. Works with with EventUnified
Parameters
- _event: EventUnified
Returns boolean
Inherited from Mutable.dispatchEvent
- Defined in Source/Core/Event/Event.ts:105

equals

equals(_compare: Rectangle, _tolerance?: number): boolean
Returns true if this rectangle is equal to the given rectagnle within the given tolerance.
Parameters
- _compare: Rectangle
- _tolerance: number = Number.EPSILON
Returns boolean
- Defined in Source/Core/Math/Rectangle.ts:138

getIntersection

getIntersection(_rect: Rectangle, _out?: Rectangle): Rectangle
Returns the rectangle created by the intersection of this and the given rectangle or null, if they don't collide.
Parameters
- _rect: Rectangle
- _out: Rectangle = ...
  Optional rectangle to store the result in.
Returns Rectangle
- Defined in Source/Core/Math/Rectangle.ts:229

getMetaAttributeTypes

getMetaAttributeTypes(): MetaAttributeTypes
Retrieves the specified attribute types from the metadata of this instance's class.

Returns MetaAttributeTypes
Inherited from Mutable.getMetaAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:289

getMetadata

getMetadata(): Metadata
Retrieves the metadata of this instance's class.

Returns Metadata
Inherited from Mutable.getMetadata
- Defined in Source/Core/Serialization/Mutable.ts:296

getMutator

getMutator(_extendable?: boolean): Mutator
Collect applicable attributes of the instance and copies of their values in a Mutator-object. By default, a mutator cannot be extended, since extensions are not available in the object the mutator belongs to. A mutator may be reduced by the descendants of Mutable to contain only the properties needed.
Parameters
- _extendable: boolean = false
Returns Mutator
Inherited from Mutable.getMutator
- Defined in Source/Core/Serialization/Mutable.ts:202

getMutatorAttributeTypes

getMutatorAttributeTypes(_mutator: Mutator): MutatorAttributeTypes
Returns an associative array with the same attributes as the given mutator, but with the corresponding types as string-values. Does not recurse into objects! This will return the decorated meta-type instead of the runtime-type of the object, if available.
Parameters
- _mutator: Mutator
Returns MutatorAttributeTypes
Inherited from Mutable.getMutatorAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:260

getMutatorForAnimation

getMutatorForAnimation(_extendable?: boolean): MutatorForAnimation
Collect the attributes of the instance and their values applicable for animation. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance
Parameters
- _extendable: boolean = false
Returns MutatorForAnimation
Inherited from Mutable.getMutatorForAnimation
- Defined in Source/Core/Serialization/Mutable.ts:237

getMutatorForUserInterface

getMutatorForUserInterface(_extendable?: boolean): MutatorForUserInterface
Collect the attributes of the instance and their values applicable for the user interface. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance
Parameters
- _extendable: boolean = false
Returns MutatorForUserInterface
Inherited from Mutable.getMutatorForUserInterface
- Defined in Source/Core/Serialization/Mutable.ts:245

isInside

isInside(_point: Vector2): boolean
Returns true if the given point is inside of this rectangle or on the border.
Parameters
- _point: Vector2
Returns boolean
- Defined in Source/Core/Math/Rectangle.ts:199

mutate

mutate(
    _mutator: Mutator,
    _selection?: string[],
    _dispatchMutate?: boolean,
): void | Promise<void>
Updates the attribute values of the instance according to the state of the mutator. The mutation may be restricted to a subset of the mutator and the event dispatching suppressed. Uses mutateBase, but can be overwritten in subclasses
Parameters
- _mutator: Mutator
- Optional_selection: string[]
- Optional_dispatchMutate: boolean
Returns void | Promise<void>
Inherited from Mutable.mutate
- Defined in Source/Core/Serialization/Mutable.ts:319

pointToRect

pointToRect(_point: Vector2, _target: Rectangle, _out?: Vector2): Vector2
Transforms the given point from this rectangles space to the target rectangles space.
Parameters
- _point: Vector2
- _target: Rectangle
- _out: Vector2 = ...
  Optional vector to store the result in.
Returns Vector2
- Defined in Source/Core/Math/Rectangle.ts:187

recycle

recycle(): void
Recycles the object for the next reuse by setting its properties to their default states.

Returns void
Implementation of Recycable.recycle
- Defined in Source/Core/Math/Rectangle.ts:131

removeEventListener

removeEventListener(
    _type: string,
    _handler: EventListenerUnified,
    _options?: boolean | AddEventListenerOptions,
): void
See EventTarget.removeEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional_options: boolean | AddEventListenerOptions
Returns void
Inherited from Mutable.removeEventListener
- Defined in Source/Core/Event/Event.ts:98

set

set(
    _x?: number,
    _y?: number,
    _width?: number,
    _height?: number,
    _origin?: ORIGIN2D,
): Rectangle
Sets the position and size of the rectangle according to the given parameters.
Parameters
- _x: number = 0
- _y: number = 0
- _width: number = 1
- _height: number = 1
- _origin: ORIGIN2D = ORIGIN2D.TOPLEFT
  The origin of the rectangle. The default is ORIGIN2D.TOPLEFT.
Returns Rectangle
A reference to this rectangle.
- Defined in Source/Core/Math/Rectangle.ts:168

setPositionAndSize

setPositionAndSize(
    _x?: number,
    _y?: number,
    _width?: number,
    _height?: number,
    _origin?: ORIGIN2D,
): Rectangle
Sets the position and size of the rectangle according to the given parameters.
Parameters
- _x: number = 0
- _y: number = 0
- _width: number = 1
- _height: number = 1
- _origin: ORIGIN2D = ORIGIN2D.TOPLEFT
  The origin of the rectangle. The default is ORIGIN2D.TOPLEFT.
Returns Rectangle
A reference to this rectangle.

Deprecated
Use set instead.
- Defined in Source/Core/Math/Rectangle.ts:159

toString

toString(): string
Creates a string representation of this rectangle.

Returns string
- Defined in Source/Core/Math/Rectangle.ts:244

updateMutator

updateMutator(_mutator: Mutator): void
Updates the values of the given mutator according to the current state of the instance
Parameters
- _mutator: Mutator
Returns void
Inherited from Mutable.updateMutator
- Defined in Source/Core/Serialization/Mutable.ts:304

`Static`GET

GET(
    _x?: number,
    _y?: number,
    _width?: number,
    _height?: number,
    _origin?: ORIGIN2D,
    _out?: Rectangle,
): Rectangle
Returns a new rectangle created with the given parameters.
Parameters
- _x: number = 0
- _y: number = 0
- _width: number = 1
- _height: number = 1
- _origin: ORIGIN2D = ORIGIN2D.TOPLEFT
- _out: Rectangle = ...
  Optional rectangle to store the result in.
Returns Rectangle
- Defined in Source/Core/Math/Rectangle.ts:37

`Static`getMutatorFromPath

getMutatorFromPath(_mutator: Mutator, _path: string[]): Mutator
Decorator allows to attach Mutable functionality to existing classes.
Parameters
- _mutator: Mutator
- _path: string[]
Returns Mutator
Inherited from Mutable.getMutatorFromPath
- Defined in Source/Core/Serialization/Mutable.ts:178

Class Rectangle

Author

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Rectangle

Properties

position

size

Accessors

bottom

Returns number

Parameters

Returns void

clone

Returns Rectangle

height

Returns number

Parameters

Returns void

left

Returns number

Parameters

Returns void

right

Returns number

Parameters

Returns void

top

Returns number

Parameters

Returns void

type

Returns string

width

Returns number

Parameters

Returns void

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

Methods

addEventListener

Parameters

Returns void

animate

Parameters

Returns void

collides

Parameters

Returns boolean

copy

Parameters

Returns Rectangle

covers

Parameters

Returns boolean

dispatchEvent

Parameters

Returns boolean

equals

Parameters

Returns boolean

getIntersection

Parameters

Returns Rectangle

getMetaAttributeTypes

Returns MetaAttributeTypes

`Static`GET

`Static`getMutatorFromPath