UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ComponentSourceInterfaces.h File Reference
#include "CoreMinimal.h"
#include "Math/UnrealMath.h"
#include "Misc/Optional.h"
#include "Templates/Function.h"

Go to the source code of this file.

Classes

class  FPrimitiveComponentTarget
 
struct  FPrimitiveComponentTarget::FCommitParams
 
class  FComponentTargetFactory
 

Functions

INTERACTIVETOOLSFRAMEWORK_API int32 AddComponentTargetFactory (TUniquePtr< FComponentTargetFactory > Factory)
 
INTERACTIVETOOLSFRAMEWORK_API FComponentTargetFactoryFindComponentTargetFactoryByKey (int32 Key)
 
INTERACTIVETOOLSFRAMEWORK_API bool RemoveComponentTargetFactoryByKey (int32 Key)
 
INTERACTIVETOOLSFRAMEWORK_API void RemoveAllComponentTargetFactoryies ()
 
INTERACTIVETOOLSFRAMEWORK_API TUniquePtr< FPrimitiveComponentTargetMakeComponentTarget (UPrimitiveComponent *Component)
 
INTERACTIVETOOLSFRAMEWORK_API bool CanMakeComponentTarget (UActorComponent *Component)
 

Function Documentation

◆ AddComponentTargetFactory()

INTERACTIVETOOLSFRAMEWORK_API int32 AddComponentTargetFactory ( TUniquePtr< FComponentTargetFactory Factory)

Add a factory method to make ComponentTarget from UPrimitiveComponent*

Parameters
FactoryThe ComponentTargetFactory
Returns
integer indentifier that identifies this Factory

◆ CanMakeComponentTarget()

INTERACTIVETOOLSFRAMEWORK_API bool CanMakeComponentTarget ( UActorComponent Component)

Determine whether a TargetComponent can be created for the given Component

Parameters
ComponentA UObject that we would like to use as tool target.
Returns
bool signifying whether or not a ComponentTarget can be built

◆ FindComponentTargetFactoryByKey()

INTERACTIVETOOLSFRAMEWORK_API FComponentTargetFactory * FindComponentTargetFactoryByKey ( int32  Key)
Returns
ComponentTargetFactory associated with the given Key, or nullptr if not found

◆ MakeComponentTarget()

INTERACTIVETOOLSFRAMEWORK_API TUniquePtr< FPrimitiveComponentTarget > MakeComponentTarget ( UPrimitiveComponent *  Component)

Create a TargetComponent for the given Component

Parameters
ComponentA UObject that we would like to use as tool target. This must presently descend from UPrimitiveComponent
Returns
An FComponentTarget instance. Must not return null, though the MeshSource and MeshSink in it's MeshBridge may be

◆ RemoveAllComponentTargetFactoryies()

INTERACTIVETOOLSFRAMEWORK_API void RemoveAllComponentTargetFactoryies ( )

remove all registered ComponentTargetFactory objects

◆ RemoveComponentTargetFactoryByKey()

INTERACTIVETOOLSFRAMEWORK_API bool RemoveComponentTargetFactoryByKey ( int32  Key)
Returns
true if ComponentTargetFactory associated with the given Key was found and removed