1. Epic GamesDeveloper
  3. UInterchangeFactoryBaseNode

UInterchangeFactoryBaseNode

This struct is used to store and retrieve key-value attributes.

API > API/Runtime > API/Runtime/InterchangeCore

This struct is used to store and retrieve key-value attributes. The attributes are stored in a generic FAttributeStorage that serializes the values in a TArray64. See UE::Interchange::EAttributeTypes to know the supported template types. This is an abstract class. This is the base class of the Interchange node graph format; all classes in this format should derive from this class.

   
Name UInterchangeFactoryBaseNode
Type class
Header File /Engine/Source/Runtime/Interchange/Core/Public/Nodes/InterchangeFactoryBaseNode.h
Include Path #include "Nodes/InterchangeFactoryBaseNode.h"

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class UInterchangeFactoryBaseNode : public UInterchangeBaseNode

Inheritance Hierarchy

Derived Classes

UInterchangeFactoryBaseNode derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UInterchangeFactoryBaseNode()

   Nodes/InterchangeFactoryBaseNode.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Macro_CustomLevelUidKey const UE::Interchange::FAttributeKey   Nodes/InterchangeFactoryBaseNode.h  
Macro_CustomReferenceObjectKey const UE::Interchange::FAttributeKey   Nodes/InterchangeFactoryBaseNode.h  
Macro_CustomSubPathKey const UE::Interchange::FAttributeKey   Nodes/InterchangeFactoryBaseNode.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddApplyAndFillDelegates ( const FString& NodeAttributeKey,
UClass* ObjectClass,
const FName PropertyName
)

 Adds the delegates that will read and write the attribute value to a UObject. Nodes/InterchangeFactoryBaseNode.h  

bool AddFactoryDependencyUid ( const FString& DependencyUid
)

 Add one dependency to this object. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

void ApplyAllCustomAttributeToObject ( UObject* Object
) const

 Each Attribute that was set and has a delegate set for the specified UObject->UClass will have the delegate executed so it applies the attribute to the UObject property. Nodes/InterchangeFactoryBaseNode.h  

bool ApplyAttributeToObject ( const FString& NodeAttributeKey,
UObject* Object,
const FName PropertyName
) const

 Specialized version of ApplyAttributeToObject for bools. Nodes/InterchangeFactoryBaseNode.h  

bool ApplyAttributeToObject ( const FString& NodeAttributeKey,
UObject* Object,
const FName PropertyName
) const

 Specialized version of ApplyAttributeToObject for strings. Nodes/InterchangeFactoryBaseNode.h  

bool ApplyAttributeToObject ( const FString& NodeAttributeKey,
UObject* Object,
const FName PropertyName
) const

 Writes an attribute value to a UObject. Nodes/InterchangeFactoryBaseNode.h  

virtual void CopyWithObject ( const UInterchangeFactoryBaseNode* SourceNode,
UObject* Object
)

 Copies all the attributes from SourceNode to this node. Nodes/InterchangeFactoryBaseNode.h  

void FillAllCustomAttributeFromObject ( UObject* Object
) const

   Nodes/InterchangeFactoryBaseNode.h  

bool FillAttributeFromObject ( const FString& NodeAttributeKey,
UObject* Object,
const FName PropertyName
)

 Reads an attribute value from a UObject. Nodes/InterchangeFactoryBaseNode.h  

bool FillAttributeFromObject ( const FString& NodeAttributeKey,
UObject* Object,
const FName PropertyName
)

 Specialized version of FillAttributeFromObject for strings. Nodes/InterchangeFactoryBaseNode.h  

bool FillAttributeFromObject ( const FString& NodeAttributeKey,
UObject* Object,
const FName PropertyName
)

 Specialized version of FillAttributeFromObject for bools. Nodes/InterchangeFactoryBaseNode.h  

bool GetCustomLevelUid ( FString& AttributeValue
) const

 If this node represent a scene asset (actor), return a specific level in which we will create this scene asset. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node | ActorFactory"

bool GetCustomReferenceObject ( FSoftObjectPath& AttributeValue
) const

 Return the custom ReferenceObject: the UObject this factory node has created. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool GetCustomSubPath ( FString& AttributeValue
) const

 Return the custom sub-path under PackageBasePath where the assets will be created. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

void GetFactoryDependencies ( TArray< FString >& OutDependencies
) const

 Retrieve the dependencies for this object. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

int32 GetFactoryDependenciesCount()

 Retrieve the number of factory dependencies for this object. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

void GetFactoryDependency ( const int32 Index,
FString& OutDependency
) const

 Retrieve one dependency for this object. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

virtual UClass * GetObjectClass()

 Return the UClass of the object we represent, so we can find the factory/writer. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

EReimportStrategyFlags GetReimportStrategyFlags()

 Return the reimport strategy flags. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

virtual bool IsRuntimeImportAllowed()

 Return if the import of the class is allowed at runtime. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

void RemoveAllCustomAttributeDelegates()

 Removes all custom attribute delegates that are currently added. Nodes/InterchangeFactoryBaseNode.h  

void RemoveCustomAttributesForClass ( UClass* Class
)

 Removes all custom attribute delegates registered for the provided class. Nodes/InterchangeFactoryBaseNode.h  

bool RemoveFactoryDependencyUid ( const FString& DependencyUid
)

 Remove one dependency from this object. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

void RestoreAllCustomAttributeDelegates()

 Adds apply and fill delegates for attributes again that were using custom delegates. Nodes/InterchangeFactoryBaseNode.h  

bool SetCustomLevelUid ( const FString& AttributeValue
)

 If this node represent a scene asset (actor), you can set a specific level in which we will create this scene asset. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node | ActorFactory"

bool SetCustomReferenceObject ( const FSoftObjectPath& AttributeValue
)

 Set the custom ReferenceObject: the UObject this factory node has created. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool SetCustomSubPath ( const FString& AttributeValue
)

 Set the custom sub-path under PackageBasePath where the assets will be created. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool SetForceNodeReimport()

 Allow the creation of the Unreal object even if it has been previously deleted in the editor. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool SetReimportStrategyFlags ( const EReimportStrategyFlags& ReimportStrategyFlags
)

 Change the reimport strategy flags. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"
Add the skip node attribute. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"
Return whether or not an object should be created even if it has been deleted in the editor. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"
Return true if this node should skip the factory import process, or false otherwise. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool UnsetForceNodeReimport()

 Disallow the creation of the Unreal object if it has been previously deleted in the editor. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool UnsetSkipNodeImport()

 Remove the skip node attribute. See ShouldSkipNodeImport for more documentation. Nodes/InterchangeFactoryBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

Overridden from UInterchangeBaseNode

Name Remarks Include Path Unreal Specifiers

virtual FString GetAttributeCategory ( const UE::Interchange::FAttributeKey& NodeAttributeKey
) const

 UI that inspects node attributes calls this to display the attribute under the returned category. Nodes/InterchangeFactoryBaseNode.h  

virtual FString GetKeyDisplayName ( const UE::Interchange::FAttributeKey& NodeAttributeKey
) const

 UI that inspects node attributes calls this to give a readable name to an attribute key. Nodes/InterchangeFactoryBaseNode.h  

virtual bool ShouldHideAttribute ( const UE::Interchange::FAttributeKey& NodeAttributeKey
) const

 UI that inspects node attributes calls this to display or hide an attribute. Nodes/InterchangeFactoryBaseNode.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void OnRestoreAllCustomAttributeDelegates()

 Adds apply and fill delegates for attributes again that were using custom delegates. Nodes/InterchangeFactoryBaseNode.h  

Static

Name Remarks Include Path Unreal Specifiers

static FString BuildFactoryNodeUid ( const FString& TranslatedNodeUid
)

   Nodes/InterchangeFactoryBaseNode.h  

static FString BuildTranslatedNodeUid ( const FString& InFactoryNodeUid
)

   Nodes/InterchangeFactoryBaseNode.h  

static UInterchangeFactoryBaseNode * DuplicateWithObject ( const UInterchangeFactoryBaseNode* SourceNode,
UObject* Object
)

 Copies all the custom attributes from SourceNode to this node, and gets the appropriate values from Object. Nodes/InterchangeFactoryBaseNode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page