Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
Inheritance Hierarchy
- FPrimitiveComponentTarget
- FStaticMeshComponentTarget
- FVolumeComponentTarget
References
| Module | InteractiveToolsFramework |
| Header | /Engine/Source/Runtime/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
| Type | Name | Description | |
|---|---|---|---|
| UPrimitiveComponent * | Component |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FPrimitiveComponentTarget
(
UPrimitiveComponent* Component |
Constructor UPrimitivecomponent* |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | CommitMaterialSetUpdate
(
const FComponentMaterialSet& MaterialSet, |
Commit an update to the material set. This may generate a transaction. | |
| void | CommitMesh
(
const FCommitter& |
||
| UMaterialInterface * | GetMaterial
(
int32 MaterialIndex |
Get pointer to a Material provided by this Source | |
| void | GetMaterialSet
(
FComponentMaterialSet& MaterialSetOut, |
Get material set provided by this source | |
| FMeshDescription * | GetMesh () |
||
| int32 | |||
| AActor * | |||
| UPrimitiveComponent * | |||
| FTransform | |||
| bool | HasSameSourceData
(
const FPrimitiveComponentTarget& OtherTarget |
Checks if the underlying asset that would be edited by CommitMesh() is the same for two ComponentTargets | |
| bool | HitTest
(
const FRay& WorldRay, |
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
| Type | Name | Description | |
|---|---|---|---|
| FCommitParams |
Typedefs
| Name | Description |
|---|---|
| FCommitter |