unreal.MinimalViewInfo¶
- class unreal.MinimalViewInfo(location: Vector = Ellipsis, rotation: Rotator = Ellipsis, fov: float = 0.0, first_person_fov: float = 0.0, first_person_scale: float = 0.0, ortho_width: float = 0.0, auto_calculate_ortho_planes: bool = False, auto_plane_shift: float = 0.0, update_ortho_planes: bool = False, use_camera_height_as_view_target: bool = False, ortho_near_clip_plane: float = 0.0, ortho_far_clip_plane: float = 0.0, perspective_near_clip_plane: float = 0.0, aspect_ratio: float = 0.0, constrain_aspect_ratio: bool = False, use_first_person_parameters: bool = False, use_field_of_view_for_lod: bool = False, projection_mode: CameraProjectionMode = Ellipsis, post_process_blend_weight: float = 0.0, post_process_settings: PostProcessSettings = [], off_center_projection_offset: Vector2D = Ellipsis, overscan_resolution_fraction: float = 0.0, crop_fraction: float = 0.0, asymmetric_crop_fraction: Vector4f = Ellipsis)¶
Bases:
StructBaseMinimal View Info
C++ Source:
Module: Engine
File: CameraTypes.h
Editor Properties: (see get_editor_property/set_editor_property)
aspect_ratio(float): [Read-Write] Aspect Ratio (Width/Height)asymmetric_crop_fraction(Vector4f): [Read-Write] Experimental: The fraction for each edge between 0.0 and 1.0 of the view to crop to during the final post process upscale, with 1.0 meaning no crop. By convention, X is the left edge, Y is the right edge, Z is the top edge, and W is the bottom edge. Stacks with uniform CropFraction.auto_calculate_ortho_planes(bool): [Read-Write] Option for the Ortho camera to automatically calculated the near/far planeauto_plane_shift(float): [Read-Write] Manually adjusts the planes of this camera, maintaining the distance between them. Positive moves out to the farplane, negative towards the near planeconstrain_aspect_ratio(bool): [Read-Write] If bConstrainAspectRatio is true, black bars will be added if the destination view has a different aspect ratio than this camera requested.crop_fraction(float): [Read-Write] The fraction between 0.0 and 1.0 of the view to crop to during the final post process upscale, with 1.0 meaning no cropfirst_person_fov(float): [Read-Write] The horizontal field of view (in degrees) used for primitives tagged as “IsFirstPerson”.first_person_scale(float): [Read-Write] The scale to apply to primitives tagged as “IsFirstPerson”. This is used to scale down primitives towards the camera such that they are small enough not to intersect with the scene.fov(float): [Read-Write] The horizontal field of view (in degrees) in perspective mode (ignored in orthographic mode).location(Vector): [Read-Write] Locationoff_center_projection_offset(Vector2D): [Read-Only] Off-axis / off-center projection offset as proportion of screen dimensionsortho_far_clip_plane(float): [Read-Write] The far plane distance of the orthographic view (in world units)ortho_near_clip_plane(float): [Read-Write] The near plane distance of the orthographic view (in world units)ortho_width(float): [Read-Write] The desired width (in world units) of the orthographic view (ignored in Perspective mode)overscan_resolution_fraction(float): [Read-Write] Resolution fraction that scales with the amount of overscan added to the viewperspective_near_clip_plane(float): [Read-Write] The near plane distance of the perspective view (in world units). Set to a negative value to use the default global value of GNearClippingPlanepost_process_blend_weight(float): [Read-Write] Indicates if PostProcessSettings should be applied.post_process_settings(PostProcessSettings): [Read-Write] Post-process settings to use if PostProcessBlendWeight is non-zero.projection_mode(CameraProjectionMode): [Read-Write] The type of camerarotation(Rotator): [Read-Write] Rotationupdate_ortho_planes(bool): [Read-Write] Adjusts the near/far planes and the view origin of the current camera automatically to avoid clipping and light artefactinguse_camera_height_as_view_target(bool): [Read-Write] If UpdateOrthoPlanes is enabled, this setting will use the cameras current height to compensate the distance to the general view (as a pseudo distance to view target when one isn’t present)use_field_of_view_for_lod(bool): [Read-Write] If true, account for the field of view angle when computing which level of detail to use for meshes.use_first_person_parameters(bool): [Read-Write] If bUseFirstPersonParameters is true, FirstPersonFOV and FirstPersonScale should be applied to primitives tagged as “IsFirstPerson”.
- property asymmetric_crop_fraction: Vector4f¶
The fraction for each edge between 0.0 and 1.0 of the view to crop to during the final post process upscale, with 1.0 meaning no crop. By convention, X is the left edge, Y is the right edge, Z is the top edge, and W is the bottom edge. Stacks with uniform CropFraction.
- Type:
(Vector4f)
- Type:
[Read-Write] Experimental
- property auto_calculate_ortho_planes: bool¶
[Read-Write] Option for the Ortho camera to automatically calculated the near/far plane
- Type:
(bool)
- property auto_plane_shift: float¶
[Read-Write] Manually adjusts the planes of this camera, maintaining the distance between them. Positive moves out to the farplane, negative towards the near plane
- Type:
(float)
- calculate_projection_matrix() Matrix¶
Calculates the projection matrix using this view info’s aspect ratio (regardless of bConstrainAspectRatio)
- Return type:
- property constrain_aspect_ratio: bool¶
[Read-Write] If bConstrainAspectRatio is true, black bars will be added if the destination view has a different aspect ratio than this camera requested.
- Type:
(bool)
- property crop_fraction: float¶
[Read-Write] The fraction between 0.0 and 1.0 of the view to crop to during the final post process upscale, with 1.0 meaning no crop
- Type:
(float)
- property first_person_fov: float¶
[Read-Write] The horizontal field of view (in degrees) used for primitives tagged as “IsFirstPerson”.
- Type:
(float)
- property first_person_scale: float¶
[Read-Write] The scale to apply to primitives tagged as “IsFirstPerson”. This is used to scale down primitives towards the camera such that they are small enough not to intersect with the scene.
- Type:
(float)
- property fov: float¶
[Read-Write] The horizontal field of view (in degrees) in perspective mode (ignored in orthographic mode).
- Type:
(float)
- property off_center_projection_offset: Vector2D¶
[Read-Only] Off-axis / off-center projection offset as proportion of screen dimensions
- Type:
(Vector2D)
- property ortho_far_clip_plane: float¶
[Read-Write] The far plane distance of the orthographic view (in world units)
- Type:
(float)
- property ortho_near_clip_plane: float¶
[Read-Write] The near plane distance of the orthographic view (in world units)
- Type:
(float)
- property ortho_width: float¶
[Read-Write] The desired width (in world units) of the orthographic view (ignored in Perspective mode)
- Type:
(float)
- property overscan_resolution_fraction: float¶
[Read-Write] Resolution fraction that scales with the amount of overscan added to the view
- Type:
(float)
- property perspective_near_clip_plane: float¶
[Read-Write] The near plane distance of the perspective view (in world units). Set to a negative value to use the default global value of GNearClippingPlane
- Type:
(float)
- property post_process_blend_weight: float¶
[Read-Write] Indicates if PostProcessSettings should be applied.
- Type:
(float)
- property post_process_settings: PostProcessSettings¶
[Read-Write] Post-process settings to use if PostProcessBlendWeight is non-zero.
- Type:
- property projection_mode: CameraProjectionMode¶
[Read-Write] The type of camera
- Type:
- property update_ortho_planes: bool¶
[Read-Write] Adjusts the near/far planes and the view origin of the current camera automatically to avoid clipping and light artefacting
- Type:
(bool)
- property use_camera_height_as_view_target: bool¶
[Read-Write] If UpdateOrthoPlanes is enabled, this setting will use the cameras current height to compensate the distance to the general view (as a pseudo distance to view target when one isn’t present)
- Type:
(bool)