Scrawl-canvas API
    Preparing search index...

    Interface VectorFactoryFunctions

    interface VectorFactoryFunctions {
        getMagnitude: () => number;
        getXYCoordinate: () => [number, number];
        getXYZCoordinate: () => [number, number, number];
        normalize: () => VectorInstance;
        reverse: () => VectorInstance;
        rotate: (angle: number) => VectorInstance;
        scalarDivide: (item: number) => VectorInstance;
        scalarMultiply: (item: number) => VectorInstance;
        set: (
            x:
                | number
                | CoordinateInstance
                | VectorInstance
                | CommonHereObjectInput
                | number[],
            y?: number,
            z?: number,
        ) => VectorInstance;
        setFromArray: (args: CoordinateInstance | number[]) => VectorInstance;
        setFromVector: (
            item: VectorInstance | CommonHereObjectInput,
        ) => VectorInstance;
        setX: (x: number) => VectorInstance;
        setXY: (x: number, y: number) => VectorInstance;
        setY: (y: number) => VectorInstance;
        setZ: (z: number) => VectorInstance;
        vectorAdd: (
            item:
                | CoordinateInstance
                | VectorInstance
                | CommonHereObjectInput
                | number[],
        ) => VectorInstance;
        vectorAddArray: (item: CoordinateInstance | number[]) => VectorInstance;
        vectorMultiply: (
            item:
                | CoordinateInstance
                | VectorInstance
                | CommonHereObjectInput
                | number[],
        ) => VectorInstance;
        vectorMultiplyArray: (
            item: CoordinateInstance | number[],
        ) => VectorInstance;
        vectorSubtract: (
            item:
                | CoordinateInstance
                | VectorInstance
                | CommonHereObjectInput
                | number[],
        ) => VectorInstance;
        vectorSubtractArray: (
            item: CoordinateInstance | number[],
        ) => VectorInstance;
        zero: () => VectorInstance;
    }

    Hierarchy (View Summary)

    Index

    Properties

    getMagnitude: () => number
    getXYCoordinate: () => [number, number]
    getXYZCoordinate: () => [number, number, number]
    normalize: () => VectorInstance
    reverse: () => VectorInstance
    rotate: (angle: number) => VectorInstance
    scalarDivide: (item: number) => VectorInstance
    scalarMultiply: (item: number) => VectorInstance
    set: (
        x:
            | number
            | CoordinateInstance
            | VectorInstance
            | CommonHereObjectInput
            | number[],
        y?: number,
        z?: number,
    ) => VectorInstance
    setFromArray: (args: CoordinateInstance | number[]) => VectorInstance
    setX: (x: number) => VectorInstance
    setXY: (x: number, y: number) => VectorInstance
    setY: (y: number) => VectorInstance
    setZ: (z: number) => VectorInstance
    vectorAdd: (
        item:
            | CoordinateInstance
            | VectorInstance
            | CommonHereObjectInput
            | number[],
    ) => VectorInstance
    vectorAddArray: (item: CoordinateInstance | number[]) => VectorInstance
    vectorMultiply: (
        item:
            | CoordinateInstance
            | VectorInstance
            | CommonHereObjectInput
            | number[],
    ) => VectorInstance
    vectorMultiplyArray: (item: CoordinateInstance | number[]) => VectorInstance
    vectorSubtract: (
        item:
            | CoordinateInstance
            | VectorInstance
            | CommonHereObjectInput
            | number[],
    ) => VectorInstance
    vectorSubtractArray: (item: CoordinateInstance | number[]) => VectorInstance
    zero: () => VectorInstance