Navigation
API > API/Plugins > API/Plugins/IKRigEditor
A thin wrapper around UStruct data to display in a details panel this is a generic wrapper that works for any struct it is intended to work with FIKRigStructViewerCustomization which simply puts the entire struct in the details panel if you need customization, you need to work with UIKRigStructWrapperBase which allows customized derived classes
| Name | UIKRigStructViewer |
| Type | class |
| Header File | /Engine/Plugins/Animation/IKRig/Source/IKRigEditor/Public/RigEditor/IKRigStructViewer.h |
| Include Path | #include "RigEditor/IKRigStructViewer.h" |
Syntax
UCLASS (Blueprintable)
class UIKRigStructViewer :
public UObject,
public IBoneReferenceSkeletonProvider
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UIKRigStructViewer
Implements Interfaces
Derived Classes
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnNeedsReinitialized | TMulticastDelegate_TwoParams< void, const FName &, const FPropertyChangedEvent & > | RigEditor/IKRigStructViewer.h | |
| FOnPostEditProperty | TMulticastDelegate_TwoParams< void, const FName &, const FPropertyChangedEvent & > | RigEditor/IKRigStructViewer.h | |
| FOnPreEditProperty | TMulticastDelegate_TwoParams< void, const FName &, const FProperty * > | RigEditor/IKRigStructViewer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< FStructOnScope > & GetStructOnScope() |
RigEditor/IKRigStructViewer.h | ||
UObject * GetStructOwner() |
RigEditor/IKRigStructViewer.h | ||
FName GetTypeName() |
RigEditor/IKRigStructViewer.h | ||
FOnNeedsReinitialized & OnNeedsReinitialized() |
Attach a delegate to be notified whenever a property is edited that requires the system to be reinitialized NOTE: This happens in a few hard-coded special cases or for any property marked with the meta tag: ReinitializeOnEdit | RigEditor/IKRigStructViewer.h | |
FOnPostEditProperty & OnPostEditProperty() |
Attach a delegate to be notified AFTER a property is edited | RigEditor/IKRigStructViewer.h | |
FOnPreEditProperty & OnPreEditProperty() |
Attach a delegate to be notified BEFORE a property is edited | RigEditor/IKRigStructViewer.h | |
void Reset() |
RigEditor/IKRigStructViewer.h | ||
void SetStructToView
(
const FIKRigStructToView& InStructToView |
Configures an instance of a struct to display in the details panel with undo/redo support. | RigEditor/IKRigStructViewer.h | |
void SetupPropertyEditingCallbacks
(
const TSharedPtr< IPropertyHandle >& InProperty |
RigEditor/IKRigStructViewer.h | ||
void TriggerReinitializationIfNeeded
(
const FPropertyChangedEvent& InEvent |
RigEditor/IKRigStructViewer.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual USkeleton * GetSkeleton
(
bool& bInvalidSkeletonIsError, |
RigEditor/IKRigStructViewer.h | ||
virtual bool IsValid() |
RigEditor/IKRigStructViewer.h |