@openhps/core/dist/cjs/three/objects/ClippingGroup.js

Open Hybrid Positioning System - Core component

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.ClippingGroup = void 0;
var _Group = require("./Group.js");
/**
 * In earlier three.js versions, clipping was defined globally
 * on the renderer or on material level. This special version of
 * `THREE.Group` allows to encode the clipping state into the scene
 * graph. Meaning if you create an instance of this group, all
 * descendant 3D objects will be affected by the respective clipping
 * planes.
 *
 * Note: `ClippingGroup` can only be used with `WebGPURenderer`.
 *
 * @augments Group
 */
class ClippingGroup extends _Group.Group {
  /**
   * Constructs a new clipping group.
   */
  constructor() {
    super();

    /**
     * This flag can be used for type testing.
     *
     * @type {boolean}
     * @readonly
     * @default true
     */
    this.isClippingGroup = true;

    /**
     * An array with clipping planes.
     *
     * @type {Array<Plane>}
     */
    this.clippingPlanes = [];

    /**
     * Whether clipping should be enabled or not.
     *
     * @type {boolean}
     * @default true
     */
    this.enabled = true;

    /**
     * Whether the intersection of the clipping planes is used to clip objects, rather than their union.
     *
     * @type {boolean}
     * @default false
     */
    this.clipIntersection = false;

    /**
     * Whether shadows should be clipped or not.
     *
     * @type {boolean}
     * @default false
     */
    this.clipShadows = false;
  }
}
exports.ClippingGroup = ClippingGroup;