FActivateToolChange Class Reference

#include <InteractiveToolManager.h>

Inheritance diagram for FActivateToolChange:

Public Member Functions
	FActivateToolChange (EToolSide SideIn, FString ToolTypeIn)
	FActivateToolChange (EToolSide SideIn, FString ToolTypeIn, EToolShutdownType ShutdownTypeIn)
virtual INTERACTIVETOOLSFRAMEWORK_API void	Apply (UObject *Object) override
virtual INTERACTIVETOOLSFRAMEWORK_API void	Revert (UObject *Object) override
virtual INTERACTIVETOOLSFRAMEWORK_API bool	HasExpired (UObject *Object) const override
virtual INTERACTIVETOOLSFRAMEWORK_API FString	ToString () const override
Public Member Functions inherited from FCommandChange
virtual EChangeStyle	GetChangeType () final
virtual TUniquePtr< FChange >	Execute (UObject *Object) final
Public Member Functions inherited from FChange
virtual void	AddReferencedObjects (FReferenceCollector &Collector)
virtual CORE_API void	PrintToLog (FFeedbackContext &FeedbackContext, const int32 IndentLevel=0)
virtual SIZE_T	GetSize () const
virtual	~FChange ()

Public Attributes
EToolSide	Side
FString	ToolType
bool	bIsDeactivate = false
EToolShutdownType	ShutdownType

Additional Inherited Members
Public Types inherited from FChange
enum class	EChangeStyle { InPlaceSwap , CommandPattern }
Protected Member Functions inherited from FChange
	FChange ()

Detailed Description

FActivateToolChange is used by UInteractiveToolManager to change the active tool. This Change has two modes, either activating or deactivating.

Constructor & Destructor Documentation

FActivateToolChange() [1/2]

FActivateToolChange::FActivateToolChange ( EToolSide  SideIn, FString  ToolTypeIn  )

inline

FActivateToolChange() [2/2]

FActivateToolChange::FActivateToolChange ( EToolSide  SideIn, FString  ToolTypeIn, EToolShutdownType  ShutdownTypeIn  )

inline

Member Function Documentation

Apply()

void FActivateToolChange::Apply ( UObject *  Object )

overridevirtual

Makes the change to the object

Implements FChange.

HasExpired()

bool FActivateToolChange::HasExpired ( UObject *  Object ) const

overridevirtual

Returns

true if this Change has Expired, ie it will no longer have any effect and could be skipped by undo/redo

Reimplemented from FChange.

Revert()

void FActivateToolChange::Revert ( UObject *  Object )

overridevirtual

Reverts change to the object

Implements FChange.

ToString()

FString FActivateToolChange::ToString ( ) const

overridevirtual

Describes this change (for debugging)

Reimplemented from FToolCommandChange.

Member Data Documentation

bIsDeactivate

bool FActivateToolChange::bIsDeactivate = false

ShutdownType

EToolShutdownType FActivateToolChange::ShutdownType

Side

EToolSide FActivateToolChange::Side

ToolType

FString FActivateToolChange::ToolType

---

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

• Engine/Source/Runtime/InteractiveToolsFramework/Public/InteractiveToolManager.h
• Engine/Source/Runtime/InteractiveToolsFramework/Private/InteractiveToolManager.cpp