1. Epic GamesDeveloper
  3. UInterchangeBaseNode

UInterchangeBaseNode

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

API > API/Runtime > API/Runtime/InterchangeCore > API/Runtime/InterchangeCore/Nodes

Inheritance Hierarchy

References

   
Module InterchangeCore
Header /Engine/Source/Runtime/Interchange/Core/Public/Nodes/InterchangeBaseNode.h
Include #include "Nodes/InterchangeBaseNode.h"

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class UInterchangeBaseNode : public UObject

Remarks

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.

Variables

  Type Name Description
Protected variable TSharedPtr< UE::Interchange::FAttributeStorage, ESPMode::ThreadSafe > Attributes The storage use to store the Key value attribute for this node.
Protected variable bool bIsInitialized  
Protected variable UE::Interchange::TArrayAttributeHelper< FString > TargetNodes This tracks the IDs of asset nodes which are the target of factories
Public variable UProperty Transient duplicatetransient EInterchangeNodeUserInterfaceContext UserInterfaceContext Temporary property set by UI to have the context for ShouldHideAttribute.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category bool

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

 Add a Boolean attribute to this node.
Public function UFunction BlueprintCallable, Category bool

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

 Add a double attribute to this node.
Public function UFunction BlueprintCallable, Category bool

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

 Add a float attribute to this node.
Public function UFunction BlueprintCallable, Category bool

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

 Add a GUID attribute to this node.
Public function UFunction BlueprintCallable, Category bool

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

 Add a int32 attribute to this node.
Public function UFunction BlueprintCallable, Category bool

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

 Add an FLinearColor attribute to this node.
Public function UFunction BlueprintCallable, Category bool

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

 Add a string attribute to this node.
Public function Const UFunction BlueprintCallable, Category bool

AddTargetNodeUid ( const FString& AssetUid
)

 Add an asset node UID relating to this object.
Public function UFunction BlueprintCallable, Category bool

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

 Add a Vector2 attribute to this node.
Public function Virtual Const void

AppendAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
)

  
Public function Virtual Const void  
Public function Static void  
Public function Static void

CopyStorage ( const UInterchangeBaseNode* SourceNode,
UInterchangeBaseNode* DestinationNode
)

  
Public function Static void

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

  
Public function Static void  
Public function Static void  
Public function Virtual Const UFunction BlueprintCallable, Category FString Optional.
Public function Const bool

GetAttribute ( const FString& NodeAttributeKey,
AttributeType& OutValue
)

  
Public function Virtual Const FString UI that inspects node attributes calls this to display the attribute under the returned category.
Public function Const AttributeType

GetAttributeChecked ( const FString& NodeAttributeKey
)

  
Public function Const UE::Interchange::FAttributeStorage::TAttributeHandle< T > This function returns an attribute handle for the specified Key.
Public function Const void Query all the node attribute keys.
Public function Virtual Const UE::Interchange::EAttributeTypes

GetAttributeType ( const UE::Interchange::FAttributeKey& NodeAttributeKey
)

 This function returns an attribute type for the specified Key.
Public function Const UFunction BlueprintCallable, Category bool

GetBooleanAttribute ( const FString& NodeAttributeKey,
bool& OutValue
)

 Get a Boolean attribute from this node. Returns false if the attribute does not exist.
Public function Const UFunction BlueprintCallable, Category FString Return the display label.
Public function Const UFunction BlueprintCallable, Category bool

GetDoubleAttribute ( const FString& NodeAttributeKey,
double& OutValue
)

 Get a double attribute from this node. Returns false if the attribute does not exist.
Public function Const UFunction BlueprintCallable, Category bool

GetFloatAttribute ( const FString& NodeAttributeKey,
float& OutValue
)

 Get a float attribute from this node. Returns false if the attribute does not exist.
Public function Const UFunction BlueprintCallable, Category bool

GetGuidAttribute ( const FString& NodeAttributeKey,
FGuid& OutValue
)

 Get a GUID attribute from this node. Returns false if the attribute does not exist.
Public function Virtual Const FGuid

GetHash ()

 Return an FGuid built from the FSHA1 of all the attribute data contained in the node.
Public function Virtual Const FName Icon name, used to retrieve the brush when we display the node in any UI.
Public function Const UFunction BlueprintCallable, Category bool

GetInt32Attribute ( const FString& NodeAttributeKey,
int32& OutValue
)

 Get a int32 attribute from this node. Returns false if the attribute does not exist.
Public function Virtual Const FString UI that inspects node attributes calls this to give a readable name to an attribute key.
Public function Const UFunction BlueprintCallable, Category bool

GetLinearColorAttribute ( const FString& NodeAttributeKey,
FLinearColor& OutValue
)

 Get an FLinearColor attribute from this node.
Public function Const UFunction BlueprintCallable, Category EInterchangeNodeContainerType Return the node container type that defines the purpose of the node (factory node, translated scene node, or translated asset node).
Public function Const UFunction BlueprintCallable, Category FString Return the parent unique ID.
Public function Const UFunction BlueprintCallable, Category bool

GetStringAttribute ( const FString& NodeAttributeKey,
FString& OutValue
)

 Get a string attribute from this node. Returns false if the attribute does not exist.
Public function Const UFunction BlueprintCallable, Category int32 Get the number of target assets relating to this object.
Public function Const UFunction BlueprintCallable, Category void

GetTargetNodeUids ( TArray< FString >& OutTargetAssets
)

 Get the target assets relating to this object.
Public function Virtual Const FString Return the node type name of the class. This is used when reporting errors.
Public function Const UFunction BlueprintCallable, Category FString Return the unique ID passed in the constructor.
Public function Const UFunction BlueprintCallable, Category bool

GetVector2Attribute ( const FString& NodeAttributeKey,
FVector2f& OutValue
)

 Get a Vector2 attribute from this node. Returns false if the attribute does not exist.
Public function Virtual Const bool

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

 Return true if the node contains an attribute with the specified Key.
Public function UFunction BlueprintCallable, Category void

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

 Initialize the base data of the node.
Public function Static FString Return the invalid unique ID.
Public function Const UFunction BlueprintCallable, Category bool If true, the node is imported or exported.
Public function UE::Interchange::FAttributeStorage::TAttributeHandle< T >

RegisterAttribute ( const UE::Interchange::FAttributeKey& NodeAttributeKey,
const T& Value
)

 Add an attribute to the node.
Public function UFunction BlueprintCallable, Category bool

RemoveAttribute ( const FString& NodeAttributeKey
)

 Remove the specified attribute from this node.
Public function Const UFunction BlueprintCallable, Category bool

RemoveTargetNodeUid ( const FString& AssetUid
)

 Remove an asset node UID relating to this object.
Public function Virtual UFunction BlueprintCallable, Category bool

SetAssetName ( const FString& AssetName
)

 Set the name for the imported asset this node represents.
Public function bool

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

  
Public function UFunction BlueprintCallable, Category bool

SetDisplayLabel ( const FString& DisplayName
)

 Change the display label.
Public function UFunction BlueprintCallable, Category bool

SetEnabled ( const bool bIsEnabled
)

 Determine whether this node should be part of the import or export process.
Public function UFunction BlueprintCallable, Category bool

SetParentUid ( const FString& ParentUid
)

 Set the parent unique ID.
Public function Virtual Const bool UI that inspects node attributes calls this to display or hide an attribute.

Overridden from UObject

  Type Name Description
Public function Virtual void Serialize the node. By default, only the attribute storage is serialized for a node.

Constants

Name Description
HierarchySeparator  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page