Проект

class integro.Project(project=None)

Проект ГИС Integro.

Содержит набор тематически связанных элементов, таких как двумерные и трехмерные сцены, корреляции и планшеты, макеты.

Можно создать пустой проект, загрузить из файла уже существующий или получить текущий проект открытый в приложении (только внутри консоли).

See also

load_project

Загрузить проект.

current_project

Получить текущий проект.

add_layout(caption: str) → Layout | None

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

Parameters:

caption (str) – Название макета.

Returns:

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

Return type:

Layout or None

add_scene2d(caption: str) → Scene2D | None

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

Parameters:

caption (str) – Название сцены.

Returns:

Новая сцена или None в случае ошибки.

Return type:

Scene2D or None

add_scene3d(caption: str) → Scene3D | None

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

Parameters:

caption (str) – Название сцены.

Returns:

Новая сцена или None в случае ошибки.

Return type:

Scene3D or None

load(filename: str) → bool

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

Parameters:

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

Returns:

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

Return type:

bool

See also

load_project

Загрузить проект.

save() → bool

Сохранить проект.

Returns:

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

Return type:

bool

save_as(filename: str) → bool

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

Parameters:

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

Returns:

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

Return type:

bool

property caption: str

Название проекта.

property correlations: Scene2DList

Список корреляций в проекте.

property layouts: LayoutList

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

property scenes2d: Scene2DList

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

property scenes3d: Scene3DList

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

property source: str

Путь к файлу проекта.

property wells: Scene2DList

Список планшетов в проекте.

class integro.Scene2DList(scenes)

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

add() → Scene2D | None

Добавить новую сцену в конец списка.

Returns:

Новая сцена или None в случае ошибки.

Return type:

Scene2D or None

clear()

Удалить все сцены из списка.

find(caption: str) → Scene2D | None

Найти сцену по названию.

Parameters:

caption (str) – Название сцены.

Returns:

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

Return type:

Scene2D or None

get(index: int) → Scene2D | None

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

Parameters:

index (int) – Индекс сцены.

Returns:

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

Return type:

Scene2D or None

remove(item: str | int)

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

Parameters:

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

property captions: List[str]

Список названий всех сцен.

property size: int

Количество сцен в списке.

class integro.Scene3DList(scenes)

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

add() → Scene3D | None

Добавить новую сцену в конец списка.

Returns:

Новая сцена или None в случае ошибки.

Return type:

Scene3D or None

clear()

Удалить все сцены из списка.

find(caption: str) → Scene3D | None

Найти сцену по названию.

Parameters:

caption (str) – Название сцены.

Returns:

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

Return type:

Scene3D or None

get(index: int) → Scene3D | None

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

Parameters:

index (int) – Индекс сцены.

Returns:

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

Return type:

Scene3D or None

remove(item: str | int)

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

Parameters:

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

property captions: List[str]

Список названий всех сцен.

property size: int

Количество сцен в списке.

class integro.LayoutList(layouts)

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

add() → Layout | None

Добавить новый макет в конец списка.

Returns:

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

Return type:

Layout or None

clear()

Удалить все макеты из списка.

find(caption: str) → Layout | None

Найти макет по названию.

Parameters:

caption (str) – Название макета

Returns:

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

Return type:

Layout or None

get(index: int) → Layout | None

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

Parameters:

index (int) – Индекс макета.

Returns:

Макет или None в случае ошибки.

Return type:

Layout or None

remove(item: str | int)

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

Parameters:

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

property captions: List[str]

Список названий всех макетов.

property size: int

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

integro.load_project(filename: str) → Project | None

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

Parameters:

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

Returns:

Загруженный проект или None в случае ошибки.

Return type:

Project or None

integro.load_scene2d(filename: str) → Scene2D | None

Загрузить двумерную сцену по указанному пути.

Parameters:

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

Returns:

Загруженная сцена или None в случае ошибки.

Return type:

Scene2D or None

integro.load_scene3d(filename: str) → Scene3D | None

Загрузить трехмерную сцену по указанному пути.

Parameters:

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

Returns:

Загруженная сцена или None в случае ошибки.

Return type:

Scene3D or None

integro.load_layout(filename: str) → Layout | None

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

Parameters:

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

Returns:

Загруженный макет или None в случае ошибки.

Return type:

Layout or None