Skip to main content

Module arch

Module arch 

Source
Expand description

ACAD Arch classes.

Walls, doors, stairs, spaces, slabs, curtain walls, structural members, and the style and display objects that belong to them are registered AEC classes. Opaque native bodies are preserved on same-version DWG saves. Supported typed edits update decoded native parameters and cached graphics together. Unsupported layouts return ArchEditError and leave the entity unchanged.

The calling guide is src/classes/arch/API.md.

Structs§

AecPlacement
Placement stored by an Arch entity after its schema tag.
ArchEntityData
Class body of an Arch entity.
ArchObject
ContinuousWall
One connected run of wall segments, in baseline order.
DecodedAec
What can be read from any Arch class without a private schema.
MemberSize
Length and the two cross-section sizes of a beam or column.
OpeningSize
Width and height of a door, window, or opening, in drawing units.
StairSize
Run, width, and floor-to-floor height of a stair.
StoredNumber
One number found in the class bytes, with the role it plays for this entity.
StraightWallGeometry
One straight run of a wall: baseline start, baseline end, full thickness, and base height.

Enums§

ArchEditError
Why an architecture edit left the entity unchanged.
ArchKind
Which Arch entity a class name represents.
NumberRole
What a stored number means.
PreviewRecord
One piece of the proxy-graphics preview.

Constants§

ENTITY_CLASSES
DXF names of the Arch entities found in the Arch sample projects, with the C++ class ACAD registers for each.

Functions§

centered_wall_profile
Closed preview of a center-justified straight wall.
continuous_wall_outline
Closed mitered outline of a center-justified wall chain.
continuous_walls
Walls in document grouped into continuous chains.
cpp_class_name
C++ class name registered for a known Arch entity, when this crate knows it. Callers that have the drawing’s CLASSES section should prefer that entry.
decode_profiles
Profiles carried by an entity’s proxy-graphics blob.
door
Create one standalone, unanchored native door at the origin.
door_size
Door leaf width and height, excluding the insertion elevation and swing clearance.
entities_anchored_to
Arch entities whose anchor depends on host.
is_architecture_name
Whether dxf_name is an ACAD Arch / MEP class.
kind_of
Entity kind for a known Arch DXF name.
map_profile_points
Map complete encoded profile runs, without scanning for isolated coordinate values.
member_size
Dimensions of the measured rectangular structural-member layout.
opening_size
Opening width along the wall, and its height.
polyline_from_type6
Decode a type-6 profile payload: u32 count, then count XYZ doubles.
reshape_rectangle
Reshape the first profile to a rectangle when it has the same point count.
set_ceiling_grid
Unsupported: native ceiling-grid placement has not been decoded.
set_column_grid
Unsupported: native column-grid placement has not been decoded.
set_continuous_wall
Replace every segment of chain so the baseline becomes points.
set_curtain_wall
Unsupported: native curtain-wall placement has not been decoded.
set_display_theme
Unsupported: native display-theme placement has not been decoded.
set_door
Set a door’s leaf width and height.
set_mass_element
Unsupported: native mass-element placement has not been decoded.
set_member
Set a rectangular member’s length along its decoded native placement axis. Cross-section changes are unsupported and leave the entity unchanged.
set_opening
Set an opening’s width along the wall and its height.
set_profile_bounds
Resize the bounds of an axis-aligned wall with a decoded native baseline. Native geometry for other entity kinds must be edited with a typed setter.
set_railing
Unsupported: native railing placement has not been decoded.
set_roof
Unsupported: native roof placement has not been decoded.
set_roof_slab
Unsupported: native roof-slab placement has not been decoded.
set_slab
Unsupported: native slab placement has not been decoded.
set_space
Unsupported: native space placement has not been decoded.
set_stair
Unsupported: linked stair rise, tread, and offset parameters are not decoded. The entity and its graphics stay unchanged.
set_wall
Rewrite one straight wall onto a new baseline.
set_window
Set a window’s plan width and height.
set_window_assembly
Unsupported: native window-assembly placement has not been decoded.
stair_size
Dimensions of the measured straight-stair layout.
wall
Create one straight, centered wall in the world XY plane.
window
Create one standalone, unanchored native window at the origin.
window_size
Window width and height. The insertion-point Z coordinate is the sill elevation.