image-in-browser/lib/image/octree-node.d.ts

Package for encoding / decoding images, transforming images, applying filters, drawing primitives on images on the client side (no need for server Node.js)

/** @format */
/**
 * Represents a node in an octree structure.
 */
export declare class OctreeNode {
    /**
     * Sum of all red colors represented by this node.
     */
    private _r;
    /**
     * Gets the sum of all red colors.
     * @returns {number} The sum of all red colors.
     */
    get r(): number;
    /**
     * Sets the sum of all red colors.
     * @param {number} v - The sum of all red colors.
     */
    set r(v: number);
    /**
     * Sum of all green colors represented by this node.
     */
    private _g;
    /**
     * Gets the sum of all green colors.
     * @returns {number} The sum of all green colors.
     */
    get g(): number;
    /**
     * Sets the sum of all green colors.
     * @param {number} v - The sum of all green colors.
     */
    set g(v: number);
    /**
     * Sum of all blue colors represented by this node.
     */
    private _b;
    /**
     * Gets the sum of all blue colors.
     * @returns {number} The sum of all blue colors.
     */
    get b(): number;
    /**
     * Sets the sum of all blue colors.
     * @param {number} v - The sum of all blue colors.
     */
    set b(v: number);
    /**
     * Count of colors represented by this node.
     */
    private _count;
    /**
     * Gets the count of colors.
     * @returns {number} The count of colors.
     */
    get count(): number;
    /**
     * Sets the count of colors.
     * @param {number} v - The count of colors.
     */
    set count(v: number);
    /**
     * Index of this node in the heap.
     */
    private _heapIndex;
    /**
     * Gets the heap index.
     * @returns {number} The heap index.
     */
    get heapIndex(): number;
    /**
     * Sets the heap index.
     * @param {number} v - The heap index.
     */
    set heapIndex(v: number);
    /**
     * Index of this node in the palette.
     */
    private _paletteIndex;
    /**
     * Gets the palette index.
     * @returns {number} The palette index.
     */
    get paletteIndex(): number;
    /**
     * Sets the palette index.
     * @param {number} v - The palette index.
     */
    set paletteIndex(v: number);
    /**
     * Parent node of this node.
     */
    private _parent;
    /**
     * Gets the parent node.
     * @returns {OctreeNode | undefined} The parent node.
     */
    get parent(): OctreeNode | undefined;
    /**
     * Array of child nodes.
     */
    private _children;
    /**
     * Gets the array of child nodes.
     * @returns {Array<OctreeNode | undefined>} The array of child nodes.
     */
    get children(): Array<OctreeNode | undefined>;
    /**
     * Count of child nodes.
     */
    private _childCount;
    /**
     * Gets the count of child nodes.
     * @returns {number} The count of child nodes.
     */
    get childCount(): number;
    /**
     * Sets the count of child nodes.
     * @param {number} v - The count of child nodes.
     */
    set childCount(v: number);
    /**
     * Index of this node among its siblings.
     */
    private _childIndex;
    /**
     * Gets the child index.
     * @returns {number} The child index.
     */
    get childIndex(): number;
    /**
     * Flags associated with this node.
     */
    private _flags;
    /**
     * Gets the flags.
     * @returns {number} The flags.
     */
    get flags(): number;
    /**
     * Sets the flags.
     * @param {number} v - The flags.
     */
    set flags(v: number);
    /**
     * Depth of this node in the octree.
     */
    private _depth;
    /**
     * Gets the depth.
     * @returns {number} The depth.
     */
    get depth(): number;
    /**
     * Creates an instance of OctreeNode.
     * @param {number} childIndex - Index of this node among its siblings.
     * @param {number} depth - Depth of this node in the octree.
     * @param {OctreeNode} [parent] - Parent node of this node.
     */
    constructor(childIndex: number, depth: number, parent?: OctreeNode);
}