1. Epic GamesDeveloper
  3. AGeneratedDynamicMeshActor

AGeneratedDynamicMeshActor

[AGeneratedDynamicMeshActor](API\Plugins\GeometryScriptingEditor\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

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.

   
Name AGeneratedDynamicMeshActor
Type class
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingEditor/Public/GeometryActors/GeneratedDynamicMeshActor.h
Include Path #include "GeometryActors/GeneratedDynamicMeshActor.h"

Syntax

UCLASS ()  
class AGeneratedDynamicMeshActor : public ADynamicMeshActor

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

AGeneratedDynamicMeshActor ( const FObjectInitializer& ObjectInitializer
)

   GeometryActors/GeneratedDynamicMeshActor.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~AGeneratedDynamicMeshActor()

   GeometryActors/GeneratedDynamicMeshActor.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bEnableRebuildProgress bool Support for progress dialog display during OnRebuildGeneratedMesh. GeometryActors/GeneratedDynamicMeshActor.h
  • Category="DynamicMeshActor|Progress"
  • EditAnywhere
  • BlueprintReadWrite
bFrozen bool If true, the DynamicMeshComponent will be "Frozen" in its current state, and automatic rebuilding will be disabled. GeometryActors/GeneratedDynamicMeshActor.h
  • Category="DynamicMeshActor"
  • EditAnywhere
  • BlueprintReadWrite
bResetOnRebuild bool If true, the DynamicMeshComponent will be cleared before the RebuildGeneratedMesh event is executed. GeometryActors/GeneratedDynamicMeshActor.h
  • Category="DynamicMeshActor|Advanced"
  • EditAnywhere
  • BlueprintReadWrite
DialogDelay float Delay in seconds before the progress dialog is shown, if enabled GeometryActors/GeneratedDynamicMeshActor.h
  • Category="DynamicMeshActor|Progress"
  • EditAnywhere
  • BlueprintReadWrite
NumProgressSteps int Number of progress steps/ticks that the progress bar will be subdivided into GeometryActors/GeneratedDynamicMeshActor.h
  • Category="DynamicMeshActor|Progress"
  • EditAnywhere
  • BlueprintReadWrite
ProgressMessage FString The default progress message GeometryActors/GeneratedDynamicMeshActor.h
  • Category="DynamicMeshActor|Progress"
  • EditAnywhere
  • BlueprintReadWrite

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsCurrentlyRebuilding bool Flag set during a rebuild used to help detect/avoid recursive rebuilds GeometryActors/GeneratedDynamicMeshActor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CopyPropertiesFromStaticMesh ( AStaticMeshActor* StaticMeshActor,
bool bCopyComponentMaterials
)

 Attempt to copy Actor Properties from a StaticMeshActor. GeometryActors/GeneratedDynamicMeshActor.h
  • BlueprintCallable
  • Category=DynamicMeshActor

void CopyPropertiesToStaticMesh ( AStaticMeshActor* StaticMeshActor,
bool bCopyComponentMaterials
)

 Attempt to copy Actor Properties to a StaticMeshActor. GeometryActors/GeneratedDynamicMeshActor.h
  • BlueprintCallable
  • Category=DynamicMeshActor

virtual void ExecuteRebuildGeneratedMeshIfPending()

 This function will fire the RebuildGeneratedMesh function if the actor has been marked for a pending rebuild (eg via OnConstruction) GeometryActors/GeneratedDynamicMeshActor.h  

void IncrementProgress ( int NumSteps,
FString Message
)

 Call this function from within OnRebuildGeneratedMesh to update progress tracking. GeometryActors/GeneratedDynamicMeshActor.h
  • BlueprintCallable
  • Category="DynamicMeshActor|Progress"

void MarkForMeshRebuild ( bool bImmediate,
bool bImmediateEvenIfFrozen
)

 Mark this Actor as modified so that OnRebuildGeneratedMesh runs GeometryActors/GeneratedDynamicMeshActor.h
  • BlueprintCallable
  • Category="DynamicMeshActor"

void OnRebuildGeneratedMesh ( UDynamicMesh* TargetMesh
)

 This event will be fired to notify the BP that the generated Mesh should be rebuilt. GeometryActors/GeneratedDynamicMeshActor.h
  • BlueprintImplementableEvent
  • CallInEditor
  • Category="Events"

virtual bool WantsRebuild()

   GeometryActors/GeneratedDynamicMeshActor.h  

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual void Destroyed()

   GeometryActors/GeneratedDynamicMeshActor.h  

virtual void OnConstruction ( const FTransform& Transform
)

   GeometryActors/GeneratedDynamicMeshActor.h  

virtual void PostActorCreated()

   GeometryActors/GeneratedDynamicMeshActor.h  

virtual void PostUnregisterAllComponents()

   GeometryActors/GeneratedDynamicMeshActor.h  

virtual void PreRegisterAllComponents()

 These are called when Actor exists in a sublevel that is hidden/shown GeometryActors/GeneratedDynamicMeshActor.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditUndo ()

   GeometryActors/GeneratedDynamicMeshActor.h  

virtual void PostEditUndo ( TSharedPtr< ITransactionObjectAnnotation > TransactionAnnotation
)

   GeometryActors/GeneratedDynamicMeshActor.h  

virtual void PostLoad()

   GeometryActors/GeneratedDynamicMeshActor.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void RebuildGeneratedMesh ( UDynamicMesh* TargetMesh
)

 Overridable native event for when the generated Mesh should be rebuilt. GeometryActors/GeneratedDynamicMeshActor.h  

virtual void RegisterWithGenerationManager()

   GeometryActors/GeneratedDynamicMeshActor.h  

virtual void UnregisterWithGenerationManager()

   GeometryActors/GeneratedDynamicMeshActor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page