Class CoordinateRatioMapper

Utility class for mapping coordinates between a ratio and a coordinate system.

Since

2.0.0

Index

Constructors

constructor

new CoordinateRatioMapper(): CoordinateRatioMapper
Constructor for the CoordinateRatioMapper class. The default coordinate system will have a width and height of Context.MIN_RESOLUTION, and the coordinate system will not be in WebGL mode.

Returns CoordinateRatioMapper
Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:64
new CoordinateRatioMapper(
    width: number,
    height: number,
    isWebGL: boolean,
): CoordinateRatioMapper
Constructor for the CoordinateRatioMapper class.
Parameters
- width: number
  {number} - The width of the coordinate system. Minimum value is Context.MIN_RESOLUTION.
- height: number
  {number} - The height of the coordinate system. Minimum value is Context.MIN_RESOLUTION.
- isWebGL: boolean
  {boolean} - Is the coordinate system in WebGL mode?
Returns CoordinateRatioMapper
Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:74

Accessors

center

get center(): Vector
Returns Vector
The center of the coordinate system.

Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:96

centerX

get centerX(): number
Returns number
The center x-axis value of the coordinate system.

Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:105

centerY

get centerY(): number
Returns number
The center y-axis value of the coordinate system.

Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:114

height

get height(): number
Returns number
The height of the coordinate system.

Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:218
set height(height: number): void
Set the height of the coordinate system.
Parameters
- height: number
  {number} - The height of the coordinate system. Minimum value is Context.MIN_RESOLUTION.
Returns void
Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:229

isWebGL

get isWebGL(): boolean
Is the coordinate system in WebGL mode?

Returns boolean
true if the coordinate system is in WebGL mode, false otherwise.

Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:125

maxX

get maxX(): number
Returns number
The maximum visible x-axis value.

Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:149

maxY

get maxY(): number
Returns number
The maximum visible y-axis value.

Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:179

minX

get minX(): number
Returns number
The minimum visible x-axis value.

Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:134

minY

get minY(): number
Returns number
The minimum visible y-axis value.

Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:164

width

get width(): number
Returns number
The width of the coordinate system.

Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:194
set width(width: number): void
Set the width of the coordinate system.
Parameters
- width: number
  {number} - The width of the coordinate system. Minimum value is Context.MIN_RESOLUTION.
Returns void
Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:205

Methods

mapCoordinateToRatio

mapCoordinateToRatio(coordinateVector: Vector): Vector
Map a coordinate vector to percentage values relative to the minimum and maximum x-axis and y-axis values.
Parameters
- coordinateVector: Vector
  {p5.Vector} - The coordinate vector.
Returns Vector
The percentage vector.

Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:293

mapCoordinateToRatioX

mapCoordinateToRatioX(coordinateX: number): number
Map a coordinate value on the x-axis to a percentage value relative to the minimum and maximum x-axis values.
Parameters
- coordinateX: number
  {number} - The coordinate value on the x-axis.
Returns number
The percentage value on the x-axis.

Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:308

mapCoordinateToRatioY

mapCoordinateToRatioY(coordinateY: number): number
Map a coordinate value on the y-axis to a percentage value relative to the minimum and maximum y-axis values.
Parameters
- coordinateY: number
  {number} - The coordinate value on the y-axis.
Returns number
The percentage value on the y-axis.

Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:321

mapRatioToCoordinate

mapRatioToCoordinate(ratioVector: Vector): Vector
Map a percentage vector to values on the x-axis and y-axis. A percentage value of 0.5 will be exactly in the middle of the respective axis, regardless of context resolution or aspect ratio.
Parameters
- ratioVector: Vector
  {p5.Vector} - The percentage vector expressed as decimal numbers (e.g. 50% = 0.5)
Returns Vector
The coordinate vector.

Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:248

mapRatioToCoordinateX

mapRatioToCoordinateX(ratioX: number): number
Map a percentage value to a value on the x-axis. A percentage value of 0.5 will be exactly in the middle of the x-axis, regardless of context resolution or aspect ratio.
Parameters
- ratioX: number
  {number} - The percentage expressed as a decimal number (e.g. 50% = 0.5)
Returns number
The coordinate value on the x-axis.

Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:265

mapRatioToCoordinateY

mapRatioToCoordinateY(ratioY: number): number
Map a percentage value to a value on the y-axis. A percentage value of 0.5 will be exactly in the middle of the y-axis, regardless of context resolution or aspect ratio.
Parameters
- ratioY: number
  {number} - The percentage expressed as a decimal number (e.g. 50% = 0.5)
Returns number
The coordinate value on the y-axis.

Since
2.0.0
- Defined in sketch/coordinate/coordinate-ratio-mapper.ts:280

Class CoordinateRatioMapper

Since

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns CoordinateRatioMapper

Since

Parameters

Returns CoordinateRatioMapper

Since

Accessors

center

Returns Vector

Since

centerX

Returns number

Since

centerY

Returns number

Since

height

Returns number

Since

Parameters

Returns void

Since

isWebGL

Returns boolean

Since

maxX

Returns number

Since

maxY

Returns number

Since

minX

Returns number

Since

minY

Returns number

Since

width

Returns number

Since

Parameters

Returns void

Since

Methods

mapCoordinateToRatio

Parameters

Returns Vector

Since

mapCoordinateToRatioX

Parameters

Returns number

Since

mapCoordinateToRatioY

Parameters

Returns number

Since

mapRatioToCoordinate

Parameters

Returns Vector

Since

mapRatioToCoordinateX

Parameters

Returns number

Since

mapRatioToCoordinateY

Parameters

Returns number

Since

Settings

On This Page