Navigation
API > API/Plugins > API/Plugins/ControlRig
FControlRigShapeProxyComponentProvider contains object classes that support primitive components to represent a control shape This allows other types than UStaticMesh and USkeletalMesh to be used a control shapes.
| Name | FShapeProxyComponentProviderRegistry |
| Type | class |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/ControlRigGizmoLibrary.h |
| Include Path | #include "ControlRigGizmoLibrary.h" |
Syntax
class FShapeProxyComponentProviderRegistry
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FShapeProxyComponentProviderRegistry() |
ControlRigGizmoLibrary.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FShapeProxyComponentProviderRegistry() |
ControlRigGizmoLibrary.h |
Structs
| Name | Remarks |
|---|---|
| FProxyFunctions | Functions associated with a specific proxy object. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FCreateFunction | TUniqueFunction< UPrimitiveComponent *(UObject *, UObject *)> | Creation function returning a new component given a proxy object. | ControlRigGizmoLibrary.h |
| FUpdateFunction | TUniqueFunction< bool(UObject *, UObject *)> | Update function updating a component given a proxy object. | ControlRigGizmoLibrary.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ProxyComponentFunctions | TMap< UClass *, FProxyFunctions > | ControlRigGizmoLibrary.h | ||
| QueriedUnregisteredClass | TSet< const UClass * > | Track proxy classes that have been queried but are not currently supported. | ControlRigGizmoLibrary.h | |
| ShapeProxyToComponent | TMap< UClass *, UClass * > | Components associated with a specific proxy object. | ControlRigGizmoLibrary.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UPrimitiveComponent * GetNewProxyComponent
(
UObject* InProxy, |
Create a new component given the proxy object if supported. | ControlRigGizmoLibrary.h | |
| Get the component class associated with this proxy class if any. | ControlRigGizmoLibrary.h | ||
bool IsShapeProxySupported
(
const UClass* InProxyClass |
Whether this proxy class is supported to represent a control shape. | ControlRigGizmoLibrary.h | |
void RegisterProvider
(
FCreateFunction&& CreateFunction, |
Registers a particular ProxyType object subclass to provide a ComponentType primitive component subclass. | ControlRigGizmoLibrary.h | |
| Update the component with the proxy object if supported. | ControlRigGizmoLibrary.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FShapeProxyComponentProviderRegistry & Get() |
Get the singleton registry object. | ControlRigGizmoLibrary.h | |
static void LogNull() |
ControlRigGizmoLibrary.h | ||
static void RegisterDefaultProviders() |
Registers proxy objects supported by default (UStaticMesh and USkeletalMesh for now). | ControlRigGizmoLibrary.h |