Сцена#

class integro.scene.Scene2D(scene=None)#

Двумерная сцена.

Содержит набор двумерных слоев с пространственными данными, информацию о системе координат, другие метаданные и настройки отображения.

add_layer(mtype: Layer2DType, caption: str, source: str) → Layer2D | None#

Добавить новый слой на сцену. Если слой с таким названием уже существует, к его названию будет добавлен уникальный суффикс.

Parameters:

  • mtype (Layer2DType) – Тип слоя, одно из значений Layer2DType.

  • caption (str) – Название слоя.

  • source (str) – Путь к файлу/папке с данными либо строка подключения.

Returns:

Новый слой или None в случае ошибки.

Return type:

Layer2D or None

load(filename: str) → bool#

Загрузить сцену из файла по указанному пути.

Parameters:

filename (str) – Путь к файлу сцены с расширением “._sn”.

Return type:

True если сцена была сохранена или False в случае ошибки.

plot(size: float | int | Tuple[float, float] | Tuple[int, int] | None = None, pos: Tuple[float, float] | None = None, scale: float | Tuple[float, float] | None = None, zoom_factor: float | Tuple[float, float] | None = None, units: str = 'cm', ax: Any = None, **kwargs) → Any#

Нарисовать заданную область сцены используя библиотеку matplotlib.

Parameters:

  • size (float, pair of floats, optional) – Ширина и высота изображения в единицах units.

  • pos (pair of floats, optional) – Центр отображаемой области сцены. Если не задан, берется центр полного охвата сцены.

  • scale (float, pair of floats, optional) – Масштаб сцены. Если не задан, берется масштаб полного охвата сцены.

  • zoom_factor (float, pair of floats, optional) – Приближает сцену в zoom_factor раз.

  • units ({'cm', 'mm', 'px', 'in'}, default=SizeUnit.CM) – Единицы размера изображения, одно из значений SizeUnit.

  • ax (matplotlib.pyplot.Artist, optional) – График для рисования изображения сцены.

  • **kwargs – Дополнительные параметры для передачи matplotlib.pyplot.imshow.

Returns:

График для рисования matplotlib.

Return type:

matplotlib.pyplot.Axes

save(filename: str) → bool#

Сохранить сцену в файл по указанному пути. Если файл уже существует, он будет перезаписан.

Parameters:

filename (str) – Путь к файлу сцены с расширением “._sn”.

Return type:

True если сцена была загружена или False в случае ошибки.

property background: Color#

Цвет фона сцены.

property caption: str#

Название сцены.

property crs: str#

Система координат сцены (строка PROJ4).

property extent: Rect2D#

Экстент сцены.

property layers: Layer2DList#

Список слоев в сцене.

property margins: Margins2D#

Отступы сцены.

property viewer: Viewer2D#

Отображение сцены.

class integro.scene.Scene3D(scene=None)#

Трехмерная сцена.

Содержит набор трехмерных слоев с пространственными данными, информацию о системе координат, другие метаданные и настройки отображения.

add_layer(mtype: Layer3DType, caption: str, source: str) → Layer3D | None#

Добавить новый слой на сцену. Если слой с таким названием уже существует, к его названию будет добавлен уникальный суффикс.

Parameters:

  • mtype (Layer3DType) – Тип слоя, одно из значений Layer3DType.

  • caption (str) – Название слоя.

  • source (str) – Путь к файлу/папке с данными либо строка подключения.

Returns:

Новый слой или None в случае ошибки.

Return type:

Layer3D or None

load(filename: str) → bool#

Загрузить сцену из файла по указанному пути.

Parameters:

filename (str) – Путь к файлу сцены с расширением “._sс”.

Return type:

True если сцена была сохранена или False в случае ошибки.

save(filename: str) → bool#

Сохранить сцену в файл по указанному пути. Если файл уже существует, он будет перезаписан.

Parameters:

filename (str) – Путь к файлу сцены с расширением “._sс”.

Return type:

True если сцена была загружена или False в случае ошибки.

property caption: str#

Название сцены.

property crs: str#

Система координат сцены (строка PROJ4).

property extent: Rect3D#

Экстент сцены.

property layers: Layer3DList#

Список слоев в сцене.

property viewer: Viewer3D#

Отображение сцены.

class integro.scene.Layout(layout=None)#

Макет.

Содержит набор элементов макета, настройки страницы и другие метаданные.

add_layer(mtype: LayoutType, caption: str, source: str | None = None) → LayoutLayer | None#

Добавить новый элемент на макет. Если элемент с таким названием уже существует, к его названию будет добавлен уникальный суффикс.

Parameters:

  • mtype (LayoutType) – Тип элемента макета, одно из значений LayoutType.

  • caption (str) – Название слоя.

  • source (str, optional) – Путь к файлу/папке с данными либо строка подключения.

Returns:

Новый элемент макета или None в случае ошибки.

Return type:

LayoutLayer or None

load(filename: str) → bool#

Загрузить макет из файла по указанному пути.

Parameters:

filename (str) – Путь к файлу сцены с расширением “.lt”.

Return type:

True если сцена была сохранена или False в случае ошибки.

plot(size: float | int | Tuple[float, float] | Tuple[int, int] | None = None, units: str = 'cm', ax: Any = None, **kwargs) → Any#

Нарисовать макет используя библиотеку matplotlib.

Parameters:

  • size (float, pair of floats, optional) – Ширина и высота изображения в единицах units.

  • units ({'cm', 'mm', 'px', 'in'}, default=SizeUnit.CM) – Единицы размера изображения, одно из значений SizeUnit.

  • ax (matplotlib.pyplot.Artist, optional) – График для рисования изображения макета.

  • **kwargs – Дополнительные параметры для передачи matplotlib.pyplot.imshow.

Returns:

График для рисования matplotlib.

Return type:

matplotlib.pyplot.Axes

save(filename: str) → bool#

Сохранить макет в файл по указанному пути. Если файл уже существует, он будет перезаписан.

Parameters:

filename (str) – Путь к файлу сцены с расширением “._lt”.

Return type:

True если сцена была загружена или False в случае ошибки.

property caption: str#

Название макета.

property layers: LayoutLayerList#

Список элементов макета.

property page: LayoutLayer#

Страница макета.

property viewer#

Отображение макета.

class integro.scene.Margins2D(margins)#

Отступы сцены.

property bottom: int#

Нижний отступ в мм.

property left: int#

Левый отступ в мм.

property right: int#

Правый отступ в мм.

property top: int#

Верхний отступ в мм.

property visible: bool#

Использовать отступы.

class integro.scene.Layer2DList(scene)#

Список двумерных слоев.

add(mtype: Layer2DType, caption: str, source: str) → Layer2D | None#

Добавить новый слой. Если слой с таким названием уже существует, к его названию будет добавлен уникальный суффикс.

Parameters:

  • mtype (Layer2DType) – Тип слоя, допустимо одно из значений Layer2DType.

  • caption (str) – Название слоя.

  • source (str) – Путь к файлу/папке с данным либо строка подключения.

Returns:

Новый слой или None в случае ошибки.

Return type:

Layer2D or None

clear()#

Удалить все слои.

find(caption: str) → Layer2D | None#

Найти слой по названию.

Parameters:

caption (str) – Название слоя.

Returns:

Найденный слой или None если слоя с таким названием нет.

Return type:

Layer2D or None

get(index: int) → Layer2D#

Получить слой по индексу.

Parameters:

index (int) – Индекс слоя.

Returns:

Слой или None в случае ошибки.

Return type:

Layer2D or None

remove(item: str | int)#

Удалить слой по названию или индексу. Если индекс отрицательный удаляет слой начиная с конца списка.

Parameters:

item (str or int) – Название или индекс слоя.

property captions: List[str]#

Названия всех слоев.

property size: int#

Количество слоев.

class integro.scene.Layer3DList(scene)#

Список трехмерных слоев.

add(mtype: Layer3DType, caption: str, source: str) → Layer3D | None#

Добавить новый слой. Если слой с таким названием уже существует, к его названию будет добавлен уникальный суффикс.

Parameters:

  • mtype (Layer3DType) – Тип слоя, допустимо одно из значений Layer3DType.

  • caption (str) – Название слоя.

  • source (str) – Путь к файлу/папке с данным либо строка подключения.

Returns:

Новый слой или None в случае ошибки.

Return type:

Layer3D or None

clear()#

Удалить все слои.

find(caption: str) → Layer3D | None#

Найти слой по названию.

Parameters:

caption (str) – Название слоя.

Returns:

Найденный слой или None если слоя с таким названием нет.

Return type:

Layer3D or None

get(index: int) → Layer3D#

Получить слой по индексу.

Parameters:

index (int) – Индекс слоя.

Returns:

Слой или None в случае ошибки.

Return type:

Layer3D or None

remove(item: str | int)#

Удалить слой по названию или индексу. Если индекс отрицательный удаляет слой начиная с конца списка.

Parameters:

item (str or int) – Название или индекс слоя.

property captions: List[str]#

Названия всех слоев.

property size: int#

Количество слоев.

class integro.scene.LayoutLayerList(scene)#

Список слоев макета.

add(mtype: LayoutType, caption: str, source: str | None = None) → LayoutLayer | None#

Добавить новый слой. Если слой с таким названием уже существует, к его названию будет добавлен уникальный суффикс.

Parameters:

  • mtype (LayoutType) – Тип слоя, допустимо одно из значений Layer2DType.

  • caption (str) – Название слоя.

  • source (str, optional) – Путь к файлу/папке с данным либо строка подключения.

Returns:

Новый слой или None в случае ошибки.

Return type:

Layout or None

clear()#

Удалить все слои.

find(caption: str) → LayoutLayer | None#

Найти слой по названию.

Parameters:

caption (str) – Название слоя.

Returns:

Найденный слой или None если слоя с таким названием нет.

Return type:

Layout or None

get(index: int) → LayoutLayer#

Получить слой по индексу.

Parameters:

index (int) – Индекс слоя.

Returns:

Слой или None в случае ошибки.

Return type:

LayoutLayer or None

remove(item: str | int)#

Удалить слой по названию или индексу. Если индекс отрицательный удаляет слой начиная с конца списка.

Parameters:

item (str or int) – Название или индекс слоя.

property captions: List[str]#

Названия всех слоев.

property size: int#

Количество слоев.