Unigine.VRMixedReality Class
The class is used for mixed reality management in Varjo devices.Класс используется для управления смешанной реальностью в устройствах Varjo.
VRMixedReality Class
Перечисления (Enums)
BLEND_MASKING_MODE#
CAMERA_PROPERTY_MODE#
CAMERA_EXPOSURE_TIME#
CAMERA_WHITE_BALANCE#
CAMERA_ISO#
CAMERA_FLICKER_COMPENSATION#
CUBEMAP_MODE#
| Имя | Описание |
|---|---|
| BEGIN = 0 | The first element to be used for iteration.Первый элемент, который будет использоваться для итерации. |
| DISABLED = 0 | The cubemap streaming from AR cameras is disabled.Потоковая передача cubemap с камер дополненной реальности отключена. |
| ENVIRONMENT_OVERLAP = 1 | The environment texture substitutes the sky.Текстура окружающей среды заменяет небо. |
| ENVIRONMENT_PRESET_0 = 2 | The first environment preset defines the way the AR texture is set for the environment.Первая предустановка среды определяет способ настройки текстуры AR для среды. |
| ENVIRONMENT_PRESET_1 = 3 | The second environment preset defines the way the AR texture is set for the environment.Вторая предустановка среды определяет способ настройки текстуры AR для среды. |
| ENVIRONMENT_PRESET_2 = 4 | The third environment preset defines the way the AR texture is set for the environment.Третья предустановка среды определяет способ настройки текстуры AR для среды. |
| END = 4 | The last element to be used for iteration.Последний элемент, который будет использоваться для итерации. |
OVERRIDE_COLOR_CORRECTION_MODE#
Свойства
bool ChromaKeyEnabled#
Console: vr_mixed_reality_chroma_key_enabled
value indicating if chroma keying is enabled. VST capturing from HMD cameras must be enabled.значение, указывающее, включена ли цветовая манипуляция. Должна быть включена запись VST с камер HMD.bool DepthTestEnabled#
Console: vr_mixed_reality_depth_test_enabled
value indicating if depth buffer submission is enabled. VST capturing from HMD cameras must be enabled.значение, указывающее, включена ли отправка буфера глубины. Должна быть включена запись VST с камер HMD.bool AlphaBlendEnabled#
Console: vr_mixed_reality_alpha_blend_enabled
value indicating if alpha blending is enabled. This option is used for blending VR and AR images using the alpha channel. VST capturing from HMD cameras must be enabled and the screen precision must be 1.значение, указывающее, включено ли альфа-смешивание. Эта опция используется для смешивания изображений виртуальной и дополненной реальности с использованием альфа-канала. Запись VST с камер HMD должна быть включена, а точность отображения должна быть равна 1.bool VideoEnabled#
Console: vr_mixed_reality_video_enabled
value indicating if the video signal from the real-world view from the front-facing HMD-mounted cameras is enabled. The real-world view is used for combining virtual and real-world elements to create an immersive experience in mixed reality.значение, указывающее, включен ли видеосигнал реального изображения с фронтальных камер, установленных на HMD. Изображение реального мира используется для объединения элементов виртуального и реального мира для создания эффекта погружения в смешанную реальность.bool DepthTestRangeEnabled#
value indicating if the depth test range usage is enabled. Use the depth test range (Depth Test Near Z, Depth Test Far Z) to control the range for which the depth test is evaluated.значение, указывающее, включено ли использование диапазона проверки глубины. Используйте диапазон проверки глубины (Depth Test Near Z, Depth Test Far Z) для управления диапазоном, для которого оценивается тест глубины.vec2 DepthTestRange#
Console: vr_mixed_reality_depth_test_range
depth test range as a two-component vector (the near and far planes). The depth test range usage must be enabled.диапазон измерения глубины в виде двухкомпонентного вектора (ближняя и дальняя плоскости). Необходимо включить использование диапазона измерения глубины.vec2(0.0f, 1.0f) - значение по умолчанию
int ChromaKeyConfigNum#
number of chroma key config indices supported. The maximum index will be count-1.количество поддерживаемых индексов конфигурации цветового ключа. Максимальный индекс будет равен count-1.VRMixedReality.BLEND_MASKING_MODE BlendMaskingMode#
Console: vr_mixed_reality_blend_masking_mode
mode of the Blend Control Mask that can be used to extend or restrict the chroma key mask or to control the depth testing against the estimated video depth.режим Blend Control Mask, который можно использовать для расширения или ограничения маски цветности или для управления тестированием глубины по сравнению с расчетной глубиной видео.- 0 - Отключено (режим маскировки отключен). (по умолчанию)
- 1 - Ограничить видео маской (показывать сквозное изображение видео (VST) в маске; можно использовать с цветовой клавишей)
- 2 - Ограничить VR маской (показывать VR в маске; можно использовать с цветовой клавишей)
- 3 - Ограничить VR хромакеем, уменьшенным по маске (показывать VR в маске и цветность в другом месте; требуется цветовой ключ)
bool BlendMaskingDebugEnabled#
value indicating if blend masking debug visualization is enabled. The blend masking mode must be enabled.значение, указывающее, включена ли визуализация отладки с маскировкой наложения. Должен быть включен режим маскировки наложением.bool IsBlendMaskingUsed#
value indicating if the Blend Control Mask is used to extend or restrict the chroma key mask or to control the depth testing against the estimated video depth.значение, указывающее, используется ли Blend Control Mask для расширения или ограничения маски цветности или для управления тестированием глубины по сравнению с расчетной глубиной видео.Texture CurrentBlendMaskColorBuffer#
image representing the current color buffer of the Blend Control Mask.изображение, представляющее текущий цветовой буфер Blend Control Mask.double CameraExposureTimeRaw#
exposure time value for the camera.значение времени экспозиции для камеры.VRMixedReality.CAMERA_EXPOSURE_TIME CameraExposureTime#
exposure time value that is valid for the connected device.значение времени экспозиции, действительное для подключенного устройства.VRMixedReality.CAMERA_PROPERTY_MODE CameraExposureTimeMode#
exposure adjustment mode for the camera.режим настройки экспозиции для фотокамеры.- 0 - регулировка экспозиции отключена
- 1 - автоматическая регулировка экспозиции (по умолчанию)
- 2 - ручная регулировка экспозиции
int CameraWhiteBalanceRaw#
white balance correction value that is valid for the connected device.значение коррекции баланса белого, действительное для подключенного устройства.VRMixedReality.CAMERA_WHITE_BALANCE CameraWhiteBalance#
white balance correction value that is valid for the connected device.значение коррекции баланса белого, действительное для подключенного устройства.VRMixedReality.CAMERA_PROPERTY_MODE CameraWhiteBalanceMode#
white balance adjustment mode for the camera.режим настройки баланса белого для фотокамеры.- 0 - регулировка баланса белого отключена
- 1 - автоматическая регулировка баланса белого (по умолчанию)
- 2 - ручная регулировка баланса белого
int CameraISORaw#
ISO value that is valid for the connected device.Значение ISO, действительное для подключенного устройства.VRMixedReality.CAMERA_ISO CameraISO#
Console: vr_mixed_reality_camera_iso
ISO value for the camera.Значение ISO для камеры.VRMixedReality.CAMERA_PROPERTY_MODE CameraISOMode#
Console: vr_mixed_reality_camera_iso_mode
ISO adjustment mode for the camera.Режим настройки ISO для камеры.- 0 - Настройка ISO отключена
- 1 - автоматическая настройка ISO (по умолчанию)
- 2 - ручная настройка ISO
int CameraFlickerCompensationRaw#
flicker compensation value for the camera. This is useful when using the HMD indoors with mostly artificial light bulbs, which flicker at the frequency of 50Hz or 60Hz and can cause visual flicker artifacts on the video see through image. The correct setting depends on the underlying power grid's frequency. For example, in most parts of Africa/Asia/Australia/Europe the frequency is 50 Hz and in most parts of North and South America 60 Hz.значение компенсации мерцания для камеры. Это полезно при использовании HMD в помещении, где в основном используются лампы искусственного освещения, которые мерцают с частотой 50 Гц или 60 Гц и могут вызывать визуальные артефакты мерцания на прозрачном изображении видео. Правильная настройка зависит от частоты базовой электросети. Например, в большинстве районов Африки/Азии/Австралии/Европы частота составляет 50 Гц, а в большинстве районов Северной и Южной Америки - 60 Гц.VRMixedReality.CAMERA_FLICKER_COMPENSATION CameraFlickerCompensation#
flicker compensation value for the camera. This is useful when using the HMD indoors with mostly artificial light bulbs, which flicker at the frequency of 50Hz or 60Hz and can cause visual flicker artifacts on the video see through image. The correct setting depends on the underlying power grid's frequency. For example, in most parts of Africa/Asia/Australia/Europe the frequency is 50 Hz and in most parts of North and South America 60 Hz. значение компенсации мерцания для камеры. Это полезно при использовании HMD в помещении, где в основном используются лампы искусственного освещения, которые мерцают с частотой 50 Гц или 60 Гц и могут вызывать визуальные артефакты мерцания на прозрачном изображении видео. Правильная настройка зависит от частоты базовой электросети. Например, в большинстве районов Африки/Азии/Австралии/Европы частота составляет 50 Гц, а в большинстве районов Северной и Южной Америки - 60 Гц.int CameraMinSharpness#
minimum possible value for the camera sharpness.минимально возможное значение для резкости камеры.int CameraMaxSharpness#
maximum possible value for the camera sharpness.максимально возможное значение для резкости камеры.int CameraSharpness#
Console: vr_mixed_reality_camera_sharpness
sharpness filter power value for the camera.значение мощности фильтра резкости для камеры.Диапазон значений: [0, 10]. Значение по умолчанию : 0.
float ViewOffset#
Console: vr_mixed_reality_view_offset
eyes view offset (where eye camera should be positioned when using Mixed Reality):
- 0 for physical eye position0 for physical eye position
- 1 for VST camera position1 for VST camera position
- 0 for physical eye position 0 для физического положения глаз
- 1 for VST camera position 1 для положения камеры VST
Диапазон значений: [0.0, 1.0]. Значение по умолчанию : 0.0.
bool MarkerTrackingEnabled#
value indicating if marker tracking is enabled.значение, указывающее, включено ли отслеживание маркера.short NumMarkerObjectVisible#
number of visible marker objects.количество видимых объектов-маркеров.VRMixedReality.CUBEMAP_MODE CubemapMode#
Console: vr_mixed_reality_cubemap_mode
mode defining the way the AR texture is set for the environment.режим, определяющий способ настройки текстуры AR для окружающей среды.- 0 - потоковая передача cubemap с камер дополненной реальности отключена.
- 1 - текстура окружающей среды заменяет небо.
- 2 - первая предустановка среды определяет способ настройки текстуры AR для среды. (по умолчанию)
- 3 - вторая предустановка окружения определяет способ настройки текстуры AR для окружения.
- 4 - третья предустановка среды определяет способ настройки текстуры AR для среды.
Render.GGX_MIPMAPS_QUALITY CubemapGGXQuality#
Console: vr_mixed_reality_cubemap_ggx_quality
quality of the generated GGX mips for the AR cubemap.качество сгенерированных GGX mips для AR cubemap.- 0 - низкий
- 1 - средний (по умолчанию)
- 2 - высокий
- 3 - крайне
VRMixedReality.OVERRIDE_COLOR_CORRECTION_MODE OverrideColorCorrectionMode#
color correction mode for the stream from the AR cameras.режим цветокоррекции для потока с камер дополненной реальности.- 0 - коррекция отключена. (по умолчанию)
- 1 - коррекция экспозиции для потока с камер дополненной реальности.
- 2 - коррекция экспозиции и баланса белого для потока.
Event EventCameraPropertyUpdateSharpness#
Event triggered when the sharpness value is changed in Varjo Base. You can subscribe to events via
Connect()
and unsubscribe via
Disconnect(). You can also use
EventConnection
and
EventConnections
classes for convenience (see examples below).
ПримечаниеFor more details see the Event Handling article.For more details see the Event Handling article.
For more details see the Event Handling article.Событие запускается при изменении резкости камеры в Varjo Base. Вы можете подписаться на события через
Connect()
и отказаться от подписки через
Disconnect(). Вы также можете использовать
EventConnection
и
EventConnections
классы для удобства (см. примеры ниже).
For more details see the Event Handling article.For more details see the Event Handling article.ПримечаниеFor more details see the Event Handling article.Для получения более подробной информации смотрите статью Обработка событий.
The event handler signature is as follows: myhandler(For more details see the Event Handling article.Для получения более подробной информации смотрите статью Обработка событий.Usage Example
Исходный код (C#)
// implement the CameraPropertyUpdateSharpness event handler
void camerapropertyupdatesharpness_event_handler()
{
Log.Message("\Handling CameraPropertyUpdateSharpness event\n");
}
//////////////////////////////////////////////////////////////////////////////
// 1. Multiple subscriptions can be linked to an EventConnections instance
// class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////
// create an instance of the EventConnections class
EventConnections camerapropertyupdatesharpness_event_connections = new EventConnections();
// link to this instance when subscribing to an event (subscription to various events can be linked)
VRMixedReality.EventCameraPropertyUpdateSharpness.Connect(camerapropertyupdatesharpness_event_connections, camerapropertyupdatesharpness_event_handler);
// other subscriptions are also linked to this EventConnections instance
// (e.g. you can subscribe using lambdas)
VRMixedReality.EventCameraPropertyUpdateSharpness.Connect(camerapropertyupdatesharpness_event_connections, () => {
Log.Message("Handling CameraPropertyUpdateSharpness event lambda\n");
}
);
// later all of these linked subscriptions can be removed with a single line
camerapropertyupdatesharpness_event_connections.DisconnectAll();
//////////////////////////////////////////////////////////////////////////////
// 2. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////
// subscribe to the CameraPropertyUpdateSharpness event with a handler function
VRMixedReality.EventCameraPropertyUpdateSharpness.Connect(camerapropertyupdatesharpness_event_handler);
// remove subscription to the CameraPropertyUpdateSharpness event later by the handler function
VRMixedReality.EventCameraPropertyUpdateSharpness.Disconnect(camerapropertyupdatesharpness_event_handler);
//////////////////////////////////////////////////////////////////////////////
// 3. Subscribe to an event and unsubscribe later via an EventConnection instance
//////////////////////////////////////////////////////////////////////////////
// define a connection to be used to unsubscribe later
EventConnection camerapropertyupdatesharpness_event_connection;
// subscribe to the CameraPropertyUpdateSharpness event with a lambda handler function and keeping the connection
camerapropertyupdatesharpness_event_connection = VRMixedReality.EventCameraPropertyUpdateSharpness.Connect(() => {
Log.Message("Handling CameraPropertyUpdateSharpness event lambda\n");
}
);
// ...
// you can temporarily disable a particular event connection
camerapropertyupdatesharpness_event_connection.Enabled = false;
// ... perform certain actions
// and enable it back when necessary
camerapropertyupdatesharpness_event_connection.Enabled = true;
// ...
// remove the subscription later using the saved connection
camerapropertyupdatesharpness_event_connection.Disconnect();
//////////////////////////////////////////////////////////////////////////////
// 4. Ignoring CameraPropertyUpdateSharpness events when necessary
//////////////////////////////////////////////////////////////////////////////
// you can temporarily disable the event to perform certain actions without triggering it
VRMixedReality.EventCameraPropertyUpdateSharpness.Enabled = false;
// ... actions to be performed
// and enable it back when necessary
VRMixedReality.EventCameraPropertyUpdateSharpness.Enabled = true;Event EventCameraPropertyUpdateFlickerCompensation#
Event triggered when the flicker compensation value of the camera is changed in Varjo Base. You can subscribe to events via
Connect()
and unsubscribe via
Disconnect(). You can also use
EventConnection
and
EventConnections
classes for convenience (see examples below).
ПримечаниеFor more details see the Event Handling article.For more details see the Event Handling article.
For more details see the Event Handling article.Событие запускается при изменении значения компенсации мерцания камеры в Varjo Base. Вы можете подписаться на события через
Connect()
и отказаться от подписки через
Disconnect(). Вы также можете использовать
EventConnection
и
EventConnections
классы для удобства (см. примеры ниже).
For more details see the Event Handling article.For more details see the Event Handling article.ПримечаниеFor more details see the Event Handling article.Для получения более подробной информации смотрите статью Обработка событий.
The event handler signature is as follows: myhandler(For more details see the Event Handling article.Для получения более подробной информации смотрите статью Обработка событий.Usage Example
Исходный код (C#)
// implement the CameraPropertyUpdateFlickerCompensation event handler
void camerapropertyupdateflickercompensation_event_handler()
{
Log.Message("\Handling CameraPropertyUpdateFlickerCompensation event\n");
}
//////////////////////////////////////////////////////////////////////////////
// 1. Multiple subscriptions can be linked to an EventConnections instance
// class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////
// create an instance of the EventConnections class
EventConnections camerapropertyupdateflickercompensation_event_connections = new EventConnections();
// link to this instance when subscribing to an event (subscription to various events can be linked)
VRMixedReality.EventCameraPropertyUpdateFlickerCompensation.Connect(camerapropertyupdateflickercompensation_event_connections, camerapropertyupdateflickercompensation_event_handler);
// other subscriptions are also linked to this EventConnections instance
// (e.g. you can subscribe using lambdas)
VRMixedReality.EventCameraPropertyUpdateFlickerCompensation.Connect(camerapropertyupdateflickercompensation_event_connections, () => {
Log.Message("Handling CameraPropertyUpdateFlickerCompensation event lambda\n");
}
);
// later all of these linked subscriptions can be removed with a single line
camerapropertyupdateflickercompensation_event_connections.DisconnectAll();
//////////////////////////////////////////////////////////////////////////////
// 2. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////
// subscribe to the CameraPropertyUpdateFlickerCompensation event with a handler function
VRMixedReality.EventCameraPropertyUpdateFlickerCompensation.Connect(camerapropertyupdateflickercompensation_event_handler);
// remove subscription to the CameraPropertyUpdateFlickerCompensation event later by the handler function
VRMixedReality.EventCameraPropertyUpdateFlickerCompensation.Disconnect(camerapropertyupdateflickercompensation_event_handler);
//////////////////////////////////////////////////////////////////////////////
// 3. Subscribe to an event and unsubscribe later via an EventConnection instance
//////////////////////////////////////////////////////////////////////////////
// define a connection to be used to unsubscribe later
EventConnection camerapropertyupdateflickercompensation_event_connection;
// subscribe to the CameraPropertyUpdateFlickerCompensation event with a lambda handler function and keeping the connection
camerapropertyupdateflickercompensation_event_connection = VRMixedReality.EventCameraPropertyUpdateFlickerCompensation.Connect(() => {
Log.Message("Handling CameraPropertyUpdateFlickerCompensation event lambda\n");
}
);
// ...
// you can temporarily disable a particular event connection
camerapropertyupdateflickercompensation_event_connection.Enabled = false;
// ... perform certain actions
// and enable it back when necessary
camerapropertyupdateflickercompensation_event_connection.Enabled = true;
// ...
// remove the subscription later using the saved connection
camerapropertyupdateflickercompensation_event_connection.Disconnect();
//////////////////////////////////////////////////////////////////////////////
// 4. Ignoring CameraPropertyUpdateFlickerCompensation events when necessary
//////////////////////////////////////////////////////////////////////////////
// you can temporarily disable the event to perform certain actions without triggering it
VRMixedReality.EventCameraPropertyUpdateFlickerCompensation.Enabled = false;
// ... actions to be performed
// and enable it back when necessary
VRMixedReality.EventCameraPropertyUpdateFlickerCompensation.Enabled = true;Event EventCameraPropertyUpdateISO#
Event triggered when the camera ISO value and/or the ISO adjustment mode are changed in Varjo Base. You can subscribe to events via
Connect()
and unsubscribe via
Disconnect(). You can also use
EventConnection
and
EventConnections
classes for convenience (see examples below).
ПримечаниеFor more details see the Event Handling article.For more details see the Event Handling article.
For more details see the Event Handling article.Событие запускается при изменении значения и/или режима настройки ISO камеры в Varjo Base. Вы можете подписаться на события через
Connect()
и отказаться от подписки через
Disconnect(). Вы также можете использовать
EventConnection
и
EventConnections
классы для удобства (см. примеры ниже).
For more details see the Event Handling article.For more details see the Event Handling article.ПримечаниеFor more details see the Event Handling article.Для получения более подробной информации смотрите статью Обработка событий.
The event handler signature is as follows: myhandler(For more details see the Event Handling article.Для получения более подробной информации смотрите статью Обработка событий.Usage Example
Исходный код (C#)
// implement the CameraPropertyUpdateISO event handler
void camerapropertyupdateiso_event_handler()
{
Log.Message("\Handling CameraPropertyUpdateISO event\n");
}
//////////////////////////////////////////////////////////////////////////////
// 1. Multiple subscriptions can be linked to an EventConnections instance
// class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////
// create an instance of the EventConnections class
EventConnections camerapropertyupdateiso_event_connections = new EventConnections();
// link to this instance when subscribing to an event (subscription to various events can be linked)
VRMixedReality.EventCameraPropertyUpdateISO.Connect(camerapropertyupdateiso_event_connections, camerapropertyupdateiso_event_handler);
// other subscriptions are also linked to this EventConnections instance
// (e.g. you can subscribe using lambdas)
VRMixedReality.EventCameraPropertyUpdateISO.Connect(camerapropertyupdateiso_event_connections, () => {
Log.Message("Handling CameraPropertyUpdateISO event lambda\n");
}
);
// later all of these linked subscriptions can be removed with a single line
camerapropertyupdateiso_event_connections.DisconnectAll();
//////////////////////////////////////////////////////////////////////////////
// 2. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////
// subscribe to the CameraPropertyUpdateISO event with a handler function
VRMixedReality.EventCameraPropertyUpdateISO.Connect(camerapropertyupdateiso_event_handler);
// remove subscription to the CameraPropertyUpdateISO event later by the handler function
VRMixedReality.EventCameraPropertyUpdateISO.Disconnect(camerapropertyupdateiso_event_handler);
//////////////////////////////////////////////////////////////////////////////
// 3. Subscribe to an event and unsubscribe later via an EventConnection instance
//////////////////////////////////////////////////////////////////////////////
// define a connection to be used to unsubscribe later
EventConnection camerapropertyupdateiso_event_connection;
// subscribe to the CameraPropertyUpdateISO event with a lambda handler function and keeping the connection
camerapropertyupdateiso_event_connection = VRMixedReality.EventCameraPropertyUpdateISO.Connect(() => {
Log.Message("Handling CameraPropertyUpdateISO event lambda\n");
}
);
// ...
// you can temporarily disable a particular event connection
camerapropertyupdateiso_event_connection.Enabled = false;
// ... perform certain actions
// and enable it back when necessary
camerapropertyupdateiso_event_connection.Enabled = true;
// ...
// remove the subscription later using the saved connection
camerapropertyupdateiso_event_connection.Disconnect();
//////////////////////////////////////////////////////////////////////////////
// 4. Ignoring CameraPropertyUpdateISO events when necessary
//////////////////////////////////////////////////////////////////////////////
// you can temporarily disable the event to perform certain actions without triggering it
VRMixedReality.EventCameraPropertyUpdateISO.Enabled = false;
// ... actions to be performed
// and enable it back when necessary
VRMixedReality.EventCameraPropertyUpdateISO.Enabled = true;Event EventCameraPropertyUpdateWhiteBalance#
Event triggered when the white balance correction value of the camera and/or the white balance adjustment mode are changed in Varjo Base. You can subscribe to events via
Connect()
and unsubscribe via
Disconnect(). You can also use
EventConnection
and
EventConnections
classes for convenience (see examples below).
ПримечаниеFor more details see the Event Handling article.For more details see the Event Handling article.
For more details see the Event Handling article.Событие запускается при изменении значения и/или режима настройки баланса белого для камеры в Varjo Base. Вы можете подписаться на события через
Connect()
и отказаться от подписки через
Disconnect(). Вы также можете использовать
EventConnection
и
EventConnections
классы для удобства (см. примеры ниже).
For more details see the Event Handling article.For more details see the Event Handling article.ПримечаниеFor more details see the Event Handling article.Для получения более подробной информации смотрите статью Обработка событий.
The event handler signature is as follows: myhandler(For more details see the Event Handling article.Для получения более подробной информации смотрите статью Обработка событий.Usage Example
Исходный код (C#)
// implement the CameraPropertyUpdateWhiteBalance event handler
void camerapropertyupdatewhitebalance_event_handler()
{
Log.Message("\Handling CameraPropertyUpdateWhiteBalance event\n");
}
//////////////////////////////////////////////////////////////////////////////
// 1. Multiple subscriptions can be linked to an EventConnections instance
// class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////
// create an instance of the EventConnections class
EventConnections camerapropertyupdatewhitebalance_event_connections = new EventConnections();
// link to this instance when subscribing to an event (subscription to various events can be linked)
VRMixedReality.EventCameraPropertyUpdateWhiteBalance.Connect(camerapropertyupdatewhitebalance_event_connections, camerapropertyupdatewhitebalance_event_handler);
// other subscriptions are also linked to this EventConnections instance
// (e.g. you can subscribe using lambdas)
VRMixedReality.EventCameraPropertyUpdateWhiteBalance.Connect(camerapropertyupdatewhitebalance_event_connections, () => {
Log.Message("Handling CameraPropertyUpdateWhiteBalance event lambda\n");
}
);
// later all of these linked subscriptions can be removed with a single line
camerapropertyupdatewhitebalance_event_connections.DisconnectAll();
//////////////////////////////////////////////////////////////////////////////
// 2. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////
// subscribe to the CameraPropertyUpdateWhiteBalance event with a handler function
VRMixedReality.EventCameraPropertyUpdateWhiteBalance.Connect(camerapropertyupdatewhitebalance_event_handler);
// remove subscription to the CameraPropertyUpdateWhiteBalance event later by the handler function
VRMixedReality.EventCameraPropertyUpdateWhiteBalance.Disconnect(camerapropertyupdatewhitebalance_event_handler);
//////////////////////////////////////////////////////////////////////////////
// 3. Subscribe to an event and unsubscribe later via an EventConnection instance
//////////////////////////////////////////////////////////////////////////////
// define a connection to be used to unsubscribe later
EventConnection camerapropertyupdatewhitebalance_event_connection;
// subscribe to the CameraPropertyUpdateWhiteBalance event with a lambda handler function and keeping the connection
camerapropertyupdatewhitebalance_event_connection = VRMixedReality.EventCameraPropertyUpdateWhiteBalance.Connect(() => {
Log.Message("Handling CameraPropertyUpdateWhiteBalance event lambda\n");
}
);
// ...
// you can temporarily disable a particular event connection
camerapropertyupdatewhitebalance_event_connection.Enabled = false;
// ... perform certain actions
// and enable it back when necessary
camerapropertyupdatewhitebalance_event_connection.Enabled = true;
// ...
// remove the subscription later using the saved connection
camerapropertyupdatewhitebalance_event_connection.Disconnect();
//////////////////////////////////////////////////////////////////////////////
// 4. Ignoring CameraPropertyUpdateWhiteBalance events when necessary
//////////////////////////////////////////////////////////////////////////////
// you can temporarily disable the event to perform certain actions without triggering it
VRMixedReality.EventCameraPropertyUpdateWhiteBalance.Enabled = false;
// ... actions to be performed
// and enable it back when necessary
VRMixedReality.EventCameraPropertyUpdateWhiteBalance.Enabled = true;Event EventCameraPropertyUpdateExposureTime#
Event triggered when the exposure time value of the camera and/or the exposure adjustment mode are changed in Varjo Base. You can subscribe to events via
Connect()
and unsubscribe via
Disconnect(). You can also use
EventConnection
and
EventConnections
classes for convenience (see examples below).
ПримечаниеFor more details see the Event Handling article.For more details see the Event Handling article.
For more details see the Event Handling article.Событие запускается при изменении значения и/или режима настройки времени экспозиции для камеры в Varjo Base. Вы можете подписаться на события через
Connect()
и отказаться от подписки через
Disconnect(). Вы также можете использовать
EventConnection
и
EventConnections
классы для удобства (см. примеры ниже).
For more details see the Event Handling article.For more details see the Event Handling article.ПримечаниеFor more details see the Event Handling article.Для получения более подробной информации смотрите статью Обработка событий.
The event handler signature is as follows: myhandler(For more details see the Event Handling article.Для получения более подробной информации смотрите статью Обработка событий.Usage Example
Исходный код (C#)
// implement the CameraPropertyUpdateExposureTime event handler
void camerapropertyupdateexposuretime_event_handler()
{
Log.Message("\Handling CameraPropertyUpdateExposureTime event\n");
}
//////////////////////////////////////////////////////////////////////////////
// 1. Multiple subscriptions can be linked to an EventConnections instance
// class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////
// create an instance of the EventConnections class
EventConnections camerapropertyupdateexposuretime_event_connections = new EventConnections();
// link to this instance when subscribing to an event (subscription to various events can be linked)
VRMixedReality.EventCameraPropertyUpdateExposureTime.Connect(camerapropertyupdateexposuretime_event_connections, camerapropertyupdateexposuretime_event_handler);
// other subscriptions are also linked to this EventConnections instance
// (e.g. you can subscribe using lambdas)
VRMixedReality.EventCameraPropertyUpdateExposureTime.Connect(camerapropertyupdateexposuretime_event_connections, () => {
Log.Message("Handling CameraPropertyUpdateExposureTime event lambda\n");
}
);
// later all of these linked subscriptions can be removed with a single line
camerapropertyupdateexposuretime_event_connections.DisconnectAll();
//////////////////////////////////////////////////////////////////////////////
// 2. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////
// subscribe to the CameraPropertyUpdateExposureTime event with a handler function
VRMixedReality.EventCameraPropertyUpdateExposureTime.Connect(camerapropertyupdateexposuretime_event_handler);
// remove subscription to the CameraPropertyUpdateExposureTime event later by the handler function
VRMixedReality.EventCameraPropertyUpdateExposureTime.Disconnect(camerapropertyupdateexposuretime_event_handler);
//////////////////////////////////////////////////////////////////////////////
// 3. Subscribe to an event and unsubscribe later via an EventConnection instance
//////////////////////////////////////////////////////////////////////////////
// define a connection to be used to unsubscribe later
EventConnection camerapropertyupdateexposuretime_event_connection;
// subscribe to the CameraPropertyUpdateExposureTime event with a lambda handler function and keeping the connection
camerapropertyupdateexposuretime_event_connection = VRMixedReality.EventCameraPropertyUpdateExposureTime.Connect(() => {
Log.Message("Handling CameraPropertyUpdateExposureTime event lambda\n");
}
);
// ...
// you can temporarily disable a particular event connection
camerapropertyupdateexposuretime_event_connection.Enabled = false;
// ... perform certain actions
// and enable it back when necessary
camerapropertyupdateexposuretime_event_connection.Enabled = true;
// ...
// remove the subscription later using the saved connection
camerapropertyupdateexposuretime_event_connection.Disconnect();
//////////////////////////////////////////////////////////////////////////////
// 4. Ignoring CameraPropertyUpdateExposureTime events when necessary
//////////////////////////////////////////////////////////////////////////////
// you can temporarily disable the event to perform certain actions without triggering it
VRMixedReality.EventCameraPropertyUpdateExposureTime.Enabled = false;
// ... actions to be performed
// and enable it back when necessary
VRMixedReality.EventCameraPropertyUpdateExposureTime.Enabled = true;Event EventChromakeyUpdate#
Event triggered when the chroma keying settings are changed in Varjo Base. You can subscribe to events via
Connect()
and unsubscribe via
Disconnect(). You can also use
EventConnection
and
EventConnections
classes for convenience (see examples below).
ПримечаниеFor more details see the Event Handling article.For more details see the Event Handling article.
For more details see the Event Handling article.Событие запускается при изменении настроек хромакея (chroma key) в Varjo Base. Вы можете подписаться на события через
Connect()
и отказаться от подписки через
Disconnect(). Вы также можете использовать
EventConnection
и
EventConnections
классы для удобства (см. примеры ниже).
For more details see the Event Handling article.For more details see the Event Handling article.ПримечаниеFor more details see the Event Handling article.Для получения более подробной информации смотрите статью Обработка событий.
The event handler signature is as follows: myhandler(For more details see the Event Handling article.Для получения более подробной информации смотрите статью Обработка событий.Usage Example
Исходный код (C#)
// implement the ChromakeyUpdate event handler
void chromakeyupdate_event_handler()
{
Log.Message("\Handling ChromakeyUpdate event\n");
}
//////////////////////////////////////////////////////////////////////////////
// 1. Multiple subscriptions can be linked to an EventConnections instance
// class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////
// create an instance of the EventConnections class
EventConnections chromakeyupdate_event_connections = new EventConnections();
// link to this instance when subscribing to an event (subscription to various events can be linked)
VRMixedReality.EventChromakeyUpdate.Connect(chromakeyupdate_event_connections, chromakeyupdate_event_handler);
// other subscriptions are also linked to this EventConnections instance
// (e.g. you can subscribe using lambdas)
VRMixedReality.EventChromakeyUpdate.Connect(chromakeyupdate_event_connections, () => {
Log.Message("Handling ChromakeyUpdate event lambda\n");
}
);
// later all of these linked subscriptions can be removed with a single line
chromakeyupdate_event_connections.DisconnectAll();
//////////////////////////////////////////////////////////////////////////////
// 2. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////
// subscribe to the ChromakeyUpdate event with a handler function
VRMixedReality.EventChromakeyUpdate.Connect(chromakeyupdate_event_handler);
// remove subscription to the ChromakeyUpdate event later by the handler function
VRMixedReality.EventChromakeyUpdate.Disconnect(chromakeyupdate_event_handler);
//////////////////////////////////////////////////////////////////////////////
// 3. Subscribe to an event and unsubscribe later via an EventConnection instance
//////////////////////////////////////////////////////////////////////////////
// define a connection to be used to unsubscribe later
EventConnection chromakeyupdate_event_connection;
// subscribe to the ChromakeyUpdate event with a lambda handler function and keeping the connection
chromakeyupdate_event_connection = VRMixedReality.EventChromakeyUpdate.Connect(() => {
Log.Message("Handling ChromakeyUpdate event lambda\n");
}
);
// ...
// you can temporarily disable a particular event connection
chromakeyupdate_event_connection.Enabled = false;
// ... perform certain actions
// and enable it back when necessary
chromakeyupdate_event_connection.Enabled = true;
// ...
// remove the subscription later using the saved connection
chromakeyupdate_event_connection.Disconnect();
//////////////////////////////////////////////////////////////////////////////
// 4. Ignoring ChromakeyUpdate events when necessary
//////////////////////////////////////////////////////////////////////////////
// you can temporarily disable the event to perform certain actions without triggering it
VRMixedReality.EventChromakeyUpdate.Enabled = false;
// ... actions to be performed
// and enable it back when necessary
VRMixedReality.EventChromakeyUpdate.Enabled = true;Event EventDeviceDisconnected#
Event triggered when the Varjo device is disconnected. You can subscribe to events via
Connect()
and unsubscribe via
Disconnect(). You can also use
EventConnection
and
EventConnections
classes for convenience (see examples below).
ПримечаниеFor more details see the Event Handling article.For more details see the Event Handling article.
For more details see the Event Handling article.Событие запускается при отключении VR устройства. Вы можете подписаться на события через
Connect()
и отказаться от подписки через
Disconnect(). Вы также можете использовать
EventConnection
и
EventConnections
классы для удобства (см. примеры ниже).
For more details see the Event Handling article.For more details see the Event Handling article.ПримечаниеFor more details see the Event Handling article.Для получения более подробной информации смотрите статью Обработка событий.
The event handler signature is as follows: myhandler(For more details see the Event Handling article.Для получения более подробной информации смотрите статью Обработка событий.Usage Example
Исходный код (C#)
// implement the DeviceDisconnected event handler
void devicedisconnected_event_handler()
{
Log.Message("\Handling DeviceDisconnected event\n");
}
//////////////////////////////////////////////////////////////////////////////
// 1. Multiple subscriptions can be linked to an EventConnections instance
// class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////
// create an instance of the EventConnections class
EventConnections devicedisconnected_event_connections = new EventConnections();
// link to this instance when subscribing to an event (subscription to various events can be linked)
VRMixedReality.EventDeviceDisconnected.Connect(devicedisconnected_event_connections, devicedisconnected_event_handler);
// other subscriptions are also linked to this EventConnections instance
// (e.g. you can subscribe using lambdas)
VRMixedReality.EventDeviceDisconnected.Connect(devicedisconnected_event_connections, () => {
Log.Message("Handling DeviceDisconnected event lambda\n");
}
);
// later all of these linked subscriptions can be removed with a single line
devicedisconnected_event_connections.DisconnectAll();
//////////////////////////////////////////////////////////////////////////////
// 2. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////
// subscribe to the DeviceDisconnected event with a handler function
VRMixedReality.EventDeviceDisconnected.Connect(devicedisconnected_event_handler);
// remove subscription to the DeviceDisconnected event later by the handler function
VRMixedReality.EventDeviceDisconnected.Disconnect(devicedisconnected_event_handler);
//////////////////////////////////////////////////////////////////////////////
// 3. Subscribe to an event and unsubscribe later via an EventConnection instance
//////////////////////////////////////////////////////////////////////////////
// define a connection to be used to unsubscribe later
EventConnection devicedisconnected_event_connection;
// subscribe to the DeviceDisconnected event with a lambda handler function and keeping the connection
devicedisconnected_event_connection = VRMixedReality.EventDeviceDisconnected.Connect(() => {
Log.Message("Handling DeviceDisconnected event lambda\n");
}
);
// ...
// you can temporarily disable a particular event connection
devicedisconnected_event_connection.Enabled = false;
// ... perform certain actions
// and enable it back when necessary
devicedisconnected_event_connection.Enabled = true;
// ...
// remove the subscription later using the saved connection
devicedisconnected_event_connection.Disconnect();
//////////////////////////////////////////////////////////////////////////////
// 4. Ignoring DeviceDisconnected events when necessary
//////////////////////////////////////////////////////////////////////////////
// you can temporarily disable the event to perform certain actions without triggering it
VRMixedReality.EventDeviceDisconnected.Enabled = false;
// ... actions to be performed
// and enable it back when necessary
VRMixedReality.EventDeviceDisconnected.Enabled = true;Event EventDeviceConnected#
Event triggered when the Varjo device is connected. You can subscribe to events via
Connect()
and unsubscribe via
Disconnect(). You can also use
EventConnection
and
EventConnections
classes for convenience (see examples below).
ПримечаниеFor more details see the Event Handling article.For more details see the Event Handling article.
For more details see the Event Handling article.Событие запускается при при подключении VR устройства. Вы можете подписаться на события через
Connect()
и отказаться от подписки через
Disconnect(). Вы также можете использовать
EventConnection
и
EventConnections
классы для удобства (см. примеры ниже).
For more details see the Event Handling article.For more details see the Event Handling article.ПримечаниеFor more details see the Event Handling article.Для получения более подробной информации смотрите статью Обработка событий.
The event handler signature is as follows: myhandler(For more details see the Event Handling article.Для получения более подробной информации смотрите статью Обработка событий.Usage Example
Исходный код (C#)
// implement the DeviceConnected event handler
void deviceconnected_event_handler()
{
Log.Message("\Handling DeviceConnected event\n");
}
//////////////////////////////////////////////////////////////////////////////
// 1. Multiple subscriptions can be linked to an EventConnections instance
// class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////
// create an instance of the EventConnections class
EventConnections deviceconnected_event_connections = new EventConnections();
// link to this instance when subscribing to an event (subscription to various events can be linked)
VRMixedReality.EventDeviceConnected.Connect(deviceconnected_event_connections, deviceconnected_event_handler);
// other subscriptions are also linked to this EventConnections instance
// (e.g. you can subscribe using lambdas)
VRMixedReality.EventDeviceConnected.Connect(deviceconnected_event_connections, () => {
Log.Message("Handling DeviceConnected event lambda\n");
}
);
// later all of these linked subscriptions can be removed with a single line
deviceconnected_event_connections.DisconnectAll();
//////////////////////////////////////////////////////////////////////////////
// 2. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////
// subscribe to the DeviceConnected event with a handler function
VRMixedReality.EventDeviceConnected.Connect(deviceconnected_event_handler);
// remove subscription to the DeviceConnected event later by the handler function
VRMixedReality.EventDeviceConnected.Disconnect(deviceconnected_event_handler);
//////////////////////////////////////////////////////////////////////////////
// 3. Subscribe to an event and unsubscribe later via an EventConnection instance
//////////////////////////////////////////////////////////////////////////////
// define a connection to be used to unsubscribe later
EventConnection deviceconnected_event_connection;
// subscribe to the DeviceConnected event with a lambda handler function and keeping the connection
deviceconnected_event_connection = VRMixedReality.EventDeviceConnected.Connect(() => {
Log.Message("Handling DeviceConnected event lambda\n");
}
);
// ...
// you can temporarily disable a particular event connection
deviceconnected_event_connection.Enabled = false;
// ... perform certain actions
// and enable it back when necessary
deviceconnected_event_connection.Enabled = true;
// ...
// remove the subscription later using the saved connection
deviceconnected_event_connection.Disconnect();
//////////////////////////////////////////////////////////////////////////////
// 4. Ignoring DeviceConnected events when necessary
//////////////////////////////////////////////////////////////////////////////
// you can temporarily disable the event to perform certain actions without triggering it
VRMixedReality.EventDeviceConnected.Enabled = false;
// ... actions to be performed
// and enable it back when necessary
VRMixedReality.EventDeviceConnected.Enabled = true;Члены класса
void ApplySettings ( ) #
Updates the mixed reality settings to the current settings.Обновляет настройки смешанной реальности до текущих настроек.bool IsChromaKeyConfigEnabled ( int index ) #
Returns the current value indicating if the chroma key configuration with the specified index is enabled.Возвращает текущее значение, указывающее, включена ли настройка цветового ключа с указанным индексом.Аргументы
- int index - Chroma key config index in the range from 0 to config count - 1.Индекс конфигурации цветового ключа в диапазоне от 0 до config count - 1.
Возвращаемое значение
1 the chroma key configuration is enabled; otherwise, 0.1 включена настройка цветового ключа; в противном случае - 0.void SetChromaKeyConfigEnabled ( int index, bool enabled ) #
Sets a new value indicating if the chroma key configuration with the specified index is enabled.Устанавливает новое значение, указывающее, включена ли конфигурация цветового ключа с указанным индексом.Аргументы
- int index - Chroma key config index in the range from 0 to config count - 1.Индекс конфигурации цветового ключа в диапазоне от 0 до config count - 1.
- bool enabled - 1 to enable the chroma key configuration; 0 to disable it.1, чтобы включить настройку цветового ключа; 0, чтобы отключить ее.
vec3 GetChromaKeyConfigFalloff ( int index ) #
Returns the current tolerance falloff values for HSV components of the chroma key target color.Возвращает текущие значения отклонения допуска для компонентов HSV целевого цвета цветового ключа.Аргументы
- int index - Chroma key config index in the range from 0 to config count - 1.Индекс конфигурации цветового ключа в диапазоне от 0 до config count - 1.
Возвращаемое значение
Current tolerance falloff values for HSV components of the chroma key target color. The range for each component is [0.0; 1.0].Текущие значения допустимого отклонения для компонентов HSV целевого цвета цветового ключа. Диапазон для каждого компонента равен [0.0; 1.0].void SetChromaKeyConfigFalloff ( int index, vec3 falloff ) #
Sets new tolerance falloff values for HSV components of the chroma key target color.Устанавливает новые значения отклонения допуска для компонентов HSV целевого цвета цветового ключа.Аргументы
- int index - Chroma key config index in the range from 0 to config count - 1.Индекс конфигурации цветового ключа в диапазоне от 0 до config count - 1.
- vec3 falloff - New tolerance falloff values to be set for HSV components of the chroma key target color. The range for each component is [0.0; 1.0].Новые значения отклонения допуска, которые будут установлены для компонентов HSV целевого цвета chroma key. Диапазон для каждого компонента равен [0.0; 1.0].
vec3 GetChromaKeyConfigTargetColor ( int index ) #
Returns the current chroma key target color.Возвращает текущий целевой цвет цветового ключа.Аргументы
- int index - Chroma key config index in the range from 0 to config count - 1.Индекс конфигурации цветового ключа в диапазоне от 0 до config count - 1.
Возвращаемое значение
Current chroma key target color in HSV colorspace. The range for each component is [0.0; 1.0].Текущий целевой цвет цветового ключа в цветовом пространстве HSV. Диапазон для каждого компонента равен [0.0; 1.0].void SetChromaKeyConfigTargetColor ( int index, vec3 target_color ) #
Sets a new chroma key target color.Устанавливает новый целевой цвет цветового ключа.Аргументы
- int index - Chroma key config index in the range from 0 to config count - 1.Индекс конфигурации цветового ключа в диапазоне от 0 до config count - 1.
- vec3 target_color - New chroma key target color to be set in HSV colorspace. The range for each component is [0.0; 1.0].Новый целевой цвет цветового ключа, который будет установлен в цветовом пространстве HSV. Диапазон для каждого компонента равен [0.0; 1.0].
vec3 GetChromaKeyConfigTolerance ( int index ) #
Returns the current tolerance values for HSV components of the chroma key target color.Возвращает текущие значения допуска для компонентов HSV целевого цвета цветового ключа.Аргументы
- int index - Chroma key config index in the range from 0 to config count - 1.Индекс конфигурации цветового ключа в диапазоне от 0 до config count - 1.
Возвращаемое значение
Current tolerance values for HSV components of the chroma key target color. The range for each component is [0.0; 1.0].Текущие допустимые значения для компонентов HSV целевого цвета chroma key. Диапазон для каждого компонента равен [0.0; 1.0].void SetChromaKeyConfigTolerance ( int index, vec3 tolerance ) #
Sets new tolerance values for HSV components of the chroma key target color.Устанавливает новые значения допуска для компонентов HSV целевого цвета цветового ключа.Аргументы
- int index - Chroma key config index in the range from 0 to config count - 1.Индекс конфигурации цветового ключа в диапазоне от 0 до config count - 1.
- vec3 tolerance - New tolerance values for HSV components of the chroma key target color to be set. The range for each component is [0.0; 1.0].Необходимо установить новые допустимые значения для компонентов HSV целевого цвета цветового ключа. Диапазон для каждого компонента равен [0.0; 1.0].
void ApplyChromaKeySettings ( int index ) #
Updates the settings of the chroma key configuration with the specified index to the current settings.Обновляет настройки конфигурации цветового ключа с указанным индексом до текущих настроек.Аргументы
- int index - Chroma key config index in the range from 0 to config count - 1.Индекс конфигурации цветового ключа в диапазоне от 0 до config count - 1.
GetCameraSupportedRawISO ( ) #
Returns a vector containing the ISO values that are set as valid for the connected device.Возвращает вектор, содержащий значения ISO, которые установлены как допустимые для подключенного устройства.Возвращаемое значение
The vector containing the ISO values.Вектор, содержащий значения ISO.VRMarkerObject GetMarkerObject ( short index ) #
Returns the marker object with the specified index.Возвращает объект-маркер с указанным индексом.Аргументы
- short index - Marker object index.Индекс объекта маркера.
Возвращаемое значение
Marker object.Объект-маркер.VRMarkerObject GetMarkerObjectByID ( short marker_id ) #
Returns the marker object with the specified ID.Возвращает объект-маркер с указанным идентификатором.Аргументы
- short marker_id - Marker object ID.Идентификатор объекта маркера.
Возвращаемое значение
Marker object.Объект-маркер.
Последнее обновление:
13.12.2024
Помогите сделать статью лучше
Была ли эта статья полезной?
(или выберите слово/фразу и нажмите Ctrl+Enter