FSlateClippingZone Class Reference

#include <Clipping.h>

Public Member Functions
SLATECORE_API	FSlateClippingZone (const FShortRect &AxisAlignedRect)
SLATECORE_API	FSlateClippingZone (const FSlateRect &AxisAlignedRect)
SLATECORE_API	FSlateClippingZone (const FGeometry &BoundingGeometry)
SLATECORE_API	FSlateClippingZone (const FPaintGeometry &PaintingGeometry)
SLATECORE_API	FSlateClippingZone (const UE::Slate::FDeprecateVector2DParameter &InTopLeft, const UE::Slate::FDeprecateVector2DParameter &InTopRight, const UE::Slate::FDeprecateVector2DParameter &InBottomLeft, const UE::Slate::FDeprecateVector2DParameter &InBottomRight)
	FSlateClippingZone ()
bool	GetShouldIntersectParent () const
void	SetShouldIntersectParent (bool bValue)
bool	GetAlwaysClip () const
void	SetAlwaysClip (bool bValue)
bool	IsAxisAligned () const
bool	HasZeroArea () const
SLATECORE_API bool	IsPointInside (const UE::Slate::FDeprecateVector2DParameter &Point) const
SLATECORE_API FSlateClippingZone	Intersect (const FSlateClippingZone &Other) const
SLATECORE_API FSlateRect	GetBoundingBox () const
bool	operator== (const FSlateClippingZone &Other) const
uint32	ComputeHash () const
FSlateClippingZone	ConvertRelativeToAbsolute (const UE::Slate::FDeprecateVector2DParameter &WindowOffset) const

Public Attributes
FVector2f	TopLeft
FVector2f	TopRight
FVector2f	BottomLeft
FVector2f	BottomRight

Friends
uint32	GetTypeHash (const FSlateClippingZone &Zone)

Detailed Description

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

Constructor & Destructor Documentation

FSlateClippingZone() [1/6]

FSlateClippingZone::FSlateClippingZone ( const FShortRect &  AxisAlignedRect )

explicit

FSlateClippingZone() [2/6]

FSlateClippingZone::FSlateClippingZone ( const FSlateRect &  AxisAlignedRect )

explicit

FSlateClippingZone() [3/6]

FSlateClippingZone::FSlateClippingZone ( const FGeometry &  BoundingGeometry )

explicit

FSlateClippingZone() [4/6]

FSlateClippingZone::FSlateClippingZone ( const FPaintGeometry &  PaintingGeometry )

explicit

FSlateClippingZone() [5/6]

FSlateClippingZone::FSlateClippingZone	(	const UE::Slate::FDeprecateVector2DParameter &	InTopLeft,
		const UE::Slate::FDeprecateVector2DParameter &	InTopRight,
		const UE::Slate::FDeprecateVector2DParameter &	InBottomLeft,
		const UE::Slate::FDeprecateVector2DParameter &	InBottomRight
	)

FSlateClippingZone() [6/6]

FSlateClippingZone::FSlateClippingZone ( )

inline

Member Function Documentation

ComputeHash()

uint32 FSlateClippingZone::ComputeHash ( ) const

inline

ConvertRelativeToAbsolute()

FSlateClippingZone FSlateClippingZone::ConvertRelativeToAbsolute ( const UE::Slate::FDeprecateVector2DParameter &  WindowOffset ) const

inline

GetAlwaysClip()

bool FSlateClippingZone::GetAlwaysClip ( ) const

inline

GetBoundingBox()

FSlateRect FSlateClippingZone::GetBoundingBox

(

)

const

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

GetShouldIntersectParent()

bool FSlateClippingZone::GetShouldIntersectParent ( ) const

inline

HasZeroArea()

bool FSlateClippingZone::HasZeroArea ( ) const

inline

Indicates if this clipping state has a zero size, aka is empty. We only possibly report true for scissor clipping zones.

Intersect()

FSlateClippingZone FSlateClippingZone::Intersect

(

const FSlateClippingZone &

Other

)

const

Intersects two clipping zones and returns the new clipping zone that would need to be used. This can only be called between two axis aligned clipping zones.

IsAxisAligned()

bool FSlateClippingZone::IsAxisAligned ( ) const

inline

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

IsPointInside()

bool FSlateClippingZone::IsPointInside

(

const UE::Slate::FDeprecateVector2DParameter &

Point

)

const

Is a point inside the clipping zone?

operator==()

bool FSlateClippingZone::operator== ( const FSlateClippingZone &  Other ) const

inline

SetAlwaysClip()

void FSlateClippingZone::SetAlwaysClip ( bool  bValue )

inline

SetShouldIntersectParent()

void FSlateClippingZone::SetShouldIntersectParent ( bool  bValue )

inline

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FSlateClippingZone &  Zone )

friend

Member Data Documentation

BottomLeft

FVector2f FSlateClippingZone::BottomLeft

BottomRight

FVector2f FSlateClippingZone::BottomRight

TopLeft

FVector2f FSlateClippingZone::TopLeft

TopRight

FVector2f FSlateClippingZone::TopRight

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/SlateCore/Public/Layout/Clipping.h
• Engine/Source/Runtime/SlateCore/Private/Layout/Clipping.cpp