Редактирование: Выборка информации об объектах сцены

[[Категория:Функции работы с объектами сцены]]
Данные функции возвращают либо сам объект, либо различную информацию об объекте сцены. Также в данном разделе присутствует ряд функций, приписывающих ту или иную информацию уже существующему объекту.

== Получение объекта по номеру ==

<code>OBJECT '''GetObjNum'''(INT ''&lt;N&gt;'')</code>

Функция возвращает <code>''&lt;N&gt;''</code>-й объект сцены верхнего уровня в диапазоне от 1 до '''sysvar(60)'''. Объекты нумеруются, начиная с единицы в порядке добавления в сцену. Следует иметь ввиду, что любая функция или команда редактирования объектов реально удаляет и вновь создает объект с новыми параметрами. То есть, редактируемый объект помещается в конец списка.


<code>OBJECT '''GetSelNum'''(INT ''&lt;N&gt;'')</code>

Функция возвращает <code>''&lt;N&gt;''</code>-й объект из списка выбранных объектов. Список выбранных объектов можно сформировать с помощью команды <code>Select</code>. Так же его создаёт большинство команд, имеющих сценарий группового выбора, например <code>Move</code>, <code>Rotate</code> и т.п. 


<code>OBJECT '''GetObjNumS'''(INT ''&lt;N&gt;'')</code>

Функция возвращает <code>''&lt;N&gt;''</code>-й объект сцены на любом уровне. <code>''&lt;N&gt;</code> ''может  быть в диапазоне от '''0''' до '''sysvar(62)'''.

== Определение типа объекта ==

===GetObjType===

<code>INT '''GetObjType'''(OBJECT ''&lt;Obj&gt;''<nowiki>[, INT VARNAME </nowiki>''&lt;BrepType&gt;''<nowiki>[, INT VARNAME </nowiki>''&lt;BrepKind&gt;'']])</code>

Функция возвращает тип объекта <code>''&lt;Obj&gt;''</code> и разновидность объекта типа '''Тело''' или '''Поверхность''' ('''Brep'''). Результат может принимать следующие значения:
:'''0''' — Текст ('''Text''')
:'''1''' — Точка ('''Point''')
:'''2''' — Отрезок ('''Line''')
:'''3''' — Окружность ('''Circle''')
:'''4''' — Дуга ('''Arc''')
:'''5''' — Контур ('''Path''')
:'''6''' — Тело ('''BRep''')
:'''7''' — Группа ('''Group''')
:'''10''' — Размер ('''Dim''')
:'''11''' — Вставка блока ('''Insert''')
:'''12''' — Сплайн ('''Spline''')
:'''15''' — Набор линий ('''Frame''')
:'''-12''' — Плоская область или полилиния ('''Polyline''')
:'''-13''' — Источник света ('''Light''')
:'''-14''' — Универсальная панель ('''Panel''')
:'''-15''' — Полочка-выноска ('''Note''')
:'''-16''' — мебельная комната ('''Room''')
:'''-19''' — набор треугольников ('''Triangle''')

Для объектов остальных типов функция возвращает отрицательное значение.

Если объект <code>''&lt;Obj&gt;</code> ''имеет тип типа '''Тело''' или '''Поверхность''' ('''Brep'''), то в переменные <code>''&lt;BrepType&gt;''</code> и <code>''&lt;BrepKind&gt;</code> ''записывается код разновидности и вида объекта соответственно.

<code>''&lt;BrepType&gt;''</code>:
:'''-1''' — Объект <code>''&lt;Obj&gt;''</code> не является объектом типа '''Тело''' или '''Поверхность''' ('''Brep''');
:'''0''' — Объект <code>''&lt;Obj&gt;''</code> является объектом типа '''Тело''';
:'''1''' — Объект <code>''&lt;Obj&gt;''</code> является объектом типа '''Поверхность''';
:'''2''' — Объект <code>''&lt;Obj&gt;''</code> является объектом типа '''Каркас'''.

<code>''&lt;BrepKind&gt;''</code>:
:'''-1''' — Объект <code>''&lt;Obj&gt;''</code>: не является объектом типа '''Тело''' или '''Поверхность''' ('''Brep''');
:'''0''' — Объект <code>''&lt;Obj&gt;''</code>: общего вида;
:'''1''' — Объект <code>''&lt;Obj&gt;''</code>: — параллелепипед;
:'''2''' — Объект <code>''&lt;Obj&gt;''</code>: — цилиндр;
:'''3''' — Объект <code>''&lt;Obj&gt;''</code>: — сфера;
:'''4''' — Объект <code>''&lt;Obj&gt;''</code>: — конус;
:'''5''' — Объект <code>''&lt;Obj&gt;''</code>: — тор;
:'''6''' — Объект <code>''&lt;Obj&gt;''</code>: — призма;
:'''7''' — Объект <code>''&lt;Obj&gt;''</code>: — пирамида;
:'''8''' — Объект <code>''&lt;Obj&gt;''</code>: — эллипсоид;
:'''9''' — Объект <code>''&lt;Obj&gt;''</code>: — шаровой пояс.

Если объект имеет тип (-12) - плоская область или полилиния, то для определения того, к какому конкретно типу относится объект, нужно использовать функцию <code>[[ContStatus]]</code>.

Пример:
 Point 10 20 30;
 Line 0 0 0 100 0 0;
 p1=GetObjNum(1);
 l1=GetObjNum(2);
 <nowiki>=GetObjType(p1);</nowiki>
 <font color="008800">1</font>
 <nowiki>=GetObjType(l1);</nowiki>
 <font color="008800">2</font>

===objtype===
<code>'''objtype''''' &lt;Object&gt;''</code>

Команда  определяет тип, слой и цвет объекта  и выводит эту информацию в командное окно. Данная команда в макропрограммах не используется.

===GetObjTypeNm===
<code>STRING '''GetObjTypeNm'''(OBJECT ''&lt;Obj&gt;''<nowiki>[, INT VARNAME </nowiki>''&lt;BrepType&gt;''<nowiki>[, INT VARNAME </nowiki>''&lt;BrepKind&gt;'']])</code>

Функция возвращает имя типа объекта <code>''&lt;Obj&gt;</code> ''и разновидность объекта типа '''Тело''' или '''Поверхность''' ('''Brep'''). Результат может принимать следующие значения:

'''”Text”, “Point”, ”Line”, ”Circle”, ”Arc”, ”Path”, “BRep”, “Group”, “Dim”, “Insert”, “Spline”, “Frame”, “PolyLine”, “Light”, "Note" '''и другие в зависимости от приложения ('''Мебель''', '''Коттедж''' и пр)

Если объект <code>''&lt;Obj&gt;</code> ''имеет тип типа '''Тело''' или '''Поверхность''' ('''Brep'''), то в переменные <code>''&lt;BrepType&gt;''</code> и <code>''&lt;BrepKind&gt;</code> ''записывается код разновидности и вида объекта соответственно.

<code>''&lt;BrepType&gt;''</code>:
:'''-1''' — Объект <code>''&lt;Obj&gt;''</code> не является объектом типа '''Тело''' или '''Поверхность''' ('''Brep''');
:'''0''' — Объект <code>''&lt;Obj&gt;''</code> является объектом типа '''Тело''';
:'''1 '''- Объект <code>''&lt;Obj&gt;''</code> является объектом типа '''Поверхность''';
:'''2''' — Объект <code>''&lt;Obj&gt;''</code> является объектом типа '''Каркас'''.

<code>''&lt;BrepKind&gt;'':</code>
:-1 — Объект <code>''&lt;Obj&gt;''</code> не является объектом типа '''Тело''' или '''Поверхность''' ('''Brep''');
:0 — Объект <code>''&lt;Obj&gt;''</code> общего вида;
:1 — Объект <code>''&lt;Obj&gt;''</code> — параллелепипед;
:2 — Объект <code>''&lt;Obj&gt;''</code> — цилиндр;
:3 — Объект <code>''&lt;Obj&gt;''</code> — сфера;
:4 — Объект <code>''&lt;Obj&gt;''</code> — конус;
:5 — Объект <code>''&lt;Obj&gt;''</code> — тор;
:6 — Объект <code>''&lt;Obj&gt;''</code> — призма;
:7 — Объект <code>''&lt;Obj&gt;''</code> — пирамида;
:8 — Объект <code>''&lt;Obj&gt;''</code> — эллипсоид;
:9 — Объект <code>''&lt;Obj&gt;''</code> — шаровой пояс.

== Работа с геометрией объекта ==

===GetObjGeo===

<code>INT '''GetObjGeo'''(OBJECT ''&lt;Obj&gt;'', Double array ''<nowiki>&lt;Arr[15]&gt;</nowiki>'')</code>

Функция заполняет массив <code>''&lt;Arr&gt;''</code> числами, описывающими геометрическую информацию о линейном объекте ('''точка, отрезок, окружность, дуга''') <code>''&lt;Obj&gt;''</code>. Функция возвращает количество заполненных элементов массива (см. таблицу):

{| class="wikitable"
|+Геометрия объектов
!
<center>'''Тип объекта'''</center>

! colspan="15" |
<center>'''Элементы массива'''</center>

|-
|


!
<center>'''1'''</center>

!
<center>'''2'''</center>

!<center>'''3'''</center>

!
<center>'''4'''</center>

!
<center>'''5'''</center>

!
<center>'''6'''</center>

!
<center>'''7'''</center>

!
<center>'''8'''</center>

!
<center>'''9'''</center>

!
<center>'''10'''</center>

!
<center>'''11'''</center>

!
<center>'''12'''</center>

!
<center>'''13'''</center>

!
<center>'''14'''</center>

!
<center>'''15'''</center>

|-
!
<center>'''Точка'''</center>

|
<center>x</center>

|
<center>y</center>

|
<center>z</center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|-
!
<center>'''Отрезок'''</center>

|
<center>xb</center>

|
<center>yb</center>

|
<center>zb</center>

|
<center>xe</center>

|
<center>ye</center>

|
<center>ze</center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|-
!
<center>'''Окружность'''</center>

|
<center>r</center>

|
<center>xn</center>

|
<center>yn</center>

|
<center>zn</center>

|
<center>xc</center>

|
<center>yc</center>

|
<center>zc</center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|
<center></center>

|-
!
<center>'''Дуга'''</center>

|
<center>r</center>

|
<center>xn</center>

|
<center>yn</center>

|
<center>zn</center>

|
<center>xc</center>

|
<center>yc</center>

|
<center>zc</center>

|
<center>xb</center>

|
<center>yb</center>

|
<center>zb</center>

|
<center>xe</center>

|
<center>ye</center>

|
<center>ze</center>

|
<center>ab</center>

|
<center>ar</center>

|}
Где:

'''(x,y,z)''' — Координаты точки в '''ГСК'''

'''(xb,yb,zb), (xe,ye,ze)''' — Координаты начальной и конечной точек отрезка, дуги в '''ГСК'''

'''r''' - Радиус окружности, дуги в '''ГСК'''

'''(xn,yn,zn)''' — Вектор нормали окружности, дуги в '''ГСК'''

'''(xc,yc,zc)''' — Координаты точки центра окружности, дуги в '''ГСК'''

'''ab, ar ''' — Начальный угол и угол раствора дуги в '''ЛСК'''

Пример:
 #p1 point 10 20 30;
 <nowiki>Defarr crd[3];</nowiki>
 <nowiki>=GetObjGeo(p1,crd);</nowiki>
 <font color="008800">3</font>
 <nowiki>=crd[1]</nowiki>
 <font color="008800">10</font>
 <nowiki>=crd[2]</nowiki>
 <font color="008800">20</font>
 <nowiki>=crd[3]</nowiki>
 <font color="008800">30</font>

===SetObjGeo===
<code>INT '''SetObjGeo'''(OBJECT ''&lt;Obj&gt;'', double ARRAY ''<nowiki>&lt;Arr[15&gt;</nowiki>''])</code>

Функция устанавливает геометрическую информацию в объект. Данная функция является обратной к функции <code>GetObjGeo</code>.

Функция для линейного объекта <code>''&lt;Obj&gt;''</code> берет из массива <code>''&lt;Arr&gt;''</code> числа, описывающие его геометрическую информацию, и передает их в объект. Функция требует регенерации (см. [[Управление отображением#Регенерировать изображение|regen]]) после применения.

== Получение свойств объекта ==

<code>LOGICAL '''GetObjVisual'''(OBJECT ''&lt;Obj&gt;'')</code>

Функция проверяет, включено ли отображение объекта <code>''&lt;Obj&gt;''</code>. Функция возвращает:

'''1''', если объект <code>''&lt;Obj&gt;</code> ''включен ('''visible''')

'''0''', если объект <code>''&lt;Obj&gt;</code> ''выключен ('''invisible''').


<code>INT '''GetColor'''(OBJECT ''&lt;Obj&gt;'')</code>

Функция возвращает индекс цвета объекта <code>''&lt;Obj&gt;''</code> (от 0 до 239 и 242 если цвет не определен).


<code>INT '''GetObjProp'''(OBJECT ''&lt;Obj&gt;'', variant ARRAY ''<nowiki>&lt;Arr[5]&gt;</nowiki>'')</code>

Функция заполняет массив <code>''&lt;Arr&gt;''</code> значениями свойств объекта <code>''&lt;Obj&gt;''</code>. Функция возвращает количество заполненных элементов в массиве (зависит от его размерности)

В массив <code>''&lt;Arr&gt;</code> ''заносятся:

'''<nowiki>arr[1] </nowiki>''' — индекс цвета объекта (от 0 до 239).

'''<nowiki>arr[2]</nowiki>''' — имя слоя объекта

'''<nowiki>arr[3]</nowiki>''' — код типа линии объекта

'''<nowiki>arr[4] </nowiki>''' — толщина линий объекта в мм

'''<nowiki>arr[5]</nowiki>''' — графический коэффициент объекта

== Извлечение и запись CSG информации ==

Данные функции используются в основном, при работе с длинномерами в приложении "'''Мебель'''". 

'''CSG''' - внутренняя структура данных '''K3''', содержащая различную информацию об объекте. Данные '''CSG '''и их интерпретация зависят не только от конкретного приложения '''K3 '''("'''Мебель'''", "'''Коттедж'''" и пр.), но и от типа объекта. Поэтому "просмотреть" всю эту информацию в приложении не представляется возможным. Возможно лишь сохранить ее целиком (<code>GetCsg</code>) в буфер и приписать ее целиком объекту (<code>SetCsg</code>).

Структура данных '''CSG''' может содержать различную служебную информацию, необходимую для корректного описания объекта.


<code>void '''GetCsg'''(object ''&lt;Object&gt;'')</code>

Функция записывает во внутренний буфер '''CSG (Constructive Solid Geometry)''' информацию объекта <code>''&lt;Object&gt;''</code>. Функция возвращает не имеющий литерального представления адрес памяти, по которому записана '''CSG''' информация объекта <code>''&lt;Object&gt;''</code>.


<code>Object '''SetCsg'''(object ''&lt;Object&gt;'', void ''&lt;CSG&gt;'')</code>

Функция приписывает объекту <code>''&lt;Object&gt;''</code> '''CSG (Constructive Solid Geometry)''' информацию, записанную в памяти по адресу <code>''&lt;CSG&gt;''</code>. Функция возвращает ссылку на объект <code>''&lt;Object&gt;''</code>.

Пример: 
 objident last 1 obj1;
 objident last 2 obj2;
 csg=GetCsg(obj1);
 booloean sub obj1 obj2 done;
 obj1=SetCsg(obj1,csg);