Class Project(studio)

class edit_db.project

level = „studio“

Данные хранимые в БД (имя столбца : тип данных) edit_db.studio.projects_keys:

projects_keys = {
'name': 'text',
'path': 'text',
'status': 'text',
'project_database': 'json',
'chat_img_path': 'text',
'list_of_assets_path': 'text',
'preview_img_path': 'text',
'fps': 'real',
'units': 'text',
}

Examples

Создание экземпляра класса:

import edit_db as db

project = db.project()
name

Имя проекта (уникально)

Type:str
path

Путь до директории проекта.

Type:str
status

Теущий статус проекта, значение из списка edit_db.studio.PROJECTS_STATUSES.

Type:str
project_database

Параметры используемой базы данных, по умолчанию: ['sqlite3', False].

Type:list
chat_img_path

Путь до директории с картинками чата.

Type:str
list_of_assets_path

Путь до файла с временными данными создаваемых ассетов.

Type:str
preview_img_path

Путь до директории с превью картинок чата.

Type:str
fps

fps проекта (по умолчанию 24).

Type:float
units

Юниты 3d сцен, значение из списка: edit_db.studio.PROJECTS_UNITS по умолчанию 'm'.

Type:str
list_active_projects

атрибут класса Список активных проектов, только имена. Заполняется при выполнении метода edit_db.project.get_list(), значение по умолчанию - [].

Type:list
list_projects

атрибут класса Список всех проектов (экземпляры). Заполняется при выполнении метода edit_db.project.get_list(), значение по умолчанию - [].

Type:list
dict_projects

атрибут класса Cловарь содержащий все проекты (экземпляры) с ключами по именам. Заполняется при выполнении метода edit_db.project.get_list(), значение по умолчанию - {}.

Type:dict
folders

атрибут класса Служебные директории папки проекта.

Type:dict
add_project(name, path)

Создаёт проект согласно Make Project

Примечание

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

Параметры:
  • name (str) – имя проекта, если имя не указано, но указана директория, проект будет назван именем директории
  • path (str) – путь к директории проекта, если путь не указан, директория проекта будет создана в директории студии
Результат:

(True, „Ok!“) или (False, comment)
Тип результата:

tuple
change_fps(fps)
  • Изменение fps проекта, предполагается автоматическое назначение этого параметра в сценах.
  • Перезаписывается edit_db.studio.PROJECT_SETTING
Параметры:fps (float) – fps
Результат:(True, „Ok!“) или (False, comment)
Тип результата:tuple
change_units(units)
  • Изменение юнитов проекта, параметр для 3d сцен (предполагается автоматическое назначение этого параметра в сценах).
  • Перезаписывается edit_db.studio.PROJECT_SETTING
Параметры:units (str) – юниты для 3d сцен, значение из edit_db.studio.PROJECTS_UNITS
Результат:(True, „Ok!“) или (False, comment)
Тип результата:tuple
edit_status(status)

Изменение статуса проекта.

Параметры:status (str) – присваиваемый статус, должен быть из списка edit_db.studio.PROJECTS_STATUSES
Результат:(True, „Ok!“) или (False, comment)
Тип результата:tuple
get_list()

Заполняет атрибуты класса:

Результат:(True, edit_db.project.list_projects) или (False, comment)
Тип результата:tuple
init(name, new=True)

Инициализация по имени, возвращает новый, или инициализирует текущий экземпляр.

Параметры:
  • name (str) – имя проекта.
  • new (bool) – если True - возвращает новый инициализированный экземпляр, если False то инициализирует текущий экземпляр
Результат:

  • если new= True - экземпляр класса edit_db.project,
  • если new= False - (True, „Ok!“) или (False, comment)
Тип результата:

edit_db.project, tuple
init_by_keys(keys, new=True)

Инициализация по словарю (без чтения БД), возвращает новый, или инициализирует текущий экземпляр.

Параметры:
  • keys (dict) – словарь по edit_db.studio.projects_keys
  • new (bool, optional) – если True - возвращает новый инициализированный экземпляр, если False то инициализирует текущий.
Результат:

  • если new= True - экземпляр класса edit_db.project,
  • если new= False - (True, „Ok!“) или (False, comment)
Тип результата:

edit_db.project, tuple
remove_project()
  • удаляет проект из БД (не удаляя файловую структуру),
  • приводит экземпляр к сосотоянию empty (все поля по edit_db.studio.projects_keys = False).
Результат:(True, „Ok!“) или (False, comment)
Тип результата:tuple
rename_project(new_name)
  • переименование проекта (данного экземпляра),
  • заполняются поля экземпляра,
  • перезаписывается edit_db.studio.PROJECT_SETTING
Параметры:new_name (str) – новое имя отдела.
Результат:(True, „Ok!“) или (False, comment)
Тип результата:tuple