FCanvasBorderItem Class Reference

#include <CanvasItem.h>

Inheritance diagram for FCanvasBorderItem:

Public Member Functions
	FCanvasBorderItem (const FVector2D &InPosition, const FTexture *InBorderTexture, const FTexture *InBackgroundTexture, const FTexture *InBorderLeftTexture, const FTexture *InBorderRightTexture, const FTexture *InBorderTopTexture, const FTexture *InBorderBottomTexture, const FVector2D &InSize, const FLinearColor &InColor)
virtual ENGINE_API void	Draw (FCanvas *InCanvas) override
virtual void	SetColor (const FLinearColor &InColor) override final
virtual void	Draw (FCanvas *InCanvas)=0
virtual void	Draw (FCanvas *InCanvas, const FVector2D &InPosition)
virtual void	Draw (FCanvas *InCanvas, float X, float Y)
Public Member Functions inherited from FCanvasItem
	FCanvasItem (const FVector2D &InPosition)
virtual	~FCanvasItem ()

Public Attributes
FVector2D	Size
FVector2D	BorderScale
FVector2D	BackgroundScale
float	Z
FVector2D	BorderUV0
FVector2D	BorderUV1
const FTexture *	BorderTexture
const FTexture *	BackgroundTexture
const FTexture *	BorderLeftTexture
const FTexture *	BorderRightTexture
const FTexture *	BorderTopTexture
const FTexture *	BorderBottomTexture
FRotator	Rotation
FVector2D	PivotPoint
FVector2D	CornerSize
Public Attributes inherited from FCanvasItem
FVector2D	Position
uint32	StereoDepth
ESimpleElementBlendMode	BlendMode
bool	bFreezeTime
FBatchedElementParameters *	BatchedElementParameters

Additional Inherited Members
Protected Attributes inherited from FCanvasItem
FLinearColor	Color

Constructor & Destructor Documentation

FCanvasBorderItem()

FCanvasBorderItem::FCanvasBorderItem ( const FVector2D &  InPosition, const FTexture *  InBorderTexture, const FTexture *  InBackgroundTexture, const FTexture *  InBorderLeftTexture, const FTexture *  InBorderRightTexture, const FTexture *  InBorderTopTexture, const FTexture *  InBorderBottomTexture, const FVector2D &  InSize, const FLinearColor &  InColor  )

inline

3x3 grid border with tiled frame and tiled interior.

Parameters

InPosition	Draw position
InBorderTexture	The texture to use for border
InBackgroundTexture	The texture to use for border background
InSize	The size to render
InColor	Tint of the border

Member Function Documentation

Draw() [1/4]

void FCanvasBorderItem::Draw ( FCanvas *  InCanvas )

overridevirtual

Draw the item at the given coordinates.

Parameters

InPosition

Draw position.

Implements FCanvasItem.

Draw() [2/4]

virtual void FCanvasItem::Draw ( FCanvas *  InCanvas )

virtual

Implements FCanvasItem.

Draw() [3/4]

virtual void FCanvasItem::Draw ( FCanvas *  InCanvas, const FVector2D &  InPosition  )

inlinevirtual

Draw this item (this will affect the items position for future draw calls that do no specify a position)

Parameters

InCanvas	Canvas on which to draw
InPosition	Draw position - this will not preserve the items position

Reimplemented from FCanvasItem.

Draw() [4/4]

virtual void FCanvasItem::Draw ( FCanvas *  InCanvas, float  X, float  Y  )

inlinevirtual

Draw this item (this will affect the items position for future draw calls that do no specify a position)

Parameters

InCanvas	Canvas on which to draw
X	X Draw position
Y	Y Draw position

Reimplemented from FCanvasItem.

SetColor()

virtual void FCanvasBorderItem::SetColor ( const FLinearColor &  InColor )

inlinefinaloverridevirtual

Reimplemented from FCanvasItem.

Member Data Documentation

BackgroundScale

FVector2D FCanvasBorderItem::BackgroundScale

Scale of the border

BackgroundTexture

const FTexture* FCanvasBorderItem::BackgroundTexture

BorderBottomTexture

const FTexture* FCanvasBorderItem::BorderBottomTexture

BorderLeftTexture

const FTexture* FCanvasBorderItem::BorderLeftTexture

BorderRightTexture

const FTexture* FCanvasBorderItem::BorderRightTexture

BorderScale

FVector2D FCanvasBorderItem::BorderScale

Scale of the border

BorderTexture

const FTexture* FCanvasBorderItem::BorderTexture

BorderTopTexture

const FTexture* FCanvasBorderItem::BorderTopTexture

BorderUV0

FVector2D FCanvasBorderItem::BorderUV0

BorderUV1

FVector2D FCanvasBorderItem::BorderUV1

CornerSize

FVector2D FCanvasBorderItem::CornerSize

Frame corner size in percent of frame texture (should be < 0.5f)

PivotPoint

FVector2D FCanvasBorderItem::PivotPoint

Rotation

FRotator FCanvasBorderItem::Rotation

Size

FVector2D FCanvasBorderItem::Size

Z

float FCanvasBorderItem::Z

---

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

• Engine/Source/Runtime/Engine/Public/CanvasItem.h
• Engine/Source/Runtime/Engine/Private/UserInterface/CanvasItem.cpp