LuciadRIA (2026.0.04)
    Preparing search index...

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

    The extruded shape is based on a 2D base shape, with 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 geometry.

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

    Type Parameters

    • TShape extends Shape = Shape

      Represents the specific Shape type of the baseShape that is extruded.

    Hierarchy (View Summary)

    Constructors

    Accessors

    • get baseShape(): TShape

      The base shape of this extruded shape.

      Returns TShape

    • set baseShape(baseShape: TShape): void

      Parameters

      Returns void

    • get bounds(): Bounds | null

      The bounds of this shape. This property is to be treated in a read only manner. An error will be thrown when trying to assign to this property. Note that the bounds property is not immutable. Modifying properties of the bounds property may corrupt your data.

      Returns Bounds | null

    • get coordinateType(): CoordinateType

      The coordinate type this shape. This property is read only. An Error will be thrown when trying to assign to this property.

      Returns CoordinateType

    • get focusPoint(): Point | null

      The focus point of this shape. This property is read only. An error will be thrown when trying to assign to this property. This property contains an object but should be treated with value semantics: changes to the shape will not be reflected in the focusPoint that was retrieved from this Polygon before the modification.

      Returns Point | null

    • get maximumHeight(): 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.

      Returns number

    • set maximumHeight(maximumHeight: number): void

      Parameters

      • maximumHeight: number

      Returns void

    • get minimumHeight(): 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.

      Returns number

    • set minimumHeight(minimumHeight: number): void

      Parameters

      • minimumHeight: number

      Returns void

    • get reference(): CoordinateReference | null

      The spatial reference of this shape. This property is read only. An Error will be thrown when trying to assign to this property.

      Returns CoordinateReference | null

    Methods

    • 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).

      Parameters

      • x: number | Point | 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

      • Optionaly: number

      Returns boolean

      true when the given point is contained in this shape

      Please use contains2DPoint instead.

    • 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).

      Parameters

      • x: number

        The x coordinate of the point for which containment must be checked

      • y: number

        The y coordinate of the point for which containment must be checked

      Returns boolean

      true when the given point is contained in this shape

    • 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).

      Parameters

      • point: Point

        The point for which containment must be checked.

      Returns boolean

      true when the given point is contained in this shape

      InvalidReferenceError when a point has another spatial reference

    • Indicates whether this shape is equal to another.

      Parameters

      Returns boolean

      true if both shapes are equal, false otherwise.

    • Converts the shape to a string. This functionality is for debugging purposes only. Results of toString cannot be used to uniquely identify a shape instance.

      Returns string

    • Translates the shape over the given vector in 2D space.

      Parameters

      • x: number

        The x coordinate of the translation vector

      • y: number

        The y coordinate of the translation vector

      Returns void

    • Tests whether the given shape can be used as a base shape for an 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.