Navigation
API > API/Plugins > API/Plugins/ControlRig
| Name | FRigBaseComponent |
| Type | struct |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchyComponents.h |
| Include Path | #include "Rigs/RigHierarchyComponents.h" |
Syntax
USTRUCT (BlueprintType )
struct FRigBaseComponent
Derived Classes
- FRigPhysicsBodyComponent
- FRigPhysicsControlComponent
- FRigPhysicsJointComponent
- FRigPhysicsSolverComponent
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigBaseComponent
(
const FRigBaseComponent& InOther |
Rigs/RigHierarchyComponents.h | ||
| Rigs/RigHierarchyComponents.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FRigBaseComponent() |
Rigs/RigHierarchyComponents.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanBeAddedTo
(
const FRigElementKey& InElementKey, |
Returns true if this component can be added to a given key. | Rigs/RigHierarchyComponents.h | |
virtual bool CanBeRenamed() |
Returns true if this component can be renamed | Rigs/RigHierarchyComponents.h | |
virtual FSlateColor GetColorForUI() |
Returns the color to use for this component in the UI | Rigs/RigHierarchyComponents.h | |
FString GetContentAsText() |
Rigs/RigHierarchyComponents.h | ||
int32 GetCreatedAtInstructionIndex() |
Rigs/RigHierarchyComponents.h | ||
virtual FName GetDefaultComponentName() |
Returns the default name to use when instantiating the component. | Rigs/RigHierarchyComponents.h | |
virtual const FName & GetDisplayName() |
Rigs/RigHierarchyComponents.h | ||
const FRigBaseElement * GetElement () |
Rigs/RigHierarchyComponents.h | ||
| Rigs/RigHierarchyComponents.h | |||
const FRigElementKey & GetElementKey() |
Rigs/RigHierarchyComponents.h | ||
const FName & GetFName() |
Rigs/RigHierarchyComponents.h | ||
virtual const FSlateIcon & GetIconForUI() |
Return the icon to use for this component in the UI | Rigs/RigHierarchyComponents.h | |
int32 GetIndexInElement() |
Rigs/RigHierarchyComponents.h | ||
int32 GetIndexInHierarchy() |
Rigs/RigHierarchyComponents.h | ||
const FRigComponentKey & GetKey() |
Rigs/RigHierarchyComponents.h | ||
const FString & GetName() |
Rigs/RigHierarchyComponents.h | ||
virtual UScriptStruct * GetScriptStruct() |
Rigs/RigHierarchyComponents.h | ||
int32 GetSpawnIndex() |
Rigs/RigHierarchyComponents.h | ||
FRigComponentState GetState() |
Rigs/RigHierarchyComponents.h | ||
bool IsA () |
Rigs/RigHierarchyComponents.h | ||
bool IsA
(
const UScriptStruct* InScriptStruct |
Rigs/RigHierarchyComponents.h | ||
bool IsProcedural() |
Rigs/RigHierarchyComponents.h | ||
bool IsSelected() |
Rigs/RigHierarchyComponents.h | ||
virtual bool IsSingleton() |
Returns true if this component can only be added once | Rigs/RigHierarchyComponents.h | |
bool IsTopLevel() |
Rigs/RigHierarchyComponents.h | ||
virtual void Load
(
FArchive& Ar |
Rigs/RigHierarchyComponents.h | ||
virtual void OnAddedToHierarchy
(
URigHierarchy* InHierarchy, |
Allows the component to react to it being spawned | Rigs/RigHierarchyComponents.h | |
virtual void OnRigHierarchyKeyChanged
(
const FRigHierarchyKey& InOldKey, |
React to an element or component being renamed / reparented in the hierarchy | Rigs/RigHierarchyComponents.h | |
virtual void Save
(
FArchive& Ar |
Rigs/RigHierarchyComponents.h | ||
bool Serialize
(
FArchive& Ar |
Rigs/RigHierarchyComponents.h | ||
bool SetState
(
const FRigComponentState& InState |
Rigs/RigHierarchyComponents.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TArray< UScriptStruct * > GetAllComponentScriptStructs
(
bool bSorted |
Rigs/RigHierarchyComponents.h | ||
static bool IsClassOf
(
const FRigBaseComponent* InComponent |
Rigs/RigHierarchyComponents.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigBaseComponent & operator=
(
const FRigBaseComponent& InOther |
Rigs/RigHierarchyComponents.h |