Class TextMetrics

a Text Metrics object that contains helper for text manipulation

Hierarchy (View Summary)

Bounds
- TextMetrics

Index

Constructors

constructor

new TextMetrics(ancestor: any): TextMetrics
Parameters
- ancestor: any
  the parent object that contains this TextMetrics object
Returns TextMetrics
Overrides Bounds.constructor
- Defined in packages/melonjs/src/renderable/text/textmetrics.js:12

Properties

_center

_center: Vector2d

ancestor

ancestor: Renderable

a reference to the parent object that contains this TextMetrics object

Default

undefined

max

max: XYPoint

min

min: XYPoint

type

type: "Bounds"

Accessors

bottom

get bottom(): number
Gets the bottom coordinate of the bounds.

Returns number
The bottom coordinate.
Inherited from Bounds.bottom
- Defined in packages/melonjs/src/physics/bounds.ts:150

center

get center(): Vector2d
Gets the center position of the bounds.

Returns Vector2d
The center position as a Vector2d.
Inherited from Bounds.center
- Defined in packages/melonjs/src/physics/bounds.ts:174

centerX

get centerX(): number
Gets the center position of the bounds on the x axis.

Returns number
The center x coordinate.
Inherited from Bounds.centerX
- Defined in packages/melonjs/src/physics/bounds.ts:158

centerY

get centerY(): number
Gets the center position of the bounds on the y axis.

Returns number
The center y coordinate.
Inherited from Bounds.centerY
- Defined in packages/melonjs/src/physics/bounds.ts:166

height

get height(): number
Gets the height of the bounds.

Returns number
The height.
Inherited from Bounds.height
- Defined in packages/melonjs/src/physics/bounds.ts:110
set height(value: number): void
Sets the height of the bounds.
Parameters
- value: number
  The new height.
Returns void
Inherited from Bounds.height
- Defined in packages/melonjs/src/physics/bounds.ts:118

left

get left(): number
Gets the left coordinate of the bounds.

Returns number
The left coordinate.
Inherited from Bounds.left
- Defined in packages/melonjs/src/physics/bounds.ts:126

right

get right(): number
Gets the right coordinate of the bounds.

Returns number
The right coordinate.
Inherited from Bounds.right
- Defined in packages/melonjs/src/physics/bounds.ts:134

top

get top(): number
Gets the top coordinate of the bounds.

Returns number
The top coordinate.
Inherited from Bounds.top
- Defined in packages/melonjs/src/physics/bounds.ts:142

width

get width(): number
Gets the width of the bounds.

Returns number
The width.
Inherited from Bounds.width
- Defined in packages/melonjs/src/physics/bounds.ts:94
set width(value: number): void
Sets the width of the bounds.
Parameters
- value: number
  The new width.
Returns void
Inherited from Bounds.width
- Defined in packages/melonjs/src/physics/bounds.ts:102

x

get x(): number
Gets the x position of the bounds.

Returns number
The x position.
Inherited from Bounds.x
- Defined in packages/melonjs/src/physics/bounds.ts:57
set x(value: number): void
Sets the x position of the bounds.
Parameters
- value: number
  The new x position.
Returns void
Inherited from Bounds.x
- Defined in packages/melonjs/src/physics/bounds.ts:65

y

get y(): number
Gets the y position of the bounds.

Returns number
The y position.
Inherited from Bounds.y
- Defined in packages/melonjs/src/physics/bounds.ts:75
set y(value: number): void
Sets the y position of the bounds.
Parameters
- value: number
  The new y position.
Returns void
Inherited from Bounds.y
- Defined in packages/melonjs/src/physics/bounds.ts:83

Methods

add

add(vertices: Vector2d[] | Point[] | XYPoint[], clear?: boolean): void
Adds the given vertices to the bounds definition.
Parameters
- vertices: Vector2d[] | Point[] | XYPoint[]
  An array of Vector2d or Point to add to the bounds.
- Optionalclear: boolean = false
  Whether to reset the bounds before adding the new vertices. Defaults to false.
Returns void
Inherited from Bounds.add
- Defined in packages/melonjs/src/physics/bounds.ts:202

addBounds

addBounds(bounds: Bounds, clear?: boolean): void
Adds the given bounds to the bounds definition.
Parameters
- bounds: Bounds
  The bounds to add.
- Optionalclear: boolean = false
  Whether to reset the bounds before adding the new bounds.
Returns void
Inherited from Bounds.addBounds
- Defined in packages/melonjs/src/physics/bounds.ts:227

addFrame

addFrame(x0: number, y0: number, x1: number, y1: number, m?: Matrix2d): void
Adds the given quad coordinates to this bounds definition, multiplied by the given matrix.
Parameters
- x0: number
  The left x coordinate of the quad.
- y0: number
  The top y coordinate of the quad.
- x1: number
  The right x coordinate of the quad.
- y1: number
  The bottom y coordinate of the quad.
- Optionalm: Matrix2d
  An optional transform to apply to the given coordinates.
Returns void
Inherited from Bounds.addFrame
- Defined in packages/melonjs/src/physics/bounds.ts:270

addPoint

addPoint(point: Vector2d | Point, m?: Matrix2d): void
Adds the given point to the bounds definition.
Parameters
- point: Vector2d | Point
  The point to add to the bounds.
- Optionalm: Matrix2d
  An optional transform to apply to the given point.
Returns void
Inherited from Bounds.addPoint
- Defined in packages/melonjs/src/physics/bounds.ts:254

centerOn

centerOn(x: number, y: number): TextMetrics
Centers the bounds position around the given coordinates.
Parameters
- x: number
  The x coordinate to center around.
- y: number
  The y coordinate to center around.
Returns TextMetrics
The current Bounds instance for method chaining.
Inherited from Bounds.centerOn
- Defined in packages/melonjs/src/physics/bounds.ts:184

clear

clear(): void
Resets the bounds to its initial state.

Returns void
Inherited from Bounds.clear
- Defined in packages/melonjs/src/physics/bounds.ts:34

clone

clone(): Bounds
Creates a clone of this bounds.

Returns Bounds
A new Bounds object that is a copy of this bounds.
Inherited from Bounds.clone
- Defined in packages/melonjs/src/physics/bounds.ts:397

contains

contains(x: number, y?: number): boolean
Returns true if the bounds contain the given point or vector.
Parameters
- x: number
- Optionaly: number
  The y coordinate if the first parameter is a number.
Returns boolean
True if the bounds contain the point or vector, otherwise false.
Inherited from Bounds.contains
- Defined in packages/melonjs/src/physics/bounds.ts:287
contains(vector: Vector2d | Bounds): boolean
Returns true if the bounds contain the given point or vector.
Parameters
- vector: Vector2d | Bounds
Returns boolean
True if the bounds contain the point or vector, otherwise false.
Inherited from Bounds.contains
- Defined in packages/melonjs/src/physics/bounds.ts:288

isFinite

isFinite(): boolean
Determines whether all coordinates of this bounds are finite numbers.

Returns boolean
False if any coordinates are positive or negative Infinity or NaN; otherwise, true.
Inherited from Bounds.isFinite
- Defined in packages/melonjs/src/physics/bounds.ts:333

lineHeight

lineHeight(): number
Returns the height of a segment of inline text in CSS pixels.

Returns number
the height of a segment of inline text in CSS pixels.
- Defined in packages/melonjs/src/renderable/text/textmetrics.js:30

lineWidth

lineWidth(text: string, context?: CanvasRenderingContext2D): number
Returns the width of the given segment of inline text in CSS pixels.
Parameters
- text: string
  the text to be measured
- Optionalcontext: CanvasRenderingContext2D
  reference to an active 2d context for canvas rendering
Returns number
the width of the given segment of inline text in CSS pixels.
- Defined in packages/melonjs/src/renderable/text/textmetrics.js:49

measureText

measureText(text: string, context?: CanvasRenderingContext2D): TextMetrics
measure the given text size in CSS pixels
Parameters
- text: string
  the text to be measured
- Optionalcontext: CanvasRenderingContext2D
  reference to an active 2d context for canvas rendering
Returns TextMetrics
this
- Defined in packages/melonjs/src/renderable/text/textmetrics.js:78

overlaps

overlaps(bounds: Bounds): boolean
Returns true if the two bounds intersect.
Parameters
- bounds: Bounds
  The bounds to check for intersection.
Returns boolean
True if the bounds overlap, otherwise false.
Inherited from Bounds.overlaps
- Defined in packages/melonjs/src/physics/bounds.ts:320

setMinMax

setMinMax(minX: number, minY: number, maxX: number, maxY: number): void
Sets the bounds to the given minimum and maximum values.
Parameters
- minX: number
  The minimum x value.
- minY: number
  The minimum y value.
- maxX: number
  The maximum x value.
- maxY: number
  The maximum y value.
Returns void
Inherited from Bounds.setMinMax
- Defined in packages/melonjs/src/physics/bounds.ts:45

shift

shift(x: number, y?: number): void
Shifts the bounds to the given x, y position or vector.
Parameters
- x: number
- Optionaly: number
  The y coordinate if the first parameter is a number.
Returns void
Inherited from Bounds.shift
- Defined in packages/melonjs/src/physics/bounds.ts:370
shift(vector: Vector2d): void
Shifts the bounds to the given x, y position or vector.
Parameters
- vector: Vector2d
Returns void
Inherited from Bounds.shift
- Defined in packages/melonjs/src/physics/bounds.ts:371

toPolygon

toPolygon(): Polygon
Returns a polygon whose edges are the same as this bounds.

Returns Polygon
A new Polygon that represents this bounds.
Inherited from Bounds.toPolygon
- Defined in packages/melonjs/src/physics/bounds.ts:407

translate

translate(x: number, y?: number): void
Translates the bounds by the given point or vector.
Parameters
- x: number
- Optionaly: number
  The y coordinate if the first parameter is a number.
Returns void
Inherited from Bounds.translate
- Defined in packages/melonjs/src/physics/bounds.ts:347
translate(vector: Vector2d): void
Translates the bounds by the given point or vector.
Parameters
- vector: Vector2d
Returns void
Inherited from Bounds.translate
- Defined in packages/melonjs/src/physics/bounds.ts:348

update

update(vertices: Vector2d[] | Point[] | XYPoint[]): void
Updates the bounds using the given vertices.
Parameters
- vertices: Vector2d[] | Point[] | XYPoint[]
  An array of Vector2d or Point to update the bounds.
Returns void
Inherited from Bounds.update
- Defined in packages/melonjs/src/physics/bounds.ts:193

wordWrap

wordWrap(
    text: string | string[],
    width: number,
    context?: CanvasRenderingContext2D,
): string[]
wrap the given text based on the given width
Parameters
- text: string | string[]
  the text to be wrapped
- width: number
  maximum width of one segment of text in css pixel
- Optionalcontext: CanvasRenderingContext2D
  reference to an active 2d context for canvas rendering
Returns string[]
an array of string representing wrapped text
- Defined in packages/melonjs/src/renderable/text/textmetrics.js:139

Class TextMetrics

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TextMetrics

Properties

_center

ancestor

Default

max

min

type

Accessors

bottom

Returns number

center

Returns Vector2d

centerX

Returns number

centerY

Returns number

height

Returns number

Parameters

Returns void

left

Returns number

right

Returns number

top

Returns number

width

Returns number

Parameters

Returns void

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

Methods

add

Parameters

Returns void

addBounds

Parameters

Returns void

addFrame

Parameters

Returns void

addPoint

Parameters

Returns void

centerOn

Parameters

Returns TextMetrics

clear

Returns void

clone

Returns Bounds

contains

Parameters

Returns boolean

Parameters

Returns boolean

isFinite

Returns boolean

lineHeight

Returns number

lineWidth

Parameters