Class Rectangle

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

Author

Jirka Dell'Oro-Friedl, HFU, 2019

Hierarchy (view full)

Mutable
- Rectangle

Implements

Recycable

Constructors

constructor

new Rectangle(_x?, _y?, _width?, _height?, _origin?): 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
Return the lowest expansion, respecting also negative values of height

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

clone

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

height

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

left

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

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

right

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

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

top

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

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

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:142

width

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

x

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

y

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

Methods

addEventListener

addEventListener(_type, _handler, _options?): 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

collides

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

copy

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

covers

covers(_rect): boolean
Returns the rectangle created by the intersection of this and the given rectangle or null, if they don't collide
Parameters
- _rect: Rectangle
Returns boolean
- Defined in Source/Core/Math/Rectangle.ts:198

dispatchEvent

dispatchEvent(_event): 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

getIntersection

getIntersection(_rect): Rectangle
Returns the rectangle created by the intersection of this and the given rectangle or null, if they don't collide
Parameters
- _rect: Rectangle
Returns Rectangle
- Defined in Source/Core/Math/Rectangle.ts:182

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:231

getMetadata

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

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

getMutator

getMutator(_extendable?): 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:150

getMutatorAttributeTypes

getMutatorAttributeTypes(_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:208

getMutatorForAnimation

getMutatorForAnimation(_extendable?): 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:185

getMutatorForUserInterface

getMutatorForUserInterface(_extendable?): 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:193

isInside

isInside(_point): 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:163

mutate

mutate(_mutator, _selection?, _dispatchMutate?): 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
- _selection: string[] = null
- _dispatchMutate: boolean = true
Returns Promise<void>
Inherited from Mutable.mutate
- Defined in Source/Core/Serialization/Mutable.ts:260

pointToRect

pointToRect(_point, _target): Vector2
Transforms the given point from this rectangles space to the target rectangles space
Parameters
- _point: Vector2
- _target: Rectangle
Returns Vector2
- Defined in Source/Core/Math/Rectangle.ts:150

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:119

removeEventListener

removeEventListener(_type, _handler, _options?): 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

setPositionAndSize

setPositionAndSize(_x?, _y?, _width?, _height?, _origin?): void
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
Returns void
- Defined in Source/Core/Math/Rectangle.ts:133

toString

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

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

updateMutator

updateMutator(_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:246

`Static` GET

GET(_x?, _y?, _width?, _height?, _origin?): 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
Returns Rectangle
- Defined in Source/Core/Math/Rectangle.ts:36

`Static` getMutatorFromPath

getMutatorFromPath(_mutator, _path): 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:127

Class Rectangle

Author

Hierarchy (view full)

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

collides

Parameters

Returns boolean

copy

Parameters

Returns void

covers

Parameters

Returns boolean

dispatchEvent

Parameters

Returns boolean

getIntersection

Parameters

Returns Rectangle

getMetaAttributeTypes

Returns MetaAttributeTypes

getMetadata

Returns Metadata

getMutator

Parameters

Returns Mutator

getMutatorAttributeTypes

`Static` GET

`Static` getMutatorFromPath