@xeokit/xeokit-sdk/types/viewer/scene/materials/PointsMaterial.d.ts

3D BIM IFC Viewer SDK for AEC engineering applications. Open Source JavaScript Toolkit based on pure WebGL for top performance, real-world coordinates and full double precision

import { Material } from "./Material";
import { Component } from "../Component";

export declare type PointsMaterialConfiguration = {
  /** Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
  id?: string;
  /** Point size in pixels. */
  pointSize?: number;
  /** Whether points are round (````true````) or square (````false````). */
  roundPoints?: boolean;
  /** Whether apparent point size reduces with distance when {@link Camera.projection} is set to "perspective". */
  perspectivePoints?: boolean;
  /** When ````perspectivePoints```` is ````true````, this is the minimum rendered size of each point in pixels. */
  minPerspectivePointSize?: number;
  /** When ````perspectivePoints```` is ````true````, this is the maximum rendered size of each point in pixels. */
  maxPerspectivePointSize?: number;
  /** When this is true, points are only rendered when their intensity value falls within the range given in {@link } */
  filterIntensity?: boolean;
  /** When ````filterIntensity```` is ````true````, points with intensity below this value will not be rendered. */
  minIntensity?: number;
  /** When ````filterIntensity```` is ````true````, points with intensity above this value will not be rendered. */
  maxIntensity?: number;
  /** Selects a preset PointsMaterial configuration - see {@link PointsMaterial.presets}. */
  preset?: string;
};

/**
 * Configures the size and shape of "points" geometry primitives.
 */
export declare class PointsMaterial extends Material {
  /**
   * @constructor
   * @param {Component} owner Owner component. When destroyed, the owner will destroy this component as well.
   * @param {PointsMaterialConfiguration} [cfg] The PointsMaterial configuration
   */
  constructor(owner: Component, cfg?: PointsMaterialConfiguration);

  /**
   * Gets available PointsMaterial presets.
   *
   * @type {Object}
   */
  get presets(): any;

  /**
   * Selects a preset ````PointsMaterial```` configuration.
   *
   * Default value is ````"default"````.
   *
   * @type {String}
   */
  set preset(arg: string);

  /**
   * The current preset ````PointsMaterial```` configuration.
   *
   * Default value is ````"default"````.
   *
   * @type {String}
   */
  get preset(): string;

  /**
   * Sets point size.
   *
   * Default value is ````2.0```` pixels.
   *
   * @type {Number}
   */
  set pointSize(arg: number);

  /**
   * Gets point size.
   *
   * Default value is ````2.0```` pixels.
   *
   * @type {Number}
   */
  get pointSize(): number;

  /**
   * Sets if points are round or square.
   *
   * Default is ````true```` to set points round.
   *
   * @type {Boolean}
   */
  set roundPoints(arg: boolean);

  /**
   * Gets if points are round or square.
   *
   * Default is ````true```` to set points round.
   *
   * @type {Boolean}
   */
  get roundPoints(): boolean;

  /**
   * Sets if rendered point size reduces with distance when {@link Camera.projection} is set to ````"perspective"````.
   *
   * Default is ````true````.
   *
   * @type {Boolean}
   */
  set perspectivePoints(arg: boolean);

  /**
   * Gets if rendered point size reduces with distance when {@link Camera.projection} is set to "perspective".
   *
   * Default is ````false````.
   *
   * @type {Boolean}
   */
  get perspectivePoints(): boolean;

  /**
   * Sets the minimum rendered size of points when {@link PointsMaterial.perspectivePoints} is ````true````.
   *
   * Default value is ````1.0```` pixels.
   *
   * @type {Number}
   */
  set minPerspectivePointSize(arg: number);

  /**
   * Gets the minimum rendered size of points when {@link PointsMaterial.perspectivePoints} is ````true````.
   *
   * Default value is ````1.0```` pixels.
   *
   * @type {Number}
   */
  get minPerspectivePointSize(): number;

  /**
   * Sets the maximum rendered size of points when {@link PointsMaterial.perspectivePoints} is ````true````.
   *
   * Default value is ````6```` pixels.
   *
   * @type {Number}
   */
  set maxPerspectivePointSize(arg: number);

  /**
   * Gets the maximum rendered size of points when {@link PointsMaterial.perspectivePoints} is ````true````.
   *
   * Default value is ````6```` pixels.
   *
   * @type {Number}
   */
  get maxPerspectivePointSize(): number;

  /**
   * Sets if rendered point size reduces with distance when {@link Camera.projection} is set to ````"perspective"````.
   *
   * Default is ````false````.
   *
   * @type {Boolean}
   */
  set filterIntensity(arg: boolean);

  /**
   * Gets if rendered point size reduces with distance when {@link Camera.projection} is set to "perspective".
   *
   * Default is ````false````.
   *
   * @type {Boolean}
   */
  get filterIntensity(): boolean;

  /**
   * Sets the minimum rendered size of points when {@link PointsMaterial.perspectivePoints} is ````true````.
   *
   * Default value is ````0````.
   *
   * @type {Number}
   */
  set minIntensity(arg: number);

  /**
   * Gets the minimum rendered size of points when {@link PointsMaterial.filterIntensity} is ````true````.
   *
   * Default value is ````0````.
   *
   * @type {Number}
   */
  get minIntensity(): number;

  /**
   * Sets the maximum rendered size of points when {@link PointsMaterial.filterIntensity} is ````true````.
   *
   * Default value is ````1````.
   *
   * @type {Number}
   */
  set maxIntensity(arg: number);

  /**
   * Gets the maximum rendered size of points when {@link PointsMaterial.filterIntensity} is ````true````.
   *
   * Default value is ````1````.
   *
   * @type {Number}
   */
  get maxIntensity(): number;

  /**
   * Destroys this ````PointsMaterial````.
   */
  destroy(): void;
}