ULayoutModifier Class Reference

#include <LayoutModifier.h>

Inheritance diagram for ULayoutModifier:

Collaboration diagram for ULayoutModifier:

Public Member Functions
	ULayoutModifier ()
virtual void	SynchronizeProperties () override
virtual void	ReleaseSlateResources (bool bReleaseChildren) override
BlueprintCallable void	SetPreviewEnabled (const bool bEnabled)
BlueprintCallable bool	IsPreviewEnabled () const
BlueprintCallable void	SetPositioningWithTouchEnabled (const bool bEnablePositioning) const
BlueprintCallable void	SetResizingWithTouchEnabled (const bool bEnableResizing) const
BlueprintCallable bool	Edit (UTouchInterfaceLayout *Layout)
BlueprintCallable bool	EditSave (UTouchInterfaceLayout *LayoutReference, const int32 UserIndex, const int32 ConfigIndex, UTouchInterfaceLayout *&OutEditedLayout)
BlueprintCallable bool	SaveLayout (const int32 UserIndex, const int32 ConfigIndex) const
BlueprintCallable bool	GetSavedLayoutData (const int32 UserIndex, const int32 ConfigIndex, FLayoutSaveData &Configuration)
BlueprintCallable void	ResetToDefault (UTouchInterfaceLayout *LayoutReference, const int32 UserIndex, const int32 ConfigIndex, const bool bSaveToDisk)
BlueprintPure TArray< FName >	GetListOfComponent (const int32 UserIndex, const int32 ConfigIndex) const
BlueprintPure FName	GetSelectedComponentName () const
BlueprintCallable void	ClearSelection ()
BlueprintPure void	GetTouchInterfaceOpacity (float &InactiveOpacity, float &ActiveOpacity)
BlueprintCallable void	SetTouchInterfaceOpacity (const float InactiveOpacity, const float ActiveOpacity)
BlueprintPure FVector2D	GetComponentLocation (const FName InputName)
BlueprintPure FVector2D	GetComponentDesignLocation (const FName ComponentName)
BlueprintCallable void	SetComponentLocation (const FName InputName, const FVector2D NewOffset)
BlueprintCallable FVector4f	GetComponentMaxOffset (const FName ComponentName)
BlueprintPure FVector2D	GetComponentSize (const FName InputName)
BlueprintPure FVector2D	GetComponentDesignSize (const FName ComponentName)
BlueprintCallable void	SetComponentSize (const FName InputName, FVector2D NewSize)
BlueprintCallable FVector2D	GetComponentMaxSize (const FName ComponentName)
BlueprintCallable UTouchInterfaceLayout *	GetLayoutAssetFromSave (int32 UserIndex, int32 ConfigIndex)
BlueprintCallable void	SetPositioningPreviewEnabled (const bool bEnable) const
BlueprintCallable void	SetDesignLocationPreviewEnabled (const bool bEnable) const

Public Attributes
	Category ="Layout Modifier"
	BlueprintCallable
	BlueprintReadWrite
EditAnywhere uint8	bUseTouchForPositioning:1
EditAnywhere uint8	bUseTouchForSizing:1
	BlueprintReadOnly
	EditAnywhere
	meta
EditAnywhere uint8	bDrawPositioningBrush:1
EditAnywhere uint8	bDrawDesignCenter:1
BlueprintAssignable FOnComponentEditedEvent	OnComponentSelected
BlueprintAssignable FOnComponentEditedEvent	OnComponentLocationEdited
BlueprintAssignable FOnComponentEditedEvent	OnComponentSizeEdited

Protected Member Functions
virtual TSharedRef< SWidget >	RebuildWidget () override

Protected Attributes
TSharedPtr< STouchInterfaceLayoutPreviewer >	LayoutModifierWidget

Detailed Description

Allows player to modify touch interface layout (position and size of layout components)

Constructor & Destructor Documentation

ULayoutModifier()

ULayoutModifier::ULayoutModifier

(

)

Member Function Documentation

ClearSelection()

void ULayoutModifier::ClearSelection

(

)

Edit()

bool ULayoutModifier::Edit

(

UTouchInterfaceLayout *

Layout

)

EditSave()

bool ULayoutModifier::EditSave	(	UTouchInterfaceLayout *	LayoutReference,
		const int32	UserIndex,
		const int32	ConfigIndex,
		UTouchInterfaceLayout *&	OutEditedLayout )

GetComponentDesignLocation()

FVector2D ULayoutModifier::GetComponentDesignLocation

(

const FName

ComponentName

)

GetComponentDesignSize()

FVector2D ULayoutModifier::GetComponentDesignSize

(

const FName

ComponentName

)

GetComponentLocation()

FVector2D ULayoutModifier::GetComponentLocation

(

const FName

InputName

)

GetComponentMaxOffset()

FVector4f ULayoutModifier::GetComponentMaxOffset

(

const FName

ComponentName

)

GetComponentMaxSize()

FVector2D ULayoutModifier::GetComponentMaxSize

(

const FName

ComponentName

)

GetComponentSize()

FVector2D ULayoutModifier::GetComponentSize

(

const FName

InputName

)

GetLayoutAssetFromSave()

UTouchInterfaceLayout * ULayoutModifier::GetLayoutAssetFromSave	(	int32	UserIndex,
		int32	ConfigIndex )

GetListOfComponent()

TArray< FName > ULayoutModifier::GetListOfComponent	(	const int32	UserIndex,
		const int32	ConfigIndex ) const

GetSavedLayoutData()

bool ULayoutModifier::GetSavedLayoutData	(	const int32	UserIndex,
		const int32	ConfigIndex,
		FLayoutSaveData &	Configuration )

GetSelectedComponentName()

FName ULayoutModifier::GetSelectedComponentName

(

)

const

GetTouchInterfaceOpacity()

void ULayoutModifier::GetTouchInterfaceOpacity	(	float &	InactiveOpacity,
		float &	ActiveOpacity )

IsPreviewEnabled()

bool ULayoutModifier::IsPreviewEnabled

(

)

const

RebuildWidget()

TSharedRef< SWidget > ULayoutModifier::RebuildWidget ( )

overrideprotectedvirtual

ReleaseSlateResources()

void ULayoutModifier::ReleaseSlateResources ( bool bReleaseChildren )

overridevirtual

ResetToDefault()

void ULayoutModifier::ResetToDefault	(	UTouchInterfaceLayout *	LayoutReference,
		const int32	UserIndex,
		const int32	ConfigIndex,
		const bool	bSaveToDisk )

SaveLayout()

bool ULayoutModifier::SaveLayout	(	const int32	UserIndex,
		const int32	ConfigIndex ) const

SetComponentLocation()

void ULayoutModifier::SetComponentLocation	(	const FName	InputName,
		const FVector2D	NewOffset )

SetComponentSize()

void ULayoutModifier::SetComponentSize	(	const FName	InputName,
		FVector2D	NewSize )

SetDesignLocationPreviewEnabled()

void ULayoutModifier::SetDesignLocationPreviewEnabled

(

const bool

bEnable

)

const

SetPositioningPreviewEnabled()

void ULayoutModifier::SetPositioningPreviewEnabled

(

const bool

bEnable

)

const

SetPositioningWithTouchEnabled()

void ULayoutModifier::SetPositioningWithTouchEnabled

(

const bool

bEnablePositioning

)

const

SetPreviewEnabled()

void ULayoutModifier::SetPreviewEnabled

(

const bool

bEnabled

)

SetResizingWithTouchEnabled()

void ULayoutModifier::SetResizingWithTouchEnabled

(

const bool

bEnableResizing

)

const

SetTouchInterfaceOpacity()

void ULayoutModifier::SetTouchInterfaceOpacity	(	const float	InactiveOpacity,
		const float	ActiveOpacity )

SynchronizeProperties()

void ULayoutModifier::SynchronizeProperties ( )

overridevirtual

Member Data Documentation

bDrawDesignCenter

EditAnywhere uint8 ULayoutModifier::bDrawDesignCenter

bDrawPositioningBrush

EditAnywhere uint8 ULayoutModifier::bDrawPositioningBrush

BlueprintCallable

ULayoutModifier::BlueprintCallable

BlueprintReadOnly

ULayoutModifier::BlueprintReadOnly

BlueprintReadWrite

ULayoutModifier::BlueprintReadWrite

bUseTouchForPositioning

EditAnywhere uint8 ULayoutModifier::bUseTouchForPositioning

bUseTouchForSizing

EditAnywhere uint8 ULayoutModifier::bUseTouchForSizing

Category

ULayoutModifier::Category ="Layout Modifier"

Manually enable or disable preview. Preview is automatically activated by calling Edit or Edit Save.

Edit layout Do not check if any modification exist in save file To be able to edit already modified layout, see Edit Save

Edit layout with modification saved in save file

Parameters

LayoutReference	LayoutReference is asset in disk (Drawer in editor). This asset is only modified in layout editor. It is only used as reference to get unmodified data
UserIndex	Index used to identify user
ConfigIndex	Index used to identify saved data of layout
OutEditedLayout	Layout that is currently edited. Copy of Layout Reference

Save modifications of edited layout in storage Create new save file if it doesn't exist

Get current selected virtual input name. Return None if nothing is selected

Return location of component (edited by layout modifier) If child, return local location If you want original location of component, see 'Get Component Design Location'

Return size of component (edited by layout modifier) If you want original size of component, see 'Get Component Design Size'

Whether or not, positioning brush should be drawn bDrawPositioningBrush should be enabled With mouse or touch, draw automatically Call this function for specific use case like using slider

Whether or not, design location (original location) of component should be drawn bDrawDesignLocation should be enabled With mouse or touch, draw automatically Call this function for specific use case like using slider

Allow user to touch virtual input widget to positioning Otherwise, it's up to you to set offset position of virtual input, with a slider for example Call Set Virtual Input Offset

Allow user to use pinch gesture for sizing Otherwise, it's up to you to set size scale of virtual input, with a slider for example Call Set Virtual Input Size Scale

EditAnywhere

ULayoutModifier::EditAnywhere

LayoutModifierWidget

TSharedPtr<STouchInterfaceLayoutPreviewer> ULayoutModifier::LayoutModifierWidget

protected

meta

ULayoutModifier::meta

Initial value:

=(ClampMin=0.1f, ClampMax=1.0f))
    float ResizeSensibility

OnComponentLocationEdited

BlueprintAssignable FOnComponentEditedEvent ULayoutModifier::OnComponentLocationEdited

OnComponentSelected

BlueprintAssignable FOnComponentEditedEvent ULayoutModifier::OnComponentSelected

OnComponentSizeEdited

BlueprintAssignable FOnComponentEditedEvent ULayoutModifier::OnComponentSizeEdited

---

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

• D:/MEGA/TouchProject/TouchProjectNext/Plugins/TouchInterfaceDesigner/Source/TouchInterface/Public/RuntimeConfigurator/LayoutModifier.h
• D:/MEGA/TouchProject/TouchProjectNext/Plugins/TouchInterfaceDesigner/Source/TouchInterface/Private/RuntimeConfigurator/LayoutModifier.cpp