bjorn/cnx-880-add-sections-and-materials-as-proxies

[bjoernsteinhagen]

Description & motivation

• Related to CNX-880
• Functionality to extract material and section data
• Single material can apply to numerous sections and a single section can apply to numerous objects
• A section can be either for a PropFrame (FRAME) or PropArea (AREA)
• To make it a little tricky, PropArea is for one of the following types: Deck, Wall or Slab. This affects the applicable api query

Changes:

Figma Link

• _materialUnpacker - CsiShared implementation (eligible for both Sap2000 and Etabs)
• _sectionUnpacker - CsiShared and host-app specific implementations (e.g. GetAllSectionProperties_2 not valid for Sap2000
• SectionMaterialRelationshipManager and ObjectSectionRelationshipManager - Method of building relationships. Based on MaterialName for section-material relationship and sectionDesignation for object-section relationship. Both of these attributes (strings) have to be unique in Etabs world
• Enums for project-wide consistency

To-do before merge:

• SectionProxy and MaterialProxy (?) in the SDK. Currently using GroupProxy

Screenshots:

See Speckle Project.

• Proxies created for materials, frame sections and shell sections:

• The nested properties dictionary orientates itself on the UI:

• The material-section relations are based on the unique material names (no ApplicationId).

• The section-object relations are based on the ApplicationId of the object(s).

Checklist:

• My pull request follows the guidelines in the Contributing guide?
• My pull request does not duplicate any other open Pull Requests for the same update/change?
• My commits are related to the pull request and do not amend unrelated code or documentation.
• My code follows a similar style to existing code.
• I have added appropriate tests.
• I have updated or added relevant documentation.

[linear]

CNX-880 Add Sections and Materials as proxies

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 14.74%. Comparing base (e52df07) to head (c3a362e).
Report is 1 commits behind head on dev.

Additional details and impacted files

@@           Coverage Diff           @@
##              dev     #499   +/-   ##
=======================================
  Coverage   14.74%   14.74%           
=======================================
  Files         239      239           
  Lines        4674     4674           
  Branches      576      576           
=======================================
  Hits          689      689           
  Misses       3954     3954           
  Partials       31       31           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[bjoernsteinhagen]

@clairekuang I had a brainwave this morning and currently exploring cDatabaseTables as a way to simplify the extraction of properties and get a more formalized return (as opposed to: determine type, use specific api query for that type etc.). If it works, it should reduce the amount of code and code complexity drastically (especially for AreaSectionProperty). Concerned the cDatabaseTables queries are a little slower though but will keep an eye on this.

cc: @dogukankaratas

[bjoernsteinhagen]

Summary of Discussion

Etabs Model here.

Changes

• Change sectionProperty to sectionId
• Append materialId to Assignments for each object to get some displayable / filterable action in the viewer

Future Issues

• Providing units to numeric properties. Potential barrier being the non-distance parameters like stress cannot be quantified just with a "mm" or "m"
• cDatabaseTables shelved / out of scope of this PR. To be investigated in separate issue.

@clairekuang I had a brainwave this morning and currently exploring cDatabaseTables as a way to simplify the extraction of properties and get a more formalized return (as opposed to: determine type, use specific api query for that type etc.). If it works, it should reduce the amount of code and code complexity drastically (especially for AreaSectionProperty). Concerned the cDatabaseTables queries are a little slower though but will keep an eye on this.

cc: @dogukankaratas

[bjoernsteinhagen]

Commit here.

• Explicit dictionary entries and use of consts for repeating entries
• Direct dictionary lookups
• Only creating proxies for sections and materials that have been assigned in the model (see screenshot below, objects will never be 0)