Navigation
API > API/Plugins > API/Plugins/DisplayCluster
TMarginSet is a template struct that stores a set of four directional values: Left, Right, Top, and Bottom.
| Name | TMarginSet |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Math/MarginSet.h |
| Include Path | #include "Math/MarginSet.h" |
Syntax
template<typename T>
struct TMarginSet
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
!std ::is_convertible_v< IntType, T > TMarginSet
(
const TIntVector4< IntType >& Vec |
Constructs a TMarginSet from a TIntVector4 with integral elements. | Math/MarginSet.h | |
!std ::is_convertible_v< U, T > TMarginSet
(
const TVector4< U >& Vec |
Constructs a floating-point TMarginSet from a TVector4. | Math/MarginSet.h | |
!std ::is_convertible_v< U, T > TMarginSet
(
const U InLeft, |
Constructs a floating-point TMarginSet from four values of type U. | Math/MarginSet.h | |
!std ::is_convertible_v< U, T > TMarginSet
(
const U InAll |
Constructs a floating-point TMarginSet from a single arithmetic value U. | Math/MarginSet.h | |
TMarginSet () |
Default constructor.The default margin size is zero on all four sides. | Math/MarginSet.h | |
!std ::is_convertible_v< U, T > TMarginSet
(
const TMarginSet< U >& Other |
Constructs a floating-point TMarginSet from another TMarginSet. | Math/MarginSet.h | |
!std ::is_convertible_v< IntType, T > TMarginSet
(
const IntType InLeft, |
Constructs an integral TMarginSet from four integral values of type U. | Math/MarginSet.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| NumSides | int32 | Math/MarginSet.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Bottom | T | Math/MarginSet.h | ||||||||||||||
| Left | T | +-----------------------+ | Top | +----+ | Left | Right | +----+ | Bottom | +-----------------------+ | Math/MarginSet.h | ||||||
| Right | T | Math/MarginSet.h | ||||||||||||||
| Top | T | Math/MarginSet.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ApplyClampedInsetToRect
(
TIntRect< IntType >& InOutRect |
Shrinks the given rectangle in-place by the values in this margin set. | Math/MarginSet.h | |
void ApplyExpandToRect
(
TIntRect< IntType >& InOutRect |
Expands the given rectangle in-place by the values in this margin set. | Math/MarginSet.h | |
TMarginSet< T > & AssignMargins
(
const U InLeft, |
Assigns margins from four numeric values of type U to a floating-point TMarginSet |
Math/MarginSet.h | |
TMarginSet< T > & AssignMargins
(
const TMarginSet< IntType >& Other |
Assigns margins from another TMarginSet |
Math/MarginSet.h | |
TMarginSet< T > & AssignMargins
(
const TMarginSet< U >& Other |
Assigns margins from another TMarginSet to a floating-point TMarginSet |
Math/MarginSet.h | |
TMarginSet & AssignMargins
(
const TIntVector4< IntType >& InVector |
Assigns margins from a TIntVector4 |
Math/MarginSet.h | |
TMarginSet & AssignMargins
(
const TVector4< U >& InVector |
Assigns margins from a TVector4 to a floating-point TMarginSet |
Math/MarginSet.h | |
TMarginSet< T > & AssignMargins
(
const IntType InLeft, |
Assigns margins from four integral values of type IntType to an integral TMarginSet |
Math/MarginSet.h | |
explicit
(
!std::is_convertible_v< IntType, T > |
Constructs an integral TMarginSet from another TMarginSet. | Math/MarginSet.h | |
explicit
(
!std::is_convertible_v< IntType, T > |
Constructs an integral TMarginSet from a single integral value U. | Math/MarginSet.h | |
TMarginSet< int32 > GetCeilToInt() |
Returns a copy of this margin set where all margins ceils to the nearest greater or equal int32. | Math/MarginSet.h | |
TMarginSet< T > GetClamped
(
const T Min, |
Returns a copy of this margin set where all margins clamped the specified [Min, Max] range. | Math/MarginSet.h | |
TMarginSet< T > GetClampedPerSide
(
const TMarginSet< T >& MinMargins, |
Returns a copy of this margin set with each side individually clamped between the corresponding sides of the provided minimum and maximum margins. | Math/MarginSet.h | |
TMarginSet< int32 > GetFloorToInt() |
Returns a copy of this margin set where all margins floors to the nearest lower int32. | Math/MarginSet.h | |
T GetMax() |
Returns the maximum value among all four margins (Left, Right, Top, Bottom). | Math/MarginSet.h | |
TMarginSet< T > GetMaxPerSide
(
const TMarginSet< T >& In |
Returns a copy of this margin set where all margins is the maximum of this margin and another. | Math/MarginSet.h | |
TMarginSet< T > GetMaxPerSideIfDefined
(
const TMarginSet< T >& In |
Returns a new margin set where each side is the maximum of: | Math/MarginSet.h | |
T GetMin() |
Returns the minimum value among all four margins (Left, Right, Top, Bottom). | Math/MarginSet.h | |
TMarginSet< T > GetMinPerSide
(
const TMarginSet< T >& In |
Returns a copy of this margin set where all margins is the minimum of this margin and another. | Math/MarginSet.h | |
TMarginSet< T > GetMinPerSideIfDefined
(
const TMarginSet< T >& In |
Returns a new margin set where each side is the minimum of: | Math/MarginSet.h | |
TMarginSet< int32 > GetRoundToInt() |
Returns a copy of this margin set where all margins rounds to the nearest int32. | Math/MarginSet.h | |
bool IsZero() |
Returns true if all margins are zero. | Math/MarginSet.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const TMarginSet& Other |
Inequality operator | Math/MarginSet.h | |
TMarginSet< T > operator*
(
const TIntPoint< IntType >& Scale |
Multiplies each margin of a TMarginSet |
Math/MarginSet.h | |
TMarginSet< T > operator*
(
const TIntVector2< IntType >& Scale |
Multiplies each margin of a TMarginSet |
Math/MarginSet.h | |
TMarginSet< T > operator*
(
const TVector2< U >& Scale |
Multiplies each margin of a TMarginSet |
Math/MarginSet.h | |
TMarginSet< T > operator*
(
const U InScale |
Multiplies each margin of a floating-point TMarginSet |
Math/MarginSet.h | |
TMarginSet< T > operator*
(
const IntType InScale |
Multiplies each margin of a TMarginSet |
Math/MarginSet.h | |
TMarginSet< T > operator/
(
const U InDivisor |
Divides each margin of a floating-point TMarginSet |
Math/MarginSet.h | |
TMarginSet< T > operator/
(
const TIntPoint< IntType >& Divisor |
Divides each margin of a TMarginSet |
Math/MarginSet.h | |
TMarginSet< T > operator/
(
const TIntVector2< IntType >& Divisor |
Divides each margin of a TMarginSet |
Math/MarginSet.h | |
TMarginSet< T > operator/
(
const TVector2< U >& Divisor |
Divides each margin of a TMarginSet |
Math/MarginSet.h | |
T & operator[]
(
int32 Index |
Provides indexed access to a margin side value by numeric index. | Math/MarginSet.h | |
T & operator[]
(
EMarginSetSideIndex SideIndex |
Provides indexed access to a margin side value. | Math/MarginSet.h | |
const T & operator[]
(
EMarginSetSideIndex SideIndex |
Provides read-only indexed access to a margin side value. | Math/MarginSet.h | |
const T & operator[]
(
int32 Index |
Provides read-only indexed access to a margin side value by numeric index. | Math/MarginSet.h | |
bool operator==
(
const TMarginSet& Other |
Equality operator | Math/MarginSet.h |