1. Epic GamesDeveloper
  3. FMinimalViewInfo

FMinimalViewInfo

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Camera

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Camera/CameraTypes.h
Include #include "Camera/CameraTypes.h"

Syntax

USTRUCT (BlueprintType )  
struct FMinimalViewInfo

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float AspectRatio Aspect Ratio (Width/Height)
Public variable TOptional< EAspectRatioAxisConstraint > AspectRatioAxisConstraint Aspect ratio axis constraint override.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float AutoPlaneShift Manually adjusts the planes of this camera, maintaining the distance between them.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bAutoCalculateOrthoPlanes Option for the Ortho camera to automatically calculated the near/far plane
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bConstrainAspectRatio If bConstrainAspectRatio is true, black bars will be added if the destination view has a different aspect ratio than this camera requested.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bUpdateOrthoPlanes Adjusts the near/far planes and the view origin of the current camera automatically to avoid clipping and light artefacting
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bUseCameraHeightAsViewTarget 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)
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite uint32: 1 bUseFieldOfViewForLOD If true, account for the field of view angle when computing which level of detail to use for meshes.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bUseFirstPersonParameters If bUseFirstPersonParameters is true, FirstPersonFOV and FirstPersonScale should be applied to primitives tagged as "IsFirstPerson".
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float CropFraction 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
Public variable UProperty Transient float DesiredFOV The originally desired horizontal field of view before any adjustments to account for different aspect ratios
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float FirstPersonFOV The horizontal field of view (in degrees) used for primitives tagged as "IsFirstPerson".
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float FirstPersonScale The scale to apply to primitives tagged as "IsFirstPerson".
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float FOV The horizontal field of view (in degrees) in perspective mode (ignored in orthographic mode).
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FVector Location Location
Public variable UProperty Category BlueprintReadWrite Transient visibleinstanceonly FVector2D OffCenterProjectionOffset Off-axis / off-center projection offset as proportion of screen dimensions
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite float OrthoFarClipPlane The far plane distance of the orthographic view (in world units)
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite float OrthoNearClipPlane The near plane distance of the orthographic view (in world units)
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float OrthoWidth The desired width (in world units) of the orthographic view (ignored in Perspective mode)
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float OverscanResolutionFraction Resolution fraction that scales with the amount of overscan added to the view
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite float PerspectiveNearClipPlane The near plane distance of the perspective view (in world units).
Public variable UProperty Category BlueprintReadWrite float PostProcessBlendWeight Indicates if PostProcessSettings should be applied.
Public variable UProperty Category BlueprintReadWrite FPostProcessSettings PostProcessSettings Post-process settings to use if PostProcessBlendWeight is non-zero.
Public variable TOptional< FTransform > PreviousViewTransform Optional transform to be considered as this view's previous transform
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TEnumAsByte< ECameraProjectionMode::Type > ProjectionMode The type of camera.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FRotator Rotation Rotation

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddWeightedViewInfo ( const FMinimalViewInfo& OtherView,
const float& Weight
)

 Combines this view with another one which will be weighted.
Public function void

ApplyBlendWeight ( const float& Weight
)

 Applies weighting to this view, in order to be blended with another one.
Public function void

ApplyOverscan ( float InOverscan,
bool bScaleResolutionWithOverscan,
bool bCropOverscan
)

 Apply overscan to the view info, which scales the field of view and ortho width to simulate expanding the view frustum.
Public function bool Automatically calculates the Near/Far plane values for an Ortho camera
Public function void

BlendViewInfo ( FMinimalViewInfo& OtherInfo,
float OtherWeight
)

 Blends view information Note: booleans are orred together, instead of blending
Public function Const float Correction factor to apply to the first person transform used on primitives tagged as "IsFirstPerson" to achieve a first person specific field of view.
Public function Const FMatrix Calculates the projection matrix using this view info's aspect ratio (regardless of bConstrainAspectRatio)
Public function Static void

CalculateProjectionMatrixGivenView ( FMinimalViewInfo& ViewInfo,
TEnumAsByte< enum EAspectRatioAxisConstraint > AspectRatioAxisConstraint,
FViewport* Viewport,
FSceneViewProjectionData& InOutProjectionData
)

 Calculates the projection matrix (and potentially a constrained view rectangle) given a FMinimalViewInfo and partially configured projection data (must have the view rect already set)
Public function Static void

CalculateProjectionMatrixGivenViewRectangle ( FMinimalViewInfo& ViewInfo,
TEnumAsByte< enum EAspectRatioAxisConstraint > AspectRatioAxisConstraint,
const FIntRect& ConstrainedViewRectangle,
FSceneViewProjectionData& InOutProjectionData
)

 Calculates the projection matrix (and potentially a constrained view rectangle) given a FMinimalViewInfo and partially configured projection data (must have the view rect already set).
Public function void Removes all overscan from the view info.
Public function Const bool

Equals ( const FMinimalViewInfo& OtherInfo
)

 Is this equivalent to the other one?
Public function Const float The near plane distance of the perspective view (in world units).
Public function Const float Gets the total amount of overscan that has been applied to the view's frustum, with 0.0 meaning no overscan and 1.0 meaning 100% overscan
Public function void

SetCameraToViewTarget ( const FVector ActorLocation
)

 Sets the camera distance from view target for AutoCalculateOrthoPlanes
Public function Const FVector

TransformWorldToFirstPerson ( const FVector& WorldPosition,
bool bIgnoreFirstPersonScale
)

 Transforms a world space location into "first person space".

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page