Unigine::VRMixedReality Class

Разделы:

Header:

#include <UnigineVRMixedReality.h>

The class is used for mixed reality management in Varjo devices.Класс используется для управления смешанной реальностью в устройствах Varjo.

Методы:

Имя	Описание View: Сортировать по:
setChromaKeyEnabled	Методы, получающие и устанавливающие значение, указывающее, включена ли цветовая манипуляция.
isChromaKeyEnabled
setDepthTestEnabled	Методы, получающие и устанавливающие значение, указывающее, включена ли отправка буфера глубины.
isDepthTestEnabled
setAlphaBlendEnabled	Методы, получающие и устанавливающие значение, указывающее, включено ли альфа-смешивание.
isAlphaBlendEnabled
setVideoEnabled	Методы, получающие и устанавливающие значение, указывающее, включен ли видеосигнал реального изображения с фронтальных камер, установленных на HMD.
isVideoEnabled
setDepthTestRangeEnabled	Методы, получающие и устанавливающие значение, указывающее, включено ли использование диапазона проверки глубины.
isDepthTestRangeEnabled
setDepthTestRange	Методы, получающие и устанавливающие диапазон измерения глубины в виде двухкомпонентного вектора (ближняя и дальняя плоскости).
getDepthTestRange
getChromaKeyConfigNum	Возвращает количество поддерживаемых индексов конфигурации цветового ключа.
setBlendMaskingMode	Методы, получающие и устанавливающие режим Blend Control Mask, который можно использовать для расширения или ограничения маски цветности или для управления тестированием глубины по сравнению с расчетной глубиной видео.
getBlendMaskingMode
setBlendMaskingDebugEnabled	Методы, получающие и устанавливающие значение, указывающее, включена ли визуализация отладки с маскировкой наложения.
isBlendMaskingDebugEnabled
isBlendMaskingUsed	Возвращает значение, указывающее, используется ли Blend Control Mask для расширения или ограничения маски цветности или для управления тестированием глубины по сравнению с расчетной глубиной видео.
getCurrentBlendMaskColorBuffer	Возвращает изображение, представляющее текущий цветовой буфер Blend Control Mask.
setCameraExposureTimeRaw	Методы, получающие и устанавливающие значение времени экспозиции для камеры.
getCameraExposureTimeRaw
setCameraExposureTime	Методы, получающие и устанавливающие значение времени экспозиции, действительное для подключенного устройства.
getCameraExposureTime
setCameraExposureTimeMode	Методы, получающие и устанавливающие режим настройки экспозиции для фотокамеры.
getCameraExposureTimeMode
setCameraWhiteBalanceRaw	Методы, получающие и устанавливающие значение коррекции баланса белого, действительное для подключенного устройства.
getCameraWhiteBalanceRaw
setCameraWhiteBalance	Методы, получающие и устанавливающие значение коррекции баланса белого, действительное для подключенного устройства.
getCameraWhiteBalance
setCameraWhiteBalanceMode	Методы, получающие и устанавливающие режим настройки баланса белого для фотокамеры.
getCameraWhiteBalanceMode
setCameraISORaw	Методы, получающие и устанавливающие Значение ISO, действительное для подключенного устройства.
getCameraISORaw
setCameraISO	Методы, получающие и устанавливающие Значение ISO для камеры.
getCameraISO
setCameraISOMode	Методы, получающие и устанавливающие Режим настройки ISO для камеры.
getCameraISOMode
setCameraFlickerCompensationRaw	Методы, получающие и устанавливающие значение компенсации мерцания для камеры.
getCameraFlickerCompensationRaw
setCameraFlickerCompensation	Методы, получающие и устанавливающие значение компенсации мерцания для камеры.
getCameraFlickerCompensation
getCameraMinSharpness	Возвращает минимально возможное значение для резкости камеры.
getCameraMaxSharpness	Возвращает максимально возможное значение для резкости камеры.
setCameraSharpness	Методы, получающие и устанавливающие значение мощности фильтра резкости для камеры.
getCameraSharpness
setViewOffset	Методы, получающие и устанавливающие .
getViewOffset	Методы, получающие и устанавливающие .
setMarkerTrackingEnabled	Методы, получающие и устанавливающие значение, указывающее, включено ли отслеживание маркера.
isMarkerTrackingEnabled
getNumMarkerObjectVisible	Возвращает количество видимых объектов-маркеров.
setCubemapMode	Методы, получающие и устанавливающие режим, определяющий способ настройки текстуры AR для окружающей среды.
getCubemapMode
setCubemapGGXQuality	Методы, получающие и устанавливающие качество сгенерированных GGX mips для AR cubemap.
getCubemapGGXQuality
setOverrideColorCorrectionMode	Методы, получающие и устанавливающие режим цветокоррекции для потока с камер дополненной реальности.
getOverrideColorCorrectionMode
getEventCameraPropertyUpdateSharpness	The Событие запускается при изменении резкости камеры в Varjo Base.
getEventCameraPropertyUpdateFlickerCompensation	The Событие запускается при изменении значения компенсации мерцания камеры в Varjo Base.
getEventCameraPropertyUpdateISO	The Событие запускается при изменении значения и/или режима настройки ISO камеры в Varjo Base.
getEventCameraPropertyUpdateWhiteBalance	The Событие запускается при изменении значения и/или режима настройки баланса белого для камеры в Varjo Base.
getEventCameraPropertyUpdateExposureTime	The Событие запускается при изменении значения и/или режима настройки времени экспозиции для камеры в Varjo Base.
getEventChromakeyUpdate	The Событие запускается при изменении настроек хромакея (chroma key) в Varjo Base.
getEventDeviceDisconnected	The Событие запускается при отключении VR устройства.
getEventDeviceConnected	The Событие запускается при при подключении VR устройства.
applySettings	Updates the mixed reality settings to the current settings.
isChromaKeyConfigEnabled	Returns the current value indicating if the chroma key configuration with the specified index is enabled.
setChromaKeyConfigEnabled	Sets a new value indicating if the chroma key configuration with the specified index is enabled.
getChromaKeyConfigFalloff	Returns the current tolerance falloff values for HSV components of the chroma key target color.
setChromaKeyConfigFalloff	Sets new tolerance falloff values for HSV components of the chroma key target color.
getChromaKeyConfigTargetColor	Returns the current chroma key target color.
setChromaKeyConfigTargetColor	Sets a new chroma key target color.
getChromaKeyConfigTolerance	Returns the current tolerance values for HSV components of the chroma key target color.
setChromaKeyConfigTolerance	Sets new tolerance values for HSV components of the chroma key target color.
applyChromaKeySettings	Updates the settings of the chroma key configuration with the specified index to the current settings.
getCameraSupportedRawExposureTimes	Returns a vector containing the exposure time values that are set as valid for the connected device.
getCameraSupportedRawWhiteBalances	Returns a vector containing the white balance values that are set as valid for the connected device.
getCameraSupportedRawISO	Returns a vector containing the ISO values that are set as valid for the connected device.
getCameraSupportedRawFlickerCompensations	Returns a vector containing the flicker compensation values that are set as valid for the connected device.
getMarkerObject	Returns the marker object with the specified index.
getMarkerObjectByID	Returns the marker object with the specified ID.

VRMixedReality Class

Перечисления (Enums)

BLEND_MASKING_MODE#

Имя	Описание
BLEND_MASKING_MODE_BEGIN = 0	The first element to be used for iteration.Первый элемент, который будет использоваться для итерации.
BLEND_MASKING_MODE_DISABLED = 0	Masking mode is disabled.Режим маскировки отключен.
BLEND_MASKING_MODE_RESTRICT_VIDEO_TO_MASK = 1	Show the video pass-through image (VST) in the mask. Can be used with chroma key.Отобразите сквозное изображение видео (VST) в маске. Может использоваться с цветовой клавишей.
BLEND_MASKING_MODE_RESTRICT_VR_TO_MASK = 2	Show VR in the mask. Can be used with chroma key.Показывать виртуальную реальность в маске. Можно использовать с цветовой клавишей.
BLEND_MASKING_MODE_RESTRICT_VR_TO_CHROMAKEY_REDUCED_BY_MASK = 3	Show VR in the mask and chroma elsewhere. Requires chroma key.Отобразите VR в маске и цветность в другом месте. Требуется цветовой ключ.
BLEND_MASKING_MODE_END = 3	The last element to be used for iteration.Последний элемент, который будет использоваться для итерации.

CAMERA_PROPERTY_MODE#

Имя	Описание
CAMERA_PROPERTY_MODE_DISABLED = 0	The camera property adjustment is disabled.Настройка свойств камеры отключена.
CAMERA_PROPERTY_MODE_AUTO = 1	Automatic property adjustment for the camera.Автоматическая настройка свойств камеры.
CAMERA_PROPERTY_MODE_MANUAL = 2	Manual property adjustment for the camera. In this mode you can set the desired property value (exposure time correction, white balance correction, ISO) manually via the corresponding methods.Ручная настройка свойств камеры. В этом режиме вы можете установить желаемое значение свойств (коррекция времени экспозиции, коррекция баланса белого, ISO) вручную с помощью соответствующих методов.

CAMERA_EXPOSURE_TIME#

Имя	Описание
CAMERA_EXPOSURE_TIME_UNKNWON = 0	The camera exposure time is not specified.Время экспозиции камеры не указано.
CAMERA_EXPOSURE_TIME_BEGIN = 1	The first element to be used for iteration.Первый элемент, который будет использоваться для итерации.
CAMERA_EXPOSURE_TIME_VALUE_91_MS = 1	The camera exposure time value equal to 91 K.Значение времени экспозиции камеры равно 91 К.
CAMERA_EXPOSURE_TIME_VALUE_125_MS = 2	The camera exposure time value equal to 125 K.Значение времени экспозиции камеры равно 125 К.
CAMERA_EXPOSURE_TIME_VALUE_250_MS = 3	The camera exposure time value equal to 250 K.Значение времени экспозиции камеры равно 250 К.
CAMERA_EXPOSURE_TIME_VALUE_500_MS = 4	The camera exposure time value equal to 500 K.Значение времени экспозиции камеры, равное 500 К.
CAMERA_EXPOSURE_TIME_VALUE_1000_MS = 5	The camera exposure time value equal to 1000 K.Значение времени экспозиции камеры, равное 1000 К.
CAMERA_EXPOSURE_TIME_VALUE_2000_MS = 6	The camera exposure time value equal to 2000 K.Значение времени экспозиции камеры, равное 2000 К.
CAMERA_EXPOSURE_TIME_VALUE_4000_MS = 7	The camera exposure time value equal to 4000 K.Значение времени экспозиции камеры равно 4000 К.
CAMERA_EXPOSURE_TIME_VALUE_8000_MS = 8	The camera exposure time value equal to 8000 K.Значение времени экспозиции камеры равно 8000 К.
CAMERA_EXPOSURE_TIME_END = 8	The last element to be used for iteration.Последний элемент, который будет использоваться для итерации.

CAMERA_WHITE_BALANCE#

Имя	Описание
CAMERA_WHITE_BALANCE_UNKNWON = 0	The camera white balance value is not specified.Значение баланса белого камеры не указано.
CAMERA_WHITE_BALANCE_BEGIN = 1	The first element to be used for iteration.Первый элемент, который будет использоваться для итерации.
CAMERA_WHITE_BALANCE_VALUE_2000_K = 1	The camera white balance value equal to 2000 K.Значение баланса белого камеры равно 2000 К.
CAMERA_WHITE_BALANCE_VALUE_3000_K = 2	The camera white balance value equal to 3000 K.Значение баланса белого камеры равно 3000 К.
CAMERA_WHITE_BALANCE_VALUE_3500_K = 3	The camera white balance value equal to 3500 K.Значение баланса белого камеры равно 3500 К.
CAMERA_WHITE_BALANCE_VALUE_4200_K = 4	The camera white balance value equal to 4200 K.Значение баланса белого камеры равно 4200 К.
CAMERA_WHITE_BALANCE_VALUE_5000_K = 5	The camera white balance value equal to 5000 K.Значение баланса белого камеры равно 5000 К.
CAMERA_WHITE_BALANCE_VALUE_5400_K = 6	The camera white balance value equal to 5400 K.Значение баланса белого камеры равно 5400 К.
CAMERA_WHITE_BALANCE_VALUE_6500_K = 7	The camera white balance value equal to 6500 K.Значение баланса белого камеры равно 6500 К.
CAMERA_WHITE_BALANCE_VALUE_8000_K = 8	The camera white balance value equal to 8000 K.Значение баланса белого камеры равно 8000 К.
CAMERA_WHITE_BALANCE_VALUE_12000_K = 9	The camera white balance value equal to 12000 K.Значение баланса белого камеры равно 12000 К.
CAMERA_WHITE_BALANCE_END = 9	The last element to be used for iteration.Последний элемент, который будет использоваться для итерации.

CAMERA_ISO#

Имя	Описание
CAMERA_ISO_UNKNWON = 0	The camera ISO value is not specified.Значение ISO камеры не указано.
CAMERA_ISO_BEGIN = 1	The first element to be used for iteration.Первый элемент, который будет использоваться для итерации.
CAMERA_ISO_GAIN_100 = 1	The camera ISO value equal to 100.Значение ISO камеры равно 100.
CAMERA_ISO_GAIN_200 = 2	The camera ISO value equal to 200.Значение ISO камеры равно 200.
CAMERA_ISO_GAIN_400 = 3	The camera ISO value equal to 400.Значение ISO камеры равно 400.
CAMERA_ISO_GAIN_800 = 4	The camera ISO value equal to 800.Значение ISO камеры равно 800.
CAMERA_ISO_GAIN_1600 = 5	The camera ISO value equal to 1600.Значение ISO камеры равно 1600.
CAMERA_ISO_GAIN_3200 = 6	The camera ISO value equal to 3200.Значение ISO камеры равно 3200.
CAMERA_ISO_GAIN_6400 = 7	The camera ISO value equal to 6400.Значение ISO камеры равно 6400.
CAMERA_ISO_END = 7	The last element to be used for iteration.Последний элемент, который будет использоваться для итерации.

CAMERA_FLICKER_COMPENSATION#

Имя	Описание
CAMERA_FLICKER_COMPENSATION_UNKNWON = 0	The camera flicker compensation value is not specified.Значение компенсации мерцания камеры не указано.
CAMERA_FLICKER_COMPENSATION_BEGIN = 1	The first element to be used for iteration.Первый элемент, который будет использоваться для итерации.
CAMERA_FLICKER_COMPENSATION_FREQ_50_HZ = 1	The camera flicker compensation value equal to 50 Hz.Значение компенсации мерцания камеры равно 50 Гц.
CAMERA_FLICKER_COMPENSATION_FREQ_60_HZ = 2	The camera flicker compensation value equal to 60 Hz.Значение компенсации мерцания камеры равно 60 Гц.
CAMERA_FLICKER_COMPENSATION_END = 2	The last element to be used for iteration.Последний элемент, который будет использоваться для итерации.

CUBEMAP_MODE#

Имя	Описание
CUBEMAP_MODE_BEGIN = 0	The first element to be used for iteration.Первый элемент, который будет использоваться для итерации.
CUBEMAP_MODE_DISABLED = 0	The cubemap streaming from AR cameras is disabled.Потоковая передача cubemap с камер дополненной реальности отключена.
CUBEMAP_MODE_ENVIRONMENT_OVERLAP = 1	The environment texture substitutes the sky.Текстура окружающей среды заменяет небо.
CUBEMAP_MODE_ENVIRONMENT_PRESET_0 = 2	The first environment preset defines the way the AR texture is set for the environment.Первая предустановка среды определяет способ настройки текстуры AR для среды.
CUBEMAP_MODE_ENVIRONMENT_PRESET_1 = 3	The second environment preset defines the way the AR texture is set for the environment.Вторая предустановка среды определяет способ настройки текстуры AR для среды.
CUBEMAP_MODE_ENVIRONMENT_PRESET_2 = 4	The third environment preset defines the way the AR texture is set for the environment.Третья предустановка среды определяет способ настройки текстуры AR для среды.
CUBEMAP_MODE_END = 4	The last element to be used for iteration.Последний элемент, который будет использоваться для итерации.

OVERRIDE_COLOR_CORRECTION_MODE#

Имя	Описание
OVERRIDE_COLOR_CORRECTION_MODE_BEGIN = 0	The first element to be used for iteration.Первый элемент, который будет использоваться для итерации.
OVERRIDE_COLOR_CORRECTION_MODE_DISABLED = 0	The color correction is disabled.Цветокоррекция отключена.
OVERRIDE_COLOR_CORRECTION_MODE_EXPOSURE = 1	Exposure correction for the stream from the AR cameras.Коррекция экспозиции для потока с камер дополненной реальности.
OVERRIDE_COLOR_CORRECTION_MODE_EXPOSURE_WHITE_BALANCE = 2	Exposure and white balance correction for the stream.Коррекция экспозиции и баланса белого для потока.
OVERRIDE_COLOR_CORRECTION_MODE_END = 2	The last element to be used for iteration.Последний элемент, который будет использоваться для итерации.

Члены класса

void setChromaKeyEnabled ( bool enabled ) #

Console: vr_mixed_reality_chroma_key_enabled

Устанавливает значение, указывающее, включена ли цветовая манипуляция. Должна быть включена запись VST с камер HMD.

Аргументы

bool enabled - Set true to enable управление цветностью; false - to disable it. Значение по умолчанию false.

bool isChromaKeyEnabled() const#

Console: vr_mixed_reality_chroma_key_enabled

Возвращает значение, указывающее, включена ли цветовая манипуляция. Должна быть включена запись VST с камер HMD.

Возвращаемое значение

true if управление цветностью is enabled; otherwise false. Значение по умолчанию false.

void setDepthTestEnabled ( bool enabled ) #

Console: vr_mixed_reality_depth_test_enabled

Устанавливает значение, указывающее, включена ли отправка буфера глубины. Должна быть включена запись VST с камер HMD.

Аргументы

bool enabled - Set true to enable испытание на глубину; false - to disable it. Значение по умолчанию false.

bool isDepthTestEnabled() const#

Console: vr_mixed_reality_depth_test_enabled

Возвращает значение, указывающее, включена ли отправка буфера глубины. Должна быть включена запись VST с камер HMD.

Возвращаемое значение

true if испытание на глубину is enabled; otherwise false. Значение по умолчанию false.

void setAlphaBlendEnabled ( bool enabled ) #

Console: vr_mixed_reality_alpha_blend_enabled

Устанавливает значение, указывающее, включено ли альфа-смешивание. Эта опция используется для смешивания изображений виртуальной и дополненной реальности с использованием альфа-канала. Запись VST с камер HMD должна быть включена, а точность отображения должна быть равна 1.

Аргументы

bool enabled - Set true to enable альфа-смешивание; false - to disable it. Значение по умолчанию false.

bool isAlphaBlendEnabled() const#

Console: vr_mixed_reality_alpha_blend_enabled

Возвращает значение, указывающее, включено ли альфа-смешивание. Эта опция используется для смешивания изображений виртуальной и дополненной реальности с использованием альфа-канала. Запись VST с камер HMD должна быть включена, а точность отображения должна быть равна 1.

Возвращаемое значение

true if альфа-смешивание is enabled; otherwise false. Значение по умолчанию false.

void setVideoEnabled ( bool enabled ) #

Console: vr_mixed_reality_video_enabled

Устанавливает значение, указывающее, включен ли видеосигнал реального изображения с фронтальных камер, установленных на HMD. Изображение реального мира используется для объединения элементов виртуального и реального мира для создания эффекта погружения в смешанную реальность.

Аргументы

bool enabled - Set true to enable изображение реального мира с фронтальных камер, установленных на HMD; false - to disable it. Значение по умолчанию false.

bool isVideoEnabled() const#

Console: vr_mixed_reality_video_enabled

Возвращает значение, указывающее, включен ли видеосигнал реального изображения с фронтальных камер, установленных на HMD. Изображение реального мира используется для объединения элементов виртуального и реального мира для создания эффекта погружения в смешанную реальность.

Возвращаемое значение

true if изображение реального мира с фронтальных камер, установленных на HMD is enabled; otherwise false. Значение по умолчанию false.

void setDepthTestRangeEnabled ( bool enabled ) #

Console: vr_mixed_reality_depth_test_range_enabled

Устанавливает значение, указывающее, включено ли использование диапазона проверки глубины. Используйте диапазон проверки глубины (Depth Test Near Z, Depth Test Far Z) для управления диапазоном, для которого оценивается тест глубины.

Аргументы

bool enabled - Set true to enable диапазон измерения глубины; false - to disable it. Значение по умолчанию false.

bool isDepthTestRangeEnabled() const#

Console: vr_mixed_reality_depth_test_range_enabled

Возвращает значение, указывающее, включено ли использование диапазона проверки глубины. Используйте диапазон проверки глубины (Depth Test Near Z, Depth Test Far Z) для управления диапазоном, для которого оценивается тест глубины.

Возвращаемое значение

true if диапазон измерения глубины is enabled; otherwise false. Значение по умолчанию false.

void setDepthTestRange ( const Math::vec2& range ) #

Console: vr_mixed_reality_depth_test_range

Устанавливает диапазон измерения глубины в виде двухкомпонентного вектора (ближняя и дальняя плоскости). Необходимо включить использование диапазона измерения глубины.

Аргументы

const Math::vec2& range - диапазон глубинных испытаний.
vec2(0.0f, 1.0f) - значение по умолчанию

Math::vec2 getDepthTestRange() const#

Console: vr_mixed_reality_depth_test_range

Возвращает диапазон измерения глубины в виде двухкомпонентного вектора (ближняя и дальняя плоскости). Необходимо включить использование диапазона измерения глубины.

Возвращаемое значение

диапазон глубинных испытаний.
vec2(0.0f, 1.0f) - значение по умолчанию

getChromaKeyConfigNum() const#

Возвращает количество поддерживаемых индексов конфигурации цветового ключа. Максимальный индекс будет равен count-1.

Возвращаемое значение

количество индексов конфигурации цветового ключа.

void setBlendMaskingMode ( VRMixedReality::BLEND_MASKING_MODE mode ) #

Console: vr_mixed_reality_blend_masking_mode

Устанавливает режим Blend Control Mask, который можно использовать для расширения или ограничения маски цветности или для управления тестированием глубины по сравнению с расчетной глубиной видео.

Аргументы

VRMixedReality::BLEND_MASKING_MODE mode - режим маскировки. Одно из следующих значений:
- 0 - Отключено (режим маскировки отключен). (по умолчанию)
- 1 - Ограничить видео маской (показывать сквозное изображение видео (VST) в маске; можно использовать с цветовой клавишей)
- 2 - Ограничить VR маской (показывать VR в маске; можно использовать с цветовой клавишей)
- 3 - Ограничить VR хромакеем, уменьшенным по маске (показывать VR в маске и цветность в другом месте; требуется цветовой ключ)

VRMixedReality::BLEND_MASKING_MODE getBlendMaskingMode() const#

Console: vr_mixed_reality_blend_masking_mode

Возвращает режим Blend Control Mask, который можно использовать для расширения или ограничения маски цветности или для управления тестированием глубины по сравнению с расчетной глубиной видео.

Возвращаемое значение

режим маскировки. Одно из следующих значений:

0 - Отключено (режим маскировки отключен). (по умолчанию)
1 - Ограничить видео маской (показывать сквозное изображение видео (VST) в маске; можно использовать с цветовой клавишей)
2 - Ограничить VR маской (показывать VR в маске; можно использовать с цветовой клавишей)
3 - Ограничить VR хромакеем, уменьшенным по маске (показывать VR в маске и цветность в другом месте; требуется цветовой ключ)

void setBlendMaskingDebugEnabled ( bool enabled ) #

Console: vr_mixed_reality_blend_masking_debug_enabled

Устанавливает значение, указывающее, включена ли визуализация отладки с маскировкой наложения. Должен быть включен режим маскировки наложением.

Аргументы

bool enabled - Set true to enable наложение маскировки визуализация отладки; false - to disable it. Значение по умолчанию false.

bool isBlendMaskingDebugEnabled() const#

Console: vr_mixed_reality_blend_masking_debug_enabled

Возвращает значение, указывающее, включена ли визуализация отладки с маскировкой наложения. Должен быть включен режим маскировки наложением.

Возвращаемое значение

true if наложение маскировки визуализация отладки is enabled; otherwise false. Значение по умолчанию false.

bool isBlendMaskingUsed() const#

Возвращает значение, указывающее, используется ли Blend Control Mask для расширения или ограничения маски цветности или для управления тестированием глубины по сравнению с расчетной глубиной видео.

Возвращаемое значение

true if используется маска для смешивания; otherwise false.

Ptr<Texture> getCurrentBlendMaskColorBuffer() const#

Возвращает изображение, представляющее текущий цветовой буфер Blend Control Mask.

Возвращаемое значение

цветовой буфер.

void setCameraExposureTimeRaw ( ) #

Устанавливает значение времени экспозиции для камеры.

Аргументы

raw - время экспозиции в кадрах в секунду (например, 90,0 -> ~11 мс).

getCameraExposureTimeRaw() const#

Возвращает значение времени экспозиции для камеры.

Возвращаемое значение

время экспозиции в кадрах в секунду (например, 90,0 -> ~11 мс).

void setCameraExposureTime ( VRMixedReality::CAMERA_EXPOSURE_TIME time ) #

Console: vr_mixed_reality_camera_exposure_time

Устанавливает значение времени экспозиции, действительное для подключенного устройства.

Аргументы

VRMixedReality::CAMERA_EXPOSURE_TIME time - допустимое значение времени экспозиции для подключенного устройства.

VRMixedReality::CAMERA_EXPOSURE_TIME getCameraExposureTime() const#

Console: vr_mixed_reality_camera_exposure_time

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

Возвращаемое значение

допустимое значение времени экспозиции для подключенного устройства.

void setCameraExposureTimeMode ( VRMixedReality::CAMERA_PROPERTY_MODE mode ) #

Console: vr_mixed_reality_camera_exposure_time_mode

Устанавливает режим настройки экспозиции для фотокамеры.

Аргументы

VRMixedReality::CAMERA_PROPERTY_MODE mode - режим регулировки экспозиции. Одно из следующих значений:
- 0 - регулировка экспозиции отключена
- 1 - автоматическая регулировка экспозиции (по умолчанию)
- 2 - ручная регулировка экспозиции

VRMixedReality::CAMERA_PROPERTY_MODE getCameraExposureTimeMode() const#

Console: vr_mixed_reality_camera_exposure_time_mode

Возвращает режим настройки экспозиции для фотокамеры.

Возвращаемое значение

режим регулировки экспозиции. Одно из следующих значений:

0 - регулировка экспозиции отключена
1 - автоматическая регулировка экспозиции (по умолчанию)
2 - ручная регулировка экспозиции

void setCameraWhiteBalanceRaw ( ) #

Устанавливает значение коррекции баланса белого, действительное для подключенного устройства.

Аргументы

raw - значение цветовой температуры.

getCameraWhiteBalanceRaw() const#

Возвращает значение коррекции баланса белого, действительное для подключенного устройства.

Возвращаемое значение

значение цветовой температуры.

void setCameraWhiteBalance ( VRMixedReality::CAMERA_WHITE_BALANCE balance ) #

Console: vr_mixed_reality_camera_white_balance

Устанавливает значение коррекции баланса белого, действительное для подключенного устройства.

Аргументы

VRMixedReality::CAMERA_WHITE_BALANCE balance - значение цветовой температуры.

VRMixedReality::CAMERA_WHITE_BALANCE getCameraWhiteBalance() const#

Console: vr_mixed_reality_camera_white_balance

Возвращает значение коррекции баланса белого, действительное для подключенного устройства.

Возвращаемое значение

значение цветовой температуры.

void setCameraWhiteBalanceMode ( VRMixedReality::CAMERA_PROPERTY_MODE mode ) #

Console: vr_mixed_reality_camera_white_balance_mode

Устанавливает режим настройки баланса белого для фотокамеры.

Аргументы

VRMixedReality::CAMERA_PROPERTY_MODE mode - режим регулировки баланса белого. Одно из следующих значений:
- 0 - регулировка баланса белого отключена
- 1 - автоматическая регулировка баланса белого (по умолчанию)
- 2 - ручная регулировка баланса белого

VRMixedReality::CAMERA_PROPERTY_MODE getCameraWhiteBalanceMode() const#

Console: vr_mixed_reality_camera_white_balance_mode

Возвращает режим настройки баланса белого для фотокамеры.

Возвращаемое значение

режим регулировки баланса белого. Одно из следующих значений:

0 - регулировка баланса белого отключена
1 - автоматическая регулировка баланса белого (по умолчанию)
2 - ручная регулировка баланса белого

void setCameraISORaw ( ) #

Устанавливает Значение ISO, действительное для подключенного устройства.

Аргументы

isoraw - Значение ISO (например, "200" -> ISO200).

getCameraISORaw() const#

Возвращает Значение ISO, действительное для подключенного устройства.

Возвращаемое значение

Значение ISO (например, "200" -> ISO200).

void setCameraISO ( VRMixedReality::CAMERA_ISO iso ) #

Console: vr_mixed_reality_camera_iso

Устанавливает Значение ISO для камеры.

Аргументы

VRMixedReality::CAMERA_ISO iso - Значение ISO.

VRMixedReality::CAMERA_ISO getCameraISO() const#

Console: vr_mixed_reality_camera_iso

Возвращает Значение ISO для камеры.

Возвращаемое значение

Значение ISO.

void setCameraISOMode ( VRMixedReality::CAMERA_PROPERTY_MODE isomode ) #

Console: vr_mixed_reality_camera_iso_mode

Устанавливает Режим настройки ISO для камеры.

Аргументы

VRMixedReality::CAMERA_PROPERTY_MODE isomode - Режим настройки ISO. Одно из следующих значений:
- 0 - Настройка ISO отключена
- 1 - автоматическая настройка ISO (по умолчанию)
- 2 - ручная настройка ISO

VRMixedReality::CAMERA_PROPERTY_MODE getCameraISOMode() const#

Console: vr_mixed_reality_camera_iso_mode

Возвращает Режим настройки ISO для камеры.

Возвращаемое значение

Режим настройки ISO. Одно из следующих значений:

0 - Настройка ISO отключена
1 - автоматическая настройка ISO (по умолчанию)
2 - ручная настройка ISO

void setCameraFlickerCompensationRaw ( ) #

Устанавливает значение компенсации мерцания для камеры. Это полезно при использовании HMD в помещении, где в основном используются лампы искусственного освещения, которые мерцают с частотой 50 Гц или 60 Гц и могут вызывать визуальные артефакты мерцания на прозрачном изображении видео. Правильная настройка зависит от частоты базовой электросети. Например, в большинстве районов Африки/Азии/Австралии/Европы частота составляет 50 Гц, а в большинстве районов Северной и Южной Америки - 60 Гц.

Аргументы

raw - компенсация мерцания в Гц.

getCameraFlickerCompensationRaw() const#

Возвращает значение компенсации мерцания для камеры. Это полезно при использовании HMD в помещении, где в основном используются лампы искусственного освещения, которые мерцают с частотой 50 Гц или 60 Гц и могут вызывать визуальные артефакты мерцания на прозрачном изображении видео. Правильная настройка зависит от частоты базовой электросети. Например, в большинстве районов Африки/Азии/Австралии/Европы частота составляет 50 Гц, а в большинстве районов Северной и Южной Америки - 60 Гц.

Возвращаемое значение

компенсация мерцания в Гц.

void setCameraFlickerCompensation ( VRMixedReality::CAMERA_FLICKER_COMPENSATION compensation ) #

Console: vr_mixed_reality_camera_flicker_compensation

Аргументы

VRMixedReality::CAMERA_FLICKER_COMPENSATION compensation - компенсация мерцания.

VRMixedReality::CAMERA_FLICKER_COMPENSATION getCameraFlickerCompensation() const#

Console: vr_mixed_reality_camera_flicker_compensation

Возвращаемое значение

компенсация мерцания.

getCameraMinSharpness() const#

Возвращает минимально возможное значение для резкости камеры.

Возвращаемое значение

минимально возможное значение резкости камеры.

getCameraMaxSharpness() const#

Возвращает максимально возможное значение для резкости камеры.

Возвращаемое значение

максимально возможное значение резкости камеры.

void setCameraSharpness ( ) #

Console: vr_mixed_reality_camera_sharpness

Устанавливает значение мощности фильтра резкости для камеры.

Аргументы

sharpness - значение мощности фильтра резкости: наименьшее значение соответствует небольшому объему фильтрации, а наибольшее значение соответствует наибольшему объему фильтрации.
Диапазон значений: [0, 10]. Значение по умолчанию : 0.

getCameraSharpness() const#

Console: vr_mixed_reality_camera_sharpness

Возвращает значение мощности фильтра резкости для камеры.

Возвращаемое значение

значение мощности фильтра резкости: наименьшее значение соответствует небольшому объему фильтрации, а наибольшее значение соответствует наибольшему объему фильтрации.
Диапазон значений: [0, 10]. Значение по умолчанию : 0.

void setViewOffset ( ) #

Console: vr_mixed_reality_view_offset

Устанавливает глаза смещение обзора (где должна располагаться камера eye при использовании смешанной реальности):

0 for physical eye position 0 для физического положения глаз
1 for VST camera position 1 для положения камеры VST

Аргументы

offset - смещение вида.
Диапазон значений: [0.0, 1.0]. Значение по умолчанию : 0.0.

getViewOffset() const#

Console: vr_mixed_reality_view_offset

Возвращает глаза смещение обзора (где должна располагаться камера eye при использовании смешанной реальности):

0 for physical eye position 0 для физического положения глаз
1 for VST camera position 1 для положения камеры VST

Возвращаемое значение

смещение вида.
Диапазон значений: [0.0, 1.0]. Значение по умолчанию : 0.0.

void setMarkerTrackingEnabled ( bool enabled ) #

Console: vr_mixed_reality_marker_tracking_enabled

Устанавливает значение, указывающее, включено ли отслеживание маркера.

Аргументы

bool enabled - Set true to enable отслеживание маркера; false - to disable it. Значение по умолчанию false.

bool isMarkerTrackingEnabled() const#

Console: vr_mixed_reality_marker_tracking_enabled

Возвращает значение, указывающее, включено ли отслеживание маркера.

Возвращаемое значение

true if отслеживание маркера is enabled; otherwise false. Значение по умолчанию false.

getNumMarkerObjectVisible() const#

Возвращает количество видимых объектов-маркеров.

Возвращаемое значение

количество видимых объектов-маркеров.

void setCubemapMode ( VRMixedReality::CUBEMAP_MODE mode ) #

Console: vr_mixed_reality_cubemap_mode

Устанавливает режим, определяющий способ настройки текстуры AR для окружающей среды.

Аргументы

VRMixedReality::CUBEMAP_MODE mode - режим кубической карты. Одно из следующих значений:
- 0 - потоковая передача cubemap с камер дополненной реальности отключена.
- 1 - текстура окружающей среды заменяет небо.
- 2 - первая предустановка среды определяет способ настройки текстуры AR для среды. (по умолчанию)
- 3 - вторая предустановка окружения определяет способ настройки текстуры AR для окружения.
- 4 - третья предустановка среды определяет способ настройки текстуры AR для среды.

VRMixedReality::CUBEMAP_MODE getCubemapMode() const#

Console: vr_mixed_reality_cubemap_mode

Возвращает режим, определяющий способ настройки текстуры AR для окружающей среды.

Возвращаемое значение

режим кубической карты. Одно из следующих значений:

0 - потоковая передача cubemap с камер дополненной реальности отключена.
1 - текстура окружающей среды заменяет небо.
2 - первая предустановка среды определяет способ настройки текстуры AR для среды. (по умолчанию)
3 - вторая предустановка окружения определяет способ настройки текстуры AR для окружения.
4 - третья предустановка среды определяет способ настройки текстуры AR для среды.

void setCubemapGGXQuality ( Render::GGX_MIPMAPS_QUALITY ggxquality ) #

Console: vr_mixed_reality_cubemap_ggx_quality

Устанавливает качество сгенерированных GGX mips для AR cubemap.

Аргументы

Render::GGX_MIPMAPS_QUALITY ggxquality - качество mip-карт GGX. Одно из следующих значений:
- 0 - низкий
- 1 - средний (по умолчанию)
- 2 - высокий
- 3 - крайне

Render::GGX_MIPMAPS_QUALITY getCubemapGGXQuality() const#

Console: vr_mixed_reality_cubemap_ggx_quality

Возвращает качество сгенерированных GGX mips для AR cubemap.

Возвращаемое значение

качество mip-карт GGX. Одно из следующих значений:

0 - низкий
1 - средний (по умолчанию)
2 - высокий
3 - крайне

void setOverrideColorCorrectionMode ( VRMixedReality::OVERRIDE_COLOR_CORRECTION_MODE mode ) #

Console: vr_mixed_reality_override_color_correction_mode

Устанавливает режим цветокоррекции для потока с камер дополненной реальности.

Аргументы

VRMixedReality::OVERRIDE_COLOR_CORRECTION_MODE mode - режим цветокоррекции. Одно из следующих значений:
- 0 - коррекция отключена. (по умолчанию)
- 1 - коррекция экспозиции для потока с камер дополненной реальности.
- 2 - коррекция экспозиции и баланса белого для потока.

VRMixedReality::OVERRIDE_COLOR_CORRECTION_MODE getOverrideColorCorrectionMode() const#

Console: vr_mixed_reality_override_color_correction_mode

Возвращает режим цветокоррекции для потока с камер дополненной реальности.

Возвращаемое значение

режим цветокоррекции. Одно из следующих значений:

0 - коррекция отключена. (по умолчанию)
1 - коррекция экспозиции для потока с камер дополненной реальности.
2 - коррекция экспозиции и баланса белого для потока.

static Event<> getEventCameraPropertyUpdateSharpness() const#

Событие запускается при изменении резкости камеры в Varjo Base. Вы можете подписаться на события через connect() и отказаться от подписки через disconnect(). Вы также можете использовать EventConnection и EventConnections классы для удобства (см. примеры ниже).

Примечание

Для получения более подробной информации смотрите статью Обработка событий.

The event handler signature is as follows: myhandler()

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 instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections camerapropertyupdatesharpness_event_connections;

// link to this instance when subscribing to an event (subscription to various events can be linked)
VRMixedReality::getEventCameraPropertyUpdateSharpness().connect(camerapropertyupdatesharpness_event_connections, camerapropertyupdatesharpness_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
VRMixedReality::getEventCameraPropertyUpdateSharpness().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 an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection camerapropertyupdatesharpness_event_connection;

// subscribe to the CameraPropertyUpdateSharpness event with a handler function keeping the connection
VRMixedReality::getEventCameraPropertyUpdateSharpness().connect(camerapropertyupdatesharpness_event_connection, camerapropertyupdatesharpness_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
camerapropertyupdatesharpness_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
camerapropertyupdatesharpness_event_connection.setEnabled(true);

// ...

// remove subscription to the CameraPropertyUpdateSharpness event via the connection
camerapropertyupdatesharpness_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A CameraPropertyUpdateSharpness event handler implemented as a class member
	void event_handler()
	{
		Log::message("\Handling CameraPropertyUpdateSharpness event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
VRMixedReality::getEventCameraPropertyUpdateSharpness().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe to the CameraPropertyUpdateSharpness event with a handler function
VRMixedReality::getEventCameraPropertyUpdateSharpness().connect(camerapropertyupdatesharpness_event_handler);


// remove subscription to the CameraPropertyUpdateSharpness event later by the handler function
VRMixedReality::getEventCameraPropertyUpdateSharpness().disconnect(camerapropertyupdatesharpness_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId camerapropertyupdatesharpness_handler_id;

// subscribe to the CameraPropertyUpdateSharpness event with a lambda handler function and keeping connection ID
camerapropertyupdatesharpness_handler_id = VRMixedReality::getEventCameraPropertyUpdateSharpness().connect([]() { 
		Log::message("\Handling CameraPropertyUpdateSharpness event (lambda).\n");
	}
);

// remove the subscription later using the ID
VRMixedReality::getEventCameraPropertyUpdateSharpness().disconnect(camerapropertyupdatesharpness_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all CameraPropertyUpdateSharpness events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
VRMixedReality::getEventCameraPropertyUpdateSharpness().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
VRMixedReality::getEventCameraPropertyUpdateSharpness().setEnabled(true);

Возвращаемое значение

Event reference.

static Event<> getEventCameraPropertyUpdateFlickerCompensation() const#

Событие запускается при изменении значения компенсации мерцания камеры в Varjo Base. Вы можете подписаться на события через connect() и отказаться от подписки через disconnect(). Вы также можете использовать EventConnection и EventConnections классы для удобства (см. примеры ниже).

Примечание

Для получения более подробной информации смотрите статью Обработка событий.

The event handler signature is as follows: myhandler()

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 instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections camerapropertyupdateflickercompensation_event_connections;

// link to this instance when subscribing to an event (subscription to various events can be linked)
VRMixedReality::getEventCameraPropertyUpdateFlickerCompensation().connect(camerapropertyupdateflickercompensation_event_connections, camerapropertyupdateflickercompensation_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
VRMixedReality::getEventCameraPropertyUpdateFlickerCompensation().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 an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection camerapropertyupdateflickercompensation_event_connection;

// subscribe to the CameraPropertyUpdateFlickerCompensation event with a handler function keeping the connection
VRMixedReality::getEventCameraPropertyUpdateFlickerCompensation().connect(camerapropertyupdateflickercompensation_event_connection, camerapropertyupdateflickercompensation_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
camerapropertyupdateflickercompensation_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
camerapropertyupdateflickercompensation_event_connection.setEnabled(true);

// ...

// remove subscription to the CameraPropertyUpdateFlickerCompensation event via the connection
camerapropertyupdateflickercompensation_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A CameraPropertyUpdateFlickerCompensation event handler implemented as a class member
	void event_handler()
	{
		Log::message("\Handling CameraPropertyUpdateFlickerCompensation event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
VRMixedReality::getEventCameraPropertyUpdateFlickerCompensation().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe to the CameraPropertyUpdateFlickerCompensation event with a handler function
VRMixedReality::getEventCameraPropertyUpdateFlickerCompensation().connect(camerapropertyupdateflickercompensation_event_handler);


// remove subscription to the CameraPropertyUpdateFlickerCompensation event later by the handler function
VRMixedReality::getEventCameraPropertyUpdateFlickerCompensation().disconnect(camerapropertyupdateflickercompensation_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId camerapropertyupdateflickercompensation_handler_id;

// subscribe to the CameraPropertyUpdateFlickerCompensation event with a lambda handler function and keeping connection ID
camerapropertyupdateflickercompensation_handler_id = VRMixedReality::getEventCameraPropertyUpdateFlickerCompensation().connect([]() { 
		Log::message("\Handling CameraPropertyUpdateFlickerCompensation event (lambda).\n");
	}
);

// remove the subscription later using the ID
VRMixedReality::getEventCameraPropertyUpdateFlickerCompensation().disconnect(camerapropertyupdateflickercompensation_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all CameraPropertyUpdateFlickerCompensation events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
VRMixedReality::getEventCameraPropertyUpdateFlickerCompensation().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
VRMixedReality::getEventCameraPropertyUpdateFlickerCompensation().setEnabled(true);

Возвращаемое значение

Event reference.

static Event<> getEventCameraPropertyUpdateISO() const#

Событие запускается при изменении значения и/или режима настройки ISO камеры в Varjo Base. Вы можете подписаться на события через connect() и отказаться от подписки через disconnect(). Вы также можете использовать EventConnection и EventConnections классы для удобства (см. примеры ниже).

Примечание

Для получения более подробной информации смотрите статью Обработка событий.

The event handler signature is as follows: myhandler()

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 instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections camerapropertyupdateiso_event_connections;

// link to this instance when subscribing to an event (subscription to various events can be linked)
VRMixedReality::getEventCameraPropertyUpdateISO().connect(camerapropertyupdateiso_event_connections, camerapropertyupdateiso_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
VRMixedReality::getEventCameraPropertyUpdateISO().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 an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection camerapropertyupdateiso_event_connection;

// subscribe to the CameraPropertyUpdateISO event with a handler function keeping the connection
VRMixedReality::getEventCameraPropertyUpdateISO().connect(camerapropertyupdateiso_event_connection, camerapropertyupdateiso_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
camerapropertyupdateiso_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
camerapropertyupdateiso_event_connection.setEnabled(true);

// ...

// remove subscription to the CameraPropertyUpdateISO event via the connection
camerapropertyupdateiso_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A CameraPropertyUpdateISO event handler implemented as a class member
	void event_handler()
	{
		Log::message("\Handling CameraPropertyUpdateISO event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
VRMixedReality::getEventCameraPropertyUpdateISO().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe to the CameraPropertyUpdateISO event with a handler function
VRMixedReality::getEventCameraPropertyUpdateISO().connect(camerapropertyupdateiso_event_handler);


// remove subscription to the CameraPropertyUpdateISO event later by the handler function
VRMixedReality::getEventCameraPropertyUpdateISO().disconnect(camerapropertyupdateiso_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId camerapropertyupdateiso_handler_id;

// subscribe to the CameraPropertyUpdateISO event with a lambda handler function and keeping connection ID
camerapropertyupdateiso_handler_id = VRMixedReality::getEventCameraPropertyUpdateISO().connect([]() { 
		Log::message("\Handling CameraPropertyUpdateISO event (lambda).\n");
	}
);

// remove the subscription later using the ID
VRMixedReality::getEventCameraPropertyUpdateISO().disconnect(camerapropertyupdateiso_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all CameraPropertyUpdateISO events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
VRMixedReality::getEventCameraPropertyUpdateISO().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
VRMixedReality::getEventCameraPropertyUpdateISO().setEnabled(true);

Возвращаемое значение

Event reference.

static Event<> getEventCameraPropertyUpdateWhiteBalance() const#

Событие запускается при изменении значения и/или режима настройки баланса белого для камеры в Varjo Base. Вы можете подписаться на события через connect() и отказаться от подписки через disconnect(). Вы также можете использовать EventConnection и EventConnections классы для удобства (см. примеры ниже).

Примечание

Для получения более подробной информации смотрите статью Обработка событий.

The event handler signature is as follows: myhandler()

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 instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections camerapropertyupdatewhitebalance_event_connections;

// link to this instance when subscribing to an event (subscription to various events can be linked)
VRMixedReality::getEventCameraPropertyUpdateWhiteBalance().connect(camerapropertyupdatewhitebalance_event_connections, camerapropertyupdatewhitebalance_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
VRMixedReality::getEventCameraPropertyUpdateWhiteBalance().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 an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection camerapropertyupdatewhitebalance_event_connection;

// subscribe to the CameraPropertyUpdateWhiteBalance event with a handler function keeping the connection
VRMixedReality::getEventCameraPropertyUpdateWhiteBalance().connect(camerapropertyupdatewhitebalance_event_connection, camerapropertyupdatewhitebalance_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
camerapropertyupdatewhitebalance_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
camerapropertyupdatewhitebalance_event_connection.setEnabled(true);

// ...

// remove subscription to the CameraPropertyUpdateWhiteBalance event via the connection
camerapropertyupdatewhitebalance_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A CameraPropertyUpdateWhiteBalance event handler implemented as a class member
	void event_handler()
	{
		Log::message("\Handling CameraPropertyUpdateWhiteBalance event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
VRMixedReality::getEventCameraPropertyUpdateWhiteBalance().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe to the CameraPropertyUpdateWhiteBalance event with a handler function
VRMixedReality::getEventCameraPropertyUpdateWhiteBalance().connect(camerapropertyupdatewhitebalance_event_handler);


// remove subscription to the CameraPropertyUpdateWhiteBalance event later by the handler function
VRMixedReality::getEventCameraPropertyUpdateWhiteBalance().disconnect(camerapropertyupdatewhitebalance_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId camerapropertyupdatewhitebalance_handler_id;

// subscribe to the CameraPropertyUpdateWhiteBalance event with a lambda handler function and keeping connection ID
camerapropertyupdatewhitebalance_handler_id = VRMixedReality::getEventCameraPropertyUpdateWhiteBalance().connect([]() { 
		Log::message("\Handling CameraPropertyUpdateWhiteBalance event (lambda).\n");
	}
);

// remove the subscription later using the ID
VRMixedReality::getEventCameraPropertyUpdateWhiteBalance().disconnect(camerapropertyupdatewhitebalance_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all CameraPropertyUpdateWhiteBalance events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
VRMixedReality::getEventCameraPropertyUpdateWhiteBalance().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
VRMixedReality::getEventCameraPropertyUpdateWhiteBalance().setEnabled(true);

Возвращаемое значение

Event reference.

static Event<> getEventCameraPropertyUpdateExposureTime() const#

Событие запускается при изменении значения и/или режима настройки времени экспозиции для камеры в Varjo Base. Вы можете подписаться на события через connect() и отказаться от подписки через disconnect(). Вы также можете использовать EventConnection и EventConnections классы для удобства (см. примеры ниже).

Примечание

Для получения более подробной информации смотрите статью Обработка событий.

The event handler signature is as follows: myhandler()

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 instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections camerapropertyupdateexposuretime_event_connections;

// link to this instance when subscribing to an event (subscription to various events can be linked)
VRMixedReality::getEventCameraPropertyUpdateExposureTime().connect(camerapropertyupdateexposuretime_event_connections, camerapropertyupdateexposuretime_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
VRMixedReality::getEventCameraPropertyUpdateExposureTime().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 an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection camerapropertyupdateexposuretime_event_connection;

// subscribe to the CameraPropertyUpdateExposureTime event with a handler function keeping the connection
VRMixedReality::getEventCameraPropertyUpdateExposureTime().connect(camerapropertyupdateexposuretime_event_connection, camerapropertyupdateexposuretime_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
camerapropertyupdateexposuretime_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
camerapropertyupdateexposuretime_event_connection.setEnabled(true);

// ...

// remove subscription to the CameraPropertyUpdateExposureTime event via the connection
camerapropertyupdateexposuretime_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A CameraPropertyUpdateExposureTime event handler implemented as a class member
	void event_handler()
	{
		Log::message("\Handling CameraPropertyUpdateExposureTime event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
VRMixedReality::getEventCameraPropertyUpdateExposureTime().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe to the CameraPropertyUpdateExposureTime event with a handler function
VRMixedReality::getEventCameraPropertyUpdateExposureTime().connect(camerapropertyupdateexposuretime_event_handler);


// remove subscription to the CameraPropertyUpdateExposureTime event later by the handler function
VRMixedReality::getEventCameraPropertyUpdateExposureTime().disconnect(camerapropertyupdateexposuretime_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId camerapropertyupdateexposuretime_handler_id;

// subscribe to the CameraPropertyUpdateExposureTime event with a lambda handler function and keeping connection ID
camerapropertyupdateexposuretime_handler_id = VRMixedReality::getEventCameraPropertyUpdateExposureTime().connect([]() { 
		Log::message("\Handling CameraPropertyUpdateExposureTime event (lambda).\n");
	}
);

// remove the subscription later using the ID
VRMixedReality::getEventCameraPropertyUpdateExposureTime().disconnect(camerapropertyupdateexposuretime_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all CameraPropertyUpdateExposureTime events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
VRMixedReality::getEventCameraPropertyUpdateExposureTime().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
VRMixedReality::getEventCameraPropertyUpdateExposureTime().setEnabled(true);

Возвращаемое значение

Event reference.

static Event<> getEventChromakeyUpdate() const#

Событие запускается при изменении настроек хромакея (chroma key) в Varjo Base. Вы можете подписаться на события через connect() и отказаться от подписки через disconnect(). Вы также можете использовать EventConnection и EventConnections классы для удобства (см. примеры ниже).

Примечание

Для получения более подробной информации смотрите статью Обработка событий.

The event handler signature is as follows: myhandler()

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 instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections chromakeyupdate_event_connections;

// link to this instance when subscribing to an event (subscription to various events can be linked)
VRMixedReality::getEventChromakeyUpdate().connect(chromakeyupdate_event_connections, chromakeyupdate_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
VRMixedReality::getEventChromakeyUpdate().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 an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection chromakeyupdate_event_connection;

// subscribe to the ChromakeyUpdate event with a handler function keeping the connection
VRMixedReality::getEventChromakeyUpdate().connect(chromakeyupdate_event_connection, chromakeyupdate_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
chromakeyupdate_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
chromakeyupdate_event_connection.setEnabled(true);

// ...

// remove subscription to the ChromakeyUpdate event via the connection
chromakeyupdate_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A ChromakeyUpdate event handler implemented as a class member
	void event_handler()
	{
		Log::message("\Handling ChromakeyUpdate event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
VRMixedReality::getEventChromakeyUpdate().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe to the ChromakeyUpdate event with a handler function
VRMixedReality::getEventChromakeyUpdate().connect(chromakeyupdate_event_handler);


// remove subscription to the ChromakeyUpdate event later by the handler function
VRMixedReality::getEventChromakeyUpdate().disconnect(chromakeyupdate_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId chromakeyupdate_handler_id;

// subscribe to the ChromakeyUpdate event with a lambda handler function and keeping connection ID
chromakeyupdate_handler_id = VRMixedReality::getEventChromakeyUpdate().connect([]() { 
		Log::message("\Handling ChromakeyUpdate event (lambda).\n");
	}
);

// remove the subscription later using the ID
VRMixedReality::getEventChromakeyUpdate().disconnect(chromakeyupdate_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all ChromakeyUpdate events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
VRMixedReality::getEventChromakeyUpdate().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
VRMixedReality::getEventChromakeyUpdate().setEnabled(true);

Возвращаемое значение

Event reference.

static Event<> getEventDeviceDisconnected() const#

Событие запускается при при отключении VR устройства. Вы можете подписаться на события через connect() и отказаться от подписки через disconnect(). Вы также можете использовать EventConnection и EventConnections классы для удобства (см. примеры ниже).

Примечание

Для получения более подробной информации смотрите статью Обработка событий.

The event handler signature is as follows: myhandler()

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 instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections devicedisconnected_event_connections;

// link to this instance when subscribing to an event (subscription to various events can be linked)
VRMixedReality::getEventDeviceDisconnected().connect(devicedisconnected_event_connections, devicedisconnected_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
VRMixedReality::getEventDeviceDisconnected().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 an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection devicedisconnected_event_connection;

// subscribe to the DeviceDisconnected event with a handler function keeping the connection
VRMixedReality::getEventDeviceDisconnected().connect(devicedisconnected_event_connection, devicedisconnected_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
devicedisconnected_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
devicedisconnected_event_connection.setEnabled(true);

// ...

// remove subscription to the DeviceDisconnected event via the connection
devicedisconnected_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A DeviceDisconnected event handler implemented as a class member
	void event_handler()
	{
		Log::message("\Handling DeviceDisconnected event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
VRMixedReality::getEventDeviceDisconnected().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe to the DeviceDisconnected event with a handler function
VRMixedReality::getEventDeviceDisconnected().connect(devicedisconnected_event_handler);


// remove subscription to the DeviceDisconnected event later by the handler function
VRMixedReality::getEventDeviceDisconnected().disconnect(devicedisconnected_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId devicedisconnected_handler_id;

// subscribe to the DeviceDisconnected event with a lambda handler function and keeping connection ID
devicedisconnected_handler_id = VRMixedReality::getEventDeviceDisconnected().connect([]() { 
		Log::message("\Handling DeviceDisconnected event (lambda).\n");
	}
);

// remove the subscription later using the ID
VRMixedReality::getEventDeviceDisconnected().disconnect(devicedisconnected_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all DeviceDisconnected events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
VRMixedReality::getEventDeviceDisconnected().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
VRMixedReality::getEventDeviceDisconnected().setEnabled(true);

Возвращаемое значение

Event reference.

static Event<> getEventDeviceConnected() const#

Событие запускается при при подключении VR устройства. Вы можете подписаться на события через connect() и отказаться от подписки через disconnect(). Вы также можете использовать EventConnection и EventConnections классы для удобства (см. примеры ниже).

Примечание

Для получения более подробной информации смотрите статью Обработка событий.

The event handler signature is as follows: myhandler()

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 instance of the EventConnections 
//  class that you can use later to remove all these subscriptions at once
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnections class
EventConnections deviceconnected_event_connections;

// link to this instance when subscribing to an event (subscription to various events can be linked)
VRMixedReality::getEventDeviceConnected().connect(deviceconnected_event_connections, deviceconnected_event_handler);

// other subscriptions are also linked to this EventConnections instance 
// (e.g. you can subscribe using lambdas)
VRMixedReality::getEventDeviceConnected().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 an instance of the EventConnection 
//  class. And toggle this particular connection off and on, when necessary.
//////////////////////////////////////////////////////////////////////////////

// create an instance of the EventConnection class
EventConnection deviceconnected_event_connection;

// subscribe to the DeviceConnected event with a handler function keeping the connection
VRMixedReality::getEventDeviceConnected().connect(deviceconnected_event_connection, deviceconnected_event_handler);

// ...

// you can temporarily disable a particular event connection to perform certain actions
deviceconnected_event_connection.setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
deviceconnected_event_connection.setEnabled(true);

// ...

// remove subscription to the DeviceConnected event via the connection
deviceconnected_event_connection.disconnect();

//////////////////////////////////////////////////////////////////////////////
//  3. You can add EventConnection/EventConnections instance as a member of the
//  class that handles the event. In this case all linked subscriptions will be 
//  automatically removed when class destructor is called
//////////////////////////////////////////////////////////////////////////////

// Class handling the event
class SomeClass
{
public:
	// instance of the EventConnections class as a class member
	EventConnections e_connections;

	// A DeviceConnected event handler implemented as a class member
	void event_handler()
	{
		Log::message("\Handling DeviceConnected event\n");
		// ...
	}
};

SomeClass *sc = new SomeClass();

// ...

// specify a class instance in case a handler method belongs to some class
VRMixedReality::getEventDeviceConnected().connect(sc->e_connections, sc, &SomeClass::event_handler);

// ...

// handler class instance is deleted with all its subscriptions removed automatically
delete sc;

//////////////////////////////////////////////////////////////////////////////
//  4. You can subscribe and unsubscribe via the handler function directly
//////////////////////////////////////////////////////////////////////////////

// subscribe to the DeviceConnected event with a handler function
VRMixedReality::getEventDeviceConnected().connect(deviceconnected_event_handler);


// remove subscription to the DeviceConnected event later by the handler function
VRMixedReality::getEventDeviceConnected().disconnect(deviceconnected_event_handler);


//////////////////////////////////////////////////////////////////////////////
//   5. Subscribe to an event saving an ID and unsubscribe later by this ID
//////////////////////////////////////////////////////////////////////////////

// define a connection ID to be used to unsubscribe later
EventConnectionId deviceconnected_handler_id;

// subscribe to the DeviceConnected event with a lambda handler function and keeping connection ID
deviceconnected_handler_id = VRMixedReality::getEventDeviceConnected().connect([]() { 
		Log::message("\Handling DeviceConnected event (lambda).\n");
	}
);

// remove the subscription later using the ID
VRMixedReality::getEventDeviceConnected().disconnect(deviceconnected_handler_id);


//////////////////////////////////////////////////////////////////////////////
//   6. Ignoring all DeviceConnected events when necessary
//////////////////////////////////////////////////////////////////////////////

// you can temporarily disable the event to perform certain actions without triggering it
VRMixedReality::getEventDeviceConnected().setEnabled(false);

// ... actions to be performed

// and enable it back when necessary
VRMixedReality::getEventDeviceConnected().setEnabled(true);

Возвращаемое значение

Event reference.

void applySettings ( ) #

Обновляет настройки смешанной реальности до текущих настроек.

bool isChromaKeyConfigEnabled ( int index ) const#

Возвращает текущее значение, указывающее, включена ли настройка цветового ключа с указанным индексом.

Аргументы

int index - Chroma key config index in the range from 0 to config count - 1.Индекс конфигурации цветового ключа в диапазоне от 0 до config count - 1.

Возвращаемое значение

1 включена настройка цветового ключа; в противном случае - 0.

void setChromaKeyConfigEnabled ( int index, bool 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, чтобы отключить ее.

Math::vec3 getChromaKeyConfigFalloff ( int index ) const#

Возвращает текущие значения отклонения допуска для компонентов HSV целевого цвета цветового ключа.

Аргументы

int index - Chroma key config index in the range from 0 to config count - 1.Индекс конфигурации цветового ключа в диапазоне от 0 до config count - 1.

Возвращаемое значение

Текущие значения допустимого отклонения для компонентов HSV целевого цвета цветового ключа. Диапазон для каждого компонента равен [0.0; 1.0].

void setChromaKeyConfigFalloff ( int index, const Math::vec3 & falloff ) #

Устанавливает новые значения отклонения допуска для компонентов HSV целевого цвета цветового ключа.

Аргументы

int index - Chroma key config index in the range from 0 to config count - 1.Индекс конфигурации цветового ключа в диапазоне от 0 до config count - 1.
const Math::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].

Math::vec3 getChromaKeyConfigTargetColor ( int index ) const#

Возвращает текущий целевой цвет цветового ключа.

Аргументы

int index - Chroma key config index in the range from 0 to config count - 1.Индекс конфигурации цветового ключа в диапазоне от 0 до config count - 1.

Возвращаемое значение

Текущий целевой цвет цветового ключа в цветовом пространстве HSV. Диапазон для каждого компонента равен [0.0; 1.0].

void setChromaKeyConfigTargetColor ( int index, const Math::vec3 & target_color ) #

Устанавливает новый целевой цвет цветового ключа.

Аргументы

int index - Chroma key config index in the range from 0 to config count - 1.Индекс конфигурации цветового ключа в диапазоне от 0 до config count - 1.
const Math::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].

Math::vec3 getChromaKeyConfigTolerance ( int index ) const#

Возвращает текущие значения допуска для компонентов HSV целевого цвета цветового ключа.

Аргументы

int index - Chroma key config index in the range from 0 to config count - 1.Индекс конфигурации цветового ключа в диапазоне от 0 до config count - 1.

Возвращаемое значение

Текущие допустимые значения для компонентов HSV целевого цвета chroma key. Диапазон для каждого компонента равен [0.0; 1.0].

void setChromaKeyConfigTolerance ( int index, const Math::vec3 & tolerance ) #

Устанавливает новые значения допуска для компонентов HSV целевого цвета цветового ключа.

Аргументы

int index - Chroma key config index in the range from 0 to config count - 1.Индекс конфигурации цветового ключа в диапазоне от 0 до config count - 1.
const Math::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 ) const#

Обновляет настройки конфигурации цветового ключа с указанным индексом до текущих настроек.

Аргументы

int index - Chroma key config index in the range from 0 to config count - 1.Индекс конфигурации цветового ключа в диапазоне от 0 до config count - 1.

Vector<int> getCameraSupportedRawExposureTimes ( ) const#

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

Возвращаемое значение

Вектор, содержащий значения времени экспозиции.

Vector<int> getCameraSupportedRawWhiteBalances ( ) const#

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

Возвращаемое значение

Вектор, содержащий значения баланса белого.

Vector<int> getCameraSupportedRawISO ( ) const#

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

Возвращаемое значение

Вектор, содержащий значения ISO.

Vector<int> getCameraSupportedRawFlickerCompensations ( ) const#

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

Возвращаемое значение

Вектор, содержащий значения компенсации мерцания.

Ptr<VRMarkerObject> getMarkerObject ( short index ) const#

Возвращает объект-маркер с указанным индексом.

Аргументы

short index - Marker object index.Индекс объекта маркера.

Возвращаемое значение

Объект-маркер.

Ptr<VRMarkerObject> getMarkerObjectByID ( short marker_id ) const#

Возвращает объект-маркер с указанным идентификатором.

Аргументы

short marker_id - Marker object ID.Идентификатор объекта маркера.

Возвращаемое значение

Объект-маркер.

Последнее обновление: 19.04.2024

Помогите сделать статью лучше

Была ли эта статья полезной?

Сообщить о проблеме в этой статье

(или выберите слово/фразу и нажмите Ctrl+Enter