MLAB wiki

Máte načtenou starší verzi dokumentu! Pokud ji uložíte, vytvoříte tím novou aktuální verzi.

====== Dobré zvyky pro použití OpenSCAD ======

[[http://www.openscad.org/|OpenSCAD]] je nástroj pro návrh 3D modelů technických zařízení. Na rozdíl od většiny návrhových nástrojů OpenSCAD využívá pro popis objektu programovací jazyk.  Tento přístup umožňuje jednak parametrizaci modelů a navíc jejich snadné verzování s identifikací přesné změny. Základní úvod do používání programu je na [[http://blog.cubehero.com/2013/11/19/know-only-10-things-to-be-dangerous-in-openscad/|Know only 10 things to be dangerous in OpenSCAD]], existuje také [[http://www.openscad.org/cheatsheet/|přehled základních funkcí]].

==== Styl psaní kódu (coding style) ====

Je praktické dodržovat některá základní pravidla při vytváření modelů v openscadu.

* Názvy proměnných vytvářet v mezinárodním jazyce (angličtina a globálně známé výrazy a zkratky) 
  * Příliš nezkracovat názvy proměnných
  * Proměnné a operátory oddělovat mezerami
  * Používat odsazení o 4 mezery (tabulátor) ve vnořeném bloku kódu
  * Operace nad tělesem (translace, rotace) jsou vždy samostatně jedna na řádku, objekty se kterými manipulují jsou na řádku následujícím a jsou považovány za vnořený blok.

Kromě těchto základních pravidel je užitečné používat metodiky, které umožňují snadnější realizaci i u velmi složitých konstrukcí. Patří mezi ně:

* Parametry společné pro celou sestavu mají být v souboru parameters.scad který je includován do všech dílů sestavy.
  * Hodnota společných parametrů je taková, jak se přímo používá v jednotlivých modelech, včetně tolerance. Jednotlivé modely si hodnotu parametru mohou upravit pomocí jiných parametrů, ale nezavádějí vlastní hodnotu.
  * V modelech jsou pouze nezbytně nutné parametry, nebo parametry, které se s jistotou nepoužijí mimo model
  * Používáme globální prarametr global_clearance, který slouží k vyřešení tolerancí jednotlivých dílů, které mají pasovat do sebe a jeho hodnota je závislá na konkrétní tiskárně, nastavení sliceru a podobně.
  * Model se snažíme kreslit v pozici v jaké se bude tisknout. Jeho skutečná pozice v sestavě je pak řešena až souborem sestavy

==== Názvy souborů ====

Názvy jednotlivých souborů modelů jsou číselné ve formátu //(Název_)XXX_XXXX.scad// kde první trojčíslí určuje zamýšlený materiál ze kterého se má model realizovat:

* 888 - PLA
  * 666 - Generický FDM materiál
  * 333 - slitiny hliníku

Následuje číslo dílu, kde první číslice je skupina dílů. Druhá číslice je sestava uvnitř skupiny dílů a pak následují pořadová čísla jednotlivých dílů ve skupině.

Důvodem k použití číslování je, že názvy souborů jsou pak striktně jednoznačné. Zároveň tak je možné snadné třídění souborů podle sestav a skupin.

==== Knihovny ====

Knihovny by v projektech měly být ve složce // src/lib/ //, s tím že složka lib může mít další podsložky. Například standardní knihovny společné pro více projektů ve formě submodulu. 
Submodul s knihovnami vytvoříme příkazem

git submodule add git@github.com:ThunderFly-aerospace/Openscad_stdlib.git lib/stdlib

==== Alternativní editory ====

Integrovaný editor v OpenSCADu není moc pohodlný pro užívání. Je proto vhodnější zdrojové kódy modelů editovat v jiném editoru. OpenSCAD to podporuje tím, že při novém uložení souboru znovu zobrazí náhled. Některé editory podporují pluginy, které znají jazyk OpenSCADdu.

=== Použití editoru Atom ===

Editor atom je pro tento účel vhodným editorem. Instalace je docela jednoduchá a rychlá. Editor pak nabízí mnoho pokročilých funkcí.

Instalace lze provést v nastavení, do kterého se dostaneme přes ```Edit -> Preferences``` (klávesová zklatka ctlr+, (čárka)). V levém sloupci nastavení je potřeba zvolit `install` a vyhledat ```language-openscad```. Následně je potřeba nainstalovat stejnojmenný plugin.

Pak stačí otevřít soubor a editor by měl sám poznat, že se jedná o OpenSCAD soubor. Bude se to projevovat tak, že syntaxe bude správně obarvená a bude to znát určité openscad funkce.

=== Použití editoru SublimeText ===

Další vhodný editor je [[https://www.sublimetext.com/|SublimeText 3]].

Instalaci pluginu lze provést přes systém balíčků, který můžeme aktivovat volbou //Tools -> Install Package Control..//.

Otevřeme nástroj pro zacházení s balíčky volbou //Preferences -> Package Control//.

V nabídce zvolíme "Install Package"

Do filtračního pole napíšeme "openscad". A klikneme na odpovídající balíček.

Nyní je potřeba SublimeText zavřít a znovu otevřít, aby se nová konfigurace projevila.
Potom je možné nastavit, aby všechny soubory s příponou //.scad// byly otevřeny s OpenSCAD zvýrazňováním syntaxe. To lze nastavit přes volbu v pravém dolním rohu a výběrem //Open all with current extension as.. -> OpenScad//

Při následujícím otevření .scad souboru bude automaticky rozpoznán jako OpenSCAD zdrojový kód.

Vyplňte, prosím, všechna písmena v poli, abyste dokázali, že nejste robot. G T D W A Ponechte prosím toto pole prázdné:

Komentář k úpravám

Poznámka: Tím, že editujete tuto stránku, souhlasíte, aby váš obsah byl licencován pod následující licencí: CC Attribution-Noncommercial-Share Alike 4.0 International