1. Epic GamesDeveloper
  3. FFramingZone

FFramingZone

Effective coordinates for a rectangular screen-space zone.

API > API/Plugins > API/Plugins/GameplayCameras > API/Plugins/GameplayCameras/Math

References

   
Module GameplayCameras
Header /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Math/CameraFramingZoneMath.h
Include #include "Math/CameraFramingZoneMath.h"

Syntax

struct FFramingZone

Remarks

Effective coordinates for a rectangular screen-space zone. Unlike FFramingZoneMargins, which stores margin values from the screen's edges, this struct is expected to store actual screen coordinates in 0..1 UI space.

Variables

  Type Name Description
Public variable double BottomBound  
Public variable double LeftBound  
Public variable double RightBound  
Public variable double TopBound  

Constructors

  Type Name Description
Public function   Builds an empty framing zone.
Public function  

FFramingZone ( const FFramingZoneMargins& FramingZoneMargins
)

 Build a framing zone from a set of margins.

Functions

  Type Name Description
Public function void Makes sure all the bounds have valid values between 0 and 1.
Public function void

ClampBounds ( const FVector2d& MustContain
)

 Makes sure all the bounds have valid values between 0 and 1, and that the enclosed rectangle contains the given target point.
Public function void

ClampBounds ( const FFramingZone& MustContain
)

 Makes sure all the bounds have valid values between 0 and 1, and that the enclosed rectangle contains the given inner rectangle.
Public function Const FVector2d

ComputeClosestIntersection ( const FVector2d& Origin,
const FVector2d& LineDir,
bool bLineDirIsNormalized
)

 Computes intersections between a line and the zone's box, and returns the one closest to the line's origin point.
Public function Const bool

Contains ( const FVector2d& Point
)

 Checks whether the given point (in 0..1 UI space) is inside this zone.
Public function Const FVector2d

GetCanvasPosition ( const FVector2d& CanvasSize
)

 Gets the coordinates of the top-left corner of the zone, in 0..Width/Height canvas units.
Public function Const FVector2d

GetCanvasSize ( const FVector2d& CanvasSize
)

 Gets the size of the zone, in 0..Width/Height canvas units.
Public function Const FVector4d Gets the inner margins of this zone compared to the screen's center.
Public function void

Serialize ( FArchive& Ar
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page