1. Epic GamesDeveloper
  3. UInterchangeBaseNode

UInterchangeBaseNode

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 UInterchangeBaseNode
Type class
Header File /Engine/Source/Runtime/Interchange/Core/Public/Nodes/InterchangeBaseNode.h
Include Path #include "Nodes/InterchangeBaseNode.h"

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class UInterchangeBaseNode : public UObject

Inheritance Hierarchy

Derived Classes

UInterchangeBaseNode derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UInterchangeBaseNode()

   Nodes/InterchangeBaseNode.h  

Constants

Name Type Remarks Include Path
HierarchySeparator const TCHAR *   Nodes/InterchangeBaseNode.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
UserInterfaceContext EInterchangeNodeUserInterfaceContext Temporary property set by UI to have the context for ShouldHideAttribute. Nodes/InterchangeBaseNode.h
  • Transient
  • DuplicateTransient

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddBooleanAttribute ( const FString& NodeAttributeKey,
const bool& Value
)

 Add a Boolean attribute to this node. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool AddDoubleAttribute ( const FString& NodeAttributeKey,
const double& Value
)

 Add a double attribute to this node. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool AddFloatAttribute ( const FString& NodeAttributeKey,
const float& Value
)

 Add a float attribute to this node. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool AddGuidAttribute ( const FString& NodeAttributeKey,
const FGuid& Value
)

 Add a GUID attribute to this node. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool AddInt32Attribute ( const FString& NodeAttributeKey,
const int32& Value
)

 Add a int32 attribute to this node. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool AddLinearColorAttribute ( const FString& NodeAttributeKey,
const FLinearColor& Value
)

 Add an FLinearColor attribute to this node. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool AddStringAttribute ( const FString& NodeAttributeKey,
const FString& Value
)

 Add a string attribute to this node. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool AddTargetNodeUid ( const FString& AssetUid
) const

 Add an asset node UID relating to this object. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool AddVector2Attribute ( const FString& NodeAttributeKey,
const FVector2f& Value
)

 Add a Vector2 attribute to this node. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

virtual void AppendAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
) const

   Nodes/InterchangeBaseNode.h  

virtual void AppendAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   Nodes/InterchangeBaseNode.h  

virtual FString GetAssetName ()

 Optional. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool GetAttribute ( const FString& NodeAttributeKey,
AttributeType& OutValue
) const

   Nodes/InterchangeBaseNode.h  

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/InterchangeBaseNode.h  

AttributeType GetAttributeChecked ( const FString& NodeAttributeKey
) const

   Nodes/InterchangeBaseNode.h  
This function returns an attribute handle for the specified Key. Nodes/InterchangeBaseNode.h  

void GetAttributeKeys ( TArray< UE::Interchange::FAttributeKey >& AttributeKeys
) const

 Query all the node attribute keys. Nodes/InterchangeBaseNode.h  
This function returns an attribute type for the specified Key. Nodes/InterchangeBaseNode.h  

bool GetBooleanAttribute ( const FString& NodeAttributeKey,
bool& OutValue
) const

 Get a Boolean attribute from this node. Returns false if the attribute does not exist. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"
Return the desired child index. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

FString GetDisplayLabel()

 Return the display label. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool GetDoubleAttribute ( const FString& NodeAttributeKey,
double& OutValue
) const

 Get a double attribute from this node. Returns false if the attribute does not exist. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool GetFloatAttribute ( const FString& NodeAttributeKey,
float& OutValue
) const

 Get a float attribute from this node. Returns false if the attribute does not exist. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool GetGuidAttribute ( const FString& NodeAttributeKey,
FGuid& OutValue
) const

 Get a GUID attribute from this node. Returns false if the attribute does not exist. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

virtual FGuid GetHash ()

 Return an FGuid built from the FSHA1 of all the attribute data contained in the node. Nodes/InterchangeBaseNode.h  

virtual FName GetIconName()

 Icon name, used to retrieve the brush when we display the node in any UI. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool GetInt32Attribute ( const FString& NodeAttributeKey,
int32& OutValue
) const

 Get a int32 attribute from this node. Returns false if the attribute does not exist. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

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/InterchangeBaseNode.h  

bool GetLinearColorAttribute ( const FString& NodeAttributeKey,
FLinearColor& OutValue
) const

 Get an FLinearColor attribute from this node. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool GetNamespace ( FString& Namespace
) const

 Namespace is a prefix added when calling GetUniqueId(). Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

EInterchangeNodeContainerType GetNodeContainerType()

 Return the node container type that defines the purpose of the node (factory node, translated scene node, or translated asset node). Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"
Return the parent unique ID. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool GetStringAttribute ( const FString& NodeAttributeKey,
FString& OutValue
) const

 Get a string attribute from this node. Returns false if the attribute does not exist. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

int32 GetTargetNodeCount()

 Get the number of target assets relating to this object. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

void GetTargetNodeUids ( TArray< FString >& OutTargetAssets
) const

 Get the target assets relating to this object. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

virtual FString GetTypeName()

 Return the node type name of the class. This is used when reporting errors. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

FString GetUniqueID()

 Return the unique ID passed in the constructor. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool GetVector2Attribute ( const FString& NodeAttributeKey,
FVector2f& OutValue
) const

 Get a Vector2 attribute from this node. Returns false if the attribute does not exist. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

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

 Return true if the node contains an attribute with the specified Key. Nodes/InterchangeBaseNode.h  

void InitializeNode ( const FString& UniqueID,
const FString& DisplayLabel,
const EInterchangeNodeContainerType NodeContainerType
)

 Initialize the base data of the node. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool IsEnabled ()

 If true, the node is imported or exported. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

UE::Interchange::FAttributeStorage::TAttributeHandle< T > RegisterAttribute ( const UE::Interchange::FAttributeKey& NodeAttributeKey,
const T& Value
)

 Add an attribute to the node. Nodes/InterchangeBaseNode.h  

bool RemoveAttribute ( const FString& NodeAttributeKey
)

 Remove the specified attribute from this node. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool RemoveTargetNodeUid ( const FString& AssetUid
) const

 Remove an asset node UID relating to this object. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

virtual bool SetAssetName ( const FString& AssetName
)

 Set the name for the imported asset this node represents. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool SetAttribute ( const FString& NodeAttributeKey,
const AttributeType& Value
)

   Nodes/InterchangeBaseNode.h  

bool SetDisplayLabel ( const FString& InDisplayLabel
)

 Change the display label. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

bool SetEnabled ( const bool bIsEnabled
)

 Determine whether this node should be part of the import or export process. Nodes/InterchangeBaseNode.h
  • BlueprintCallable
  • Category="Interchange | Node"

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

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

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void Serialize ( FArchive& Ar
)

 Serialize the node. By default, only the attribute storage is serialized for a node. Nodes/InterchangeBaseNode.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool SetDesiredChildIndex ( const int32& ChildIndex
)

 Set the desired child index. Only the container should set the desired child index Nodes/InterchangeBaseNode.h  

bool SetNamespace ( const FString& InNamespace
)

 Return true if the Namespace attribute is added, false otherwise. Nodes/InterchangeBaseNode.h  

bool SetParentUid ( const FString& ParentUid
)

 Set the parent unique ID. Nodes/InterchangeBaseNode.h  

Static

Name Remarks Include Path Unreal Specifiers

static void CompareNodeStorage ( const UInterchangeBaseNode* NodeA,
const UInterchangeBaseNode* NodeB,
TArray< UE::Interchange::FAttributeKey >& RemovedAttributes,
TArray< UE::Interchange::FAttributeKey >& AddedAttributes,
TArray< UE::Interchange::FAttributeKey >& ModifiedAttributes
)

   Nodes/InterchangeBaseNode.h  

static void CopyStorage ( const UInterchangeBaseNode* SourceNode,
UInterchangeBaseNode* DestinationNode
)

   Nodes/InterchangeBaseNode.h  

static void CopyStorageAttributes ( const UInterchangeBaseNode* SourceNode,
UE::Interchange::FAttributeStorage& DestinationStorage,
const TArray< UE::Interchange::FAttributeKey >& AttributeKeys
)

   Nodes/InterchangeBaseNode.h  

static void CopyStorageAttributes ( const UInterchangeBaseNode* SourceNode,
UInterchangeBaseNode* DestinationNode,
const TArray< UE::Interchange::FAttributeKey >& AttributeKeys
)

   Nodes/InterchangeBaseNode.h  

static void CopyStorageAttributes ( const UE::Interchange::FAttributeStorage& SourceStorage,
UInterchangeBaseNode* DestinationNode,
const TArray< UE::Interchange::FAttributeKey >& AttributeKeys
)

   Nodes/InterchangeBaseNode.h  

static void CopyStorageAttributes ( const UInterchangeBaseNode* SourceNode,
UE::Interchange::FAttributeStorage& DestinationStorage,
const TArray< TPair< UE::Interchange::FAttributeKey, UE::Interchange::FAttributeKey > >& SrcDestAtt...
)

   Nodes/InterchangeBaseNode.h  

static FString InvalidNodeUid()

 Return the invalid unique ID. Nodes/InterchangeBaseNode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page