unreal.CameraFocusSettings

class unreal.CameraFocusSettings(focus_method: CameraFocusMethod = Ellipsis, manual_focus_distance: float = 0.0, tracking_focus_settings: CameraTrackingFocusSettings = Ellipsis, smooth_focus_changes: bool = False, focus_smoothing_interp_speed: float = 0.0, focus_offset: float = 0.0)

Bases: StructBase

Settings to control camera focus

C++ Source:

  • Module: CinematicCamera

  • File: CineCameraSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

  • debug_focus_plane_color (Color): [Read-Write] Debug Focus Plane Color: For customizing the focus plane color, in case the default doesn’t show up well in your scene.

  • draw_debug_focus_plane (bool): [Read-Write] Draw Debug Focus Plane: True to draw a translucent plane at the current focus depth, for easy tweaking.

  • focus_method (CameraFocusMethod): [Read-Write] Focus Method: Which method to use to handle camera focus

  • focus_offset (float): [Read-Write] Focus Offset: Additional focus depth offset, used for manually tweaking if your chosen focus method needs adjustment

  • focus_smoothing_interp_speed (float): [Read-Write] Focus Smoothing Interp Speed: Controls interpolation speed when smoothing focus distance changes. Ignored if bSmoothFocusChanges is false.

  • manual_focus_distance (float): [Read-Write] Manual Focus Distance: Manually-controlled focus distance (manual focus mode only)

  • smooth_focus_changes (bool): [Read-Write] Smooth Focus Changes: True to use interpolation to smooth out changes in focus distance, false for focus distance changes to be instantaneous.

  • tracking_focus_settings (CameraTrackingFocusSettings): [Read-Write] Tracking Focus Settings: Settings to control tracking focus (tracking focus mode only)

property focus_method: CameraFocusMethod

[Read-Write] Focus Method: Which method to use to handle camera focus

Type:

(CameraFocusMethod)

property focus_offset: float

[Read-Write] Focus Offset: Additional focus depth offset, used for manually tweaking if your chosen focus method needs adjustment

Type:

(float)

property focus_smoothing_interp_speed: float

[Read-Write] Focus Smoothing Interp Speed: Controls interpolation speed when smoothing focus distance changes. Ignored if bSmoothFocusChanges is false.

Type:

(float)

property manual_focus_distance: float

[Read-Write] Manual Focus Distance: Manually-controlled focus distance (manual focus mode only)

Type:

(float)

property smooth_focus_changes: bool

[Read-Write] Smooth Focus Changes: True to use interpolation to smooth out changes in focus distance, false for focus distance changes to be instantaneous.

Type:

(bool)

property tracking_focus_settings: CameraTrackingFocusSettings

[Read-Write] Tracking Focus Settings: Settings to control tracking focus (tracking focus mode only)

Type:

(CameraTrackingFocusSettings)