Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > InteractiveToolsFramework > FPrimitiveComponentTarget

Light Theme

Dark Theme

FPrimitiveComponentTarget

Wrapper around a [UObject](API\Runtime\CoreUObject\UObject\UObject) Component that can provide a MeshDescription, and (optionally) bake a modified MeshDescription back to this Component.

Windows

MacOS

Linux

Inheritance Hierarchy

FPrimitiveComponentTarget

	FProceduralMeshComponentTarget
	FStaticMeshComponentTarget

References

Module	InteractiveToolsFramework
Header	/Engine/Source/Runtime/Experimental/InteractiveToolsFramework/Public/ComponentSourceInterfaces.h
Include	#include "ComponentSourceInterfaces.h"

Syntax

class FPrimitiveComponentTarget

Remarks

Wrapper around a UObject Component that can provide a MeshDescription, and (optionally) bake a modified MeshDescription back to this Component. An example of a Source might be a StaticMeshComponent. How a modified MeshDescription is committed back is context-dependent (in Editor vs PIE vs Runtime, etc).

(Conceivably this doesn't have to be backed by a Component, but most usage will assume there is an Actor)

Variables

		Name	Description
	UPrimitiveCompo...	Component

Constructors

	Name	Description
	FPrimitiveComponentTarget ( UPrimitiveComponent* Component )	Constructor UPrimitivecomponent*

Destructors

	Name	Description
	~FPrimitiveComponentTarget()

Functions

	Name	Description
void	CommitMaterialSetUpdate ( const FComponentMaterialSet& Mater..., bool bApplyToAsset )	Commit an update to the material set. This may generate a transaction.
void	CommitMesh ( const FCommitter& )
UMaterialInt...	GetMaterial ( int32 MaterialIndex )	Get pointer to a Material provided by this Source
void	GetMaterialSet ( FComponentMaterialSet& MaterialSet..., bool bAssetMaterials )	Get material set provided by this source
FMeshDescrip...	GetMesh()
int32	GetNumMaterials()
AActor *	GetOwnerActor()
UPrimitiveCo...	GetOwnerComponent()
FTransform	GetWorldTransform()
bool	HasSameSourceData ( const FPrimitiveComponentTarget& O... )	Checks if the underlying asset that would be edited by CommitMesh() is the same for two ComponentTargets
bool	HitTest ( const FRay& WorldRay, FHitResult& OutHit )	Compute ray intersection with the MeshDescription this Source is providing
bool	IsValid()
void	SetOwnerVisibility ( bool bVisible )	Set the visibility of the Component associated with this Source (ie to hide during Tool usage)

Classes

	Name	Description
	FCommitParams

Typedefs

Name	Description
FCommitter

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss