Interface IVRVideoControl

Namespace

VisioForge.Core.Types

Assembly

VisioForge.Core.dll

Defines an interface for controlling Virtual Reality (VR) video playback parameters. This interface allows manipulation of camera orientation (yaw, pitch, roll), field of view, and the VR projection mode.

public interface IVRVideoControl

Remarks

Implementations of this interface are typically found in video renderers or effects that support 360-degree or VR video content. It enables interactive viewing of immersive video by adjusting the viewer's perspective within the virtual environment. Yaw controls horizontal rotation (looking left/right), pitch controls vertical rotation (looking up/down), and roll controls tilting. Field of view determines how zoomed in or out the view appears - smaller values create a telephoto effect, larger values create a wide-angle effect. The Mode property determines how the 2D video source is projected into 3D space (equirectangular for 360° videos, cubemap for better quality at poles, or normal for standard video). Different VR modes may be supported by different components - use IsModeSupported to check compatibility before setting the mode. The SettingsChanged event notifies listeners when any VR parameters change, useful for synchronizing UI controls.

Properties

FieldOfView

Gets or sets the field of view (FOV) of the VR camera in degrees. This controls the zoom level or how much of the scene is visible.

float FieldOfView { get; set; }

Property Value

float

Mode

Gets or sets the current VR projection mode.

VRMode Mode { get; set; }

Property Value

VRMode

Pitch

Gets or sets the pitch (up/down rotation) of the VR camera in degrees.

float Pitch { get; set; }

Property Value

float

Roll

Gets or sets the roll (tilt) of the VR camera in degrees.

float Roll { get; set; }

Property Value

float

Yaw

Gets or sets the yaw (left/right rotation) of the VR camera in degrees.

float Yaw { get; set; }

Property Value

float

Methods

IsModeSupported(VRMode)

Checks if a specific VR mode is supported by the implementing component (e.g., video block, effect, or renderer).

bool IsModeSupported(VRMode mode)

Parameters

mode VRMode

The VisioForge.Core.Types.VRMode to check for support.

Returns

bool

true if the mode is supported; otherwise, false.

SettingsChanged

Occurs when any of the VR control settings (Yaw, Pitch, Roll, FieldOfView, Mode) have changed.

event EventHandler<EventArgs> SettingsChanged

Event Type

EventHandler<EventArgs>