Руководство пользователя по OpenSCAD/Общие сведения

Шаблон:Incomplete

ВступлениеПравить


OpenSCAD это программа 2D/3D и твердотельного моделирования которая основанная на функциональном программном языке используемая для создания моделей которые можно отобразить на экране и отрэндерить в 3D сетку, что позволяет модель экспортировать в различные 2D/3D форматы файлов.

Скрипт на языке OpenSCAD используется для создания 2D или 3D моделей. Этот скрипт представляет собой свободно форматируемый список действий с выражениями.

 object();
 variable = value;
 operator()   action();
 operator() { action();    action(); }
 operator()   operator() { action(); action(); }
 operator() { operator()   action();
              operator() { action(); action(); } }
Объекты

Объекты являются строительными блоками для моделей, созданных с помощью 2D и 3D примитивов. Объекты заканчиваются точкой с запятой ';'.

Действия

Действия с выражениями включают создание объектов использующих примитивы и присвоение значений переменным. Действия с выражениями также заканчиваются точкой с запятой ";".

Операторы

Операторы, или преобразования, изменяют местоположение, цвет и другие свойства объектов. Операторы используют фигурные скобки "{}", когда их область действия охватывает более одного действия. Для одного действия или группы действий можно использовать более чем один оператор. Несколько операторов обрабатываются справа налево, то есть оператор, ближайший к действию, обрабатывается первым. Операторы не заканчиваются точкой с запятой ";", но отдельные действия, которые они содержат, заканчиваются.

 Примеры
  
   cube(5);
   x = 4+y;
   rotate(40) square(5,10);
   translate([10,5]) { circle(5); square(4); }
   rotate(60) color("red") { circle(5); square(4); }
   color("blue") { translate([5,3,0]) sphere(5); rotate([45,0,45]) { cylinder(10); cube([5,6,7]); } }

КомментарииПравить


Комментарии — это способ оставлять заметки в сценарии или коде (либо для себя, либо для будущих программистов), описывающий, как работает код или что он делает. Комментарии не обрабатываются компилятором и не должны использоваться для описания самоочевидного кода.

OpenSCAD использует C++-стиль комментариев:

// Это комментарий
  
myvar = 10; // Остальная часть строки - это комментарий
  
/*
   Многострочные комментарии
   могут охватывать несколько строк.
*/

Значения и типы данныхПравить


Значение в OpenSCAD - это либо число (например, 42), логическое значение (например, true), строка (например, "foo"), диапазон (например, [0:1:10]), вектор (например, [1,2,3]) или Неопределенное значение (undef). Значения могут храниться в переменных, передаваться в качестве аргументов функции и возвращаться в виде результатов функции.

[OpenSCAD - это динамически типизированный язык с фиксированным набором типов данных. Здесь нет имен типов и нет определяемых пользователем типов. Функции не являются значениями. На самом деле переменные и функции занимают непересекающиеся пространства имен.]

ЧислаПравить

Числа являются наиболее важным типом данных в OpenSCAD, и они записываются в привычной десятичной системе счисления, используемой в других языках. Например, -1, 42, 0,5, 2,99792458e+8. [OpenSCAD не поддерживает восьмеричную или шестнадцатеричную запись чисел.]

В дополнение к десятичным числам определены следующие имена для специальных чисел:

  • PI

В OpenSCAD есть только один тип чисел, который представляет собой 64-разрядное число IEEE с плавающей запятой. [OpenSCAD не различает целые числа и числа с плавающей запятой как два разных типа и не поддерживает комплексные числа.] Поскольку OpenSCAD использует стандарт IEEE с плавающей запятой, то существует несколько отклонений от поведения чисел в математике:

  • Мы используем двоичную систему с плавающей точкой. Дробное число не представляется точно, если только знаменатель не равен степени 2. Например, 0.2 (2/10) не имеет точного внутреннего представления, но 0.25 (1/4) и 0.125 (1/8) представлены точно.
  • Наибольшее представимое число составляет около 1e308. Если числовой результат слишком велик, то результатом может быть бесконечность (печатаемая как inf в echo).
  • Наименьшее представимое число составляет около -1e308. Если числовой результат слишком мал, то результатом может быть -бесконечность (печатаемая как -inf в echo).
  • Если числовой результат недействителен, то результат может быть не ч1ислом (англ.: Not A Number) (печатаемая как nan в echo).
  • Если ненулевой числовой результат слишком близок к нулю, чтобы быть представимым, то результат равен -0, если результат отрицательный, в противном случае он равен 0. Ноль (0) и отрицательный ноль (-0) обрабатываются как два разных числа некоторыми математическими операциями и печатаются в 'echo' по-разному, хотя они сравниваются как равные.

Константы "inf" и "nan" не поддерживаются OpenSCAD в качестве числовых констант, хотя вы можете вычислять числа, которые печатаются таким образом с помощью "echo". Вы можете определить переменные с этими значениями используя:

inf = 1e200 * 1e200;
nan = 0 / 0;
echo(inf,nan);

Значение 'nan' - это единственное значение OpenSCAD, которое не равно никакому другому значению, включая его самого. Хотя вы можете проверить, имеет ли переменная 'x' неопределенное значение, используя 'x==undef', вы не можете использовать 'x==0/0', чтобы проверить, не является ли x числом. Вместо этого вы должны использовать 'x != x', чтобы проверить, является ли x nan.

Логические значенияПравить

Логические значения - это значения истинности. Существует два логических значения, а именно true (истина) и false (ложь). Логическое значение передается в качестве аргумента условному выражению 'if()'. условному оператору '? :', и логическим операторам '!' (нет), '&&' (и) и '||' (или). In all of these contexts, you can actually pass any quantity. Большинство значений преобразуются в "истину" в логическом контексте, значения, которые считаются "ложными", являются:

  • false
  • 0 and -0
  • ""
  • []
  • undef

Обратите внимание, что "false" (строка), [0] (числовой вектор), [ [] ] (вектор, содержащий пустой вектор), [false] (вектор, содержащий логическое значение false) и 0/0 (не число (Not A Number(nan))) все считаются истинными.

СтрокиПравить

Строка - это последовательность из нуля или более символов юникода. Строковые значения используются для указания имен файлов при импорте файла и для отображения текста в целях отладки при использовании echo(). Строки также можно использовать с новым примитивом text() добавленном в 2015.03.

Строковый литерал записывается как последовательность символов, заключенных в кавычки ", например: "" (пустая строка), или "это строка".

Чтобы включить символ " в строковый литерал, используйте \". Чтобы включить символ \ в строковый литерал, используйте \\. В строковых литералах можно использовать следующие escape-последовательности, начинающиеся с \:

  • \" → "
  • \\ → \
  • \t → табуляция
  • \n → новая строка
  • \r → возврат каретки
  • \u03a9 → Ω - смотри text() для получения дополнительной информации о символах юникода

Примечание: Это поведение является новым с версии OpenSCAD-2011.04. Вы можете обновить старые файлы с помощью следующей команды sed: sed 's/\\/\\\\/g' non-escaped.scad > escaped.scad

 Пример:
  
 echo("The quick brown fox \tjumps \"over\" the lazy dog.\rThe quick brown fox.\nThe \\lazy\\ dog.");
  
 Результат
ECHO: "The quick brown fox jumps "over" the lazy dog. The quick brown fox. The \lazy\ dog." Старый результат
ECHO: "The quick brown fox \tjumps \"over\" the lazy dog. The quick brown fox.\nThe \\lazy\\ dog."

ДиапазоныПравить

Диапазоны используются в циклах for() и в children(). У них есть 2 разновидности:

[<начало>: <конец>]
[<начало>: <прирост>: <конец>]

Хотя они заключены в квадратные скобки [], они не являются векторами. Они используют двоеточия : для разделителей, а не запятые.

r1 = [0:10];
r2 = [0.5:2.5:20];
echo(r1); // ECHO: [0: 1: 10]
echo(r2); // ECHO: [0.5: 2.5: 20]

Вам следует избегать значений шага, которые не могут быть представлены точно в виде двоичных чисел с плавающей запятой. Целые числа в порядке, как и дробные значения, знаменатель которых равен степени двух. Например, 0,25 (1/4) и 0,125 (1/8) безопасны, но следует избегать 0,2 (2/10). Проблема с этими значениями шага заключается в том, что в вашем диапазоне может быть слишком много или слишком мало элементов из-за неточной арифметики.

Пропущенный <прирост> по умолчанию равняется 1. Диапазон в форме [<начало>:<конец>] с <началом> больше, чем <конец>, генерирует предупреждение и эквивалентен [<конец>: 1: <начало>]. Диапазон в форме [<начало>:1:<конец>] с <началом> больше, чем <конец>, не генерирует предупреждение и эквивалентен []. <Приращение> в диапазоне может быть отрицательным (для версий после 2014 года).

Неопределенное ЗначениеПравить

Неопределенное (англ.: undefined) значение - это специальное значение, записанное как undef. Это начальное значение переменной, которой не было присвоено значение, и оно часто возвращается в результате функций или операций, которым передаются недопустимые аргументы. Наконец, undef может использоваться в качестве нулевого значения, эквивалентного null или NULL на других языках программирования.

Все арифметические выражения, содержащие undef значения оцениваются как undef. В логических выражениях, undef эквивалентен false. Выражения оператора отношения с undef оцениваются как false, за исключением undef==undef, который является true.

Обратите внимание, что числовые операции могут также возвращать 'nan' (not-a-number(не число)), чтобы указать на недопустимый аргумент. Например, 0/false это undef, но 0/0 это 'nan'. Операторы отношений, такие как < and > возвращают false если передаются недопустимые аргументы. Хотя undef является значением языка, 'nan' - нет.

ПеременныеПравить


Переменные OpenSCAD создаются оператором с именем или идентификатором, присваиванием с помощью выражения и точки с запятой. Роль массивов, встречающихся во многих императивных языках, обрабатывается в OpenSCAD при использовании векторов.

var = 25;
xx = 1.25 * cos(50);
y = 2*xx+var;
logic = true;
MyString = "Это строка";
a_vector = [1,2,3];
rr = a_vector[2];      // член вектора
range1 = [-1.5:0.5:3]; // for() диапазон циклов
xx = [0:5];            // альтернативный for() диапазон циклов

OpenSCAD - это функциональный язык программирования, как таковые переменные привязаны к выражениям и сохраняют одно значение в течение всего срока службы из-за требований ссылочной прозрачности. В императивных языках, таких как C, то же поведение рассматривается как константы, которые обычно противопоставляются обычным переменным.

Другими словами, переменные OpenSCAD больше похожи на константы, но с важным отличием. Если переменным присваивается значение несколько раз, во всех местах кода используется только последнее присвоенное значение. См. Дальнейшее обсуждение в Переменные устанавливаются во время компиляции, а не во время выполнения. Такое поведение связано с необходимостью для поддержки входа переменных через командную строку, с помощью параметра -D переменная=значение. В настоящее время OpenSCAD помещает это присваивание в конец исходного кода и, следовательно, должен позволять изменять значение переменной для этой цели.

Значения не могут быть изменены во время выполнения; все переменные фактически являются константами, которые не изменяются. Каждая переменная сохраняет свое последнее присвоенное значение во время компиляции в соответствии с Функциональными языками программирования. В отличие от императивных языков, таких как C, OpenSCAD iне является итеративным языком, и поэтому концепция x = x + 1 неверна. Понимание этой концепции ведет к пониманию красоты OpenSCAD.

До версии 2015.03

Невозможно было выполнять назначения в любом месте, кроме верхнего уровня файла и верхнего уровня модуля. Внутри if/else  или for  цикла, assign() был необходим.

Начиная с версии 2015.03

Переменные теперь можно назначать в любой области. Обратите внимание, что назначения допустимы только в той области, в которой они определены - вам по-прежнему не разрешается передавать значения во внешнюю область. См. Область действия переменных для получения более подробной информации.

a=0;
if (a==0) 
  {
 a=1; //  до 2015.03 эта строка будет выдавать Ошибку Компиляции
      //  с 2015.03 больше не является ошибкой, но значение a=1 ограничено фигурными скобками {}
  }

Неопределенная переменнаяПравить

Неназначенная переменная имеет специальное значение undef. Он может быть проверен в условном выражении и возвращен функцией.

 Пример:
  
 echo("Переменная a", a);                        // Переменная a не определена
 if (a==undef) {
   echo("Переменная a является неопределенной"); // Переменная a является неопределенной
 }

Область действия переменныхПравить

Когда такие операторы, как translate() и color(), должны охватывать более одного действия (действия заканчиваются на ;), фигурные скобки {} необходимы для группировки действий, создавая новую внутреннюю область. Когда есть только одна точка с запятой, фигурные скобки обычно необязательны.

Каждая пара фигурных скобок создает новую область внутри области, в которой они используются. Начиная с 2015.03, в этой новой области можно создавать новые переменные. Новые значения могут быть присвоены переменным, которые были созданы во внешней области. Эти переменные и их значения также доступны для других внутренних областей, созданных в этой области, но "недоступны" для чего-либо за пределами этой области. Переменные по-прежнему содержат только последнее значение, присвоенное в пределах области.

                       // область 1
 a = 6;                // создать a
 echo(a,b);            //                6, undef
 translate([5,0,0]){   // область 1.1
   a= 10;
   b= 16;              // создать b
   echo(a,b);          //              100, 16   a=10; был переопределен более поздним a=100;
   color("blue") {     // область 1.1.1
     echo(a,b);        //              100, 20
     cube();
     b=20;
   }                   // возврат в 1.1
   echo(a,b);          //              100, 16
   a=100;              // переопределить a в 1.1
 }                     // возврат в 1   
 echo(a,b);            //                6, undef
 color("red"){         // область 1.2
   cube();
   echo(a,b);          //                6, undef
 }                     // возврат в 1
 echo(a,b);            //                6, undef
  
 //В этом примере области 1 и 1.1 являются внешними областями для 1.1.1, а 1.2 - нет.
Анонимные области не считаются областями:
 {
   angle = 45;
 }
 rotate(angle) square(10);

Циклы for() не являются исключением из правила о переменных, имеющих только одно значение в области видимости. Для каждого прохода создается копия содержимого цикла. Каждому проходу присваивается своя область действия, что позволяет любым переменным иметь уникальные значения для этого прохода. Нет, вы все еще не можете сделать a=a+1;

Переменные задаются во время компиляции, а не во время выполненияПравить

Поскольку OpenSCAD вычисляет значения своих переменных во время компиляции, а не во время выполнения, последнее назначение переменной в области применяется везде в этой области или ее внутренних областях. Возможно, было бы полезно думать о них как о переопределяемых константах, а не как о переменных.

// Значение 'a' отражает только последнее установленное значение
   a = 0;
   echo(a);  // 5
   a = 3;
   echo(a);  // 5
   a = 5;

Хотя это кажется нелогичным, это позволяет вам делать некоторые интересные вещи: например, если вы настроили файлы общей библиотеки так, чтобы значения по умолчанию определялись как переменные на их корневом уровне, когда вы включаете этот файл в свой собственный код, вы можете 'переопределить' эти константы, просто присвоив им новое значение. Таким образом, изменение постоянных значений дает вам больше гибкости. Если константы никогда не изменятся, конечно, вы всегда можете быть уверены, что у вас есть значение, которое вы видите в любом определении константы. Здесь все не так. Если вы видите определение постоянного значения в любом другом месте, его значение может быть другим. Это очень гибкий подход.

Специальные переменныеПравить

Специальные переменные предоставляют альтернативные средства передачи аргументов модулям и функциям. Все переменные, начинающиеся с '$' являются специальными переменными, подобными специальным переменным в lisp. Как таковые, они более динамичны, чем обычные переменные. (для получения более подробной информации см. Другие языковые функции)

ВекторыПравить


Вектор или список - это последовательность из нуля или более значений OpenSCAD. Векторы представляют собой набор числовых или логических значений, переменных, векторов, строк или любой их комбинации. Они также могут быть выражениями, которые оценивают одно из них. Векторы выполняют роль массивов, найденных во многих императивных языках. Приведенная здесь информация также относится к спискам и таблицам, которые используют векторы для своих данных.

Вектор имеет квадратные скобки, [] заключающие ноль или более элементов (элементов или членов), разделенных запятыми. Вектор может содержать векторы, которые содержат векторы и т.д.


Примеры:
   [1,2,3]
   [a,5,b]
   []
   [5.643]
   ["a","b","string"]
   [[1,r],[x,y,z,4,5]]
   [3, 5, [6,7], [[8,9],[10,[11,12],13], c, "string"]
   [4/3, 6*1.5, cos(60)]

использование в OpenSCAD:

  cube( [width,depth,height] );           // дополнительные пробелы, показанны для ясности
  translate( [x,y,z] )
  polygon( [ [x0,y0],  [x1,y1],  [x2,y2] ] );
Создание

Векторы создаются путем написания списка элементов, разделенных запятыми и заключенных в квадратные скобки. Переменные заменяются их значениями.

  cube([10,15,20]);
  a1 = [1,2,3];
  a2 = [4,5];
  a3 = [6,7,8,9];
  b  = [a1,a2,a3];    // [ [1,2,3], [4,5], [6,7,8,9] ]  обратите внимание на увеличенную глубину вложенности
Индексирование элементов в векторахПравить

Элементы в векторах пронумерованы от 0 до n-1, где n - длина, возвращаемая len(). Адреса элементов внутри векторов со следующем обозначением:

e[5]           // элемент № 5 (шестой)      1-го уровня вложенности
e[5][2]        // элемент 2 элемента 5      2-го уровня вложенности
e[5][2][0]     // элемент 0 из 2 из 5       3-го уровня вложенности
e[5][2][0][1]  // элемент 1 из 0 из 2 из 5  4-го уровня вложенности
примеры элементов с длинами из len()
e = [ [1], [], [3,4,5], "string", "x", [[10,11],[12,13,14],[[15,16],[17]]] ];  // length 6

адрес         длина   элемент
e[0]          1       [1]
e[1]          0       []
e[5]          3       [ [10,11], [12,13,14], [[15,16],[17]] ]
e[5][1]       3       [ 12, 13, 14 ]
e[5][2]       2       [ [15,16], [17] ]
e[5][2][0]    2       [ 15, 16 ]
e[5][2][0][1] undef   16
    
e[3]          6       "string"
e[3 ][2]      1       "r"
  
s = [2,0,5]; a = 2;
s[a]          undef   5
e[s[a]]       3       [ [10,11], [12,13,14], [[15,16],[17]] ]
Индексация точечных обозначенийПравить

К первым трем элементам вектора можно получить доступ с помощью альтернативной точечной нотации:

e.x    //равнозначно e[0]
e.y    //равнозначно e[1]
e.z    //равнозначно e[2]
Векторные операторыПравить

concatПравить

Шаблон:Requires

concat() cобъединяет элементы 2 или более векторов в один вектор. Никаких изменений в уровне вложенности не делается.

 vector1 = [1,2,3]; vector2 = [4]; vector3 = [5,6];
 new_vector = concat(vector1, vector2, vector3); // [1,2,3,4,5,6]
  
 string_vector = concat("abc","def");                 // ["abc", "def"]
 one_string = str(string_vector[0],string_vector[1]); // "abcdef"
lenПравить

len() это функция, которая возвращает длину векторов или строк. Индексы элементов находятся в диапазоне от [0] до [длина-1].

вектор
Возвращает количество элементов на этом уровне.
Единичные значения, которые являются не not векторами, возвращает undef.
строка
Возвращает количество символов в строке.
 a = [1,2,3]; echo(len(a));   //  3

См. Примеры элементов с длиной

МатрицаПравить

Матрица - это вектор векторов.

Пример, который определяет двумерную матрицу вращения
mr = [
     [cos(angle), -sin(angle)],
     [sin(angle),  cos(angle)]
    ];

Получение входных данныхПравить


Теперь у нас есть переменные, было бы неплохо иметь возможность вводить их вместо того, чтобы задавать значения из кода. Существует несколько функций для чтения данных из файлов DXF, или вы можете установить переменную с помощью переключателя -D в командной строке.

Получение точки из рисунка

Получение точки полезно для считывания исходной точки в 2D-виде на техническом чертеже. Функция dxf_cross считывает пересечение двух линий на указанном вами слое и возвращает точку пересечения. Это означает, что точка должна быть задана двумя строками в файле DXF, а не точечным объектом.

OriginPoint = dxf_cross(file="drawing.dxf", layer="SCAD.Origin", 
                        origin=[0, 0], scale=1);

Получение значения измерения

Вы можете прочитать размеры из технического чертежа. Это может быть полезно для считывания угла поворота, высоты выдавливания или расстояния между деталями. На чертеже создайте размер, в котором отображается не значение размера, а идентификатор. Чтобы прочитать значение, вы указываете этот идентификатор в своей программе:

TotalWidth = dxf_dim(file="drawing.dxf", name="TotalWidth",
                        layer="SCAD.Origin", origin=[0, 0], scale=1);

Для наглядного примера обеих функций см. Example009 и изображение на домашней странице OpenSCAD.