Navigation
API > API/Plugins > API/Plugins/ClonerEffector > API/Plugins/ClonerEffector/Cloner > API/Plugins/ClonerEffector/Cloner/Layouts
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UCEClonerLayoutBase
- UCEClonerCircleLayout
- UCEClonerCylinderLayout
- UCEClonerGridLayout
- UCEClonerHoneycombLayout
- UCEClonerLineLayout
- UCEClonerMeshLayout
- UCEClonerSphereRandomLayout
- UCEClonerSphereUniformLayout
- UCEClonerSplineLayout
References
| Module | ClonerEffector |
| Header | /Engine/Plugins/Experimental/ClonerEffector/Source/ClonerEffector/Public/Cloner/Layouts/CEClonerLayoutBase.h |
| Include | #include "Cloner/Layouts/CEClonerLayoutBase.h" |
Syntax
UCLASS (MinimalAPI, Abstract, BlueprintType, AutoExpandCategories=("Layout"))
class UCEClonerLayoutBase : public UObject
Remarks
Base class for layouts available in the cloner actor Steps to add a new layout :
Create a new system that extends from NS_ClonerBase and expose all the parent parameters (examples can be found in Content)
Extend this layout class and give it a unique name with the newly created system path
Expose all new system specific parameters in the layout extended class and update them when required Your new layout is ready and will be available in the cloner in the layout dropdown
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
|||
 |
UCEClonerLayoutBase
(
const FName& InLayoutName, |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
bool | Activate this layout system on the cloner, must be loaded first | |
 |
bool | Deactivate this layout system if active | |
  |
AActor * | Get the actor using this layout | |
  |
UCEClonerComponent * | Get the cloner component using this layout | |
  |
FString | ||
    |
FName | ||
  |
UNiagaraMeshRendererProperties * | ||
  |
TSet< TSubclassOf< UCEClonerExtensionBase > > | Gets the cloner extensions supported by this layout | |
  |
UNiagaraSystem * | GetSystem () |
|
   |
bool | IsExtensionSupported
(
const UCEClonerExtensionBase* InExtension |
Filter supported extension for this layout |
    |
bool | Is this layout system in use within the cloner | |
  |
bool | Is the cloner not up to date with layout parameters | |
  |
bool | Is this layout system cached and ready to be used | |
  |
bool | Checks if the niagara system asset is valid and usable with the cloner | |
 |
void | LoadLayout () |
Load this layout system if not already loaded |
 |
void | MarkLayoutDirty
(
bool bInUpdateCloner |
Request refresh layout next tick |
  |
void | Called after layout becomes active | |
  |
void | Called after layout becomes inactive | |
  |
void | Called once after layout is loaded | |
 |
FOnClonerLayoutLoaded::RegistrationType & | ||
  |
void | OnLayoutParametersChanged
(
UCEClonerComponent* InComponent |
Called to reapply layout parameters |
 |
void | ||
  |
void | Called once after layout is unloaded | |
 |
bool | UnloadLayout () |
Free the loaded system and return to idle state |
 |
void | Updates all parameters handled by this layout |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization | |
  |
void | PostEditUndo () |
Called after applying a transaction to the object. |
  |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
Typedefs
| Name | Description |
|---|---|
| FOnClonerLayoutLoaded |
Constants
| Name | Description |
|---|---|
| LayoutBaseAssetPath |