UMeshBasedModifierBase

A helper base class for modifiers that want to use a mesh that a user sets using the detail panel.

API > API/Plugins > API/Plugins/MeshPartitionEditor

A helper base class for modifiers that want to use a mesh that a user sets using the detail panel. If a class doesn't use the detail panel to set the mesh, it should not need to use this base class, but it could use MeshPartition::UMeshBasedModifierBase::FMeshInstanceData to hold data about mesh instances.

   
Name UMeshBasedModifierBase
Type class
Header File /Engine/Plugins/Experimental/MeshPartition/Source/MeshPartitionEditor/Public/Modifiers/MeshPartitionMeshBasedModifierBase.h
Include Path #include "Modifiers/MeshPartitionMeshBasedModifierBase.h"

Syntax

UCLASS (MinimalAPI, Abstract)  
class UMeshBasedModifierBase : public UE::MeshPartition::UModifierComponent

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMeshBasedModifierBase()

   Modifiers/MeshPartitionMeshBasedModifierBase.h  

Structs

Name Remarks
FMeshInstanceData Encapsulates information one would want for a mesh-based modifier, so that a single modifier component could potentially manage multiple instances at once.

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AllowedClasses     Modifiers/MeshPartitionMeshBasedModifierBase.h
  • EditInstanceOnly
  • Category=Mesh
  • Meta=(UseComponentPicker, AllowAnyActor, AllowedClasses="/Script/GeometryFramework.DynamicMeshComponent", EditCondition="MeshSourceMode == EModifierMeshSourceMode::DynamicMeshComponent", EditConditionHides)
DesiredLOD EditConditionHides int32   Modifiers/MeshPartitionMeshBasedModifierBase.h
  • EditAnywhere
  • Category=Mesh
  • AdvancedDisplay
  • Meta=(ClampMin=1, ClampMax=7, EditCondition="MeshSourceMode == EModifierMeshSourceMode::StaticMesh", EditConditionHides)
EditCondition   Level of detail of the mesh to use. Modifiers/MeshPartitionMeshBasedModifierBase.h
  • EditAnywhere
  • Category=Mesh
  • Meta=(EditCondition="MeshSourceMode == EModifierMeshSourceMode::StaticMesh", EditConditionHides)
MeshComponent EditConditionHides FComponentReference   Modifiers/MeshPartitionMeshBasedModifierBase.h
  • EditInstanceOnly
  • Category=Mesh
  • Meta=(UseComponentPicker, AllowAnyActor, AllowedClasses="/Script/GeometryFramework.DynamicMeshComponent", EditCondition="MeshSourceMode == EModifierMeshSourceMode::DynamicMeshComponent", EditConditionHides)
MeshSourceMode MeshPartition::EModifierMeshSourceMode   Modifiers/MeshPartitionMeshBasedModifierBase.h
  • EditAnywhere
  • Category=Mesh
StaticMesh EditConditionHides TObjectPtr< UStaticMesh >   Modifiers/MeshPartitionMeshBasedModifierBase.h
  • EditAnywhere
  • Category=Mesh
  • Meta=(EditCondition="MeshSourceMode == EModifierMeshSourceMode::StaticMesh", EditConditionHides)
UpdatingDynamicMeshComponent TWeakObjectPtr< UDynamicMeshComponent > Weak pointer to the mesh component which has its update event linked to this modifier (if any) Modifiers/MeshPartitionMeshBasedModifierBase.h  

Functions

Public

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual MeshPartition::EModifierMeshSourceMode GetMeshSourceMode()

   Modifiers/MeshPartitionMeshBasedModifierBase.h  

virtual UStaticMesh * GetStaticMesh()

   Modifiers/MeshPartitionMeshBasedModifierBase.h  

virtual bool SetMeshComponent ( UDynamicMeshComponent* DynamicMeshComponent
)

   Modifiers/MeshPartitionMeshBasedModifierBase.h  

virtual void SetMeshSourceMode ( const MeshPartition::EModifierMeshSourceMode InModifierMeshSourceMode
)

   Modifiers/MeshPartitionMeshBasedModifierBase.h  

virtual void SetStaticMesh ( UStaticMesh* InStaticMesh
)

   Modifiers/MeshPartitionMeshBasedModifierBase.h  

Overridden from UModifierComponent

Name Remarks Include Path Unreal Specifiers

virtual UE::Tasks::FTask GetAsyncPrepareResourcesTask()

   Modifiers/MeshPartitionMeshBasedModifierBase.h  

virtual void InitializeModifier()

 MeshPartition::UModifierComponent. Modifiers/MeshPartitionMeshBasedModifierBase.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Modifiers/MeshPartitionMeshBasedModifierBase.h  

virtual void PostEditUndo()

   Modifiers/MeshPartitionMeshBasedModifierBase.h  

virtual void Serialize ( FArchive& Ar
)

 UObject. Modifiers/MeshPartitionMeshBasedModifierBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

void UpdateMeshInstance()

   Modifiers/MeshPartitionMeshBasedModifierBase.h  

Protected Virtual

Name Remarks Include Path Unreal Specifiers

virtual void PostUpdateMeshInstance ( const FDynamicMesh3&
)

 Called after Mesh Instance has been updated (changed or cleared) Modifiers/MeshPartitionMeshBasedModifierBase.h  

virtual void ProcessMeshInstance ( FDynamicMesh3& InstanceDataOut
)

 Apply any post-processing and compute derived data (including Spatial and MeshBounds) after a mesh instance is created/updated. Modifiers/MeshPartitionMeshBasedModifierBase.h  

Overridden from UModifierComponent

Name Remarks Include Path Unreal Specifiers

virtual void GatherDependencies ( MeshPartition::IDependencyInterface& Dependencies
) const

 Gather Dependencies for this modifier, including asset and class dependencies and other relevant data (for example local settings) that affect the modifier apply behavior. Modifiers/MeshPartitionMeshBasedModifierBase.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool CopyDynamicMeshComponent ( const UDynamicMeshComponent* MeshComponent,
bool bWantAttributes,
FDynamicMesh3& OutMesh
)

   Modifiers/MeshPartitionMeshBasedModifierBase.h  

static bool CopyStaticMesh ( const UStaticMesh* StaticMesh,
EMeshLODIdentifier DesiredLOD,
bool bWantAttributes,
FDynamicMesh3& OutMesh
)

   Modifiers/MeshPartitionMeshBasedModifierBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page