SpatialFilter

The SPATIAL_FILTER object stores the clipping path for external references and block references. For more information about getting, setting and removing clippings paths read the docs for the ezdxf.xclip.XClip class.

The HEADER variable $XCLIPFRAME determines if the clipping path is displayed and plotted:

0

not displayed, not plotted

1

displayed, not plotted

2

displayed and plotted

See also

Subclass of

ezdxf.entities.DXFObject

DXF type

'SPATIAL_FILTER'

Factory function

internal data structure
class ezdxf.entities.SpatialFilter
dxf.back_clipping_plane_distance

Defines the distance of the back clipping plane from the origin in direction of the extrusion vector.

dxf.is_clipping_enabled

Block reference clipping is enabled when 1 and disabled when 0.

dxf.extrusion

Defines the orientation of the OCS

dxf.front_clipping_plane_distance

Defines the distance of the front clipping plane from the origin in direction of the extrusion vector.

dxf.has_back_clipping_plane
dxf.has_front_clipping_plane
dxf.origin

Defines the origin of the OCS

property boundary_vertices: tuple[Vec2, ...]

Returns the clipping path vertices in OCS coordinates.

property inverse_insert_matrix: Matrix44

Returns the inverse insert matrix.

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.

property transform_matrix: Matrix44

Returns the transform matrix.

This matrix transforms points into the coordinate system of the clip boundary.

set_boundary_vertices(vertices: Iterable[UVec]) → None

Set the clipping path vertices in OCS coordinates.

set_inverse_insert_matrix(m: Matrix44) → None
set_transform_matrix(m: Matrix44) → None