Options
All
  • Public
  • Public/Protected
  • All
Menu

An ExtrudedShape represents a 3D volume created by extruding a 2D shape.

The extruded shape has a 2D base shape, a minimum height and a maximum height. Both values are expressed in the unit of measure of the georeference of the extruded shape. For geodetic references, this is meters. These values can be defined relative to the geoid, or the terrain, depending on the reference. Also have a look at ReferenceProvider.

The minimum and maximum height form the bottom and top boundaries of the volume.

The isSupportedBaseShape supported base shapes are all 2D line and area shapes.

Hierarchy

Implements

Overview

Constructors

Private constructor

  • This class should not be instantiated by users of LuciadRIA.

    Returns ExtrudedShape

Accessors

baseShape

  • get baseShape(): Shape
  • set baseShape(baseShape: Shape): void
  • The base shape of this extruded shape.

    Returns Shape

  • The base shape of this extruded shape.

    Parameters

    Returns any

bounds

coordinateType

focusPoint

  • get focusPoint(): Point | null

maximumHeight

  • get maximumHeight(): number
  • set maximumHeight(maximumHeight: number): void
  • The maximum height of this extruded shape, expressed in the unit of measure of the georeference of this extruded shape. For geodetic references, this is meters.This value can be defined relative to the geoid, or the terrain, depending on the reference. Also have a look at ReferenceProvider.

    It represents the top/upper boundary of the volume. The maximum height must be higher than or equal to the minimum height.

    Returns number

  • The maximum height of this extruded shape, expressed in the unit of measure of the georeference of this extruded shape. For geodetic references, this is meters.This value can be defined relative to the geoid, or the terrain, depending on the reference. Also have a look at ReferenceProvider.

    It represents the top/upper boundary of the volume. The maximum height must be higher than or equal to the minimum height.

    Parameters

    • maximumHeight: number

    Returns any

minimumHeight

  • get minimumHeight(): number
  • set minimumHeight(minimumHeight: number): void
  • The minimum height of this extruded shape, expressed in the unit of measure of the georeference of this extruded shape. For geodetic references, this is meters. This value can be defined relative to the geoid, or the terrain, depending on the reference. Also have a look at ReferenceProvider.

    It represents the bottom/lower boundary of the volume. The minimum height must be lower than or equal to the maximum height.

    Returns number

  • The minimum height of this extruded shape, expressed in the unit of measure of the georeference of this extruded shape. For geodetic references, this is meters. This value can be defined relative to the geoid, or the terrain, depending on the reference. Also have a look at ReferenceProvider.

    It represents the bottom/lower boundary of the volume. The minimum height must be lower than or equal to the maximum height.

    Parameters

    • minimumHeight: number

    Returns any

reference

type

Methods

contains2D

  • Determines whether a given point is inside this shape. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).

    throws

    InvalidReferenceError when passing a Point with another spatial reference

    deprecated

    Please use contains2DPoint instead.

    Parameters

    • x: Point | number | Bounds

      The point for which containment must be checked. If a 3D point is passed to this function, it will be treated as a 2D point: the z coordinate (height) will be ignored. The reference of this point must be the same reference as this Shape

    • Optional y: number

    Returns boolean

    true when the given point is contained in this shape

contains2DCoordinates

  • (x: number, y: number): boolean

contains2DPoint

  • (point: Point): boolean
  • Determines whether the given point is inside this shape. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).

    throws

    InvalidReferenceError when passing a Point with another spatial reference

    Parameters

    • point: Point

      The point for which containment must be checked.

    Returns boolean

    true when the given point is contained in this shape

copy

equals

  • (aExtrudedShape: Shape): boolean

toString

  • (): string

translate2D

  • (x: number, y: number): void

Static isSupportedBaseShape

  • (shape: Shape): boolean
  • Tests whether the given shape can be used as a base shape for a ExtrudedShape.

    Currently ExtrudedShape supports all 2D line or area shapes.

    Parameters

    • shape: Shape

      The shape to be tested.

    Returns boolean

    Whether the shape is a possible base shape.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method