terriajs/lib/Traits/TraitsClasses/ClippingPlanesTraits.ts

Geospatial data visualization platform.

import BoxDrawingTraits from "../BoxDrawingTraits";
import objectArrayTrait from "../Decorators/objectArrayTrait";
import objectTrait from "../Decorators/objectTrait";
import primitiveArrayTrait from "../Decorators/primitiveArrayTrait";
import primitiveTrait from "../Decorators/primitiveTrait";
import mixTraits from "../mixTraits";
import ModelTraits from "../ModelTraits";
import LatLonHeightTraits from "./LatLonHeightTraits";

export class ClippingPlaneDefinitionTraits extends ModelTraits {
  @primitiveTrait({
    name: "Distance",
    type: "number",
    description:
      " The shortest distance from the origin to the plane. The sign of distance determines which side of the plane the origin is on. If distance is positive, the origin is in the half-space in the direction of the normal; if negative, the origin is in the half-space opposite to the normal; if zero, the plane passes through the origin."
  })
  distance: number = 0;

  @primitiveArrayTrait({
    name: "Normal Cartesian3",
    type: "number",
    description: "The plane's normal (normalized)."
  })
  normal: number[] = [];
}

export class ClippingPlaneCollectionTraits extends ModelTraits {
  @primitiveTrait({
    type: "boolean",
    name: "Enabled Clipping Plane",
    description: "Determines whether the clipping planes are active."
  })
  enabled: boolean = true;

  @primitiveTrait({
    type: "boolean",
    name: "UnionClippingRegions",
    description:
      "If true, a region will be clipped if it is on the outside of any plane in the collection. Otherwise, a region will only be clipped if it is on the outside of every plane."
  })
  unionClippingRegions: boolean = false;

  @primitiveTrait({
    type: "number",
    name: "Edge Width",
    description:
      "The width, in pixels, of the highlight applied to the edge along which an object is clipped."
  })
  edgeWidth?: number;

  @primitiveTrait({
    type: "string",
    name: "Edge Color",
    description:
      "The color applied to highlight the edge along which an object is clipped."
  })
  edgeColor?: string;

  @objectArrayTrait({
    type: ClippingPlaneDefinitionTraits,
    name: "Clipping Plane Array",
    description:
      "An array of ClippingPlane objects used to selectively disable rendering on the outside of each plane.",
    idProperty: "index"
  })
  planes?: ClippingPlaneDefinitionTraits[];

  @primitiveArrayTrait({
    name: "Model Matrix",
    type: "number",
    description:
      "The 4x4 transformation matrix specifying an additional transform relative to the clipping planes original coordinate system."
  })
  modelMatrix?: number[];
}

export class ClippingBoxDimensionTraits extends ModelTraits {
  @primitiveTrait({
    type: "number",
    name: "Length",
    description: "Length of the clipping box (along the x-axis)."
  })
  length?: number;

  @primitiveTrait({
    type: "number",
    name: "Length",
    description: "Width of the clipping box (along the y-axis)."
  })
  width?: number;

  @primitiveTrait({
    type: "number",
    name: "Length",
    description: "Height of the clipping box."
  })
  height?: number;
}

export class ClippingBoxTraits extends mixTraits(BoxDrawingTraits) {
  @primitiveTrait({
    type: "boolean",
    name: "Enable clipping box features",
    description:
      "Set false to completely disable clipping box feature for the item."
  })
  enableFeature: boolean = true;

  @primitiveTrait({
    type: "boolean",
    name: "Toggle model clipping.",
    description: "Applies clipping when true."
  })
  clipModel = false;

  @primitiveTrait({
    type: "boolean",
    name: "Show clipping box",
    description: "Shows a 3D box and associated UI for editing the clip volume."
  })
  showClippingBox = true;

  @primitiveTrait({
    type: "boolean",
    name: "Keep clipping box above ground",
    description: "When true, prevents the box from going underground."
  })
  keepBoxAboveGround = true;

  @objectTrait({
    type: LatLonHeightTraits,
    name: "position",
    description:
      "Latitude, longitude and height of the clipping box. When not set, the box is positioned at the center of the screen."
  })
  position?: LatLonHeightTraits = undefined;

  @objectTrait({
    type: ClippingBoxDimensionTraits,
    name: "Dimensions",
    description:
      "The length, width and height of the clipping box. When not set, the box will be 1/3rd the screen size."
  })
  dimensions?: ClippingBoxDimensionTraits;

  @primitiveTrait({
    type: "string",
    name: "Clip direction",
    description: `Whether to clip the model outside of the box or inside. When this value is "outside", everything outside the box is clipped and when the value is "inside", everything inside the box is clipped. Default value is "inside"`
  })
  clipDirection = "inside";
}

export default class ClippingPlanesTraits extends ModelTraits {
  @objectTrait({
    type: ClippingPlaneCollectionTraits,
    name: "ClippingPlanes",
    description:
      "The ClippingPlaneCollection used to selectively disable rendering the tileset."
  })
  clippingPlanes?: ClippingPlaneCollectionTraits;

  @objectTrait({
    type: ClippingBoxTraits,
    name: "Clipping box",
    description:
      "Defines a user controllable clipping box used to hide or show sections of a model."
  })
  clippingBox?: ClippingBoxTraits;
}