Navigation
API > API/Plugins > API/Plugins/CustomizableObject > API/Plugins/CustomizableObject/MuCO
References
Module | CustomizableObject |
Header | /Engine/Plugins/Experimental/Mutable/Source/CustomizableObject/Public/MuCO/MultilayerProjector.h |
Include | #include "MuCO/MultilayerProjector.h" |
Syntax
USTRUCT&40;&41;
struct FMultilayerProjector
Remarks
Multilayer Projector Helper. Eases the management of Layers and Virtual Layers.
Layer: Management of Multilayer Projector Layers by index. All layers indices has to be consecutive.
Virtual Layer: Management of Multilayer Projector Layers by name.
- Allows to enabled and disabled layers.
- Allows to sort layers.
Variables
Type | Name | Description | |
---|---|---|---|
![]() |
friend | FCustomizableObjectInstanceDescriptor | |
![]() |
friend | FMultilayerProjectorLayer |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
Constructors. | ||
![]() |
FMultilayerProjector
(
const FName& InParamName |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | CreateLayer
(
FCustomizableObjectInstanceDescriptor& Descriptor, |
Insert the Layer at the given index moving all the following layers one position. |
![]() |
void | CreateVirtualLayer
(
FCustomizableObjectInstanceDescriptor& Descriptor, |
Given a new identifier, create a new Virtual Layer (if non-existent). |
![]() |
FMultilayerProjectorVirtualLayer | FindOrCreateVirtualLayer
(
FCustomizableObjectInstanceDescriptor& Descriptor, |
Given a new identifier, find or create a new Virtual Layer. |
![]() ![]() |
FMultilayerProjectorLayer | GetLayer
(
const FCustomizableObjectInstanceDescriptor& Descriptor, |
Get the properties of the Layer at the given index. |
![]() ![]() |
FMultilayerProjectorVirtualLayer | GetVirtualLayer
(
const FCustomizableObjectInstanceDescriptor& Descriptor, |
Given its identifier, get the Virtual Layer properties. |
![]() ![]() |
TArray< FName > | Get all created Virtual Layers. | |
![]() ![]() |
int32 | NumLayers
(
const FCustomizableObjectInstanceDescriptor& Descriptor |
Returns the number of layers. |
![]() ![]() |
void | RemoveLayerAt
(
FCustomizableObjectInstanceDescriptor& Descriptor, |
Remove the Layer at the given index moving all the following layers one position. |
![]() |
void | RemoveVirtualLayer
(
FCustomizableObjectInstanceDescriptor& Descriptor, |
Given its identifier, remove the Virtual Layer. |
![]() ![]() |
void | UpdateLayer
(
FCustomizableObjectInstanceDescriptor& Descriptor, |
Update the Layer properties at the given index. |
![]() |
void | UpdateVirtualLayer
(
FCustomizableObjectInstanceDescriptor& Descriptor, |
Given its identifier, update a Virtual Layer properties. |
Constants
Name | Description |
---|---|
DESCRIPTOR_PARAMETERS_INVALID | Log texts. |
IMAGE_PARAMETER_POSTFIX | |
NEW_VIRTUAL_LAYER_ORDER | New Virtual Layer default order. |
NUM_LAYERS_PARAMETER_POSTFIX | Parameters encoding. |
OPACITY_PARAMETER_POSTFIX | |
POSE_PARAMETER_POSTFIX | |
VIRTUAL_LAYER_DISABLED | Virtual Layer Disabled Index. |