rc-js-util

Version:

A collection of TS and C++ utilities to help writing performant and correct applications, achieved through strict typing and (removable) invariant checking.

phuhgh.github.io/js-util/rc-js-util.html

phuhgh/js-util

560 lines (240 loc) • 6.37 kB

Markdown

[Home](./index.md) > [rc-js-util](./rc-js-util.md) > [Range1d](./rc-js-util.range1d.md) ## Range1d class Vec2 representing a 1d range. **Signature:** ```typescript export declare abstract class Range1d<TArray extends TTypedArray> extends Vec2<TArray> ``` **Extends:** [Vec2](./rc-js-util.vec2.md)<TArray> ## Remarks See static properties for constructors. Instances are not an extension of this class, but of the static members. ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td> ["0"](./rc-js-util.range1d._0_.md) </td><td> </td><td> number </td><td> min </td></tr> <tr><td> ["1"](./rc-js-util.range1d._1_.md) </td><td> </td><td> number </td><td> max </td></tr> <tr><td> [constructor](./rc-js-util.range1d.constructor.md) </td><td> </td><td> [IRange1dCtor](./rc-js-util.irange1dctor.md)<TArray> </td><td> </td></tr> <tr><td> [constructors](./rc-js-util.range1d.constructors.md) </td><td> `protected` `static` </td><td> Map<import("../../t-typed-array-ctor.js").[TFullSetTypedArrayCtor](./rc-js-util.tfullsettypedarrayctor.md), Function> </td><td> </td></tr> <tr><td> [f32](./rc-js-util.range1d.f32.md) </td><td> `static` </td><td> [IRange1dCtor](./rc-js-util.irange1dctor.md)<Float32Array> </td><td> </td></tr> <tr><td> [f64](./rc-js-util.range1d.f64.md) </td><td> `static` </td><td> [IRange1dCtor](./rc-js-util.irange1dctor.md)<Float64Array> </td><td> </td></tr> <tr><td> [i16](./rc-js-util.range1d.i16.md) </td><td> `static` </td><td> [IRange1dCtor](./rc-js-util.irange1dctor.md)<Int16Array> </td><td> </td></tr> <tr><td> [i32](./rc-js-util.range1d.i32.md) </td><td> `static` </td><td> [IRange1dCtor](./rc-js-util.irange1dctor.md)<Int32Array> </td><td> </td></tr> <tr><td> [i8](./rc-js-util.range1d.i8.md) </td><td> `static` </td><td> [IRange1dCtor](./rc-js-util.irange1dctor.md)<Int8Array> </td><td> </td></tr> <tr><td> [TTypeGuardRange1d](./rc-js-util.range1d.ttypeguardrange1d.md) </td><td> </td><td> true </td><td> </td></tr> <tr><td> [u16](./rc-js-util.range1d.u16.md) </td><td> `static` </td><td> [IRange1dCtor](./rc-js-util.irange1dctor.md)<Uint16Array> </td><td> </td></tr> <tr><td> [u32](./rc-js-util.range1d.u32.md) </td><td> `static` </td><td> [IRange1dCtor](./rc-js-util.irange1dctor.md)<Uint32Array> </td><td> </td></tr> <tr><td> [u8](./rc-js-util.range1d.u8.md) </td><td> `static` </td><td> [IRange1dCtor](./rc-js-util.irange1dctor.md)<Uint8Array> </td><td> </td></tr> <tr><td> [u8c](./rc-js-util.range1d.u8c.md) </td><td> `static` </td><td> [IRange1dCtor](./rc-js-util.irange1dctor.md)<Uint8ClampedArray> </td><td> </td></tr> </tbody></table> ## Methods <table><thead><tr><th> Method </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td> [bound1d(\_boundTo)](./rc-js-util.range1d.bound1d.md) </td><td> </td><td> Bound this range to the argument. </td></tr> <tr><td> [castToBaseType()](./rc-js-util.range1d.casttobasetype.md) </td><td> </td><td> Although the typed array tuples extend a typed array, they are not structurally compatible. This function returns the argument passed without modification but cast as the underlying storage type, e.g. Float32Array. </td></tr> <tr><td> [copyFromBuffer(\_memoryDataView, \_pointer, \_littleEndian)](./rc-js-util.range1d.copyfrombuffer.md) </td><td> </td><td> If endianness is not supplied the platform's endianness will be used. </td></tr> <tr><td> [copyToBuffer(\_memoryDataView, \_pointer, \_littleEndian)](./rc-js-util.range1d.copytobuffer.md) </td><td> </td><td> If endianness is not supplied the platform's endianness will be used. </td></tr> <tr><td> [extendRange(\_value, \_writeTo)](./rc-js-util.range1d.extendrange.md) </td><td> </td><td> </td></tr> <tr><td> [getCenter()](./rc-js-util.range1d.getcenter.md) </td><td> </td><td> </td></tr> <tr><td> [getCtor(ctor)](./rc-js-util.range1d.getctor.md) </td><td> `static` </td><td> </td></tr> <tr><td> [getMax()](./rc-js-util.range1d.getmax.md) </td><td> </td><td> </td></tr> <tr><td> [getMin()](./rc-js-util.range1d.getmin.md) </td><td> </td><td> </td></tr> <tr><td> [getRange()](./rc-js-util.range1d.getrange.md) </td><td> </td><td> </td></tr> <tr><td> [getRangeTransform(\_toRange, \_result)](./rc-js-util.range1d.getrangetransform.md) </td><td> </td><td> Creates a transform matrix that maps values in this range onto `_toRange`. </td></tr> <tr><td> [isValueInRange1d(\_value)](./rc-js-util.range1d.isvalueinrange1d.md) </td><td> </td><td> </td></tr> <tr><td> [mat2Multiply(\_mat, \_writeTo)](./rc-js-util.range1d.mat2multiply.md) </td><td> </td><td> </td></tr> <tr><td> [scaleRelativeTo(\_scalingFactor, \_relativeTo, \_result)](./rc-js-util.range1d.scalerelativeto.md) </td><td> </td><td> Scales the range relative to a point (may not be outside of the range). </td></tr> <tr><td> [setMax(\_value)](./rc-js-util.range1d.setmax.md) </td><td> </td><td> </td></tr> <tr><td> [setMin(\_value)](./rc-js-util.range1d.setmin.md) </td><td> </td><td> </td></tr> <tr><td> [translate1d(\_dv)](./rc-js-util.range1d.translate1d.md) </td><td> </td><td> Shifts the range by dv. </td></tr> <tr><td> [unionRange(\_range, \_writeTo)](./rc-js-util.range1d.unionrange.md) </td><td> </td><td> </td></tr> </tbody></table>