Interface DwgSpatialFilterObject

interface DwgSpatialFilterObject {
    backClippingPlaneDistance: number;
    backClippingPlaneFlag: boolean;
    clipBoundaryVisible: boolean;
    extrusionDirection: DwgPoint3D;
    frontClippingPlaneDistance: number;
    frontClippingPlaneFlag: boolean;
    handle: string;
    invertBlockMatrix: number[];
    matrix: number[];
    numberOfPointsOnClipBoundary: number;
    origin: DwgPoint3D;
    ownerHandle: string;
    vertices: DwgPoint2D[];
}

Hierarchy (View Summary)

Properties

backClippingPlaneDistance backClippingPlaneFlag clipBoundaryVisible extrusionDirection frontClippingPlaneDistance frontClippingPlaneFlag handle invertBlockMatrix matrix numberOfPointsOnClipBoundary origin ownerHandle vertices

Properties

backClippingPlaneDistance

backClippingPlaneDistance: number

Back clipping plane distance if clipBoundaryVisible is true (1)

backClippingPlaneFlag

backClippingPlaneFlag: boolean

Back clipping plane flag

  • 0 = No
  • 1 = Yes

clipBoundaryVisible

clipBoundaryVisible: boolean

Clip boundary display enabled flag

  • 0 = Disabled
  • 1 = Enabled

extrusionDirection

extrusionDirection: DwgPoint3D

Extrusion direction (optional; default = 0, 0, 1)

frontClippingPlaneDistance

frontClippingPlaneDistance: number

Front clipping plane distance if clipBoundaryVisible is true (1)

frontClippingPlaneFlag

frontClippingPlaneFlag: boolean

Front clipping plane flag

  • 0 = No
  • 1 = Yes

handle

handle: string

invertBlockMatrix

invertBlockMatrix: number[]

4x3 transformation matrix written out in column major order. This matrix is the inverse of the original block reference (insert entity) transformation. The original block reference transformation is the one that is applied to all entities in the block when the block reference is regenerated (always 12 entries).

matrix

matrix: number[]

4x3 transformation matrix written out in column major order. This matrix transforms points into the coordinate system of the clip boundary (12 entries).

numberOfPointsOnClipBoundary

numberOfPointsOnClipBoundary: number

Number of points on the clip boundary

  • 2 = Rectangular clip boundary (lower-left and upper-right)
  • greater than 2 = Polyline clip boundary

origin

origin: DwgPoint3D

Origin used to define the local coordinate system of the clip boundary

ownerHandle

ownerHandle: string

vertices

vertices: DwgPoint2D[]

Clip boundary definition point (in OCS) (always 2 or more) based on an xref scale of 1

Settings

Member Visibility

On This Page

Properties