SVisualSocket Class Reference

Slate widget that acts as a socket for the child widget with additional features for UVisualImage. More...

#include <SVisualSocket.h>

Inheritance diagram for SVisualSocket:

Public Member Functions
void	Construct (const FArguments &Args)
	Constructor call for slate declarative syntax.
virtual int32	OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override
virtual FVector2D	ComputeDesiredSize (float) const override
	Calculates desire size.
virtual void	OnArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) const override
	Handles geometry for child widgets.
void	SetSocketOffset (FVector2D InPosition)
	Setter for SVisualSocket::SocketPosition.
void	SetVisualImage (UVisualImage *InVisualImage)
	Setter for SVisualSocket::VisualImage.
void	SetImageDesiredPosition (FVector2D InPosition)
	Setter for SVisualSocket::ImageDesiredPosition.

Private Attributes
FVector2D	ChildDesiredSize
	Desired size of the child.
UVisualImage *	VisualImage
	Optional child visual image.
FVector2D	SocketPosition
	Offset to apply to the child widget.
FVector2D	ImageDesiredPosition
	Desired position of the child visual image.

Detailed Description

Slate widget that acts as a socket for the child widget with additional features for UVisualImage.

See also

UVisualSocket

Member Function Documentation

ComputeDesiredSize()

FVector2D SVisualSocket::ComputeDesiredSize ( float InScale ) const

overridevirtual

Calculates desire size.

SVisualSocket has zero size.

Returns

computed desired size of this widget

Construct()

void SVisualSocket::Construct

(

const FArguments &

Args

)

Constructor call for slate declarative syntax.

Parameters

Args	slate arguments

OnArrangeChildren()

void SVisualSocket::OnArrangeChildren ( const FGeometry & AllottedGeometry, FArrangedChildren & ArrangedChildren ) const

overridevirtual

Handles geometry for child widgets.

Offsets by SVisualSocket::SocketPosition and SVisualSocket::ChildDesiredSize.

Parameters

AllottedGeometry	base geometry for this widget
ArrangedChildren	result of this children arrangement

SetImageDesiredPosition()

void SVisualSocket::SetImageDesiredPosition

(

FVector2D

InPosition

)

Setter for SVisualSocket::ImageDesiredPosition.

Parameters

InPosition

new image position

SetSocketOffset()

void SVisualSocket::SetSocketOffset

(

FVector2D

InPosition

)

Setter for SVisualSocket::SocketPosition.

Invalidates layout of this widget.

Parameters

InPosition

new socket offset

SetVisualImage()

void SVisualSocket::SetVisualImage

(

UVisualImage *

InVisualImage

)

Setter for SVisualSocket::VisualImage.

Parameters

InVisualImage

child visual image

Member Data Documentation

ChildDesiredSize

FVector2D SVisualSocket::ChildDesiredSize

mutableprivate

Desired size of the child.

It is affected by the scale applied to the SVisualSocket.

---

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

• SVisualSocket.h
• SVisualSocket.cpp