Navigation
API > API/Runtime > API/Runtime/SlateCore
The Clipping Zone represents some arbitrary plane segment that can be used to clip the geometry in Slate.
| Name | FSlateClippingZone |
| Type | class |
| Header File | /Engine/Source/Runtime/SlateCore/Public/Layout/Clipping.h |
| Include Path | #include "Layout/Clipping.h" |
Syntax
class FSlateClippingZone
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSlateClippingZone
(
const FGeometry& BoundingGeometry |
Layout/Clipping.h | ||
FSlateClippingZone
(
const FSlateRect& AxisAlignedRect |
Layout/Clipping.h | ||
FSlateClippingZone
(
const FShortRect& AxisAlignedRect |
Layout/Clipping.h | ||
| Layout/Clipping.h | |||
FSlateClippingZone
(
const FPaintGeometry& PaintingGeometry |
Layout/Clipping.h | ||
FSlateClippingZone
(
const UE::Slate::FDeprecateVector2DParameter& InTopLeft, |
Layout/Clipping.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BottomLeft | FVector2f | Layout/Clipping.h | ||
| BottomRight | FVector2f | Layout/Clipping.h | ||
| TopLeft | FVector2f | Layout/Clipping.h | ||
| TopRight | FVector2f | Layout/Clipping.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAlwaysClip | uint8 | Should this clipping zone always clip, even if another zone wants to ignore intersection? | Layout/Clipping.h | |
| bIntersect | uint8 | Should this clipping zone intersect the current one? | Layout/Clipping.h | |
| bIsAxisAligned | uint8 | Is the clipping zone axis aligned? Axis aligned clipping zones are much cheaper. | Layout/Clipping.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint32 ComputeHash() |
Layout/Clipping.h | ||
FSlateClippingZone ConvertRelativeToAbsolute
(
const UE::Slate::FDeprecateVector2DParameter& WindowOffset |
Layout/Clipping.h | ||
bool GetAlwaysClip() |
Layout/Clipping.h | ||
FSlateRect GetBoundingBox() |
Gets the bounding box of the points making up this clipping zone. | Layout/Clipping.h | |
bool GetShouldIntersectParent() |
Layout/Clipping.h | ||
bool HasZeroArea () |
Indicates if this clipping state has a zero size, aka is empty. | Layout/Clipping.h | |
FSlateClippingZone Intersect
(
const FSlateClippingZone& Other |
Intersects two clipping zones and returns the new clipping zone that would need to be used. | Layout/Clipping.h | |
bool IsAxisAligned() |
Is the clipping rect axis aligned? If it is, we can use a much cheaper clipping solution. | Layout/Clipping.h | |
bool IsPointInside
(
const UE::Slate::FDeprecateVector2DParameter& Point |
Is a point inside the clipping zone? | Layout/Clipping.h | |
void SetAlwaysClip
(
bool bValue |
Layout/Clipping.h | ||
void SetShouldIntersectParent
(
bool bValue |
Layout/Clipping.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator==
(
const FSlateClippingZone& Other |
Layout/Clipping.h |