1. Epic GamesDeveloper
  3. UBaseDynamicMeshComponent

UBaseDynamicMeshComponent

[UBaseDynamicMeshComponent](API\Runtime\GeometryFramework\Components\UBaseDynamicMeshComponent) is a base interface for a [UMeshComponent](API\Runtime\Engine\Components\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

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 TArray< TObjectPtr< UMaterialInterface > > BaseMaterials  
Protected variable bool bDrawSecondaryBuffers  
Public variable bool bEnableFlatShading Flat shading support.
Public variable bool bEnableRaytracing Raytracing support.
Public variable bool bEnableViewModeOverrides This flag controls whether Editor View Mode Overrides are enabled for this mesh.
Public variable bool bExplicitShowWireframe Built-in Wireframe-on-Shaded Rendering support.
Public variable EDynamicMeshComponentColorOverrideMode ColorMode Built-in Color Rendering Support.
Public variable 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 FColor ConstantColor Constant Color used when Override Color Mode is set to Constant
Protected variable TObjectPtr< UMaterialInterface > OverrideRenderMaterial  
Protected variable TObjectPtr< UMaterialInterface > SecondaryRenderMaterial  
Public variable 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
Public function Virtual void

ApplyTransform ( const FTransform3d& Transform,
bool bInvert
)

 Apply a transform to the mesh
Public function Virtual void Clear any active override render material
Public function Virtual 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 EDynamicMeshComponentColorOverrideMode  
Public function Virtual Const FColor  
Protected function Static UMaterialInterface *  
Protected function Static UMaterialInterface *  
Public function Virtual UDynamicMesh *  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
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 UMaterialInterface *

GetOverrideRenderMaterial ( int MaterialIndex
)

  
Public function Virtual Const bool  
Public function Virtual Const UMaterialInterface *  
Public function Virtual Const bool  
Public function Virtual Const EDynamicMeshVertexColorTransformMode  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Protected function Static void  
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

OnRenderingStateChanged ( bool bForceImmedateRebuild
)

  
Public function Virtual Const void

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

 Allow external code to read the internal mesh.
Public function Virtual void

SetColorOverrideMode ( EDynamicMeshComponentColorOverrideMode NewMode
)

 Configure the active Color Override
Public function Virtual void Configure the Color used with Constant Color Override Mode
Public function Static void Set the vertex color material used for all BaseDynamicMeshComponent-derived Components
Public function Static void Class-wide Default Materials used for Wireframe and VertexColor display mode.
Public function Virtual void

SetEnableFlatShading ( bool bEnable
)

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

SetEnableRaytracing ( bool bSetEnabled
)

 Enable/Disable raytracing support.
Public function Virtual void

SetEnableWireframeRenderPass ( bool bEnable
)

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

SetNumMaterials ( int32 NumMaterials
)

  
Public function Virtual void Override rendering material support.
Public function Virtual void

SetSecondaryBuffersVisibility ( bool bSetVisible
)

 Show/Hide the secondary triangle buffers. Does not invalidate SceneProxy.
Public function Virtual void Secondary Render Buffers support.
Public function Virtual void

SetShadowsEnabled ( bool bEnabled
)

 API for changing Rendering settings.
Public function Virtual void

SetVertexColorSpaceTransformMode ( EDynamicMeshVertexColorTransformMode NewMode
)

 Configure the active Color Space Transform Mode
Public function Virtual void

SetViewModeOverridesEnabled ( bool bEnabled
)

  

Overridden from UMeshComponent

  Type Name Description
Public function Virtual Const FMaterialRelevance Accesses the scene relevance information for the materials applied to the mesh.

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual Const UMaterialInterface *

GetMaterial ( int32 ElementIndex
)

 Returns the material used by the element at the specified index
Public function Virtual Const int32 Standard Component interfaces
Public function Virtual Const void

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

 Retrieves the materials used in this component
Public function Virtual void

SetMaterial ( int32 ElementIndex,
UMaterialInterface* Material
)

 Changes the material applied to an element of the mesh.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally

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