Unigine::InputVRHead Class
Header: | #include <UnigineInput.h> |
Inherits from: | InputVRDevice |
InputVRHead Class
Enums
MODEL_TYPE#
Members
InputVRHead::MODEL_TYPE getModelType ( ) const#
Returns the model type of the HMD.Return value
HMD model type.bool hasButtons ( ) const#
Returns a value indicating if the HMD has buttons.Return value
true if there are buttons; otherwise, false.Vector<float> getSupportedRefreshRates ( ) const#
Returns an array of supported display refresh rates, in Hz, with at least one supported refresh rate.Return value
The vector of supported display refresh rates, in Hz.void setRefreshRate ( float rate ) #
Sets the display refresh rate, if supported.Arguments
- float rate - The display refresh rate, in Hz.
float getRefreshRate ( ) const#
Returns the current display refresh rate, in Hz.Return value
The display refresh rate, in Hz.void setTrackingPositionEnabled ( bool enabled ) #
Sets the value indicating if head position tracking is enabled.Arguments
- bool enabled - true to enable position tracking; false to disable it.
bool isTrackingPositionEnabled ( ) const#
Returns a value indicating if head position tracking is enabled.Return value
true if position tracking is enabled; otherwise, false.void setTrackingRotationEnabled ( bool enabled ) #
Sets the value indicating if head rotation tracking is enabled.Arguments
- bool enabled - true to enable rotation tracking; false to disable it.
bool isTrackingRotationEnabled ( ) const#
Returns a value indicating if head rotation tracking is enabled.Return value
true if rotation tracking is enabled; otherwise, false.bool isButtonPressed ( Input::VR_BUTTON button ) const#
Returns a value indicating if the specified button is pressed. Check this value to perform continuous actions.Arguments
- Input::VR_BUTTON button - Button.
Return value
true if the button is pressed; otherwise, false.bool isButtonDown ( Input::VR_BUTTON button ) const#
Returns a value indicating if the specified button was pressed during the current frame.Arguments
- Input::VR_BUTTON button - Button.
Return value
true if the button was pressed; otherwise, false.bool isButtonUp ( Input::VR_BUTTON button ) const#
Returns a value indicating if the specified button was released during the current frame.Arguments
- Input::VR_BUTTON button - Button.
Return value
true if the button was released; otherwise, false.Ptr<InputEventVRButton> getButtonEvent ( Input::VR_BUTTON button ) const#
Returns the currently processed HMD button input event.Arguments
- Input::VR_BUTTON button - Button.
Return value
HMD button input event, or nullptr if there are no events for the specified button in the current frame.int getButtonEvents ( Input::VR_BUTTON button, Vector<Ptr<InputEventVRButton>> & OUT_events ) #
Returns the number of input events for the specified HMD button and puts the events to the specified output buffer.Arguments
- Input::VR_BUTTON button - Button.
- Vector<Ptr<InputEventVRButton>> & OUT_events - Buffer with HMD button input events.This output buffer is to be filled by the Engine as a result of executing the method.
Return value
Number of input events for the specified HMD button.Last update:
2024-08-16
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)