1. Epic GamesDeveloper
  3. FGeometry

FGeometry

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

Unreal Engine C++ API Reference > Runtime > SlateCore > Layout

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

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

Constructors

  Type Name Description
Public function   Default constructor. Creates a geometry with identity transforms.
Public function  

FGeometry ( const FGeometry& RHS
)

 Copy constructor.
Public function  

FGeometry ( const UE::Slate::FDeprecateVector2DParameter& OffsetFromParent,
const UE::Slate::FDeprecateVector2DParameter& ParentAbsolutePosition,
const UE::Slate::FDeprecateVector2DParameter& InLocalSize,
float InScale
)

 !!! DEPRECATED FUNCTION !!! Use MakeChild taking a layout transform instead! Construct a new geometry given the following parameters:

Functions

  Type Name Description
Public function Const UE::Slate::FDeprecateVector2DResult Absolute coordinates could be either desktop or window space depending on what space the root of the widget hierarchy is in.
Public function void

AppendTransform ( const FSlateLayoutTransform& LayoutTransform
)

 Special case method to append a layout transform to a geometry.
Public function Const UE::Slate::FDeprecateVector2DResult Get the absolute position in render space.
Public function Const UE::Slate::FDeprecateVector2DResult Get the absolute position on the surface of the geometry using normalized coordinates.
Public function Const UE::Slate::FDeprecateVector2DResult Get the absolute size of the geometry in render space.
Public function Const FSlateLayoutTransform  
Public function Const const FSlateRenderTransform &  
Public function Const UE::Slate::FDeprecateVector2DResult !!! DEPRECATED !!! This legacy function does not account for render transforms.
Public function Const FSlateRect

GetLayoutBoundingRect ( const FSlateRect& LocalSpaceRect
)

  
Public function Const FSlateRect

GetLayoutBoundingRect ( const FMargin& LocalSpaceExtendBy
)

  
Public function Const FSlateRect  
Public function Const UE::Slate::FDeprecateVector2DResult Get the local position on the surface of the geometry using normalized coordinates.
Public function Const UE::Slate::FDeprecateVector2DResult  
Public function Const FSlateRect

GetRenderBoundingRect ( const FSlateRect& LocalSpaceRect
)

  
Public function Const FSlateRect

GetRenderBoundingRect ( const FMargin& LocalSpaceExtendBy
)

  
Public function Const FSlateRect  
Public function Const bool  
Public function Const bool Absolute coordinates could be either desktop or window space depending on what space the root of the widget hierarchy is in.
Public function Const UE::Slate::FDeprecateVector2DResult Translates local coordinates into absolute coordinates
Public function Const UE::Slate::FDeprecateVector2DResult 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.
Public function Const FArrangedWidget

MakeChild ( const TSharedRef< SWidget >& ChildWidget,
const UE::Slate::FDeprecateVector2DParameter& InLocalSize,
const FSlateLayoutTransform& LayoutTransform
)

 FGeometry Arranged Widget Inlined Functions.
Public function Const FGeometry

MakeChild ( const FSlateRenderTransform& RenderTransform,
const UE::Slate::FDeprecateVector2DParameter& RenderTransformPivot
)

  
Public function Const FGeometry

MakeChild ( const UE::Slate::FDeprecateVector2DParameter& InLocalSize,
const FSlateLayoutTransform& LayoutTransform,
const FSlateRenderTransform& RenderTransform,
const UE::Slate::FDeprecateVector2DParameter& RenderTransformPivot
)

 Create a child geometry relative to this one with a given local space size, layout transform, and render transform.
Public function Const FArrangedWidget

MakeChild ( const TSharedRef< SWidget >& ChildWidget,
const UE::Slate::FDeprecateVector2DParameter& ChildOffset,
const UE::Slate::FDeprecateVector2DParameter& 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.
Public function Const FGeometry

MakeChild ( const UE::Slate::FDeprecateVector2DParameter& InLocalSize,
const FSlateLayoutTransform& LayoutTransform
)

 Create a child geometry relative to this one with a given local space size, layout transform, and identity render transform.
Public function Const FArrangedWidget

MakeChild ( const TSharedRef< SWidget >& ChildWidget,
const FLayoutGeometry& LayoutGeometry
)

 Create a child geometry+widget relative to this one using the given LayoutGeometry.
Public function Static FGeometry

MakeRoot ( const UE::Slate::FDeprecateVector2DParameter& InLocalSize,
const FSlateLayoutTransform& LayoutTransform
)

 Makes a new geometry that is essentially the root of a hierarchy (has no parent transforms to inherit).
Public function Static FGeometry

MakeRoot ( const UE::Slate::FDeprecateVector2DParameter& InLocalSize,
const FSlateLayoutTransform& LayoutTransform,
const FSlateRenderTransform& RenderTransform
)

 Makes a new geometry that is essentially the root of a hierarchy (has no parent transforms to inherit).
Public function Const FPaintGeometry Create a paint geometry relative to this one that whose local space is "inflated" by the specified amount in each direction.
Public function Const FPaintGeometry !!! 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.
Public function Const FPaintGeometry Create a paint geometry that represents this geometry.
Public function Const FPaintGeometry

ToPaintGeometry ( const FSlateLayoutTransform& LayoutTransform
)

 Create a paint geometry with the same size as this geometry with a given layout transform.
Public function Const FPaintGeometry

ToPaintGeometry ( const UE::Slate::FDeprecateVector2DParameter& InLocalSize,
const FSlateLayoutTransform& InLayoutTransform
)

 Create a paint geometry relative to this one with a given local space size and layout transform.
Public function Const FPaintGeometry

ToPaintGeometry ( const UE::Slate::FDeprecateVector2DParameter& InLocalSize,
const FSlateLayoutTransform& InLayoutTransform,
const FSlateRenderTransform& RenderTransform,
const UE::Slate::FDeprecateVector2DParameter& RenderTransformPivot
)

 Create a paint geometry relative to this one with a given local space size and layout transform.
Public function Const FString  

Operators

  Type Name Description
Public function Const bool

operator!= ( const FGeometry& Other
)

 Test geometries for strict inequality (i.e. exact float equality negated).
Public function FGeometry &

operator= ( const FGeometry& RHS
)

 !!! HACK!!! We're keeping members of FGeometry const to prevent mutability without making them private, for backward compatibility.
Public function Const bool

operator== ( const FGeometry& Other
)

 Test geometries for strict equality (i.e. exact float equality).

Deprecated Functions

  Type Name Description
Public function Const FGeometry

MakeChild ( const FVector2D& ChildOffset,
const FVector2D& InLocalSize,
float ChildScale
)

 Use FGeometry MakeChild(const FVector2f& InLocalSize, const FSlateLayoutTransform& InLayoutTransform) instead.
Public function Const FPaintGeometry

ToPaintGeometry ( const UE::Slate::FDeprecateVector2DParameter& InLocalOffset,
const UE::Slate::FDeprecateVector2DParameter& InLocalSize,
float InLocalScale
)

 Use FPaintGeometry ToPaintGeometry(const FVector2f& InLocalSize, const FSlateLayoutTransform& InLayoutTransform) instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page