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

#include <LayoutGroupComponent.h>

Inheritance diagram for ULayoutGroupComponent:
Collaboration diagram for ULayoutGroupComponent:

Public Member Functions

 ULayoutGroupComponent ()
virtual void BeginDestroy () override
virtual TSharedRef< SLayoutComponentTakeWidget (SConstraintCanvas::FSlot *WidgetSlot, TSharedPtr< STouchInterface > LayoutWidget, ULocalPlayer *LocalPlayer, TSharedPtr< SLayoutComponent > InParent=nullptr) override
virtual TArray< ULayoutComponent * > GetChildren ()
virtual BlueprintCallable ULayoutComponentAddChild (const FName DesiredName, const FVector2D ChildPosition, FVector2D ChildSize, const TSubclassOf< UComponentLogic > ChildLogicClass)
virtual BlueprintCallable void AddChildByRef (ULayoutComponent *LayoutComponentInstance)
virtual BlueprintCallable void RemoveComponentFromGroup (ULayoutComponent *Component)
virtual BlueprintCallable void RemoveComponentByName (const FName ComponentName)
virtual BlueprintCallable void ShowAllComponentsInGroup ()
virtual BlueprintCallable void HideAllComponentsInGroup ()
virtual BlueprintCallable void ShowAllExcept (const FName Name)
virtual BlueprintCallable void HideAllExcept (const FName Name)
virtual BlueprintCallable void ShowAllExceptNamedOnes (const TArray< FName > Names)
virtual BlueprintCallable void HideAllExceptNamedOnes (const TArray< FName > Names)
virtual BlueprintCallable bool ContainComponent (const ULayoutComponent *Component)
virtual BlueprintCallable bool ContainComponentByName (const FName ComponentName) const
virtual BlueprintCallable bool GetAllComponentsInGroup (TArray< ULayoutComponent * > &Components)
virtual BlueprintCallable ULayoutComponentGetComponentByName (const FName Name) const
virtual BlueprintCallable bool GetComponentsByLogicClass (const TSubclassOf< UComponentLogic > Class, const bool bIncludeInherited, TArray< ULayoutComponent * > &Components)
BlueprintPure int32 GetIndexOfComponent (ULayoutComponent *Component)
virtual BlueprintCallable bool GetAllComponentNameInGroup (TArray< FName > &Names)
Public Member Functions inherited from ULayoutComponent
 ULayoutComponent ()
UTextureRenderTarget2D * GetCollapsedLayer ()
FVector2D GetComponentOffset () const
void SetComponentOffset (const FVector2D InCenterOffset)
virtual void UpdateScaleFactor (const FGeometry &LayoutGeometry, const float &ScaleFactor)
void SetPortraitMode (const bool bEnable)
bool IsInPortraitMode () const
bool AllowPositionModification () const
bool AllowSizeModification () const
virtual TSharedPtr< SLayoutComponentGetWidgetInstance () const
TSharedPtr< STouchInterfaceGetTouchInterfaceWidget () const
void SetAnchor (const FAnchors NewAnchor)
void SetTopLeftLocation (const FVector2D Value)
void SetSize (const FVector2D Value)
FVector2D GetParentSize () const
BlueprintCallable FAnchors GetAnchor () const
BlueprintCallable FVector2D GetAlignment () const
BlueprintPure FVector4f GetAnchorOffset () const
virtual BlueprintPure FVector2D GetComponentLocation () const
virtual BlueprintPure FVector2D GetComponentTopLeftLocation ()
virtual BlueprintPure FVector2D GetComponentLocalLocation () const
virtual BlueprintPure FVector2D GetLayoutTopLeftLocation () const
virtual BlueprintPure FVector2D GetLayoutTopLeftCenterLocation () const
virtual BlueprintPure FVector2D GetLayoutTopLeftLocationAtAlignment (FVector2D AtAlignment)
BlueprintPure float GetComponentAngle () const
BlueprintPure FVector2D GetComponentSize () const
virtual BlueprintPure FVector4f GetComponentMaxOffset () const
BlueprintPure FVector2D GetComponentSizeScale () const
virtual BlueprintCallable void SetComponentAnchorPreset (const EAnchorPosition Anchor)
virtual BlueprintCallable void SetComponentAlignment (const FVector2D NewAlignment)
virtual BlueprintCallable void SetAnchorOffset (const FVector4f NewAnchorOffset)
virtual BlueprintCallable void SetComponentLocation (const FVector2D NewLocation)
virtual BlueprintCallable void SetComponentLocalLocation (const FVector2D NewLocation)
virtual BlueprintCallable void SetComponentPortraitOffset (const FVector2D NewOffset)
virtual BlueprintCallable void SetComponentAngle (const float Value)
virtual BlueprintCallable void SetComponentSize (const FVector2D NewSize)
virtual BlueprintCallable void SetComponentSizeScale (const FVector2D NewSizeScale)
virtual BlueprintPure bool IsUnderLocation (const FVector2D AbsoluteLocation)
virtual BlueprintPure bool CanInteract () const
virtual BlueprintCallable bool IsPressed () const
virtual BlueprintCallable void SetComponentVisibility (const bool bVisible)
virtual BlueprintCallable bool IsVisible ()
virtual BlueprintCallable void Recenter (const FVector2D LayoutPosition=FVector2D::ZeroVector)
virtual BlueprintCallable void ResetPosition ()
virtual BlueprintCallable const FGeometry & GetComponentGeometry ()
virtual BlueprintPure bool IsChild () const
BlueprintPure ULayoutComponentGetParent () const
BlueprintPure UTouchInterfaceLayoutGetTouchInterfaceLayout () const
virtual BlueprintCallable void RebuildDecorators () const
BlueprintCallable UComponentDecoratorAddDecoratorByClass (TSubclassOf< UComponentDecorator > DecoratorClass, const FName Name)
BlueprintCallable void AddDecorator (UComponentDecorator *Decorator)
BlueprintCallable UComponentDecoratorInsertDecoratorByClassAt (TSubclassOf< UComponentDecorator > DecoratorClass, FName Name, int32 Index)
BlueprintCallable void InsertDecoratorAt (UComponentDecorator *Decorator, int32 Index)
BlueprintCallable void RemoveDecoratorByName (const FName Name)
BlueprintCallable void RemoveDecoratorAt (const int32 Index)
BlueprintPure int32 GetDecoratorIndex (const FName Name)
BlueprintPure UComponentDecoratorGetDecoratorByName (const FName Name, bool bRecursive)
BlueprintPure UComponentDecoratorGetDecoratorByIndex (const int32 Index)
BlueprintPure TArray< UComponentDecorator * > GetAllDecorators (bool bRecursive)
BlueprintPure TArray< FName > GetAllDecoratorNames (bool bRecursive)
BlueprintPure UProgressBarLayerGetDecoratorAsProgressBar (const FName LayerName)
BlueprintPure UTextLayerGetDecoratorAsText (const FName LayerName)
BlueprintPure UBlurLayerGetDecoratorAsBlur (const FName LayerName)
BlueprintPure UFlipbookLayerGetDecoratorAsFlipbook (const FName LayerName)
BlueprintPure UComponentDecoratorGroupGetDecoratorAsGroup (const FName LayerName)
BlueprintPure UWidgetLayerGetDecoratorAsWidget (const FName LayerName)
BlueprintPure bool ContainDecoratorName (const FName Name, bool bRecursive=false)
BlueprintPure bool ContainDecorator (UObject *LayerObject)
BlueprintPure bool ContainDecoratorClass (TSubclassOf< UComponentDecorator > Class)
BlueprintCallable float GetOpacity () const
BlueprintCallable void SetOpacity (const float Value)
bool HitPixel (const FVector2D NormalizedPosition, const float AlphaTolerance=0)
BlueprintCallable void BeginEditDecorator (const FName LayerName)
BlueprintCallable void EndEditDecorator ()
bool ConsumeInput () const
bool CanRecenter () const
FVector2D GetOffsetFromCenter () const
EInteractionType GetInteractionShape () const
BlueprintPure float GetInteractionSize () const
BlueprintCallable int32 GetInputPriority () const
BlueprintCallable bool IsConsumeInput () const
BlueprintPure ULayoutGroupComponentGetGroup ()
BlueprintCallable void SetInteractionSize (const float Value)
BlueprintCallable void SetInputPriority (const int32 NewPriority)
BlueprintCallable void SetConsumeInput (const bool Value)
BlueprintCallable void EnableInput ()
BlueprintCallable void DisableInput ()
BlueprintPure bool IsInputEnabled ()
BlueprintCallable UComponentLogic * SetLogic (const TSubclassOf< UComponentLogic > NewLogicClass)

Public Attributes

 Category ="Group Input Component"
 BlueprintCallable
TArray< TObjectPtr< ULayoutComponent > > Children
 EditAnywhere
BlueprintReadOnly uint8 bSupportInput:1
Public Attributes inherited from ULayoutComponent
 Category ="Layout Component"
 BlueprintCallable
 meta
 EditAnywhere
 BlueprintReadOnly
FVector2D DesignLocation
BlueprintReadOnly FVector2D PortraitOffset
FVector2D DesignSize
TArray< TObjectPtr< UComponentDecorator > > Decorators
BlueprintReadOnly uint8 bIsVisible:1
BlueprintReadOnly uint8 bOptimizeRendering:1
BlueprintReadOnly bool bAllowLocationModification
BlueprintReadOnly FVector4f MaxCenterOffset
BlueprintReadOnly uint8 bAllowSizeModification:1
BlueprintReadOnly FVector2D MaxSizeScale
BlueprintReadOnly uint8 bRecenterOnTouch:1
BlueprintReadWrite EInteractionType InteractionShape
BlueprintReadOnly uint8 bConsumeInput:1
Instanced TObjectPtr< UComponentLogic > Logic

Additional Inherited Members

Protected Attributes inherited from ULayoutComponent
FVector2D LayoutModifierOffset
float CurrentSizeScale
TSharedPtr< SLayoutComponentComponentWidget
TSharedPtr< STouchInterfaceTouchInterfaceWidget
TObjectPtr< UComponentLogic > LogicCompInstance
FVector2D OffsetFromCenter
FVector2D TopLeftLocation

Detailed Description

Layout component with children support

Constructor & Destructor Documentation

◆ ULayoutGroupComponent()

ULayoutGroupComponent::ULayoutGroupComponent ( )

Member Function Documentation

◆ AddChild()

ULayoutComponent * ULayoutGroupComponent::AddChild ( const FName DesiredName,
const FVector2D ChildPosition,
FVector2D ChildSize,
const TSubclassOf< UComponentLogic > ChildLogicClass )
virtual

◆ AddChildByRef()

void ULayoutGroupComponent::AddChildByRef ( ULayoutComponent * LayoutComponentInstance)
virtual

◆ BeginDestroy()

void ULayoutGroupComponent::BeginDestroy ( )
overridevirtual

Reimplemented from ULayoutComponent.

◆ ContainComponent()

bool ULayoutGroupComponent::ContainComponent ( const ULayoutComponent * Component)
virtual

◆ ContainComponentByName()

bool ULayoutGroupComponent::ContainComponentByName ( const FName ComponentName) const
virtual

◆ GetAllComponentNameInGroup()

bool ULayoutGroupComponent::GetAllComponentNameInGroup ( TArray< FName > & Names)
virtual

◆ GetAllComponentsInGroup()

bool ULayoutGroupComponent::GetAllComponentsInGroup ( TArray< ULayoutComponent * > & Components)
virtual

◆ GetChildren()

TArray< ULayoutComponent * > ULayoutGroupComponent::GetChildren ( )
virtual

◆ GetComponentByName()

ULayoutComponent * ULayoutGroupComponent::GetComponentByName ( const FName Name) const
virtual

◆ GetComponentsByLogicClass()

bool ULayoutGroupComponent::GetComponentsByLogicClass ( const TSubclassOf< UComponentLogic > Class,
const bool bIncludeInherited,
TArray< ULayoutComponent * > & Components )
virtual

◆ GetIndexOfComponent()

int32 ULayoutGroupComponent::GetIndexOfComponent ( ULayoutComponent * Component)

◆ HideAllComponentsInGroup()

void ULayoutGroupComponent::HideAllComponentsInGroup ( )
virtual

◆ HideAllExcept()

void ULayoutGroupComponent::HideAllExcept ( const FName Name)
virtual

◆ HideAllExceptNamedOnes()

void ULayoutGroupComponent::HideAllExceptNamedOnes ( const TArray< FName > Names)
virtual

◆ RemoveComponentByName()

void ULayoutGroupComponent::RemoveComponentByName ( const FName ComponentName)
virtual

◆ RemoveComponentFromGroup()

void ULayoutGroupComponent::RemoveComponentFromGroup ( ULayoutComponent * Component)
virtual

◆ ShowAllComponentsInGroup()

void ULayoutGroupComponent::ShowAllComponentsInGroup ( )
virtual

◆ ShowAllExcept()

void ULayoutGroupComponent::ShowAllExcept ( const FName Name)
virtual

◆ ShowAllExceptNamedOnes()

void ULayoutGroupComponent::ShowAllExceptNamedOnes ( const TArray< FName > Names)
virtual

◆ TakeWidget()

TSharedRef< SLayoutComponent > ULayoutGroupComponent::TakeWidget ( SConstraintCanvas::FSlot * WidgetSlot,
TSharedPtr< STouchInterface > LayoutWidget,
ULocalPlayer * LocalPlayer,
TSharedPtr< SLayoutComponent > InParent = nullptr )
overridevirtual

Reimplemented from ULayoutComponent.

Member Data Documentation

◆ BlueprintCallable

ULayoutGroupComponent::BlueprintCallable

◆ bSupportInput

BlueprintReadOnly uint8 ULayoutGroupComponent::bSupportInput

◆ Category

ULayoutGroupComponent::Category ="Group Input Component"

Add layout component to group

Parameters
DesiredNameName of component. Can be modified if name is not available.
ChildPositionPosition of component in group
ChildSizeSize of component in group
ChildLogicClassLogic class used by the new component

Add layout component to group

Return true if group contain the component.

Parameters
Componentlayout component to search in layout

Return true if group contain the component.

Parameters
ComponentNamename of layout component to search in layout

Return true if there is at least one component in group

Parameters
ComponentsArray of all components in layout

Returns the component with the searched name

Parameters
NameName of component searched

Returns true if the component is found

Parameters
ClassLogic class searched
bIncludeInherited
ComponentsArray of all components that have searched logic class

Returns true if there is at least one component in layout

Parameters
NamesArray of component names

If enabled, support input and decorator

  • Support Group Recenter
  • Allow some functionalities like button that show/hide children

◆ Children

TArray<TObjectPtr<ULayoutComponent> > ULayoutGroupComponent::Children

◆ EditAnywhere

ULayoutGroupComponent::EditAnywhere

The documentation for this class was generated from the following files:
  • D:/MEGA/TouchProject/TouchProjectNext/Plugins/TouchInterfaceDesigner/Source/TouchInterface/Public/Components/LayoutGroupComponent.h
  • D:/MEGA/TouchProject/TouchProjectNext/Plugins/TouchInterfaceDesigner/Source/TouchInterface/Private/Components/LayoutGroupComponent.cpp