1. Epic GamesDeveloper
  3. UBaseDynamicMeshComponent

UBaseDynamicMeshComponent

[UBaseDynamicMeshComponent](API\Runtime\GeometryFramework\Components\UBaseDynamicMeshComponent) is a base interface for a UMeshComponent based on a [UDynamicMesh](API\Runtime\GeometryFramework\UDynamicMesh).

API > API/Runtime > API/Runtime/GeometryFramework > API/Runtime/GeometryFramework/Components

Inheritance Hierarchy

References

   
Module GeometryFramework
Header /Engine/Source/Runtime/GeometryFramework/Public/Components/BaseDynamicMeshComponent.h
Include #include "Components/BaseDynamicMeshComponent.h"

Syntax

UCLASS (Abstract, HideCategories=(LOD), ClassGroup=Rendering, MinimalAPI)  
class UBaseDynamicMeshComponent :  
    public UMeshComponent,  
    public IToolFrameworkComponent,  
    public IMeshVertexCommandChangeTarget ,  
    public IMeshCommandChangeTarget ,  
    public IMeshReplacementCommandChangeTarget

Remarks

UBaseDynamicMeshComponent is a base interface for a UMeshComponent based on a UDynamicMesh.

Variables

  Type Name Description
Public variable UProperty TArray< TObjectPtr< UMaterialInterface > > BaseMaterials  
Protected variable bool bDrawSecondaryBuffers  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bEnableFlatShading Flat shading support.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bEnableRaytracing Raytracing support.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bEnableViewModeOverrides This flag controls whether Editor View Mode Overrides are enabled for this mesh.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bExplicitShowWireframe Built-in Wireframe-on-Shaded Rendering support.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintgetter, blueprintsetter   BlueprintGetter  
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintgetter, blueprintsetter   BlueprintSetter Controls whether to use the dynamic or static draw path

Controls how distance field is computed |

Protected variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintgetter, blueprintsetter   Category  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EDynamicMeshComponentColorOverrideMode ColorMode Built-in Color Rendering Support.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EDynamicMeshVertexColorTransformMode ColorSpaceMode Color Space Transform that will be applied to the colors stored in the DynamicMesh Attribute Color Overlay when constructing render buffers.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FColor ConstantColor Constant Color used when Override Color Mode is set to Constant
Protected variable UProperty TObjectPtr< UMaterialInterface > OverrideRenderMaterial  
Protected variable UProperty TObjectPtr< UMaterialInterface > SecondaryRenderMaterial  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FLinearColor WireframeColor Constant Color used when Override Color Mode is set to Constant

Constructors

  Type Name Description
Public function  

UBaseDynamicMeshComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function Virtual bool Whether the fast update paths will be used for the mesh.
Public function Virtual void

ApplyTransform ( const FTransform3d& Transform,
bool bInvert
)

 Apply a transform to the mesh
Public function Virtual UFunction BlueprintCallable, Category void Clear any active override render material
Public function Virtual UFunction BlueprintCallable, Category void Clear any active secondary render material
Protected function Virtual FBaseDynamicMeshSceneProxy * Subclass must implement this to return scene proxy if available, or nullptr
Public function Virtual Const UFunction BlueprintCallable, Category EDynamicMeshComponentColorOverrideMode  
Public function Virtual Const UFunction BlueprintCallable, Category FColor  
Protected function Static UMaterialInterface *  
Protected function Static UMaterialInterface *  
Public function Virtual Const UFunction BlueprintPure, Category EDynamicMeshComponentDistanceFieldMode  
Public function Virtual UFunction BlueprintCallable, Category UDynamicMesh *  
Public function Virtual Const UFunction BlueprintCallable, Category bool  
Public function Virtual Const UFunction BlueprintCallable, Category bool  
Public function Virtual Const UFunction BlueprintCallable, Category bool  
Public function Virtual Const UMaterialInterface *

GetMaterial ( int32 ElementIndex
)

  
Public function Virtual Const UMaterialInterface *

GetMaterialByName ( FName MaterialSlotName
)

  
Public function Virtual Const FMaterialRelevance

GetMaterialRelevance ( ERHIFeatureLevel::Type InFeatureLevel
)

  
Public function Virtual Const TArray< FName >  
Public function Virtual FDynamicMesh3 *

GetMesh ()

 Avoid usage of this function, access via GetDynamicMesh() instead
Public function Virtual Const const FDynamicMesh3 *

GetMesh ()

  
Public function Virtual Const UFunction BlueprintPure, Category EDynamicMeshDrawPath  
Public function Virtual Const int32 Standard Component interfaces
Public function Virtual Const UFunction BlueprintCallable, Category UMaterialInterface *

GetOverrideRenderMaterial ( int MaterialIndex
)

  
Public function Virtual Const UFunction BlueprintCallable, Category bool  
Public function Virtual Const UFunction BlueprintCallable, Category UMaterialInterface *  
Public function Virtual Const UFunction BlueprintCallable, Category bool  
Public function Virtual Const void

GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials,
bool bGetDebugMaterials
)

  
Public function Virtual Const UFunction BlueprintCallable, Category EDynamicMeshVertexColorTransformMode  
Public function Virtual Const UFunction BlueprintCallable, Category bool  
Public function Virtual Const UFunction BlueprintCallable, Category bool  
Public function Virtual Const bool  
Protected function Static void  
Public function Virtual Const bool

IsMaterialSlotNameValid ( FName MaterialSlotName
)

  
Protected function Virtual void Subclass must implement this to notify allocated proxies of updated materials
Public function Virtual void Call this if you update the mesh via GetMesh()
Protected function Virtual void This will be called if a change to distance field mode is detected
Protected function Virtual void

OnRenderingStateChanged ( bool bForceImmedateRebuild
)

  
Public function void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual Const void

ProcessMesh ( TFunctionRef< void(const UE::Geometry::FDynamicMesh3&)> ProcessFunc
)

 Allow external code to read the internal mesh.
Public function Virtual UFunction BlueprintCallable, Category void Configure the active Color Override
Public function Virtual UFunction BlueprintCallable, Category void

SetConstantOverrideColor ( FColor NewColor
)

 Configure the Color used with Constant Color Override Mode
Public function Static void

SetDefaultVertexColorMaterial ( UMaterialInterface* Material
)

 Set the vertex color material used for all BaseDynamicMeshComponent-derived Components
Public function Static void

SetDefaultWireframeMaterial ( UMaterialInterface* Material
)

 Class-wide Default Materials used for Wireframe and VertexColor display mode.
Public function Virtual UFunction BlueprintCallable, Category void Configure Distance Field computation mode
Public function Virtual UFunction BlueprintCallable, Category void

SetEnableFlatShading ( bool bEnable
)

 Configure the Color used with Constant Color Override Mode
Public function Virtual UFunction BlueprintCallable, Category void

SetEnableRaytracing ( bool bSetEnabled
)

 Enable/Disable raytracing support.
Public function Virtual UFunction BlueprintCallable, Category void

SetEnableWireframeRenderPass ( bool bEnable
)

 Configure whether wireframe rendering is enabled or not
Public function Virtual void

SetMaterial ( int32 ElementIndex,
UMaterialInterface* Material
)

  
Public function Virtual void

SetMesh ( UE::Geometry::FDynamicMesh3&& MoveMesh
)

 UBaseDynamicMeshComponent API.
Public function Virtual UFunction BlueprintCallable, Category void Set the mesh rendering to use the static or dynamic draw path
Public function Virtual void

SetNumMaterials ( int32 NumMaterials
)

  
Public function Virtual UFunction BlueprintCallable, Category void

SetOverrideRenderMaterial ( UMaterialInterface* Material
)

 Override rendering material support.
Public function Virtual UFunction BlueprintCallable, Category void

SetSecondaryBuffersVisibility ( bool bSetVisible
)

 Show/Hide the secondary triangle buffers. Does not invalidate SceneProxy.
Public function Virtual UFunction BlueprintCallable, Category void

SetSecondaryRenderMaterial ( UMaterialInterface* Material
)

 Secondary Render Buffers support.
Public function Virtual UFunction BlueprintCallable, Category void

SetShadowsEnabled ( bool bEnabled
)

 API for changing Rendering settings.
Public function Virtual UFunction BlueprintCallable, Category void Configure the active Color Space Transform Mode
Public function Virtual UFunction BlueprintCallable, Category void

SetViewModeOverridesEnabled ( bool bEnabled
)

  

Overridden from IMeshVertexCommandChangeTarget

  Type Name Description
Public function Virtual void

ApplyChange ( const FMeshVertexChange* Change,
bool bRevert
)

 Apply a vertex deformation change to the internal mesh (implements IMeshVertexCommandChangeTarget)

Overridden from IMeshCommandChangeTarget

  Type Name Description
Public function Virtual void

ApplyChange ( const FMeshChange* Change,
bool bRevert
)

 Apply a general mesh change to the internal mesh (implements IMeshCommandChangeTarget)

Overridden from IMeshReplacementCommandChangeTarget

  Type Name Description
Public function Virtual void

ApplyChange ( const FMeshReplacementChange* Change,
bool bRevert
)

 Apply a full mesh replacement change to the internal mesh (implements IMeshReplacementCommandChangeTarget)

Constants

Name Description
DefaultVertexColorMaterial  
DefaultWireframeMaterial These Materials are used by the render thread.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page