Работа с компонентами в Редакторе

First, open your project in an IDE (Microsoft Visual Studio is recommended) - go to SDK Browser and choose Open Code IDE on your project's card.Первым делом, откройте код вашего проекта в IDE (рекомендуется использовать Microsoft Visual Studio) - переключитесь в SDK Browser и щелкните Open Code IDE на карточке вашего проекта.

In an IDE create a new C++ class (Project → Add Class) and call it MyComponent.В IDE создайте новый C++ класс (Project → Add Class) и назовите его MyComponent.

Make sure it inherits from the ComponentBase class. You can build a whole hierarchy using your own components, by inheriting some components from others in accordance with the OOP principles (we'll review this in detail later).Убедитесь, что он отнаследован от базового класса ComponentBase. Из своих компонентов вы можете построить целую иерархию, наследуя одни компоненты от других – все в соответствии с принципами ООП (об этом чуть позже).

Two files*.h and *.cpp will be added to your C++ project.К вашему C++ проекту будет добавлено два файла (*.h и *.cpp).

Header File (*.H)

Заголовочный файл (*.H)#

Implementation File (*.CPP)

Файл реализации (*.CPP)#

We'll make a simple component that will rotate a node to which it is assigned every frame at a certain angle. Summarizing all the things above we can make our component look like it is shown below. You can copy the code, paste it to the corresponding files in your project and save them in your IDE.Напишем простой компонент, который каждый кадр будет поворачивать ноду, на которую он назначен, на определенный угол. Собирая воедино все вышесказанное, получим приведенный ниже код компонента. Его можно скопировать и вставить в соответствующие файлы вашего проекта в IDE и сохранить изменения.

#pragma once
// include the ComponentSystem header
#include <UnigineComponentSystem.h>
class MyComponent :
	public Unigine::ComponentBase
{
	// Объявляем конструктор и деструктор для нашего класса, а также задаем имя связанного с компонентом свойства (property). 
	// Файл MyComponent.prop со всеми описанными ниже параметрами будет сгенерирован Компонентной системой в папке 'data' вашего проекта при первом запуске приложения
	COMPONENT_DEFINE(MyComponent, Unigine::ComponentBase);

	// объявляем параметры компонента и задаем начальные значения
	PROP_PARAM(Float, angle, 10.0f, "Angle", "Node rotation angle", 0, "max=360;min=0");

	// регистрация методов, которые будут вызываться на соответствующих этапах жизненного цикла приложения (сами методы объявляются в protected-блоке ниже)
	COMPONENT_UPDATE(update);

protected:
	// объявление методов, которые будут вызываться на соответствующих этапах жизненного цикла приложения
	void update();
};

#include "MyComponent.h"
// Регистрация компонента MyComponent в Компонентной системе
REGISTER_COMPONENT(MyComponent);
using namespace Unigine;
using namespace Math;

// метод, который будет вызываться каждый кадр
void MyComponent::update()
{
	// поворачиваем объект вокруг оси Z на угол, заданный параметром (Angle) 
	node->rotate(0.0f, 0.0f, angle);
}

Don't forget to set the appropriate platform and configuration settings for your project before compiling your code in Visual Studio.Не забудьте выбрать нужную конфигурацию сборки для своего проекта прежде, чем запускать компиляцию в Visual Studio.

Build and run your application by hitting Ctrl + F5 to make the Component System register the component and generate an associated property with the corresponding set of parameters (according to your component's class declaration) to be used to assign the component to nodes. Close the application after running it and switch to UnigineEditor.Соберите и запустите свое приложение, нажав Ctrl + F5, чтобы Компонентная система зарегистрировала компонент и сгенерировала ассоциированное свойство (property) с соответствующим набором параметров (согласно определению класса компонента), которое будет использоваться для связи компонента с нодами. После запуска приложения закройте его и вернитесь в UnigineEditor.

After successful registration all available properties associated with your C++ components are displayed in the Properties window as children of the basic node_base property.После успешной регистрации компонент, все доступные свойства (property) ассоциированные с вашими C++ компонентами появятся в окне Properties как дочерние элементы базового свойства node_base.

The component is ready, but now it must be assigned to some node, otherwise its code won't be executed. Decide which object you want to rotate (e.g. Material Ball), drag the property (MyComponent.cpp) from the Properties hierarchy and drop onto this object (you can drop it on the object directly in the viewport or on the node in the World Nodes window).Компонент готов, но его еще нужно назначить на ноду, чтобы его код начал работать. Определите, какой объект вы хотите повращать (например, пусть это будет Material Ball из стандартного мира), перетащите свойство MyComponent.cpp из иерархии Properties прямо на этот объект (либо непосредственно во вьюпорте, либо в окне иерархии сцены World Nodes).

In the Parameters window set the desired Angle value with a slider and save the world by hitting Ctrl + S.В окне Parameters при помощи слайдера установите желаемое значение угла (Angle) и сохраните изменения в мире, нажав Ctrl + S.

// так:
ComponentSystem::get()->addComponent<MyComponent>(node);
// или вот так (через назначение свойства ассоциированного с компонентом):
node->addProperty("mycomponent_prop_name");

Now, we're ready to launch our application via the SDK Browser by selecting the project on the Projects tab and clicking Run. But before doing so let's make sure, that appropriate Customize Run Options (Debug version in our case) are selected, by clicking an ellipsis under the Run button (check Debug and Remember then click Run).Теперь мы готовы запустить наше приложение через SDK Browser, выбрав карточку проекта в списке на вкладке Projects и нажав Run. Но, прежде чем мы это сделаем, давайте установим конфигурацию запуска в окне Customize Run Options (включим версию Debug в нашем случае), для этого щелкнем на многоточие рядом с кнопкой Run (отметьте Debug и Remember, чтобы запомнить настройки, а затем щелкните Run).

The Microsoft Visual Studio environment is known for its excellent debugging tools. You can test the source code of C++ components while your application is running, whether the application is launched via the SDK Browser or created and running from the IDE.Среда Microsoft Visual Studio известна своими отличными инструментами отладки. Можно проверить исходный код компонентов C# во время работы вашего приложения, независимо от того, запущено ли приложение через SDK Browser (Attach) или создано и запущено из IDE.

Now you can add the necessary breakpoints and just press F5 to start the debugging process.Теперь вы можете добавить необходимые точки останова и просто нажать F5, чтобы запустить процесс отладки.

At startup, the application will run with the world set for your project in SDK Browser at creation. If the default world is not set, you will see a black screen after launching the app. In this case, you can open the console (press "~" on the keyboard) and load the desired world using the world_load <world_name> console command.При запуске приложение будет работать с миром, установленным для вашего проекта Браузером SDK при создании. Если мир по умолчанию не установлен, после запуска приложения вы увидите черный экран. В этом случае вы можете открыть консоль (нажмите "~" на клавиатуре) и загрузить желаемый мир с помощью консольной команды: world_load <имя_мира>.

Breakpoints are used to pause your application by stopping execution of your code and giving you a chance to inspect and analyze your program's operation. You can check values of variables, and move step-by-step through your code.Точки останова используются для приостановки вашего приложения, выполнение вашего кода прерывается и вы получаете возможность проверить и проанализировать работу своей программы. Вы можете проверять значения переменных и двигаться по коду по шагам.

To set up a breakpoint put the cursor to the desired line of your code and press F9 or use the menu.Чтобы установить точку останова, поместите курсор на нужную строку вашего кода и нажмите F9 или используйте меню.