A "Framed Roof" is simultaneously a beam, a panel and a roof

[usai-sylvain]

To reproduce :

1. Create a new Roof/Floor/Multilayer wall, Multilayer Floor, Multilayer Roof

Add / Architecture / Roof/Floor/Multilayer wall, Multilayer Floor, Multilayer Roof

2. run the following script :

import cadwork
import element_controller as ec
import attribute_controller as ac


def main():
    ids = ec.get_active_identifiable_element_ids()
    for id in ids:
        print (id,"element type:", ec.get_element_type_description(id))
        
        print (id,"beam:", ac.is_beam(id))
        print (id,"panel:", ac.is_panel(id))
        print (id,"wall:", ac.is_wall(id))
        print (id,"floor:", ac.is_floor(id))        
        print (id,"roof:", ac.is_roof(id))

result on a Floor element :

1264585775 element type: Beam
1264585775 beam: True
1264585775 panel: True
1264585775 wall: False
1264585775 floor: False
1264585775 roof: True

Is that a feature ?

[Brunner246]

Well, i recommend you to follow this approach

import cadwork
import element_controller as ec
import attribute_controller as ac

elements = ec.get_active_identifiable_element_ids()

for element in elements:
    element_type: cadwork.element_type = ac.get_element_type(element)
    if element_type.is_rectangular_beam(): print(f"Element {element} is a rectangular beam.")
    elif element_type.is_circular_beam(): print(f"Element {element} is a circular beam.")
    elif element_type.is_connector_axis(): print(f"Element {element} is a connector axis.")
    elif element_type.is_drilling_axis(): print(f"Element {element} is a drilling axis.")
    elif ac.is_framed_wall(element): print(f"Element {element} is a framed wall.")

[usai-sylvain]

Thanks ! got it 🙏

when should ac.is_beam(id) be used then ?

[usai-sylvain]

I tried to map the c++ api methods to python and found some gaps between the c++ api, the element_type in python and the attribute controller in the python api.

Some of it I can piece back (ac.is_beam probably map to both rectangular_beam and circular_beam). But i'm still confuse about the difference for these two things and how to use it best.

Nothing urgent though, for now all element types i really need I can access.

Thanks!

map table below :

Type concept	C++ (ICwAPI3DElementType)	Python element_type class	attribute_controller (ac) direct is_*
Additional element	isAdditionalElement()	is_additional_element()	—
Architecture wall 2dc	—	—	is_architecture_wall_2dc()
Architecture wall xml	—	—	is_architecture_wall_xml()
Auxiliary	isAuxiliary()	is_auxiliary()	is_auxiliary()
Beam (generic)	—	—	is_beam()
BTL processing group	—	—	is_btl_processing_group()
Cadwork	isCadwork()	is_cadwork()	—
Caddy object	—	—	is_caddy_object()
Circular axis	isCircularAxis()	is_circular_axis()	—
Circular beam	isCircularBeam()	is_circular_beam()	—
Circular MEP	isCircularMEP()	—	is_circular_mep()
Connector axis	isConnectorAxis()	is_connector_axis()	is_connector_axis()
Connector node	isConnectorNode()	is_connector_node()	—
Container	isContainer()	is_container()	is_container()
Dimension	isDimension()	is_dimension()	—
Drilling axis	isDrillingAxis()	is_drilling_axis()	—
Drilling (generic)	—	—	is_drilling()
Eave axis	isEaveAxis()	is_eave_axis()	—
Envelope	—	—	is_envelope()
Export solid	isExportSolid()	is_export_solid()	is_export_solid()
Export solid scene	isExportSolidScene()	is_export_solid_scene()	—
Floor (generic)	isFloor()	is_floor()	is_floor()
Framed floor	isFramedFloor()	—	is_framed_floor()
Framed roof	isFramedRoof()	—	is_framed_roof()
Framed wall	isFramedWall()	—	is_framed_wall()
Global cut	isGlobalCut()	is_global_cut()	—
Graphical object	isGraphicalObject()	is_graphical_object()	—
Hundegger processing group	—	—	is_hundegger_processing_group()
Line	isLine()	is_line()	is_line()
Log wall	isLogWall()	—	is_log_wall()
Metal	—	—	is_metal()
Nesting parent	isNestingParent()	is_nesting_parent()	is_nesting_parent()
Nesting raw part	—	—	is_nesting_raw_part()
Node (generic)	—	—	is_node()
None	isNone()	is_none()	—
Normal node	isNormalNode()	is_normal_node()	—
Opening	isOpening()	is_opening()	is_opening()
Panel	isPanel()	is_panel()	is_panel()
Processing	—	—	is_processing()
Rectangular axis	isRectangularAxis()	is_rectangular_axis()	—
Rectangular beam	isRectangularBeam()	is_rectangular_beam()	—
Rectangular MEP	isRectangularMEP()	—	is_rectangular_mep()
Roof (generic)	isRoof()	is_roof()	is_roof()
Roof surface	—	—	is_roof_surface()
Room	isRoom()	is_room()	—
Rotation element	isRotationElement()	is_rotation_element()	—
Section trace	isSectionTrace()	is_section_trace()	—
Solid floor	isSolidWoodFloor()	—	is_solid_floor()
Solid roof	isSolidWoodRoof()	—	is_solid_roof()
Solid wall	isSolidWoodWall()	—	is_solid_wall()
Steel shape	isSteelShape()	is_steel_shape()	—
Surface	isSurface()	is_surface()	is_surface()
Text document	isTextDocument()	is_text_document()	—
Wall (generic)	isWall()	is_wall()	is_wall()
Wire axis	isWireAxis()	is_wire_axis()	—

[Brunner246]

I tried to map the c++ api methods to python and found some gaps between the c++ api, the element_type in python and the attribute controller in the python api.

Some of it I can piece back (ac.is_beam probably map to both rectangular_beam and circular_beam). But i'm still confuse about the difference for these two things and how to use it best.

Nothing urgent though, for now all element types i really need I can access.

Thanks!

map table below :

Type concept C++ (ICwAPI3DElementType) Python element_type class attribute_controller (ac) direct is_*
Additional element isAdditionalElement() is_additional_element() —
Architecture wall 2dc — — is_architecture_wall_2dc()
Architecture wall xml — — is_architecture_wall_xml()
Auxiliary isAuxiliary() is_auxiliary() is_auxiliary()
Beam (generic) — — is_beam()
BTL processing group — — is_btl_processing_group()
Cadwork isCadwork() is_cadwork() —
Caddy object — — is_caddy_object()
Circular axis isCircularAxis() is_circular_axis() —
Circular beam isCircularBeam() is_circular_beam() —
Circular MEP isCircularMEP() — is_circular_mep()
Connector axis isConnectorAxis() is_connector_axis() is_connector_axis()
Connector node isConnectorNode() is_connector_node() —
Container isContainer() is_container() is_container()
Dimension isDimension() is_dimension() —
Drilling axis isDrillingAxis() is_drilling_axis() —
Drilling (generic) — — is_drilling()
Eave axis isEaveAxis() is_eave_axis() —
Envelope — — is_envelope()
Export solid isExportSolid() is_export_solid() is_export_solid()
Export solid scene isExportSolidScene() is_export_solid_scene() —
Floor (generic) isFloor() is_floor() is_floor()
Framed floor isFramedFloor() — is_framed_floor()
Framed roof isFramedRoof() — is_framed_roof()
Framed wall isFramedWall() — is_framed_wall()
Global cut isGlobalCut() is_global_cut() —
Graphical object isGraphicalObject() is_graphical_object() —
Hundegger processing group — — is_hundegger_processing_group()
Line isLine() is_line() is_line()
Log wall isLogWall() — is_log_wall()
Metal — — is_metal()
Nesting parent isNestingParent() is_nesting_parent() is_nesting_parent()
Nesting raw part — — is_nesting_raw_part()
Node (generic) — — is_node()
None isNone() is_none() —
Normal node isNormalNode() is_normal_node() —
Opening isOpening() is_opening() is_opening()
Panel isPanel() is_panel() is_panel()
Processing — — is_processing()
Rectangular axis isRectangularAxis() is_rectangular_axis() —
Rectangular beam isRectangularBeam() is_rectangular_beam() —
Rectangular MEP isRectangularMEP() — is_rectangular_mep()
Roof (generic) isRoof() is_roof() is_roof()
Roof surface — — is_roof_surface()
Room isRoom() is_room() —
Rotation element isRotationElement() is_rotation_element() —
Section trace isSectionTrace() is_section_trace() —
Solid floor isSolidWoodFloor() — is_solid_floor()
Solid roof isSolidWoodRoof() — is_solid_roof()
Solid wall isSolidWoodWall() — is_solid_wall()
Steel shape isSteelShape() is_steel_shape() —
Surface isSurface() is_surface() is_surface()
Text document isTextDocument() is_text_document() —
Wall (generic) isWall() is_wall() is_wall()
Wire axis isWireAxis() is_wire_axis() —

There is also an AttributeController in CPP.

[usai-sylvain]

Ok, then it's only the MEPs and Solid/Framed-Floor-Wall-Roof that are missing.
Fine for me for now. updating the list for completeness :

Type concept	C++ ICwAPI3DElementType	Python element_type	C++ ICwAPI3DAttributeController	Python attribute_controller
Additional element	isAdditionalElement()	is_additional_element()	—	—
Architecture wall 2dc	—	—	isArchitectureWall2dc()	is_architecture_wall_2dc()
Architecture wall xml	—	—	isArchitectureWallXml()	is_architecture_wall_xml()
Auxiliary	isAuxiliary()	is_auxiliary()	isAuxiliary()	is_auxiliary()
Beam (generic)	—	—	isBeam()	is_beam()
BTL processing group	—	—	isBTLProcessingGroup()	is_btl_processing_group()
Cadwork	isCadwork()	is_cadwork()	—	—
Caddy object	—	—	isCaddyObject()	is_caddy_object()
Circular axis	isCircularAxis()	is_circular_axis()	—	—
Circular beam	isCircularBeam()	is_circular_beam()	—	—
Circular MEP	isCircularMEP()	—	isCircularMEP()	is_circular_mep()
Connector axis	isConnectorAxis()	is_connector_axis()	isConnectorAxis()	is_connector_axis()
Connector node	isConnectorNode()	is_connector_node()	—	—
Container	isContainer()	is_container()	isContainer()	is_container()
Dimension	isDimension()	is_dimension()	—	—
Drilling axis	isDrillingAxis()	is_drilling_axis()	—	—
Drilling (generic)	—	—	isDrilling()	is_drilling()
Eave axis	isEaveAxis()	is_eave_axis()	—	—
Envelope	—	—	isEnvelope()	is_envelope()
Export solid	isExportSolid()	is_export_solid()	isExportSolid()	is_export_solid()
Export solid scene	isExportSolidScene()	is_export_solid_scene()	—	—
Floor (generic)	isFloor()	is_floor()	isFloor()	is_floor()
Framed floor	isFramedFloor()	—	isFramedFloor()	is_framed_floor()
Framed roof	isFramedRoof()	—	isFramedRoof()	is_framed_roof()
Framed wall	isFramedWall()	—	isFramedWall()	is_framed_wall()
Global cut	isGlobalCut()	is_global_cut()	—	—
Graphical object	isGraphicalObject()	is_graphical_object()	—	—
Hundegger processing group	—	—	isHundeggerProcessingGroup()	is_hundegger_processing_group()
Line	isLine()	is_line()	isLine()	is_line()
Log wall	isLogWall()	—	isLogWall()	is_log_wall()
Metal	—	—	isMetal()	is_metal()
Nesting parent	isNestingParent()	is_nesting_parent()	isNestingParent()	is_nesting_parent()
Nesting raw part	—	—	isNestingRawPart()	is_nesting_raw_part()
Node (generic)	—	—	isNode()	is_node()
None	isNone()	is_none()	—	—
Normal node	isNormalNode()	is_normal_node()	—	—
Opening	isOpening()	is_opening()	isOpening()	is_opening()
Panel	isPanel()	is_panel()	isPanel()	is_panel()
Processing	—	—	isProcessing()	is_processing()
Rectangular axis	isRectangularAxis()	is_rectangular_axis()	—	—
Rectangular beam	isRectangularBeam()	is_rectangular_beam()	—	—
Rectangular MEP	isRectangularMEP()	—	isRectangularMEP()	is_rectangular_mep()
Roof (generic)	isRoof()	is_roof()	isRoof()	is_roof()
Roof surface	—	—	isRoofSurface()	is_roof_surface()
Room	isRoom()	is_room()	—	—
Rotation element	isRotationElement()	is_rotation_element()	—	—
Section trace	isSectionTrace()	is_section_trace()	—	—
Solid floor	isSolidWoodFloor()	—	isSolidFloor()	is_solid_floor()
Solid roof	isSolidWoodRoof()	—	isSolidRoof()	is_solid_roof()
Solid wall	isSolidWoodWall()	—	isSolidWall()	is_solid_wall()
Steel shape	isSteelShape()	is_steel_shape()	—	—
Surface	isSurface()	is_surface()	isSurface()	is_surface()
Text document	isTextDocument()	is_text_document()	—	—
Wall (generic)	isWall()	is_wall()	isWall()	is_wall()
Wire axis	isWireAxis()	is_wire_axis()	—	—