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 |
|---|---|---|---|
| FOnStructPropertyEdited | TMulticastDelegate_TwoParams< void, const FName &, const FPropertyChangedEvent & > | RigEditor/IKRigStructViewer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual USkeleton * GetSkeleton
(
bool& bInvalidSkeletonIsError, |
RigEditor/IKRigStructViewer.h | ||
TSharedPtr< FStructOnScope > & GetStructOnScope() |
RigEditor/IKRigStructViewer.h | ||
UObject * GetStructOwner() |
RigEditor/IKRigStructViewer.h | ||
FName GetTypeName() |
RigEditor/IKRigStructViewer.h | ||
virtual bool IsValid() |
RigEditor/IKRigStructViewer.h | ||
FOnStructPropertyEdited & OnStructNeedsReinit() |
Attach a delegate to be notified whenever a property (or child property) marked " in the currently displayed UStruct 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 TriggerReinitIfNeeded
(
const FPropertyChangedEvent& InEvent |
RigEditor/IKRigStructViewer.h |