1. Epic GamesDeveloper
  3. UBaseDynamicMeshComponent

UBaseDynamicMeshComponent

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

API > API/Runtime > API/Runtime/GeometryFramework

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

   
Name UBaseDynamicMeshComponent
Type class
Header File /Engine/Source/Runtime/GeometryFramework/Public/Components/BaseDynamicMeshComponent.h
Include Path #include "Components/BaseDynamicMeshComponent.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UBaseDynamicMeshComponent ( const FObjectInitializer& ObjectInitializer
)

   Components/BaseDynamicMeshComponent.h  

Constants

Name Type Remarks Include Path
DefaultVertexColorMaterial UMaterialInterface *   Components/BaseDynamicMeshComponent.h
DefaultWireframeMaterial UMaterialInterface * These Materials are used by the render thread. Components/BaseDynamicMeshComponent.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BaseMaterials TArray< TObjectPtr< UMaterialInterface > >   Components/BaseDynamicMeshComponent.h  
bEnableFlatShading bool Flat shading support. Components/BaseDynamicMeshComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Dynamic Mesh Component|Rendering"
  • Meta=(DisplayName="Flat Shading")
bEnableRaytracing bool Raytracing support. Components/BaseDynamicMeshComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Dynamic Mesh Component|Rendering"
bEnableViewModeOverrides bool This flag controls whether Editor View Mode Overrides are enabled for this mesh. Components/BaseDynamicMeshComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Dynamic Mesh Component|Rendering"
  • Meta=(DisplayName="View Mode Overrides")
bExplicitShowWireframe bool Built-in Wireframe-on-Shaded Rendering support. Components/BaseDynamicMeshComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Dynamic Mesh Component|Rendering"
  • Meta=(DisplayName="Wireframe Overlay")
ColorMode EDynamicMeshComponentColorOverrideMode Built-in Color Rendering Support. Components/BaseDynamicMeshComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Dynamic Mesh Component|Rendering"
  • Meta=(DisplayName="Color Override")
ColorSpaceMode EDynamicMeshVertexColorTransformMode Color Space Transform that will be applied to the colors stored in the DynamicMesh Attribute Color Overlay when constructing render buffers. Components/BaseDynamicMeshComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Dynamic Mesh Component|Rendering"
  • Meta=(DisplayName="Vertex Color Space")
ConstantColor FColor Constant Color used when Override Color Mode is set to Constant Components/BaseDynamicMeshComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Dynamic Mesh Component|Rendering"
  • Meta=(DisplayName="Constant Color", EditCondition="ColorMode==EDynamicMeshComponentColorOverrideMode::Constant")
WireframeColor FLinearColor Constant Color used when Override Color Mode is set to Constant Components/BaseDynamicMeshComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Dynamic Mesh Component|Rendering"
  • Meta=(DisplayName="Wireframe Color")

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void ApplyTransform ( const FTransform3d& Transform,
bool bInvert
)

 Apply a transform to the mesh Components/BaseDynamicMeshComponent.h  

virtual void ClearOverrideRenderMaterial()

 Clear any active override render material Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual void ClearOverrideSecondaryWireframeRenderMaterial()

 Clear any active secondary wireframe override render material Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual void ClearOverrideWireframeRenderMaterial()

 Clear any active wireframe override render material Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual void ClearSecondaryRenderMaterial()

 Clear any active secondary render material Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual EDynamicMeshComponentColorOverrideMode GetColorOverrideMode()

   Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component|Rendering"

virtual FColor GetConstantOverrideColor()

   Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component|Rendering"

virtual EDynamicMeshComponentDistanceFieldMode GetDistanceFieldMode()

   Components/BaseDynamicMeshComponent.h
  • Category="Dynamic Mesh Component"
  • Meta=(DeprecatedFunction, DeprecationMessage="Dynamic Mesh distance field support has been deprecated")

virtual UDynamicMesh * GetDynamicMesh()

   Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual bool GetEnableRaytracing()

   Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual bool GetEnableWireframeRenderPass()

   Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual bool GetFlatShadingEnabled()

   Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component|Rendering"

virtual FDynamicMesh3 * GetMesh ()

 Avoid usage of this function, access via GetDynamicMesh() instead Components/BaseDynamicMeshComponent.h  

virtual const FDynamicMesh3 * GetMesh ()

   Components/BaseDynamicMeshComponent.h  

virtual EDynamicMeshDrawPath GetMeshDrawPath()

   Components/BaseDynamicMeshComponent.h
  • BlueprintPure
  • Category="Dynamic Mesh Component"

virtual UMaterialInterface * GetOverrideRenderMaterial ( int MaterialIndex
) const

   Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual UMaterialInterface * GetOverrideSecondaryWireframeRenderMaterial()

   Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual UMaterialInterface * GetOverrideWireframeRenderMaterial()

   Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual bool GetSecondaryBuffersVisibility()

   Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual UMaterialInterface * GetSecondaryRenderMaterial()

   Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual bool GetShadowsEnabled()

   Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual bool GetTwoSided()

   Components/BaseDynamicMeshComponent.h  

virtual EDynamicMeshVertexColorTransformMode GetVertexColorSpaceTransformMode()

   Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component|Rendering"

virtual bool GetViewModeOverridesEnabled()

   Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual bool HasOverrideRenderMaterial ( int k
) const

   Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual bool HasOverrideSecondaryWireframeRenderMaterial()

   Components/BaseDynamicMeshComponent.h  

virtual bool HasOverrideWireframeRenderMaterial()

   Components/BaseDynamicMeshComponent.h  

virtual bool HasSecondaryRenderMaterial()

   Components/BaseDynamicMeshComponent.h  

virtual void NotifyMeshUpdated()

 Call this if you update the mesh via GetMesh() Components/BaseDynamicMeshComponent.h  

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

 Allow external code to read the internal mesh. Components/BaseDynamicMeshComponent.h  

virtual void SetColorOverrideMode ( EDynamicMeshComponentColorOverrideMode NewMode
)

 Configure the active Color Override Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component|Rendering"

virtual void SetConstantOverrideColor ( FColor NewColor
)

 Configure the Color used with Constant Color Override Mode Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component|Rendering"

virtual void SetDistanceFieldMode ( EDynamicMeshComponentDistanceFieldMode NewDistFieldMode
)

 Configure Distance Field computation mode Components/BaseDynamicMeshComponent.h
  • Category="Dynamic Mesh Component"
  • Meta=(DeprecatedFunction, DeprecationMessage="Dynamic Mesh distance field support has been deprecated")

virtual void SetEnableFlatShading ( bool bEnable
)

 Configure the Color used with Constant Color Override Mode Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component|Rendering"

virtual void SetEnableRaytracing ( bool bSetEnabled
)

 Enable/Disable raytracing support. Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual void SetEnableWireframeRenderPass ( bool bEnable
)

 Configure whether wireframe rendering is enabled or not Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

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

 UBaseDynamicMeshComponent API. Components/BaseDynamicMeshComponent.h  

virtual void SetMeshDrawPath ( EDynamicMeshDrawPath NewDrawPath
)

 Set the mesh rendering to use the static or dynamic draw path Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual void SetNumMaterials ( int32 NumMaterials
)

   Components/BaseDynamicMeshComponent.h  

virtual void SetOverrideRenderMaterial ( UMaterialInterface* Material
)

 Override rendering material support. Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual void SetOverrideSecondaryWireframeRenderMaterial ( UMaterialInterface* Material
)

 Wireframe Material Secondary Override Support : Allow to override default secondary wireframe material Set an active secondary wireframe override render material Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual void SetOverrideWireframeRenderMaterial ( UMaterialInterface* Material
)

 Wireframe Material Override Support : Allow to override default wireframe material Set an active wireframe override render Material Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual void SetSecondaryBuffersVisibility ( bool bSetVisible
)

 Show/Hide the secondary triangle buffers. Does not invalidate SceneProxy. Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual void SetSecondaryRenderMaterial ( UMaterialInterface* Material
)

 Secondary Render Buffers support. Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual void SetShadowsEnabled ( bool bEnabled
)

 API for changing Rendering settings. Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

virtual void SetTwoSided ( bool bEnable
)

 Two-Sided rendering support. When enabled, triangles will be rendered whether they are facing the camera or not. Components/BaseDynamicMeshComponent.h  

virtual void SetVertexColorSpaceTransformMode ( EDynamicMeshVertexColorTransformMode NewMode
)

 Configure the active Color Space Transform Mode Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component|Rendering"

virtual void SetViewModeOverridesEnabled ( bool bEnabled
)

   Components/BaseDynamicMeshComponent.h
  • BlueprintCallable
  • Category="Dynamic Mesh Component"

Overridden from UMeshComponent

Name Remarks Include Path Unreal Specifiers

virtual FMaterialRelevance GetMaterialRelevance ( EShaderPlatform InShaderPlatform
) const

   Components/BaseDynamicMeshComponent.h  
  Components/BaseDynamicMeshComponent.h  

Overridden from UPrimitiveComponent

Name Remarks Include Path Unreal Specifiers

virtual UMaterialInterface * GetMaterial ( int32 ElementIndex
) const

   Components/BaseDynamicMeshComponent.h  

virtual UMaterialInterface * GetMaterialByName ( FName MaterialSlotName
) const

   Components/BaseDynamicMeshComponent.h  

virtual TArray< FName > GetMaterialSlotNames()

   Components/BaseDynamicMeshComponent.h  

virtual int32 GetNumMaterials()

 Standard Component interfaces Components/BaseDynamicMeshComponent.h  

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

   Components/BaseDynamicMeshComponent.h  

virtual bool IsMaterialSlotNameValid ( FName MaterialSlotName
) const

   Components/BaseDynamicMeshComponent.h  

virtual void SetMaterial ( int32 ElementIndex,
UMaterialInterface* Material
)

   Components/BaseDynamicMeshComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Components/BaseDynamicMeshComponent.h  

Overridden from IMeshVertexCommandChangeTarget

Name Remarks Include Path Unreal Specifiers

virtual void ApplyChange ( const FMeshVertexChange* Change,
bool bRevert
)

 Apply a vertex deformation change to the internal mesh (implements IMeshVertexCommandChangeTarget) Components/BaseDynamicMeshComponent.h  

Overridden from IMeshCommandChangeTarget

Name Remarks Include Path Unreal Specifiers

virtual void ApplyChange ( const FMeshChange* Change,
bool bRevert
)

 Apply a general mesh change to the internal mesh (implements IMeshCommandChangeTarget) Components/BaseDynamicMeshComponent.h  

Overridden from IMeshReplacementCommandChangeTarget

Name Remarks Include Path Unreal Specifiers

virtual void ApplyChange ( const FMeshReplacementChange* Change,
bool bRevert
)

 Apply a full mesh replacement change to the internal mesh (implements IMeshReplacementCommandChangeTarget) Components/BaseDynamicMeshComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual bool AllowFastUpdate ()

 Whether the fast update paths will be used for the mesh. Components/BaseDynamicMeshComponent.h  

virtual FBaseDynamicMeshSceneProxy * GetBaseSceneProxy()

 Subclass must implement this to return scene proxy if available, or nullptr Components/BaseDynamicMeshComponent.h  

virtual void NotifyMaterialSetUpdated()

 Subclass must implement this to notify allocated proxies of updated materials Components/BaseDynamicMeshComponent.h  

virtual void OnNewDistanceFieldMode()

 This will be called if a change to distance field mode is detected Components/BaseDynamicMeshComponent.h  

virtual void OnRenderingStateChanged ( bool bForceImmedateRebuild
)

   Components/BaseDynamicMeshComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static UMaterialInterface * GetDefaultVertexColorMaterial_RenderThread()

   Components/BaseDynamicMeshComponent.h  

static UMaterialInterface * GetDefaultWireframeMaterial_RenderThread()

   Components/BaseDynamicMeshComponent.h  

static void InitializeDefaultMaterials()

   Components/BaseDynamicMeshComponent.h  

static void SetDefaultVertexColorMaterial ( UMaterialInterface* Material
)

 Set the vertex color material used for all BaseDynamicMeshComponent-derived Components Components/BaseDynamicMeshComponent.h  
Class-wide Default Materials used for Wireframe and VertexColor display mode. Components/BaseDynamicMeshComponent.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
DistanceFieldMode_DEPRECATED EDynamicMeshComponentDistanceFieldMode Controls how distance field is computed Components/BaseDynamicMeshComponent.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Dynamic Mesh distance field support has been deprecated")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page