Difference between revisions of "Prj"

From Wiki.OSArch
(Add Documentation paragraph)
m
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
{{Infobox software
 
{{Infobox software
| icon      = ""
+
| icon      = Grey1x4.png
| screenshot = ""
+
| screenshot = Grey1x4.png
 
| website    = [https://gitlab.com/marzof/prj gitlab.com/marzof/prj]
 
| website    = [https://gitlab.com/marzof/prj gitlab.com/marzof/prj]
 
| source    = [https://gitlab.com/marzof/prj Repo on gitlab]
 
| source    = [https://gitlab.com/marzof/prj Repo on gitlab]
Line 7: Line 7:
 
| bugs      = [https://gitlab.com/marzof/prj/-/issues Issue page on gitlab]
 
| bugs      = [https://gitlab.com/marzof/prj/-/issues Issue page on gitlab]
 
| community  = ""
 
| community  = ""
| maturity  = At the very beginning
+
| maturity  = Promising
 
| donation  = ""
 
| donation  = ""
 
}}
 
}}
  
 +
''prj'' is a [https://docs.blender.org/manual/en/latest/editors/preferences/addons.html Blender_Add-on] for generating semantic technical drawings from 3d model. Its main purpose is to help architects and designer to make building and interior drawings automatically. ''prj'' generates linked data-rich SVG drawings.
 +
It has particular strengths:
  
=== What is prj ===
+
* Drawings are in the open file format [[Scalable_Vector_Graphics_(SVG)|Scalable Vector Graphics (SVG)]]. SVG is a non-binary and non-proprietary format that can be viewed by a simple browser on any device. Interactivity can be implemented in SVG files and their styles can be handled by [https://en.wikipedia.org/wiki/CSS web standard CSS]. Editing is easy and graphically powerful using free software like [[Inkscape]] and [[Krita]].
''prj'' is a Blender add-on for '''generating semantic technical drawings from 3d model.'''<br>
 
Its main purpose is to ''help architects and designer to make building and interior drawings automatically''.
 
  
=== Disclaimer ===
+
* Drawings are linked. Every 3D object is represented in a single dedicated SVG file and all those files are linked (as <use> element) to the main drawing. That allows to keep files size small and to limit redrawing to changed objects only.
''prj'' is currently '''under development and may be subject to changes''': using it on production is on your own responsibility.<br>
 
At the moment ''prj'' has been '''tested on Linux and Windows machines only''' and is not supposed to work on other OS
 
  
=== About prj ===
+
* Drawings are data-rich. Every object stores information about it directly inside the SVG. Hence text searches are possible over single and multiple drawings.
''prj'' generates '''''linked data-rich SVG''''' drawings.<br>
 
In particular:
 
* '''drawings are in SVG format'''
 
:''Scalable Vector Graphics'' is a '''non-binary''' and '''non-proprietary format''' that can be viewed by a simple browser on any device. '''Interactivity''' can be implemented on it and its style can be '''handled by CSS'''. Editing is easy and graphically powerful using both open source source and proprietary softwares.
 
  
* '''drawings are linked'''
+
''prj'' is also able to produce drawings in the less free [[Drawing_Exchange_Format_(DXF)|DXF]] or [[Drawing_(DWG)|DWG]] file formats.
:Every 3D object is represented in a single dedicated SVG file and all those files are linked (as <use> element) to the main drawing. That allows to '''keep files size small''' and to limit redrawing to changed objects only.
 
  
* '''drawings are data-rich'''
+
''prj'' uses [https://docs.blender.org/manual/en/latest/scene_layout/object/properties/line_art.html Blender Line Art] feature and SVG grease pencil exporter.
:Every object '''stores information''' about it directly inside the SVG. Hence '''text searches''' are possible over single and multiple drawings.
 
  
''prj'' is able to produce drawings in ''DXF'' or ''DWG'' file format as well.<br>
+
== Why use prj? ==
 +
''prj'' isn't trying to be a simple drawing tool. Its main aim is to be a tool to manage projects information by generating data-rich drawings (a kind of BIM drawing tool).
  
''prj'' uses Blender ''Line Art'' feature and ''SVG grease pencil exporter''.
+
This is why it generates drawings in SVG format with a linked structure: this way every object in the drawing can return informations about it (product id, size, weight, physical properties, cost, typology, family belonging, etc…) and allow user to get, for example, bill of quantities or interactive drawing you can query.
  
=== Why using prj? ===
+
For these reasons it's recommended to complete the drawing process (composing, styling with css, adding annotations and dimensions) using an SVG editor (like the open source [[Inkscape]]). There are plans for prj SVG exports to store many other types of data in the future (such as quantities).
''prj'' '''doesn't mean to be a simple drawing tool''': its main aim is to be '''a tool to manage projects information by generating data-rich drawings''' (a kind of BIM drawing tool).
 
  
This is why it generates drawings in SVG format with a linked structure: this way every object in the drawing can return informations about it (product id, size, weight, physical properties, cost, typology, family belonging, etc…)* and allow user to get, for example, bill of quantities or interactive drawing you can query.
+
=== prj vs blenderbim 2d drawing ===
 +
Main difference between prj and BlenderBIM 2D_documentation:
  
For these reasons it's recommended to complete the drawing process (composing, styling with css, adding annotations and dimensions) using an SVG editor (like the open source [[Inkscape]]).<br>
+
* BlenderBim focuses on creating 2d documentation based on an ifc project
Anyway, if you don't care to keep these information inside your drawings, you can produce ''DXF'' or ''DWG'' files.
+
* prj exports Blender objects regardless of being part of an ifc project
  
''* It's important to point out that, at the moment, the add-on is not capable to store some data yet (like quantities) but in future it should be able to do it.''
+
As of July 2022 have tested prj (v0.0.9d) exported svg files imported to [[QCAD|qcad professional]] . This seems to work fine.
  
=== Documentation ===
+
= See also =
At the moment a proper documentation is missing.<br>
+
* [[Inkscape]]
However, a [https://gitlab.com/marzof/prj#getting-started ''Getting started'' guide] is present on the main page of the add-on repo.
+
* [[Blender]]
 +
* [[Krita]]
 +
* [[Category:Blender_Add-on]]
 +
* [[Scalable_Vector_Graphics_(SVG)]]
 +
* The [https://community.osarch.org/discussions/tagged/prj prj tag] on the OSArch forum
 +
 
 +
= External Resources =
 +
* [https://gitlab.com/marzof/prj#getting-started ''Getting started''] guide
 +
* [https://gitlab.com/marzof/prj/-/wikis/Tips-and-tricks ''Tips and tricks'']
 +
 
 +
{{Blender_Add-on}}
 +
{{software}}
 +
[[Category:Blender Add-on]]
 +
[[Category:Blender]]

Latest revision as of 06:10, 16 August 2022

Grey1x4.png
Grey1x4.png
Website: gitlab.com/marzof/prj
Source: Repo on gitlab
License: GNU GPLv2
Bugs: Issue page on gitlab
Community: ""
Maturity: Category:Promising
Donate: ""
Red curve on white disc 128px.png Software Directory


prj is a Blender_Add-on for generating semantic technical drawings from 3d model. Its main purpose is to help architects and designer to make building and interior drawings automatically. prj generates linked data-rich SVG drawings. It has particular strengths:

  • Drawings are in the open file format Scalable Vector Graphics (SVG). SVG is a non-binary and non-proprietary format that can be viewed by a simple browser on any device. Interactivity can be implemented in SVG files and their styles can be handled by web standard CSS. Editing is easy and graphically powerful using free software like Inkscape and Krita.
  • Drawings are linked. Every 3D object is represented in a single dedicated SVG file and all those files are linked (as <use> element) to the main drawing. That allows to keep files size small and to limit redrawing to changed objects only.
  • Drawings are data-rich. Every object stores information about it directly inside the SVG. Hence text searches are possible over single and multiple drawings.

prj is also able to produce drawings in the less free DXF or DWG file formats.

prj uses Blender Line Art feature and SVG grease pencil exporter.

Why use prj?[edit]

prj isn't trying to be a simple drawing tool. Its main aim is to be a tool to manage projects information by generating data-rich drawings (a kind of BIM drawing tool).

This is why it generates drawings in SVG format with a linked structure: this way every object in the drawing can return informations about it (product id, size, weight, physical properties, cost, typology, family belonging, etc…) and allow user to get, for example, bill of quantities or interactive drawing you can query.

For these reasons it's recommended to complete the drawing process (composing, styling with css, adding annotations and dimensions) using an SVG editor (like the open source Inkscape). There are plans for prj SVG exports to store many other types of data in the future (such as quantities).

prj vs blenderbim 2d drawing[edit]

Main difference between prj and BlenderBIM 2D_documentation:

  • BlenderBim focuses on creating 2d documentation based on an ifc project
  • prj exports Blender objects regardless of being part of an ifc project

As of July 2022 have tested prj (v0.0.9d) exported svg files imported to qcad professional . This seems to work fine.

See also[edit]

External Resources[edit]

Icon blender icon 64x64.png This page describes a Blender Add-on relevant to AEC work. See similar add-ons in the Category:Blender Add-on.
This page describes a software project from our AEC Free Software directory