FGeometry

Represents the position, size, and absolute position of a Widget in Slate.

Choose your operating system:

Windows

macOS

Linux

References

Module	SlateCore
Header	/Engine/Source/Runtime/SlateCore/Public/Layout/Geometry.h
Include	#include "Layout/Geometry.h"

Syntax

struct FGeometry

Remarks

Represents the position, size, and absolute position of a Widget in Slate. The absolute location of a geometry is usually screen space or window space depending on where the geometry originated. Geometries are usually paired with a SWidget pointer in order to provide information about a specific widget (see FArrangedWidget). A Geometry's parent is generally thought to be the Geometry of the the corresponding parent widget.

Variables

	Name	Description
const FVector2f	AbsolutePosition	!!! DEPRECATED !!! These legacy public members should ideally not be referenced, as they do not account for the render transform.
const FVector2f	Position	!!! DEPRECATED !!!
const float	Scale	!!! DEPRECATED !!! These legacy public members should ideally not be referenced, as they do not account for the render transform.
const FVector2D	Size	!!! DEPRECATED !!! Use GetLocalSize() accessor instead of directly accessing public members.

Constructors

	Name	Description
	FGeometry()	Default constructor. Creates a geometry with identity transforms.
	FGeometry ( const FVector2D& OffsetFromParent, const FVector2D& ParentAbsolutePos..., const FVector2D& InLocalSize, float InScale )	!!! DEPRECATED FUNCTION !!! Use MakeChild taking a layout transform instead! Construct a new geometry given the following parameters:

Functions

	Name	Description
FVector2D	AbsoluteToLocal ( FVector2D AbsoluteCoordinate )	Absolute coordinates could be either desktop or window space depending on what space the root of the widget hierarchy is in.
void	AppendTransform ( const FSlateLayoutTransform& Layou... )	Special case method to append a layout transform to a geometry.
FVector2D	GetAbsolutePosition()	Get the absolute position in render space.
FVector2D	GetAbsolutePositionAtCoordinates ( const FVector2D& NormalCoordinates )	Get the absolute position on the surface of the geometry using normalized coordinates.
FVector2D	GetAbsoluteSize()	Get the absolute size of the geometry in render space.
FSlateLayout...	GetAccumulatedLayoutTransform()
const FSlate...	GetAccumulatedRenderTransform()
FVector2D	GetDrawSize()	!!! DEPRECATED !!! This legacy function does not account for render transforms.
FSlateRect	GetLayoutBoundingRect ( const FSlateRect& LocalSpaceRect )
FSlateRect	GetLayoutBoundingRect ( const FMargin& LocalSpaceExtendBy )
FSlateRect	GetLayoutBoundingRect()
FVector2D	GetLocalPositionAtCoordinates ( const FVector2D& NormalCoordinates )	Get the local position on the surface of the geometry using normalized coordinates.
const FVecto...	GetLocalSize()
FSlateRect	GetRenderBoundingRect ( const FSlateRect& LocalSpaceRect )
FSlateRect	GetRenderBoundingRect ( const FMargin& LocalSpaceExtendBy )
FSlateRect	GetRenderBoundingRect()
bool	HasRenderTransform()
bool	IsUnderLocation ( const FVector2D& AbsoluteCoordinat... )	Absolute coordinates could be either desktop or window space depending on what space the root of the widget hierarchy is in.
FVector2D	LocalToAbsolute ( FVector2D LocalCoordinate )	Translates local coordinates into absolute coordinates
FVector2D	LocalToRoundedLocal ( FVector2D LocalCoordinate )	Translates the local coordinates into local coordinates that after being transformed into absolute space will be rounded to a whole number or approximately a whole number.
FArrangedWid...	MakeChild ( const TSharedRef< SWidget >& Child..., const FVector2D& InLocalSize, const FSlateLayoutTransform& Layou... )	FGeometry Arranged Widget Inlined Functions.
FGeometry	MakeChild ( const FVector2D& InLocalSize, const FSlateLayoutTransform& Layou... )	Create a child geometry relative to this one with a given local space size, layout transform, and identity render transform.
FGeometry	MakeChild ( const FSlateRenderTransform& Rende..., const FVector2D& RenderTransformPi... )
FArrangedWid...	MakeChild ( const TSharedRef< SWidget >& Child..., const FLayoutGeometry& LayoutGeome... )	Create a child geometry+widget relative to this one using the given LayoutGeometry.
FGeometry	MakeChild ( const FVector2D& ChildOffset, const FVector2D& InLocalSize, float ChildScale )	!!! DEPRECATED FUNCTION !!! Use MakeChild taking a layout transform instead! Create a child geometry relative to this one with a given local space size and layout transform given by a scale+offset.
FGeometry	MakeChild ( const FVector2D& InLocalSize, const FSlateLayoutTransform& Layou..., const FSlateRenderTransform& Rende..., const FVector2D& RenderTransformPi... )	Create a child geometry relative to this one with a given local space size, layout transform, and render transform.
FArrangedWid...	MakeChild ( const TSharedRef< SWidget >& Child..., const FVector2D& ChildOffset, const FVector2D& InLocalSize, float ChildScale )	!!! DEPRECATED FUNCTION !!! Use MakeChild taking a layout transform instead! Create a child geometry+widget relative to this one with a given local space size and layout transform given by a scale+offset.
FGeometry	MakeRoot ( const FVector2D& InLocalSize, const FSlateLayoutTransform& Layou... )	Makes a new geometry that is essentially the root of a hierarchy (has no parent transforms to inherit).
FGeometry	MakeRoot ( const FVector2D& InLocalSize, const FSlateLayoutTransform& Layou..., const FSlateRenderTransform& Rende... )	Makes a new geometry that is essentially the root of a hierarchy (has no parent transforms to inherit).
FPaintGeomet...	ToInflatedPaintGeometry ( const FVector2D& InflateAmount )	Create a paint geometry relative to this one that whose local space is "inflated" by the specified amount in each direction.
FPaintGeomet...	ToOffsetPaintGeometry ( const FVector2D& LocalOffset )	!!! DEPRECATED FUNCTION !!! Use ToPaintGeometry taking a layout transform instead! Create a paint geometry relative to this one with the same size size and a given local space offset.
FPaintGeomet...	ToPaintGeometry ( const FVector2D& InLocalSize, const FSlateLayoutTransform& InLay... )	Create a paint geometry relative to this one with a given local space size and layout transform.
FPaintGeomet...	ToPaintGeometry ( const FSlateLayoutTransform& Layou... )	Create a paint geometry with the same size as this geometry with a given layout transform.
FPaintGeomet...	ToPaintGeometry ( const FVector2D& InLocalSize, const FSlateLayoutTransform& InLay..., const FSlateRenderTransform& Rende..., const FVector2D& RenderTransformPi... )	Create a paint geometry relative to this one with a given local space size and layout transform.
FPaintGeomet...	ToPaintGeometry ( const FVector2D& InLocalOffset, const FVector2D& InLocalSize, float InLocalScale )	!!! DEPRECATED FUNCTION !!! Use ToPaintGeometry taking a layout transform instead! Create a paint geometry relative to this one with a given local space size and layout transform given as a scale+offset.
FPaintGeomet...	ToPaintGeometry()	Create a paint geometry that represents this geometry.
FString	ToString()

Operators

	Name	Description
bool	operator!= ( const FGeometry& Other )	Test geometries for strict inequality (i.e. exact float equality negated).
FGeometry &	operator= ( const FGeometry& RHS )	!!! HACK!!! We're keeping members of FGeometry const to prevent mutability without making them private, for backward compatibility.
bool	operator== ( const FGeometry& Other )	Test geometries for strict equality (i.e. exact float equality).

Deprecated Functions

		Name	Description
	FSlateRect	GetClippingRect()	This no longer represents any sort of clipping rect. Please use GetLayoutBoundingRect() to get the layout rect of this geometry.