Методы создания графиков

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

Упрощение

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

Модульная организация с помощью групп

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

Цвета в этой программе обозначают назначение каждой группы. Этот метод может использоваться для создания иерархии в любых разрабатываемых графических стандартах или шаблонах.
Группа функций (синий)
Группа входных данных (оранжевый)
Группа сценариев (зеленый)
Сведения об использовании групп см. в разделе Управление программой.

Эффективная разработка с помощью блоков кода

Иногда с помощью блока кода можно быстрее ввести число или метод узла, чем при поиске (Point.ByCoordinates, Number, String, Formula).
Блоки кода (узлы Code Blocks) можно использовать для настройки пользовательских функций в DesignScript, уменьшающих количество узлов в графике.

Примеры 1 и 2 выполняют одну и ту же функцию. Получилось значительно быстрее написать несколько строк кода, чем прибегать к функции поиска и добавлять каждый узел по отдельности. Кроме того, блок кода значительно меньше по объему.
Сценарий DesignScript, написанный с помощью блока кода
Аналогичная программа с использованием узлов
Сведения о работе с элементами Code Block см. в разделе Что такое Code Block.

Сжатие узла в код

Сложность графика можно уменьшить с помощью преобразования узла в код (Node to Code). При этом для набора простых узлов будет создан соответствующий сценарий DesignScript, состоящий из одного блока кода.
Функция «Узел для кодировки» позволяет** сжать код, не усложняя восприятие программы**.
Далее перечислены преимущества использования функции Node to Code.
- Простое сжатие кода в один редактируемый компонент.
- Упрощение значительной части графика.
- Удобство применения к мини-программам, которые редко редактируются.
- Возможность встраивания других типов блоков кода, таких как функции.
Ниже представлены недостатки использования функции Node to Code.
- Типовые имена ухудшают удобочитаемость.
- Сложность восприятия для других пользователей.
- Нет простого способа вернуться к визуальной версии программы.

Существующая программа
Блок кода, созданный с помощью функции Node to Code
Сведения о работе с функцией Node to Code см. в разделе Синтаксис DesignScript.

Гибкий доступ к данным с помощью функции List@Level

С помощью функции List@Level можно упростить график, заменив узлы List.Map и List.Combine, которые могут занимать значительное место рабочей области.
При построении логики узла List@Level работает быстрее**, чем List.Map/List.Combine**, так как предоставляет доступ к данным любого уровня в списке непосредственно с порта ввода узла.

Активировав функцию List@Level для входных данных списка CountTrue, можно проверить, сколько истинных значений и в каких списках возвращает функция BoundingBox.Contains. List@Level позволяет определить, с какого уровня данные будут подаваться на ввод. Работа с List@Level отличается гибкостью, эффективностью и более предпочтительна по сравнению с другими методами, где используются функции List.Map и List.Combine.
Подсчет истинных значений на 2 уровне списка.
Подсчет истинных значений на 3 уровне списка.
Сведения о работе с функцией List@Level см. в разделе Списки списков.

Обеспечение наглядности

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

Достижение визуальной целостности посредством выравнивания узлов

Чтобы уменьшить количество доработок после построения графика, попытайтесь сделать компоновку узлов удобочитаемой, периодически выравнивая их.
Если с графиком будут работать другие пользователи, убедитесь, что компоновка проводов и узлов имеет четкую логику.
Для упрощения выравнивания используйте функцию «Очистить компоновку узла», чтобы автоматически выровнять график (однако в таком случае точность будет меньше, чем при выравнивании вручную).

Неупорядоченный график
Выровненный график
Сведения об использовании функции выравнивания узлов см. в разделе Управление программой.

Использование описательных меток при переименовании

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

Входные данные для управления поверхностью
Входные данные архитектурных параметров
Входные данные в сценарии моделирования водоспуска
Чтобы переименовать узел, щелкните его имя правой кнопкой мыши и выберите «Переименовать узел...».

Разъяснения в примечаниях

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

Примечание, описывающее часть программы, которая возвращает примерные расстояния переноса.
Примечание, описывающее код, который сопоставляет эти значения с синусоидальной волной.
Сведения о том, как добавить примечание, см. в разделе Управление программой.

Зондирование на всех этапах работы

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

Мониторинг данных с помощью марок наблюдения (Watch) и предварительного просмотра (Preview)

При создании программы используйте марки Watch и Preview, чтобы** убедиться в правильности ключевых выходных данных**.

Узлы Watch используются для сравнения следующих данных:
примерные расстояния переноса;
значения, проходящие через уравнение синусоиды.
Сведения о работе с узлом Watch см. в разделе Библиотека.

Повторное использование

Весьма вероятно, что рано или поздно вашу программу откроет другой пользователь, даже если вы работаете самостоятельно. На основе входных и выходных данных этому пользователю нужно будет быстро понять, что требуется для работы программы и каковы результаты этой работы. Это особенно важно при разработке пользовательских узлов, которые будут применяться сообществом Dynamo и добавляться в программы других разработчиков. Следующие рекомендации помогут создавать надежные, многократно используемые программы и узлы.

Управление вводом/выводом

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

Использование наборов параметров при добавлении входных значений

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

Сведения о работе с набором параметров см. в разделе Управление данными с помощью наборов параметров.

Упаковка программ с пользовательскими узлами в контейнеры

Пользовательский узел применяется, если программу можно объединить в одном контейнере.
Еще пользовательский узел применяется, если часть графика будет повторно использоваться в других программах.
И, наконец, пользовательский узел применяется, если необходимо сделать функцию доступной сообществу Dynamo.

Если собрать программу преобразования точек в пользовательский узел, получится более надежная и оригинальная переносная программа, в которой легко разобраться. Правильно обозначенные порты ввода помогут другим пользователям понять, как применять узел. Не забудьте добавить описания и требуемые типы данных для каждого входного элемента.
Существующая программа точки притяжения
Пользовательский узел для размещения программы, PointGrid
Сведения о работе с пользовательскими узлами см. в разделе Введение в пользовательские узлы.

Создание шаблонов

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

Пользовательский интерфейс (внешняя часть программы). Включает в себя имя проекта, регуляторы ввода и импортируемую геометрию.
Внутренняя часть программы.
Цветовые категории групп (проект в целом, входные данные, сценарии на языке Python, импортированная геометрия).

Упражнение «Архитектурная крыша»

Скачайте файл примера, щелкнув указанную ниже ссылку.
Полный список файлов примеров можно найти в приложении.

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

Программа работает, но график не структурирован.

Начните с определения данных и геометрии, возвращаемых программой.

Чтобы создать логические разделы или модули, очень важно понимать, когда данные подвергаются наибольшим изменениям. Перед переходом к следующему шагу попробуйте проверить остальную часть программы с помощью узлов Watch, чтобы убедиться в возможности определить группы.
Этот узел Code Block с математическим уравнением выглядит как ключевая часть программы. Узел Watch возвращает списки расстояний переноса.
Назначение этой области не очевидно. Расположение истинных значений на уровне списка L2 из BoundingBox.Contains и наличие List.FilterByBoolMask говорит о том, что это выборка части из сетки точек.

Разобравшись в компонентах программы, разделите их на группы.

Группы позволяют визуально дифференцировать компоненты программы.
Импорт 3D-модели площадки
Преобразование сетки точек на основе уравнения синусоиды
Выборка части из сетки точек
Создание поверхности архитектурной крыши
Создание стеклянного витража

После определения групп выровняйте узлы, чтобы обеспечить визуальную целостность графика.

Визуальная целостность позволяет видеть ход выполнения программы и скрытые взаимосвязи между узлами.

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

Благодаря этим улучшениям графического интерфейса пользователи лучше поймут назначение этой программы. Различные цвета групп позволяют отличать входные данные от функций.
Примечания
Входные данные с описательными именами

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

Сценарий встраивается в эту часть программы, чтобы можно было запустить моделирование водоспуска на одной исходной поверхности крыши. Данная поверхность не отображается в области предварительного просмотра, но при этом не нужно выбирать верхнюю поверхность на сложной поверхности с фаской.
Исходная геометрия для входных данных сценария
Узел Python
Регуляторы ввода
Переключатель вкл./откл.

Упростите график, чтобы расставить все по местам.

Сжатие программы с помощью функций Node to Code и Custom Node привело к значительному уменьшению размера графика. Группы, отвечающие за создание поверхности крыши и стен, преобразованы в код, так как характерны только для данной программы. Группа преобразования точек содержится в пользовательском узле, так как ее можно использовать в другой программе. Создайте в файле примера собственный пользовательский узел из группы преобразования точек.
Пользовательский узел для размещения группы «преобразование сетки точек»
Функция Node to Code для сжатия групп «Создание поверхности архитектурной крыши и виража»

В завершение создайте наборы параметров для образцов формы крыши.