1. Epic GamesDeveloper
  3. FRigBaseElement

FRigBaseElement

API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/Rigs

Inheritance Hierarchy

References

   
Module ControlRig
Header /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchyElements.h
Include #include "Rigs/RigHierarchyElements.h"

Syntax

USTRUCT&40;BlueprintType&41;  
struct FRigBaseElement

Variables

  Type Name Description
Protected variable UProperty Category, Meta BlueprintReadOnly Transient bool bSelected  
Protected variable FRigBaseElementChildrenArray CachedChildren  
Protected variable UProperty Category, Meta BlueprintReadOnly Transient int32 CreatedAtInstructionIndex  
Protected variable UProperty Category, Meta BlueprintReadOnly visibleanywhere int32 Index  
Protected variable UProperty Category, Meta BlueprintReadOnly visibleanywhere FRigElementKey Key  
Protected variable TArray< FRigBaseMetadata * > Metadata  
Protected variable FRigElementMetadataChangedDelegate MetadataChangedDelegate  
Protected variable TMap< FName, int32 > MetadataNameToIndex  
Protected variable FRigElementMetadataTagChangedDelegate MetadataTagChangedDelegate  
Protected variable uint16 MetadataVersion  
Protected variable UProperty Transient FString NameString  
Protected variable int32 OwnedInstances Used for constructing / destructing the memory. typically == 1
Protected variable UProperty Category, Meta BlueprintReadOnly visibleanywhere int32 SubIndex  
Protected variable uint16 TopologyVersion  

Constructors

  Type Name Description
Public function    
Public function  

FRigBaseElement ( const FRigBaseElement& InOther
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function Virtual void

CopyFrom ( URigHierarchy* InHierarchy,
FRigBaseElement* InOther,
URigHierarchy* InOtherHierarchy
)

 Helper function to be called as part of URigHierarchy::CopyHierarchy
Public function Virtual void

CopyPose ( FRigBaseElement* InOther,
bool bCurrent,
bool bInitial,
bool bWeights
)

  
Public function Const int32  
Public function Virtual Const const FName &  
Public function Const UScriptStruct *  
Public function Const int32  
Public function Const const FRigElementKey &

GetKey ()

  
Public function Const FRigBaseMetadata *

GetMetadata ( int32 InIndex
)

  
Public function Const FRigBaseMetadata *

GetMetadata ( const FName& InName
)

  
Public function Const FRigBaseMetadata *

GetMetadata ( const FName& InName,
ERigMetadataType InType
)

  
Public function Const int32  
Public function Const const FName &

GetName ()

  
Public function Const const FString &  
Public function Const int32  
Public function Const ERigElementType

GetType ()

  
Public function Const bool

IsA ()

  
Protected function Static bool

IsClassOf ( const FRigBaseElement* InElement
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool

IsTypeOf ( ERigElementType InElementType
)

  
Public function Virtual void

Load ( FArchive& Ar,
URigHierarchy* Hierarchy,
ESerializationPhase SerializationPhase
)

  
Protected function void

NotifyMetadataChanged ( const FName& InName
)

  
Protected function void

NotifyMetadataTagChanged ( const FName& InTag,
bool bAdded
)

  
Public function Const int32  
Public function bool  
Public function bool

RemoveMetadata ( const FName& InName
)

  
Public function Virtual void

Save ( FArchive& Ar,
URigHierarchy* Hierarchy,
ESerializationPhase SerializationPhase
)

  
Public function void

Serialize ( FArchive& Ar,
URigHierarchy* Hierarchy,
ESerializationPhase SerializationPhase
)

  
Public function bool

SetMetaData ( const FName& InName,
ERigMetadataType InType,
const void* InData,
int32 InSize
)

  
Protected function FRigBaseMetadata *

SetupValidMetadata ( const FName& InName,
ERigMetadataType InType
)

 Sets up the metadata and ensures the right type

Operators

  Type Name Description
Public function FRigBaseElement &

operator= ( const FRigBaseElement& InOther
)

  

Enums

  Type Name Description
Public enum ESerializationPhase    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page