FSlateClippingZone

The Clipping Zone represents some arbitrary plane segment that can be used to clip the geometry in Slate.

Choose your operating system:

Windows

macOS

Linux

References

Module

SlateCore

Header

/Engine/Source/Runtime/SlateCore/Public/Layout/Clipping.h

Include

#include "Layout/Clipping.h"

Syntax

class FSlateClippingZone

Remarks

The Clipping Zone represents some arbitrary plane segment that can be used to clip the geometry in Slate.

Variables

Name Description

Public variable

FVector2f

 

BottomLeft

Public variable

FVector2f

 

BottomRight

Public variable

FVector2f

 

TopLeft

Public variable

FVector2f

 

TopRight

Constructors

Name Description

Public function

FSlateClippingZone()

Public function

FSlateClippingZone

(
    const FShortRect& AxisAlignedRect
)

Public function

FSlateClippingZone

(
    const FSlateRect& AxisAlignedRect
)

Public function

FSlateClippingZone

(
    const FGeometry& BoundingGeometry
)

Public function

FSlateClippingZone

(
    const FPaintGeometry& PaintingGeom...
)

Public function

FSlateClippingZone

(
    const FVector2D& InTopLeft,
    const FVector2D& InTopRight,
    const FVector2D& InBottomLeft,
    const FVector2D& InBottomRight
)

Functions

Name Description

Public function Const

uint32

 

ComputeHash()

Public function Const

FSlateClippi...

 

ConvertRelativeToAbsolute

(
    const FVector2D& WindowOffset
)

Public function Const

bool

 

GetAlwaysClip()

Public function Const

FSlateRect

 

GetBoundingBox()

Gets the bounding box of the points making up this clipping zone.

Public function Const

bool

 

GetShouldIntersectParent()

Public function Const

bool

 

HasZeroArea()

Indicates if this clipping state has a zero size, aka is empty.

Public function Const

FSlateClippi...

 

Intersect

(
    const FSlateClippingZone& Other
)

Intersects two clipping zones and returns the new clipping zone that would need to be used.

Public function Const

bool

 

IsAxisAligned()

Is the clipping rect axis aligned? If it is, we can use a much cheaper clipping solution.

Public function Const

bool

 

IsPointInside

(
    const FVector2D& Point
)

Is a point inside the clipping zone?

Public function

void

 

SetAlwaysClip

(
    bool bValue
)

Public function

void

 

SetShouldIntersectParent

(
    bool bValue
)

Operators

Name Description

Public function Const

bool

 

operator==

(
    const FSlateClippingZone& Other
)