unreal.CameraFocusSettings

class unreal.CameraFocusSettings(focus_method=CameraFocusMethod.MANUAL, manual_focus_distance=100000.0, tracking_focus_settings=[None, [0.0, 0.0, 0.0], False], smooth_focus_changes=False, focus_smoothing_interp_speed=8.0, focus_offset=0.0)

Bases: unreal.StructBase

Settings to control camera focus

C++ Source:

  • Module: CinematicCamera
  • File: CineCameraComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • debug_focus_plane_color (Color): [Read-Write] 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] True to draw a translucent plane at the current focus depth, for easy tweaking.
  • focus_method (CameraFocusMethod): [Read-Write] Which method to use to handle camera focus
  • focus_offset (float): [Read-Write] Additional focus depth offset, used for manually tweaking if your chosen focus method needs adjustment
  • focus_smoothing_interp_speed (float): [Read-Write] Controls interpolation speed when smoothing focus distance changes. Ignored if bSmoothFocusChanges is false.
  • manual_focus_distance (float): [Read-Write] Manually-controlled focus distance (manual focus mode only)
  • smooth_focus_changes (bool): [Read-Write] 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] Settings to control tracking focus (tracking focus mode only)
focus_method

(CameraFocusMethod) – [Read-Write] Which method to use to handle camera focus

focus_offset

(float) – [Read-Write] Additional focus depth offset, used for manually tweaking if your chosen focus method needs adjustment

focus_smoothing_interp_speed

(float) – [Read-Write] Controls interpolation speed when smoothing focus distance changes. Ignored if bSmoothFocusChanges is false.

manual_focus_distance

(float) – [Read-Write] Manually-controlled focus distance (manual focus mode only)

smooth_focus_changes

(bool) – [Read-Write] 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] Settings to control tracking focus (tracking focus mode only)