应用逻辑系统

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 functionUnigineScript 函数
  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/ 文件夹中，并在整个引擎运行时保持加载状态。它已经实现了将逻辑代码放入其中的方法。
• 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 的默认系统脚本中实现，并作为 core.ung 存档存储在项目的 data/ 文件夹中。如果您只使用 UnigineScript，您可以将您的逻辑放在这个文件中。您还可以继承 SystemLogic 类并在 C++ 或 C# 中实现您的逻辑。 C++/C# 中的 WorldLogic（与 UnigineScript 不同）适用于每个加载的世界，因此您不能将特定的 WorldLogic 分配给某个世界。

• 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。如果您需要实现自己的编辑器，将使用此组件。 它有更多的实现方法，让您清楚地了解当前的引擎事件（节点已创建、属性已删除、材质已更改等）。你可以继承EditorLogic 类并在 C++ 或 C# 中实现您的逻辑。
  编辑器的默认 UnigineScript 逻辑从存储在 editor2.ung 中的 editor2/editor.usc 文件加载。 您可以通过在 data 文件夹中创建一个名为 editor2 的文件夹并将包含以下代码的 editor.usc 文件放在那里来覆盖此 UnigineScript 逻辑文件 （您可以修改此脚本，但不要删除现有的 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# 项目时，它已经继承了 World Logic 类（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() function#

updateAsyncThread() function

updateAsyncThread() function#

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() function#

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() function#

postUpdate() function

postUpdate() function#

updatePhysics() function

updatePhysics() function#

swap() function

swap() function#

shutdown() function

shutdown() function#

save() and restore() functions

save() and restore() functions#

注意

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() function#

update() function

update() function#

postUpdate() function

postUpdate() function#

shutdown() function

shutdown() function#

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.).如果您需要实现自己的编辑器，将使用此组件。 它有更多的实现方法，让您清楚地了解当前的引擎事件（节点已创建、属性已删除、材质已更改等）。

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() function#

update() function

update() function#

postUpdate() function

postUpdate() function#

shutdown() function

shutdown() function#

worldInit() function

worldInit() function#

worldShutdown() function

worldShutdown() function#

worldSave() function

worldSave() function#