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

587 lines (251 loc) • 6.01 kB

Markdown

[Home](./index.md) > [rc-js-util](./rc-js-util.md) > [Vec3](./rc-js-util.vec3.md) ## Vec3 class Vector 3. **Signature:** ```typescript export declare abstract class Vec3<TArray extends TTypedArray> extends ATypedArrayTuple<3, TArray> ``` **Extends:** [ATypedArrayTuple](./rc-js-util.atypedarraytuple.md)<3, 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.vec3._0_.md) </td><td> </td><td> number </td><td> x </td></tr> <tr><td> ["1"](./rc-js-util.vec3._1_.md) </td><td> </td><td> number </td><td> y </td></tr> <tr><td> ["2"](./rc-js-util.vec3._2_.md) </td><td> </td><td> number </td><td> z </td></tr> <tr><td> [constructor](./rc-js-util.vec3.constructor.md) </td><td> </td><td> [IVec3Ctor](./rc-js-util.ivec3ctor.md)<TArray> </td><td> </td></tr> <tr><td> [constructors](./rc-js-util.vec3.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.vec3.f32.md) </td><td> `static` </td><td> [IVec3Ctor](./rc-js-util.ivec3ctor.md)<Float32Array> </td><td> </td></tr> <tr><td> [f64](./rc-js-util.vec3.f64.md) </td><td> `static` </td><td> [IVec3Ctor](./rc-js-util.ivec3ctor.md)<Float64Array> </td><td> </td></tr> <tr><td> [i16](./rc-js-util.vec3.i16.md) </td><td> `static` </td><td> [IVec3Ctor](./rc-js-util.ivec3ctor.md)<Int16Array> </td><td> </td></tr> <tr><td> [i32](./rc-js-util.vec3.i32.md) </td><td> `static` </td><td> [IVec3Ctor](./rc-js-util.ivec3ctor.md)<Int32Array> </td><td> </td></tr> <tr><td> [i64](./rc-js-util.vec3.i64.md) </td><td> `static` </td><td> null </td><td> </td></tr> <tr><td> [i8](./rc-js-util.vec3.i8.md) </td><td> `static` </td><td> [IVec3Ctor](./rc-js-util.ivec3ctor.md)<Int8Array> </td><td> </td></tr> <tr><td> [TTypeGuardVec3](./rc-js-util.vec3.ttypeguardvec3.md) </td><td> </td><td> true </td><td> </td></tr> <tr><td> [u16](./rc-js-util.vec3.u16.md) </td><td> `static` </td><td> [IVec3Ctor](./rc-js-util.ivec3ctor.md)<Uint16Array> </td><td> </td></tr> <tr><td> [u32](./rc-js-util.vec3.u32.md) </td><td> `static` </td><td> [IVec3Ctor](./rc-js-util.ivec3ctor.md)<Uint32Array> </td><td> </td></tr> <tr><td> [u64](./rc-js-util.vec3.u64.md) </td><td> `static` </td><td> null </td><td> </td></tr> <tr><td> [u8](./rc-js-util.vec3.u8.md) </td><td> `static` </td><td> [IVec3Ctor](./rc-js-util.ivec3ctor.md)<Uint8Array> </td><td> </td></tr> <tr><td> [u8c](./rc-js-util.vec3.u8c.md) </td><td> `static` </td><td> [IVec3Ctor](./rc-js-util.ivec3ctor.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> [castToBaseType()](./rc-js-util.vec3.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.vec3.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.vec3.copytobuffer.md) </td><td> </td><td> If endianness is not supplied the platform's endianness will be used. </td></tr> <tr><td> [dotProduct(\_vec)](./rc-js-util.vec3.dotproduct.md) </td><td> </td><td> </td></tr> <tr><td> [getCtor(ctor)](./rc-js-util.vec3.getctor.md) </td><td> `static` </td><td> </td></tr> <tr><td> [getLoggableValue()](./rc-js-util.vec3.getloggablevalue.md) </td><td> </td><td> </td></tr> <tr><td> [getMagnitude()](./rc-js-util.vec3.getmagnitude.md) </td><td> </td><td> </td></tr> <tr><td> [getMagnitudeSquared()](./rc-js-util.vec3.getmagnitudesquared.md) </td><td> </td><td> </td></tr> <tr><td> [getX()](./rc-js-util.vec3.getx.md) </td><td> </td><td> </td></tr> <tr><td> [getY()](./rc-js-util.vec3.gety.md) </td><td> </td><td> </td></tr> <tr><td> [getZ()](./rc-js-util.vec3.getz.md) </td><td> </td><td> </td></tr> <tr><td> [isEqualTo(\_other)](./rc-js-util.vec3.isequalto.md) </td><td> </td><td> Component-wise equals. </td></tr> <tr><td> [setX(\_x)](./rc-js-util.vec3.setx.md) </td><td> </td><td> </td></tr> <tr><td> [setY(\_y)](./rc-js-util.vec3.sety.md) </td><td> </td><td> </td></tr> <tr><td> [setZ(\_z)](./rc-js-util.vec3.setz.md) </td><td> </td><td> </td></tr> <tr><td> [update(\_x, \_y, \_z)](./rc-js-util.vec3.update.md) </td><td> </td><td> </td></tr> </tbody></table>