unreal.OculusMR_Settings
¶
-
class
unreal.
OculusMR_Settings
(outer=None, name='None')¶ Bases:
unreal.Object
Oculus MR Settings
C++ Source:
Plugin: OculusVR
Module: OculusMR
File: OculusMR_Settings.h
Editor Properties: (see get_editor_property/set_editor_property)
backdrop_color
(Color): [Read-Write] When CompositionMethod is External Composition, the color of the backdrop in the foreground viewcasting_latency
(float): [Read-Write] When CompositionMethod is External Composition, the latency of the casting output which could be adjusted to match the camera latency in the external composition applicationchroma_key_color
(Color): [Read-Write] [Green-screen removal] Chroma Key Color. Apply when CompositionMethod is DirectCompositionchroma_key_similarity
(float): [Read-Write] [Green-screen removal] Chroma Key Similarity. Apply when CompositionMethod is DirectCompositionchroma_key_smooth_range
(float): [Read-Write] [Green-screen removal] Chroma Key Smooth Range. Apply when CompositionMethod is DirectCompositionchroma_key_spill_range
(float): [Read-Write] [Green-screen removal] Chroma Key Spill Range. Apply when CompositionMethod is DirectCompositionclipping_reference
(OculusMR_ClippingReference): [Read-Write] Specify the distance to the camera which divide the background and foreground in MxR casting. Set it to CR_TrackingReference to use the distance to the Tracking Reference, which works better in the stationary experience. Set it to CR_Head would use the distance to the HMD, which works better in the room scale experience.external_composition_post_process_effects
(OculusMR_PostProcessEffects): [Read-Write] Set the amount of post process effects in the MR view for external compositionhand_pose_state_latency
(float): [Read-Write] When CompositionMethod is Direct Composition, you could adjust this latency to delay the virtual hand movement by a small amount of time to match the camera latencyheight_per_view
(int32): [Read-Write] When bUseTrackedCameraResolution is false, the height of each casting viewportuse_tracked_camera_resolution
(bool): [Read-Write] The casting viewports would use the same resolution of the camera which used in the calibration process.width_per_view
(int32): [Read-Write] When bUseTrackedCameraResolution is false, the width of each casting viewport
-
property
backdrop_color
¶ [Read-Write] When CompositionMethod is External Composition, the color of the backdrop in the foreground view
- Type
(Color)
-
bind_to_tracked_camera_index_if_available
(tracked_camera_index) → None¶ Bind the casting camera to the calibrated external camera. (Requires a calibrated external camera)
- Parameters
tracked_camera_index (int32) –
-
property
casting_latency
¶ [Read-Write] When CompositionMethod is External Composition, the latency of the casting output which could be adjusted to match the camera latency in the external composition application
- Type
(float)
-
property
chroma_key_color
¶ [Read-Write] [Green-screen removal] Chroma Key Color. Apply when CompositionMethod is DirectComposition
- Type
(Color)
-
property
chroma_key_similarity
¶ [Read-Write] [Green-screen removal] Chroma Key Similarity. Apply when CompositionMethod is DirectComposition
- Type
(float)
-
property
chroma_key_smooth_range
¶ [Read-Write] [Green-screen removal] Chroma Key Smooth Range. Apply when CompositionMethod is DirectComposition
- Type
(float)
-
property
chroma_key_spill_range
¶ [Read-Write] [Green-screen removal] Chroma Key Spill Range. Apply when CompositionMethod is DirectComposition
- Type
(float)
-
property
clipping_reference
¶ [Read-Write] Specify the distance to the camera which divide the background and foreground in MxR casting. Set it to CR_TrackingReference to use the distance to the Tracking Reference, which works better in the stationary experience. Set it to CR_Head would use the distance to the HMD, which works better in the room scale experience.
- Type
-
property
external_composition_post_process_effects
¶ [Read-Write] Set the amount of post process effects in the MR view for external composition
- Type
-
get_bind_to_tracked_camera_index
() → int32¶ Get Bind to Tracked Camera Index
- Returns
- Return type
int32
-
get_capturing_camera
() → OculusMR_CameraDeviceEnum¶ When CompositionMethod is DirectComposition, the physical camera device which provide the frame
- Returns
- Return type
-
get_composition_method
() → OculusMR_CompositionMethod¶ ExternalComposition: The casting window includes the background and foreground view DirectComposition: The game scene would be composited with the camera frame directly
- Returns
- Return type
-
property
hand_pose_state_latency
¶ [Read-Write] When CompositionMethod is Direct Composition, you could adjust this latency to delay the virtual hand movement by a small amount of time to match the camera latency
- Type
(float)
-
property
height_per_view
¶ [Read-Write] When bUseTrackedCameraResolution is false, the height of each casting viewport
- Type
(int32)
-
set_capturing_camera
(val) → None¶ When CompositionMethod is DirectComposition, the physical camera device which provide the frame
- Parameters
val (OculusMR_CameraDeviceEnum) –
-
set_composition_method
(val) → None¶ ExternalComposition: The casting window includes the background and foreground view DirectComposition: The game scene would be composited with the camera frame directly
- Parameters
val (OculusMR_CompositionMethod) –
-
property
use_tracked_camera_resolution
¶ [Read-Write] The casting viewports would use the same resolution of the camera which used in the calibration process.
- Type
(bool)
-
property
width_per_view
¶ [Read-Write] When bUseTrackedCameraResolution is false, the width of each casting viewport
- Type
(int32)