1. Epic GamesDeveloper
  3. AGeneratedDynamicMeshActor

AGeneratedDynamicMeshActor

[AGeneratedDynamicMeshActor](API\Plugins\GeometryScriptingEditor\GeometryActors\AGeneratedDynamicMeshActor) is an Editor-only subclass of [ADynamicMeshActor](API\Runtime\GeometryFramework\ADynamicMeshActor) that provides special support for dynamic procedural generation of meshes in the Editor, eg via Blueprints.

API > API/Plugins > API/Plugins/GeometryScriptingEditor > API/Plugins/GeometryScriptingEditor/GeometryActors

Inheritance Hierarchy

References

   
Module GeometryScriptingEditor
Header /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingEditor/Public/GeometryActors/GeneratedDynamicMeshActor.h
Include #include "GeometryActors/GeneratedDynamicMeshActor.h"

Syntax

UCLASS ()  
class AGeneratedDynamicMeshActor : public ADynamicMeshActor

Remarks

AGeneratedDynamicMeshActor is an Editor-only subclass of ADynamicMeshActor that provides special support for dynamic procedural generation of meshes in the Editor, eg via Blueprints. Expensive procedural generation implemented via BP can potentially cause major problems in the Editor, in particular with interactive performance. AGeneratedDynamicMeshActor provides special infrastructure for this use case. Essentially, instead of doing procedural generation in the Construction Script, a BP-implementable event OnRebuildGeneratedMesh is available, and doing the procedural mesh regeneration when that function fires will generally provide better in-Editor interactive performance.

Variables

  Type Name Description
Protected variable FScopedSlowTask * ActiveSlowTask  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bEnableRebuildProgress Support for progress dialog display during OnRebuildGeneratedMesh.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bFrozen If true, the DynamicMeshComponent will be "Frozen" in its current state, and automatic rebuilding will be disabled.
Protected variable bool bGeneratedMeshRebuildPending This internal flag is set in OnConstruction, and will cause ExecuteRebuildGeneratedMesh to fire the RebuildGeneratedMesh event, after which the flag will be cleared
Protected variable bool bIsRegisteredWithGenerationManager Indicates that this Actor is registered with the UEditorGeometryGenerationSubsystem, which is where the mesh rebuilds are executed
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bResetOnRebuild If true, the DynamicMeshComponent will be cleared before the RebuildGeneratedMesh event is executed.
Protected variable int32 CurProgressAccumSteps  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float DialogDelay Delay in seconds before the progress dialog is shown, if enabled
Public variable UProperty Category, EditAnywhere BlueprintReadWrite int NumProgressSteps Number of progress steps/ticks that the progress bar will be subdivided into
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FString ProgressMessage The default progress message

Constructors

  Type Name Description
Public function  

AGeneratedDynamicMeshActor ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

CopyPropertiesFromStaticMesh ( AStaticMeshActor* StaticMeshActor,
bool bCopyComponentMaterials
)

 Attempt to copy Actor Properties from a StaticMeshActor.
Public function UFunction BlueprintCallable, Category void

CopyPropertiesToStaticMesh ( AStaticMeshActor* StaticMeshActor,
bool bCopyComponentMaterials
)

 Attempt to copy Actor Properties to a StaticMeshActor.
Public function Virtual void  
Public function Virtual void This function will fire the RebuildGeneratedMesh function if the actor has been marked for a pending rebuild (eg via OnConstruction)
Public function UFunction BlueprintCallable, Category void

IncrementProgress ( int NumSteps,
FString Message
)

 Call this function from within OnRebuildGeneratedMesh to update progress tracking.
Public function UFunction BlueprintCallable, Category void

MarkForMeshRebuild ( bool bImmediate,
bool bImmediateEvenIfFrozen
)

 Mark this Actor as modified so that OnRebuildGeneratedMesh runs
Public function Virtual void

OnConstruction ( const FTransform& Transform
)

  
Public function UFunction Category, BlueprintImplementableEvent callineditor void This event will be fired to notify the BP that the generated Mesh should be rebuilt.
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void These are called when Actor exists in a sublevel that is hidden/shown
Protected function Virtual void Overridable native event for when the generated Mesh should be rebuilt.
Protected function Virtual void  
Protected function Virtual void  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page