@babylonjs/core 6.8.0 → 6.9.0

package/Materials/greasedLinePluginMaterial.d.ts

@@ -0,0 +1,307 @@
+import { MaterialPluginBase } from "./materialPluginBase";
+import type { Scene } from "../scene";
+import type { UniformBuffer } from "./uniformBuffer";
+import type { Vector2 } from "../Maths/math.vector";
+import { Color3 } from "../Maths/math.color";
+import type { Nullable } from "../types";
+import type { Material } from "./material";
+import { MaterialDefines } from "./materialDefines";
+import type { AbstractMesh } from "../Meshes/abstractMesh";
+import type { BaseTexture } from "./Textures/baseTexture";
+export declare enum GreasedLineMeshMaterialType {
+    MATERIAL_TYPE_STANDARD = 0,
+    MATERIAL_TYPE_PBR = 1
+}
+export declare enum GreasedLineMeshColorMode {
+    COLOR_MODE_SET = 0,
+    COLOR_MODE_ADD = 1,
+    COLOR_MODE_MULTIPLY = 2
+}
+export declare enum GreasedLineMeshColorDistributionType {
+    COLOR_DISTRIBUTION_TYPE_SEGMENT = 0,
+    COLOR_DISTRIBUTION_TYPE_LINE = 1
+}
+/**
+ * Options for GreasedLineMaterial
+ */
+export interface GreasedLineMaterialOptions {
+    /**
+     * Line width. If sizeAttenuation os false scene units will be used for width.
+     * Defaults to 0.1 if @see sizeAttenuation is false, or to 1 if it's true.
+     */
+    width?: number;
+    /**
+     * If false then width units = scene units. If true then line will width be reduced.
+     * Defaults to false.
+     */
+    sizeAttenuation?: boolean;
+    /**
+     * Type of the material to use to render the line.
+     * Defaults to StandardMaterial.
+     */
+    materialType?: GreasedLineMeshMaterialType;
+    /**
+     * Color of the line. Applies to all line segments.
+     * Defaults to White.
+     */
+    color?: Color3;
+    /**
+     * Color mode of the line. Applies to all line segments.
+     * The pixel color from the material shader will be modified with the value of @see color using the colorMode.
+     * Defaults to @see GreasedLineMeshColorMode.SET
+     */
+    colorMode?: GreasedLineMeshColorMode;
+    /**
+     * Colors of the line segments.
+     * Defaults to empty.
+     */
+    colors?: Color3[];
+    /**
+     * If true, @see colors are used, otherwise they're ignored.
+     * Defaults to false.
+     */
+    useColors?: boolean;
+    /**
+     * Sampling type of the colors texture
+     * Defaults to NEAREST_NEAREST.
+     */
+    colorsSampling?: number;
+    /**
+     * The method used to distribute the colors along the line.
+     * You can use segment distribution when each segment will use on color from the color table.
+     * Or you can use line distribution when the colors are distributed evenly along the line ignoring the segments.
+     */
+    colorDistributionType?: GreasedLineMeshColorDistributionType;
+    /**
+     * If true, dashing is used.
+     * Defaults to false.
+     */
+    useDash?: boolean;
+    /**
+     * @see GreasedLinePluginMaterial.setDashCount
+     * Number of dashes in the line.
+     * Defaults to 1.
+     */
+    dashCount?: number;
+    /**
+     * Offset of the dashes along the line. 0 to 1.
+     * Defaults to 0.
+     * @see GreasedLinePluginMaterial.setDashOffset
+     */
+    dashOffset?: number;
+    /**
+     * Length of the dash. 0 to 1. 0.5 means half empty, half drawn.
+     * Defaults to 0.5.
+     * @see GreasedLinePluginMaterial.setDashRatio
+     */
+    dashRatio?: number;
+    /**
+     * Sets the line length visibility.
+     * 0 - 0% of the line will be visible.
+     * 1 - 100% of the line will be visible.
+     * @see GreasedLinePluginMaterial.setVisibility
+     */
+    visibility?: number;
+    /**
+     * Defaults to engine.getRenderWidth() and engine.getRenderHeight()
+     * Rendering resolution
+     */
+    resolution?: Vector2;
+}
+/**
+ * @internal
+ */
+export declare class MaterialGreasedLineDefines extends MaterialDefines {
+    /**
+     * The material has a color option specified
+     */
+    GREASED_LINE_HAS_COLOR: boolean;
+    /**
+     * The material's size attenuation optiom
+     */
+    GREASED_LINE_SIZE_ATTENUATION: boolean;
+    /**
+     * The type of color distribution is set to line this value equals to true.
+     */
+    GREASED_LINE_COLOR_DISTRIBUTION_TYPE_LINE: boolean;
+}
+/**
+ * GreasedLinePluginMaterial for GreasedLineMesh
+ */
+export declare class GreasedLinePluginMaterial extends MaterialPluginBase {
+    private _scene;
+    /**
+     * Plugin name
+     */
+    static readonly GREASED_LINE_MATERIAL_NAME = "GreasedLinePluginMaterial";
+    private _colorsTexture?;
+    private _dashArray;
+    private _options;
+    private _engine;
+    private static _EmptyColorsTexture;
+    constructor(material: Material, _scene: Scene, options: GreasedLineMaterialOptions);
+    /**
+     * Get the shader attributes
+     * @param attributes array which will be filled with the attributes
+     */
+    getAttributes(attributes: string[]): void;
+    /**
+     * Get the shader samplers
+     * @param samplers
+     */
+    getSamplers(samplers: string[]): void;
+    /**
+     * Get the shader textures
+     * @param activeTextures
+     */
+    getActiveTextures(activeTextures: BaseTexture[]): void;
+    /**
+     * Get the shader uniforms
+     * @returns uniforms
+     */
+    getUniforms(): {
+        ubo: {
+            name: string;
+            size: number;
+            type: string;
+        }[];
+        vertex: string;
+        fragment: string;
+    };
+    get isEnabled(): boolean;
+    /**
+     * Bind the uniform buffer
+     * @param uniformBuffer
+     */
+    bindForSubMesh(uniformBuffer: UniformBuffer): void;
+    /**
+     * Prepare the defines
+     * @param defines
+     * @param _scene
+     * @param _mesh
+     */
+    prepareDefines(defines: MaterialGreasedLineDefines, _scene: Scene, _mesh: AbstractMesh): void;
+    /**
+     * Get the class name
+     * @returns class name
+     */
+    getClassName(): string;
+    /**
+     * Get shader code
+     * @param shaderType vertex/fragment
+     * @returns shader code
+     */
+    getCustomCode(shaderType: string): Nullable<{
+        [pointName: string]: string;
+    }>;
+    /**
+     * Converts boolean to number.
+     * @param bool
+     * @returns 1 if true, 0 if false.
+     */
+    private static _BooleanToNumber;
+    /**
+     * Converts an array of Color3 to Uint8Array
+     * @param colors Arrray of Color3
+     * @returns Uin8Array of colors [r, g, b, a, r, g, b, a, ...]
+     */
+    private static _Color3toRGBAUint8;
+    /**
+     * Creates a RawTexture from an RGBA color array and sets it on the plugin material instance.
+     * @param name name of the texture
+     * @param colors Uint8Array of colors
+     */
+    private _createColorsTexture;
+    /**
+     * Disposes the plugin material.
+     */
+    dispose(): void;
+    /**
+     * Sets whether to use the colors option to colorize the line.
+     * @param value true if use the colors, otherwise false
+     */
+    setUseColors(value: boolean): void;
+    /**
+     * Creates or updates the colors texture
+     * @param colors color table RGBA
+     * @param lazy if lazy, the colors are not updated
+     * @param forceUpdate force creation of a new texture
+     * @returns
+     */
+    setColors(colors: Nullable<Color3[]>, lazy?: boolean, forceUpdate?: boolean): void;
+    /**
+     * Updates the material. Use when material created in lazy mode.
+     */
+    updateLazy(): void;
+    /**
+     * Gets the plugin material options
+     * @returns the plugin material options @see GreasedLineMaterialOptions
+     */
+    getOptions(): GreasedLineMaterialOptions;
+    /**
+     * Sets the line length visibility.
+     * 0 - 0% of the line will be visible
+     * 1 - 100% of the line will be visible
+     * @param value
+     */
+    setVisibility(value: number): void;
+    /**
+     * Turns on/off dashmode
+     * @param value
+     */
+    setUseDash(value: boolean): void;
+    /**
+     * Sets the dash array.
+     * @param value dash array
+     */
+    setDashCount(value: number): void;
+    /**
+     * Sets the dash ratio
+     * @param value dash length ratio 0..1 (0.5 = half empty, half drawn)
+     */
+    setDashRatio(value: number): void;
+    /**
+     * Sets the dash offset
+     * @param value the dashes will be offset by this value
+     */
+    setDashOffset(value: number): void;
+    /**
+     * Sets line base width. At each point the line width is calculated by widths[pointIndex] * width
+     * @param value base width
+     */
+    setWidth(value: number): void;
+    /**
+     * Turn on/off attenuation of the width option and widths array.
+     * @param value false means 1 unit in width = 1 unit on scene, true means 1 unit in width is reduced on the screen to make better looking lines
+     */
+    setSizeAttenuation(value: boolean): void;
+    /**
+     * Sets the color of the line. If set the whole line will be mixed with this color according to the colorMode option.
+     * @param value color
+     */
+    setColor(value: Color3 | undefined, doNotMarkDirty?: boolean): void;
+    /**
+     * Sets the mixing mode of the color paramater. Default value is GreasedLineMeshColorMode.SET
+     * @see GreasedLineMeshColorMode
+     * @param value color mode
+     */
+    setColorMode(value: GreasedLineMeshColorMode): void;
+    /**
+     * Serializes this plugin material
+     * @returns serializationObjec
+     */
+    serialize(): any;
+    /**
+     * Parses a serialized objects
+     * @param source serialized object
+     * @param scene scene
+     * @param rootUrl root url for textures
+     */
+    parse(source: any, scene: Scene, rootUrl: string): void;
+    /**
+     * A minimum size texture for the colors sampler2D when there is no colors texture defined yet.
+     * For fast switching using the useColors property without the need to use defines.
+     * @param scene Scene
+     */
+    private static _PrepareEmptyColorsTexture;
+}