Touch Interface Designer 2025.2
Create touch interface with a visual editor and manage all mobile inputs like gestures
Loading...
Searching...
No Matches
UComponentDecorator Class Reference

#include <ComponentDecorator.h>

Inheritance diagram for UComponentDecorator:
Inheritance graph
[legend]
Collaboration diagram for UComponentDecorator:
Collaboration graph
[legend]

Public Member Functions

 UComponentDecorator ()
virtual void BeginDestroy () override
virtual void Initialize (TObjectPtr< ULayoutComponent > Component)
virtual bool CanAcceptChildren ()
bool IsInGroup () const
TSharedRef< SWidget > GetWidget (const bool bForceReconstruct=true)
virtual TSharedRef< SWidget > CreateWidgetInstance ()
const TObjectPtr< ULayoutComponent > & GetOwner () const
TObjectPtr< UComponentDecoratorGroup > GetGroup () const
bool EjectFromParent ()
BlueprintPure FVector2D GetSize () const
BlueprintPure FVector2D GetAbsoluteSize () const
virtual BlueprintPure float GetMaxHorizontalSize (bool bRecursive=false) const
virtual BlueprintPure float GetMaxVerticalSize (bool bRecursive=false) const
BlueprintPure FVector2D GetOffset () const
BlueprintPure float GetRotation () const
BlueprintPure FSlateBrush GetBrush () const
virtual BlueprintCallable void SetBrushResource (UObject *Resource)
virtual BlueprintCallable void SetBrush (const FSlateBrush InBrush)
virtual BlueprintCallable void SetBrushOpacity (const float Value)
virtual BlueprintCallable void SetSize (const FVector2D Value)
virtual BlueprintCallable void SetOffset (FVector2D NewOffset)
virtual BlueprintCallable void SetRotation (float Angle)
virtual BlueprintCallable void SetDrawType (const EDrawType NewType)
virtual BlueprintCallable float AddRotationDelta (float Delta)
virtual BlueprintCallable UMaterialInstanceDynamic * GetDynamicMaterialInstance ()
virtual BlueprintCallable void ShowDecorator ()
virtual BlueprintCallable void HideDecorator ()
virtual BlueprintCallable bool IsVisible () const

Public Attributes

 Category ="Decorator"
 BlueprintCallable
 EditAnywhere
BlueprintReadOnly uint8 bStartHidden:1
BlueprintReadOnly FSlateBrush Brush
 BlueprintReadOnly
 meta
BlueprintReadOnly FVector2D Offset
BlueprintReadOnly float Rotation
BlueprintReadOnly EDrawType DrawType
BlueprintReadOnly int32 ZOrder
BlueprintReadOnly TEnumAsByte< EHorizontalAlignment > HorizontalAlignment
BlueprintReadOnly TEnumAsByte< EVerticalAlignment > VerticalAlignment
Instanced TArray< TObjectPtr< UComponentDecorator_Animation > > Animations

Protected Member Functions

virtual void HandleOnPressEvent (const FGeometry &ComponentGeometry, const FGeometry &LayoutGeometry, const FPointerEvent &PointerEvent)
virtual void HandleOnReleaseEvent (const FGeometry &ComponentGeometry, const FGeometry &LayoutGeometry, const FPointerEvent &PointerEvent)

Protected Attributes

uint8 bIsVisible:1
uint8 bGeneratedByLayoutComponentLogic:1
TObjectPtr< ULayoutComponent > Owner
TSharedPtr< SWidget > DecoratorWidget

Friends

class FTouchInterfaceLayoutEditor
class FTouchInterfaceDesignerEditorMenuExtender

Constructor & Destructor Documentation

◆ UComponentDecorator()

UComponentDecorator::UComponentDecorator ( )

Member Function Documentation

◆ AddRotationDelta()

float UComponentDecorator::AddRotationDelta ( float Delta)
virtual

◆ BeginDestroy()

void UComponentDecorator::BeginDestroy ( )
overridevirtual

Reimplemented in UFlipbookLayer, UProgressBarLayer, URetainerLayer, and UTextLayer.

◆ CanAcceptChildren()

virtual bool UComponentDecorator::CanAcceptChildren ( )
inlinevirtual

Reimplemented in UComponentDecoratorGroup, and URetainerLayer.

◆ CreateWidgetInstance()

TSharedRef< SWidget > UComponentDecorator::CreateWidgetInstance ( )
virtual

Create widget

Reimplemented in UBlurLayer, UComponentDecoratorGroup, UFlipbookLayer, UProgressBarLayer, URetainerLayer, UTextLayer, and UWidgetLayer.

◆ EjectFromParent()

bool UComponentDecorator::EjectFromParent ( )

◆ GetAbsoluteSize()

FVector2D UComponentDecorator::GetAbsoluteSize ( ) const

◆ GetBrush()

BlueprintPure FSlateBrush UComponentDecorator::GetBrush ( ) const
inline

◆ GetDynamicMaterialInstance()

UMaterialInstanceDynamic * UComponentDecorator::GetDynamicMaterialInstance ( )
virtual

, Name?

◆ GetGroup()

TObjectPtr< UComponentDecoratorGroup > UComponentDecorator::GetGroup ( ) const

◆ GetMaxHorizontalSize()

float UComponentDecorator::GetMaxHorizontalSize ( bool bRecursive = false) const
virtual

Reimplemented in UComponentDecoratorGroup.

◆ GetMaxVerticalSize()

float UComponentDecorator::GetMaxVerticalSize ( bool bRecursive = false) const
virtual

Reimplemented in UComponentDecoratorGroup.

◆ GetOffset()

BlueprintPure FVector2D UComponentDecorator::GetOffset ( ) const
inline

◆ GetOwner()

const TObjectPtr< ULayoutComponent > & UComponentDecorator::GetOwner ( ) const
inline

Get the decorator widget with alignment Override this function only on specific case. In most case, you must only override GetWidget()

◆ GetRotation()

BlueprintPure float UComponentDecorator::GetRotation ( ) const
inline

◆ GetSize()

BlueprintPure FVector2D UComponentDecorator::GetSize ( ) const
inline

◆ GetWidget()

TSharedRef< SWidget > UComponentDecorator::GetWidget ( const bool bForceReconstruct = true)

Get the decorator widget Return instance if already constructed

◆ HandleOnPressEvent()

void UComponentDecorator::HandleOnPressEvent ( const FGeometry & ComponentGeometry,
const FGeometry & LayoutGeometry,
const FPointerEvent & PointerEvent )
protectedvirtual

Reimplemented in UWidgetLayer.

◆ HandleOnReleaseEvent()

void UComponentDecorator::HandleOnReleaseEvent ( const FGeometry & ComponentGeometry,
const FGeometry & LayoutGeometry,
const FPointerEvent & PointerEvent )
protectedvirtual

Reimplemented in UWidgetLayer.

◆ HideDecorator()

void UComponentDecorator::HideDecorator ( )
virtual

◆ Initialize()

void UComponentDecorator::Initialize ( TObjectPtr< ULayoutComponent > Component)
virtual

Reimplemented in UFlipbookLayer, UProgressBarLayer, and UWidgetLayer.

◆ IsInGroup()

bool UComponentDecorator::IsInGroup ( ) const

◆ IsVisible()

bool UComponentDecorator::IsVisible ( ) const
virtual

◆ SetBrush()

void UComponentDecorator::SetBrush ( const FSlateBrush InBrush)
virtual

Reimplemented in UFlipbookLayer.

◆ SetBrushOpacity()

void UComponentDecorator::SetBrushOpacity ( const float Value)
virtual

◆ SetBrushResource()

void UComponentDecorator::SetBrushResource ( UObject * Resource)
virtual

◆ SetDrawType()

void UComponentDecorator::SetDrawType ( const EDrawType NewType)
virtual

◆ SetOffset()

void UComponentDecorator::SetOffset ( FVector2D NewOffset)
virtual

◆ SetRotation()

void UComponentDecorator::SetRotation ( float Angle)
virtual

◆ SetSize()

void UComponentDecorator::SetSize ( const FVector2D Value)
virtual

◆ ShowDecorator()

void UComponentDecorator::ShowDecorator ( )
virtual

◆ FTouchInterfaceDesignerEditorMenuExtender

friend class FTouchInterfaceDesignerEditorMenuExtender
friend

◆ FTouchInterfaceLayoutEditor

friend class FTouchInterfaceLayoutEditor
friend

Member Data Documentation

◆ Animations

Instanced TArray<TObjectPtr<UComponentDecorator_Animation> > UComponentDecorator::Animations

◆ bGeneratedByLayoutComponentLogic

uint8 UComponentDecorator::bGeneratedByLayoutComponentLogic
protected

◆ bIsVisible

uint8 UComponentDecorator::bIsVisible
protected

◆ BlueprintCallable

UComponentDecorator::BlueprintCallable

◆ BlueprintReadOnly

UComponentDecorator::BlueprintReadOnly

◆ Brush

BlueprintReadOnly FSlateBrush UComponentDecorator::Brush

◆ bStartHidden

BlueprintReadOnly uint8 UComponentDecorator::bStartHidden

◆ Category

UComponentDecorator::Category ="Decorator"

The image to render in slate brush. Can be a UTexture, UMaterialInterface or an object implementing the AtlasedTextureInterface.

Returns the material instance dynamic if possible otherwise, returns null. Valid only if slate brush contain material.

Size of decorator (percentage of component size). By default, all decorator has a size that match component size. If you want, you can adjust visual size of this component by increasing or decreasing this percentage. For example, if the component size is 150su (Slate Unit): 100% = 150su. 150% = 225su. 50% = 75su.

Define the drawing order of the decorator. Allow a decorator to be drawn before or after another decorator.

◆ DecoratorWidget

TSharedPtr<SWidget> UComponentDecorator::DecoratorWidget
protected

◆ DrawType

BlueprintReadOnly EDrawType UComponentDecorator::DrawType

◆ EditAnywhere

UComponentDecorator::EditAnywhere

◆ HorizontalAlignment

BlueprintReadOnly TEnumAsByte<EHorizontalAlignment> UComponentDecorator::HorizontalAlignment

◆ meta

UComponentDecorator::meta
Initial value:
=(ClampMin=0.0f))
FVector2D Size

◆ Offset

BlueprintReadOnly FVector2D UComponentDecorator::Offset

◆ Owner

TObjectPtr<ULayoutComponent> UComponentDecorator::Owner
protected

◆ Rotation

BlueprintReadOnly float UComponentDecorator::Rotation

◆ VerticalAlignment

BlueprintReadOnly TEnumAsByte<EVerticalAlignment> UComponentDecorator::VerticalAlignment

◆ ZOrder

BlueprintReadOnly int32 UComponentDecorator::ZOrder
The documentation for this class was generated from the following files:
  • D:/MEGA/TouchProject/TouchProjectNext/Plugins/TouchInterfaceDesigner/Source/TouchInterface/Public/Decorators/ComponentDecorator.h
  • D:/MEGA/TouchProject/TouchProjectNext/Plugins/TouchInterfaceDesigner/Source/TouchInterface/Private/Decorators/ComponentDecorator.cpp