Class DimensionsFloat

Lightweight DimensionsFloat value type.

Index

Constructors

Properties

Methods

clampToDims clone duplicate equals equalsApprox format gt isZero lt normalize normalizeAndScale round scale scaleBy sub toBool toInt toJSON toString fromDimensions

Constructors

constructor

new DimensionsFloat(width?: number, height?: number): DimensionsFloat
Parameters
- width: number = 0
- height: number = 0
Returns DimensionsFloat
- Defined in src/types.ts:123

Properties

height

height: number

width

width: number

Methods

clampToDims

clampToDims(
clampDims: DimensionsFloat,
): { delta: PointFloat; result: DimensionsFloat }
clampToDims
Parameters
- clampDims: DimensionsFloat
Returns { delta: PointFloat; result: DimensionsFloat }
- Defined in src/types.ts:214

clone

clone(): DimensionsFloat
Create a shallow copy.

Returns DimensionsFloat
- Defined in src/types.ts:144

duplicate

duplicate(): DimensionsFloat
duplicate

Returns DimensionsFloat
- Defined in src/types.ts:231

equals

equals(other: DimensionsFloat): boolean
Value equality.
Parameters
- other: DimensionsFloat
Returns boolean
- Defined in src/types.ts:129

equalsApprox

equalsApprox(other: DimensionsInt): boolean
Cross-type equality with DimensionsInt.
Parameters
- other: DimensionsInt
Returns boolean
- Defined in src/types.ts:137

format

format(): string
format

Returns string
- Defined in src/types.ts:236

gt

gt(other: DimensionsFloat): boolean
Operator: gt
Parameters
- other: DimensionsFloat
Returns boolean
- Defined in src/types.ts:278

isZero

isZero(): boolean
isZero

Returns boolean
- Defined in src/types.ts:158

lt

lt(other: DimensionsFloat): boolean
Operator: lt
Parameters
- other: DimensionsFloat
Returns boolean
- Defined in src/types.ts:267

normalize

normalize(squeeze: number): DimensionsFloat
normalize
Parameters
- squeeze: number
Returns DimensionsFloat
- Defined in src/types.ts:166

normalizeAndScale

normalizeAndScale(
    inputSqueeze: number,
    scaleFactor: number,
    targetSqueeze: number,
): DimensionsFloat
normalizeAndScale
Parameters
- inputSqueeze: number
- scaleFactor: number
- targetSqueeze: number
Returns DimensionsFloat
- Defined in src/types.ts:187

round

round(even: RoundingEven, mode: RoundingMode): DimensionsFloat
round
Parameters
- even: RoundingEven
- mode: RoundingMode
Returns DimensionsFloat
- Defined in src/types.ts:203

scale

scale(scaleFactor: number, targetSqueeze: number): DimensionsFloat
scale
Parameters
- scaleFactor: number
- targetSqueeze: number
Returns DimensionsFloat
- Defined in src/types.ts:176

scaleBy

scaleBy(factor: number): void
scaleBy
Parameters
- factor: number
Returns void
- Defined in src/types.ts:251

sub

sub(other: DimensionsFloat): DimensionsFloat
Operator: sub
Parameters
- other: DimensionsFloat
Returns DimensionsFloat
- Defined in src/types.ts:257

toBool

toBool(): boolean
Operator: bool

Returns boolean
- Defined in src/types.ts:289

toInt

toInt(): DimensionsInt
toInt

Returns DimensionsInt
- Defined in src/types.ts:241

toJSON

toJSON(): Record<string, unknown>
Convert to plain object.

Returns Record<string, unknown>
- Defined in src/types.ts:153

toString

toString(): string
Returns string
- Defined in src/types.ts:148

`Static`fromDimensions

fromDimensions(dims: DimensionsFloat): DimensionsFloat
fromDimensions
Parameters
- dims: DimensionsFloat
Returns DimensionsFloat
- Defined in src/types.ts:246