unreal.CineCameraSettings

class unreal.CineCameraSettings(outer: Object | None = None, name: Name | str = 'None')

Bases: DeveloperSettings

Cine Camera Settings

C++ Source:

  • Module: CinematicCamera

  • File: CineCameraSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

  • crop_presets (Array[NamedPlateCropPreset]): [Read-Write] List of available crop presets

  • default_crop_preset_name (str): [Read-Write] Name of the default crop preset

  • default_filmback_preset (str): [Read-Write] Name of the default filmback preset

  • default_lens_f_stop (float): [Read-Write] Default aperture (will be constrained by default lens)

  • default_lens_focal_length (float): [Read-Write] Default focal length (will be constrained by default lens)

  • default_lens_preset_name (str): [Read-Write] Name of the default lens preset

  • filmback_presets (Array[NamedFilmbackPreset]): [Read-Write] List of available filmback presets

  • lens_presets (Array[NamedLensPreset]): [Read-Write] List of available lens presets

property crop_presets: None

[Read-Write] List of available crop presets

Type:

(Array[NamedPlateCropPreset])

property default_crop_preset_name: str

[Read-Write] Name of the default crop preset

Type:

(str)

property default_filmback_preset: str

[Read-Write] Name of the default filmback preset

Type:

(str)

property default_lens_f_stop: float

[Read-Write] Default aperture (will be constrained by default lens)

Type:

(float)

property default_lens_focal_length: float

[Read-Write] Default focal length (will be constrained by default lens)

Type:

(float)

property default_lens_preset_name: str

[Read-Write] Name of the default lens preset

Type:

(str)

property filmback_presets: None

[Read-Write] List of available filmback presets

Type:

(Array[NamedFilmbackPreset])

classmethod get_cine_camera_settings() CineCameraSettings

Get Cine Camera Settings

Return type:

CineCameraSettings

get_crop_preset_by_name(preset_name) PlateCropSettings or None

Gets the Crop settings associated with a given preset name Returns true if a preset with the given name was found

Parameters:

preset_name (str) –

Returns:

crop_settings (PlateCropSettings):

Return type:

PlateCropSettings or None

get_filmback_preset_by_name(preset_name) CameraFilmbackSettings or None

Gets the Filmback settings associated with a given preset name Returns true if a preset with the given name was found

Parameters:

preset_name (str) –

Returns:

filmback_settings (CameraFilmbackSettings):

Return type:

CameraFilmbackSettings or None

get_lens_preset_by_name(preset_name) CameraLensSettings or None

Gets the Lens settings associated with a given preset name Returns true if a preset with the given name was found

Parameters:

preset_name (str) –

Returns:

lens_settings (CameraLensSettings):

Return type:

CameraLensSettings or None

property lens_presets: None

[Read-Write] List of available lens presets

Type:

(Array[NamedLensPreset])