Система логики приложения

In UNIGINE, you can implement application logic in the following ways:В UNIGINE вы можете реализовать логику приложения следующими способами:

• in C++ or C#На C++ или C#
• combining C++ or C# with UnigineScript — in this case, the execution sequence for each implemented method, corresponding to a certain stage of the application's life cycle (i.e., init(), update(), postUpdate(), etc.), is the following:
  1. UnigineScript functionUnigineScript function
  2. C++/C# methodC++/C# method
  UnigineScript functionC++/C# methodСочетая C++ или C# с UnigineScript - в данном случае последовательность выполнения для каждого реализованного метода, соответствующая определенному этапу жизненного цикла приложения (т.е.init(), update(), postUpdate()и т.д.) выглядит следующим образом:
  1. UnigineScript functionФункция UnigineScript
  2. C++/C# methodC++ / C# метод

The application logic has three basic components that have different lifetimes: Логика приложения состоит из трех основных компонентов, которые имеют разное время жизни:

• World logic. It takes effect only when the world is loaded. For projects that use UnigineScript only, the logic is written to the world script (each particular world can have its own script). A default script is created as a *.usc file named after your project at the project creation. Such files are stored in the data/ folder.
  For applications that use C++ AppWorldLogic.cpp is created, and for C# applications — AppWorldLogic.cs. These files are stored in the <your_project_folder>/source/ folder and stay loaded during the whole engine runtime. They have implemented methods to put your logic code inside. WorldLogic in C++/C# (unlike UnigineScript) works with every loaded world, so you can't assign a specific WorldLogic to a certain world. World logic. Существует только тогда, когда мир загружен. Для проектов, использующих только UnigineScript, логика записывается в скрипт мира (каждый мир может иметь свой собственный сценарий). Этот сценарий по умолчанию генерируется как файл *.usc, с именем вашего проекта при его создании. Такие файлы хранятся в папке data/.
  Для приложений, использующих C++, создается AppWorldLogic.cpp, а для приложений C# - AppWorldLogic.cs. Эти файлы хранятся в папке <your_project_folder>/source/ и остаются загруженным в течение всего времени работы движка. В них реализованы методы в которые вы можете поместить свой код. WorldLogic в C++/C# (в отличие от UnigineScript) работает с каждым загруженным миром, поэтому конкретный WorldLogic определенному миру назначить нельзя.
• System logic. It exists during the application life cycle. The logic is implemented in the default system script named unigine.usc and stored in the data/ folder of your project as the core.ung archive. You can put your logic in this file if you use UnigineScript only. You can also inherit SystemLogic class and implement your logic in C++ or C#. System logic. Существует в течение всего жизненного цикла приложения. Логика реализована в системном скрипте по умолчанию с именем unigine.usc и хранится в папке data/ вашего проекта в виде архива core.ung. Вы можете поместить свою логику в этот файл, если используете только UnigineScript. Вы также можете унаследовать класс SystemLogic и реализовать свою логику на C++ или C#.

• Editor logic. This component is to be used in case you need to implement your own Editor. It has more implemented methods providing you with clear understanding of the current Engine events (a node has been created, a property has been deleted, a material has been changed, etc.). You can inherit EditorLogic class and implement your logic in C++ or C#.
  Default UnigineScript logic for the Editor is loaded from the editor2/editor.usc file stored inside editor2.ung. You can override this UnigineScript logic file by creating a folder named editor2 in your data folder and putting there the editor.usc file with the following code (you can modify this script, but do not remove existing include lines as they are required for Editor operation):Editor logic. Этот компонент следует использовать в случае, если вам нужен собственный редактор. В нем реализовано больше методов, дающих вам четкое представление о текущих событиях Engine (создана нода, удалено свойство, изменен материал и т.д.). Вы можете унаследовать свой класс от класса EditorLogic и реализовать свою логику на C++ или C#.
  Логика UnigineScript по умолчанию для Редактора загружается из файла editor2/editor.usc, хранящегося внутри editor2.ung. Вы можете переопределить этот файл UnigineScript-логики, создав папку с именем editor2 внутри папки data и поместив туда файл editor.usc со следующим кодом (вы можете изменить этот скрипт, но не удаляйте существующие строки include, поскольку они необходимы для работы Редактора):

  editor.usc

  Исходный код

  #include <editor2/editor_tracker.h>
  #include <editor2/editor_video_grabber.h>
  
  int init() {
  	return 1;
  }
  
  int update() {
  	return 1;
  }
  
  int shutdown() {
  	return 1;
  }

  Примечание

  When you create a new C++ / C# project, it has already inherited World Logic class (AppWorldLogic), System Logic class (AppSystemLogic), and Editor Logic class (AppEditorLogic) with implemented methods to put your logic code inside. Когда вы создаете новый C++/C# проект, он уже имеет унаследованый класс логики мира ( AppWorldLogic ), класс системной логики (AppSystemLogic) и класс логики редактора (AppEditorLogic) с реализованными методами для помещения кода вашей логики.

If a project uses UnigineScript only, its execution sequence is strictly defined in scripts and cannot be modified.
If a project is created using C++ or C#, a programmer can control the execution sequence by manually calling Engine's init(), update(), postUpdate(), swap(), and shutdown() methods when required and add logic anywhere between these blocks, as shown in the C++ sample <UnigineSDK>/source/samples/Api/Render/Screenshot/Screenshot.cpp.Если в проекте используется только UnigineScript, то для него последовательность исполнения строго определена в скриптах и не может быть изменена.
Если проект создается с использованием C++ или C#, программист может контролировать последовательность выполнения, вручную вызывая методы Engine init(), update(), postUpdate(), swap() и shutdown(), когда это необходимо, и добавлять логику в любом месте между этими блоками, как показано в примере C++ <UnigineSDK>/source/samples/Api/Render/Screenshot/Screenshot.cpp.

If the World Logic is implemented in UnigineScript, it is loaded or unloaded at the same time as the world itself is loaded or unloaded. The World Logic implemented in C++/C# stays loaded during the whole UNIGINE engine runtime. The World Logic may use the following methods, which are available for both UnigineScript and C++/C#: Если логика мира реализована на UnigineScript, она загружается или выгружается одновременно с загрузкой или выгрузкой самого мира. Логика мира, реализованная на C++ / C#, остается загруженной в течение всего времени работы движка UNIGINE. World Logic может использовать следующие методы, доступные как для UnigineScript, так и для C++ / C#:

#include "AppWorldLogic.h"

AppWorldLogic::AppWorldLogic() {

}

AppWorldLogic::~AppWorldLogic() {

}

int AppWorldLogic::init() {

	return 1;
}

int AppWorldLogic::update() {

	return 1;
}

int AppWorldLogic::postUpdate() {

	return 1;
}

int AppWorldLogic::updatePhysics() {

	return 1;
}

int AppWorldLogic::shutdown() {

	return 1;
}

int AppWorldLogic::save(const Unigine::StreamPtr &stream) {
	UNIGINE_UNUSED(stream);
	return 1;
}

int AppWorldLogic::restore(const Unigine::StreamPtr &stream) {
	UNIGINE_UNUSED(stream);
	return 1;
}

init() function

Функция init()#

updateAsyncThread() function

Функция updateAsyncThread()#

In the updateAsyncThread() function, you can specify all logic functions you want to be called every frame independently of the rendering thread. This function does not block the Main Thread.В функции updateAsyncThread() вы можете указать все логические функции, которые вы хотите вызывать в каждом кадре независимо от потока рендеринга. Эта функция не блокирует основной поток.

Примечание

This function does not have protection locks, so it is not recommended to modify other components inside this function, unless you are absolutely sure, that these components won't be modified or removed elsewhere.Эта функция не имеет защитных блокировок, поэтому не рекомендуется изменять другие компоненты внутри этой функции, если вы не уверены, что эти компоненты не будут изменены или удалены где-либо еще.

updateSyncThread() function

Функция updateSyncThread()#

In the updateSyncThread() function, you can specify any parallel logic functions to be executed before the Update(). This function blocks the Main Thread until all calls are completed.В функции updateSyncThread() вы можете указать любые функции параллельной логики, которые будут выполняться перед Update(). Эта функция блокирует основной поток до тех пор, пока не будут завершены все вызовы.

Примечание

This function should be used to call only the API methods related to the current node: the node itself, its materials and properties.Эта функция должна использоваться для вызова только методов API, относящихся к текущей ноде: самой ноде, ее материалам и свойствам.

update() function

Функция update()#

postUpdate() function

Функция postUpdate()#

updatePhysics() function

Функция updatePhysics()#

swap() function

Функция swap()#

shutdown() function

Функция shutdown()#

save() and restore() functions

Функции save() и restore()#

Примечание

The basic recommended workflow is to have a single AppWorldLogic class to process all worlds in your project. However, you can split world-specific code between separate classes inherited from WorldLogic.Основной рекомендуемый подход - иметь один класс AppWorldLogic для обработки всех миров в вашем проекте. Однако вы можете разделить специфичный для мира код между отдельными классами унаследованными от WorldLogic.

The System Logic stays loaded during the whole UNIGINE Engine runtime. It may use the following methods, which are available for both UnigineScript and C++/C#: Системная логика остается загруженной в течение всего времени работы UNIGINE Engine. Могут использоваться следующие методы, доступные как для UnigineScript, так и для C++ / C#:

#include "AppSystemLogic.h"

AppSystemLogic::AppSystemLogic() {

}

AppSystemLogic::~AppSystemLogic() {

}

int AppSystemLogic::init() {
	return 1;
}

int AppSystemLogic::update() {
	return 1;
}

int AppSystemLogic::postUpdate() {
	return 1;
}

int AppSystemLogic::shutdown() {
	return 1;
}

init() function

Функция init()#

update() function

Функция update()#

postUpdate() function

Функция postUpdate()#

shutdown() function

Функция shutdown()#

This component is to be used in case you need to implement your own Editor. It has more implemented methods providing you with clear understanding of the current Engine events (a node has been created, a property has been deleted, a material has been changed, etc.).Этот компонент следует использовать в случае, если вам нужен собственный редактор. В нем реализовано больше методов, дающих вам четкое представление о текущих событиях Engine (создана нода, удалено свойство, изменен материал и т.д.).

The Editor Logic may use the following methods, which are available for both UnigineScript and C++/C#: Логика редактора может использовать следующие методы, доступные как для UnigineScript, так и для C++ / C#:

#include "AppEditorLogic.h"

AppEditorLogic::AppEditorLogic() {
	
}

AppEditorLogic::~AppEditorLogic() {
	
}

int AppEditorLogic::init() {
	return 1;
}

int AppEditorLogic::update() {
	return 1;
}

int AppEditorLogic::postUpdate() {
	return 1;
}

int AppEditorLogic::shutdown() {
	return 1;
}

int AppEditorLogic::worldInit() {
	return 1;
}

int AppEditorLogic::worldShutdown() {
	return 1;
}

int AppEditorLogic::worldSave() {
	return 1;
}

init() function

Функция init()#

update() function

Функция update()#

postUpdate() function

Функция postUpdate()#

shutdown() function

Функция shutdown()#

worldInit() function

Функция worldInit()#

worldShutdown() function

Функция worldShutdown()#

worldSave() function

Функция worldSave()#