madscrewdriver / qsketchmetric Goto Github PK

Python 2D parametric DXF rendering CAD engine

License: MIT License

Python 100.00%

2d 2d-cad cad dwg dxf dxf-files ezdxf parameters parametric parametric-modelling

qsketchmetric's Introduction

QSketchMetric is a Python 2D parametric DXF CAD rendering engine. Parametrization is done using QCAD Professional software

⚡️ Quickstart

from qsketchmetric.renderer import Renderer
from ezdxf import new
from ezdxf import units

output_dxf = new()
output_dxf.units = units.MM

input_parametric_dxf_path = 'tutorial.dxf'
input_variables = {"h": 50}

renderer = Renderer(input_parametric_dxf_path, output_dxf,
                    variables=input_variables)
renderer.render()

output_dxf.saveas('tutorial_rendered.dxf')

📷 Demo showcase

⚙️ Installation

The most common case is the installation by pip package manager:

  pip install qsketchmetric

📐 DXF Parametrization

Parametrization is done using QCAD Professional software. You can download the free trial version of the software and use it for parametrization of your DXF files. We need to use it because it is the only software that supports adding custom data to DXF entities. See docs to learn more...

✅ QSketchMetric Validator

To verify the proper parametrization of a DXF file during parametrization process, use the QSketchMetric Validator. It is a web application that allows you to upload DXF file and check if it is properly parametrized. In the event of an error, the app will give you full debug report. Including place where the error occurred in the DXF file and the error message. See docs to learn more...

🎯 Features

Parametric DXF rendering
Easy dxf files parametrization using QCAD Professional software
Explicit support for parametrization of LINE,CIRCLE,ARC, POINT entities
Support for parametrization of LWPOLYLINE, POLYLINE, SPLINE, ELLIPSE, MTEXT, TEXT etc. entities using INSERT entity.
Open source and daily maintained

📚 Documentation

Documentation is available at QSketchMetric docs

📈 Roadmap

Explicit support for more entities is planned in the future. If you have any suggestions, please create an issue. If you want to contribute, see How to contribute section in the documentation. I am open to any suggestions and waiting for your pull requests!

⚠️ License

QSketchMetric is licensed under the MIT license. When using the QSketchMetric in your open-source project I would be grateful for a reference to the repository.

🏆 Hall of fame

This project exists thanks to all the people who contribute. Thank you!

qsketchmetric's People

Contributors

Stargazers

Watchers

Forkers

makschernetskyi

qsketchmetric's Issues

Explicit support for Elipse parametrization

Specific issue of #9. Add support for Elipse parametriztion.
For exmple using center, major and minor axis.

Explicit support for LWpolyline parametrization

Specific issue of #9. Add support for LWPOLYLINE parametriztion.

Probably it it useless to explicly parametrize complex LWPolylines. Noone will use it because it would be too complex. Parametrizing it using INSERT entity is enough.

It is good idea to have it if somone would like to parametrize silmple LWPOLYLINE entitie.

Constant variable c in INSERT parametric decription doesn't exist

For width and height variable c needs to be defined as width or height value of the INSERT entities bounding box.

Add support for Complex Linetype Pattern

Add support for complex linetype patterns and change the current way lines are defined.
For example change it to pattern string only - not as two integers as it is now.

https://ezdxf.readthedocs.io/en/stable/tutorials/linetypes.html#tut-linetypes

Refactor tests

Refactor Renderer and SemiAutomaticParametrization tests to smaller test cases.

Repair Codecov Coverage Report

Codecov Coverage Report is broken at the moment ant not updating

Add support for QCAD/CAM

Hi,

Does the library skip elements that don't have the "c" attribute?

I've just tried adding CAM data from QCAD/CAM, and getting an error (line 142; xdata parsing).

I've not properly gone through the code, but cursory glance, doesn't seem to be a reason to intentionally fail when elements don't have the "c" attribute? It seems like a nice potential feature, that elements that don't have "c" are not constrained and should be ignored altogether and left alone.

I can see quite a few potential benefits, the biggest is being able to have CAM prepared, so that the rendered file just needs the CAM exporting (it'll regenerate the new path positions), vs having to start from scratch, setting up config, tools, paths and then generating. As I assume paths are moved, but not replaced (so they have their original ID's), anything referencing elements will continue to work after rendering. Another is to have a frame, or other finished elements on different layers... using a point reference, or even graph elements, you could then lay out parametric elements on a finished CAD drawing etc, without ever having to touch the non-parametric elements.

Errors in Docs

Hi,

Just started using the Library - absolutely brilliant tool!

I had a really steep learning curve, mostly I found from a number of missing details, and a few errors/typos in the docs. One of the bigger ones is the interchanged use of "Build" and "Buld" for the MTEXT. Seems not an issue for renderer.py, but is referenced in semiautomatic.py.

I've also struggled to understand the ideal graph of constraints to build for an object, so an explanation of that and different examples would be incredibly useful!

I'm happy to edit and push my updates, or can list issues I've found?

Thanks

Explicit support for entities parametrization

Add explicit support for LWPOLYLINE, POLYLINE, SPLINE, ELLIPSE, MTEXT, TEXT etc.