ClonerEffector


Name	ClonerEffector
Type	Plugin
Part of Plugins	Cloners and Effectors
Location	/Engine/Plugins/VirtualProduction/ClonerEffector/Source/ClonerEffector/
Module Build Rules	ClonerEffector.Build.cs

Name	Remarks
FCEClonerAttachmentFlatBehavior	Flat hierarchy where any grouped actor is unboxed as if it was under a root cloner actor
FCEClonerAttachmentGroupBehavior	Base hierarchy where children are grouped under a root cloner actor
TCEPropertyChangeDispatcher
UCEClonerCircleLayout
UCEClonerCollisionExtension	Extension dealing with collisions and physics related options
UCEClonerConstraintExtension	Extension dealing with clone grid constraints
UCEClonerCylinderLayout
UCEClonerDisplacementExtension	Extension dealing with clone grid displacements
UCEClonerEffectorExtension	Extension dealing with effectors options
UCEClonerEmitterSpawnExtension	Extension dealing with clones spawning options
UCEClonerExtensionBase	Reusable extension on cloner layout to group similar options
UCEClonerFreePlacementLayout
UCEClonerGridLayout
UCEClonerHoneycombLayout
UCEClonerLayoutBase	Base class for layouts available in the cloner actor Steps to add a new layout :
UCEClonerLibrary	Blueprint operations for cloner
UCEClonerLifetimeExtension	Extension dealing with clones lifetime options
UCEClonerLineLayout
UCEClonerMeshLayout
UCEClonerMeshRendererExtension	Extension dealing with mesh rendering options
UCEClonerProgressExtension	Extension dealing with clone progress options
UCEClonerRangeExtension	Extension dealing with range options
UCEClonerSphereRandomLayout
UCEClonerSphereUniformLayout
UCEClonerSplineLayout
UCEClonerStepExtension	Extension dealing with delta step accumulated options
UCEClonerSubsystem
UCEClonerTextureExtension	Extension dealing with clone grid texture and UV for material
UCEEffectorBoundType
UCEEffectorBoxType
UCEEffectorCancelMode	Negates all effects applied on clones
UCEEffectorCullMode
UCEEffectorDelayEffect	Effector delay extension to affect clones after a period of time with a spring effect
UCEEffectorEffectBase	Represents an effect for an effector to affect clones in a specific way, works with modes and types
UCEEffectorExtensionBase	Represents an extension for an effector to apply a custom behavior on cloner
UCEEffectorForceEffect	Effector supported forces to affect clones
UCEEffectorLibrary	Blueprint operations for effector
UCEEffectorModeBase	Represents a behavior for an effector to affect clones in a specific way
UCEEffectorOffsetMode
UCEEffectorPlaneType
UCEEffectorProceduralMode
UCEEffectorPushMode
UCEEffectorRadialType
UCEEffectorSphereType
UCEEffectorStepMode
UCEEffectorSubsystem
UCEEffectorTargetMode
UCEEffectorTorusType
UCEEffectorTypeBase	Represents a shape for an effector to affect clones on specific zones
UCEEffectorUnboundType

Name	Remarks
FCEClonerAttachmentItem
FCEClonerAttachmentRootItem
FCEClonerAttachmentTree	Represents a logical tree used by the cloner to render its attachments Could differ from the actual physical tree used in the scene
FCEClonerEffectorChannelData
FCEClonerGridConstraintCylinder
FCEClonerGridConstraintSphere
FCEClonerGridConstraintTexture
FCEExtensionSection

Name	Remarks
ICEClonerAttachmentTreeBehavior	Defines a custom implementation for the attachment tree
ICEClonerSceneTreeCustomResolver	Used to resolve underlying actors in the scene

Name	Remarks
ECEClonerActorVisibility	Enumerates all visibility options for an actor
ECEClonerAttachmentStatus
ECEClonerAxis	Enumerate the axis available to use
ECEClonerCollisionRadiusMode	Enumerates all modes for how clones radius are calculed
ECEClonerCompareMode	Enumerate all operation compare mode for constraint
ECEClonerEasing	Enumerates all easing functions that are available to apply on weights See https://easings.net/ for curves visualizations and web open domain implementations Used as one enum to send the index to niagara as uint8 and apply easing directly in niagara
ECEClonerEffectorMode	Enumerates the effector mode available
ECEClonerEffectorProceduralPattern	Enumerates the effector procedural pattern available
ECEClonerEffectorPushDirection	Enumerates the effector push direction available
ECEClonerEffectorType	Enumerates the effector shapes available
ECEClonerGridConstraint	Enumerate the grid constraints available when cloner layout selected is grid
ECEClonerMeshAsset	Enumerate the mesh asset to look for when mesh layout is selected
ECEClonerMeshConversion	Enumerates all conversion possible for cloner simulation
ECEClonerMeshRenderMode	Enumerate the mesh render modes available to render a cloner instance
ECEClonerMeshSampleData	Enumerate the mesh sample dataset to pick from when mesh layout is selected
ECEClonerPlane	Enumerate the planes available to use
ECEClonerSpawnBehaviorMode	Enumerates all modes for how clones are spawned
ECEClonerSpawnLoopMode	Enumerates all modes to handle cloner spawn mode
ECEClonerSystemStatus	Enumerates all states for extension/layout
ECEClonerTextureProvider
ECEClonerTextureSampleChannel	Enumerate all texture channels to sample for constraint
ECEEffectorCullModeBehavior

Name	Remarks	Include Path
AutoExpandCategories		Cloner/CEClonerComponent.h
AutoExpandCategories		Cloner/CEClonerActor.h
BlueprintType		Effector/CEEffectorComponent.h
BlueprintType		Effector/CEEffectorActor.h
BlueprintType		Cloner/CEClonerComponent.h
BlueprintType		Cloner/CEClonerActor.h
DisplayName		Cloner/CEClonerActor.h
DisplayName		Effector/CEEffectorComponent.h
DisplayName		Effector/CEEffectorActor.h
DisplayName		Cloner/CEClonerComponent.h
HideCategories		Effector/CEEffectorComponent.h
HideCategories		Effector/CEEffectorActor.h
HideCategories		Cloner/CEClonerComponent.h
HideCategories		Cloner/CEClonerActor.h
meta		Cloner/CEClonerComponent.h
meta		Effector/CEEffectorComponent.h
MinimalAPI	Class used to define an effector	Effector/CEEffectorComponent.h
MinimalAPI		Effector/CEEffectorActor.h

Name	Remarks	Include Path
ADynamicMeshActor * UE::ClonerEffector::Conversion::ConvertClonerToDynamicMesh ( UCEClonerComponent* InCloner )	Convert a cloner to a single merged dynamic mesh actor	CEClonerEffectorShared.h
TArray< ADynamicMeshActor * > UE::ClonerEffector::Conversion::ConvertClonerToDynamicMeshes ( UCEClonerComponent* InCloner )	Convert a cloner to multiple dynamic mesh actors	CEClonerEffectorShared.h
TArray< AActor * > UE::ClonerEffector::Conversion::ConvertClonerToInstancedStaticMeshes ( UCEClonerComponent* InCloner )	Convert a cloner to multiple instanced static mesh actors	CEClonerEffectorShared.h
AStaticMeshActor * UE::ClonerEffector::Conversion::ConvertClonerToStaticMesh ( UCEClonerComponent* InCloner )	Convert a cloner to a single merged static mesh actor	CEClonerEffectorShared.h
TArray< AStaticMeshActor * > UE::ClonerEffector::Conversion::ConvertClonerToStaticMeshes ( UCEClonerComponent* InCloner )	Convert a cloner to multiple static mesh actors	CEClonerEffectorShared.h
InClass * UE::ClonerEffector::Conversion::CreateAssetPackage ( const FString& InAssetPath )		CEClonerEffectorShared.h
UObject * UE::ClonerEffector::Conversion::CreateAssetPackage ( TSubclassOf< UObject > InAssetClass, const FString& InAssetPath )	Create a specific asset in a package	CEClonerEffectorShared.h
UActorComponent * UE::ClonerEffector::Conversion::CreateRootComponent ( AActor* InActor, TSubclassOf< USceneComponent > InComponentClass, const FTransform& InWorldTransform )	Creates the root component for an actor	CEClonerEffectorShared.h
bool UE::ClonerEffector::Conversion::PickAssetPath ( const FString& InDefaultPath, FString& OutPickedPath )	Pick assets location	CEClonerEffectorShared.h
FCEExtensionSection UE::ClonerEffector::EditorSection::GetExtensionSectionFromClass ( UClass* InClass )	Retrieves section metadata from class	CEClonerEffectorShared.h
bool UE::ClonerEffector::Utilities::FilterSupportedMaterial ( UMaterialInterface& InMaterial, UMaterialInterface InDefaultMaterial )	Check if a material is supported otherwise replaces it with default material	Utilities/CEClonerEffectorUtilities.h
bool UE::ClonerEffector::Utilities::FilterSupportedMaterials ( TArray< TWeakObjectPtr< UMaterialInterface > >& InMaterials, TArray< TWeakObjectPtr< UMaterialInterface > >& OutUnsetMaterials, UMaterialInterface* InDefaultMaterial )	Replaces all unsupported material by default material, gathers unset materials that needs recompiling with proper flags	Utilities/CEClonerEffectorUtilities.h
AActor * UE::ClonerEffector::Utilities::FindClonerActor ( AActor* InActor )	Look parent attach actor until first cloner component is found	Utilities/CEClonerEffectorUtilities.h
const FText & UE::ClonerEffector::Utilities::GetMaterialWarningText()		Utilities/CEClonerEffectorUtilities.h
bool UE::ClonerEffector::Utilities::IsMaterialDirtyable ( const UMaterialInterface* InMaterial )	Only materials transient or part of the content folder can be dirtied, engine or plugins cannot	Utilities/CEClonerEffectorUtilities.h
bool UE::ClonerEffector::Utilities::IsMaterialUsageFlagSet ( const UMaterialInterface* InMaterial )	Check if material has niagara usage flag set	Utilities/CEClonerEffectorUtilities.h
void UE::ClonerEffector::Utilities::SetActorVisibility ( AActor* InActor, bool bInVisibility, ECEClonerActorVisibility InTarget )	Set specific actor visibility	Utilities/CEClonerEffectorUtilities.h
void UE::ClonerEffector::Utilities::ShowWarning ( const FText& InWarning )	Show material warning notification when missing niagara usage flag	Utilities/CEClonerEffectorUtilities.h

Navigation

Classes

Structs

Interfaces

Enums

Public

Variables

Public

Functions

Public