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

class UInterchangeBaseNode : public UObject

Remarks

This struct is used to store and retrieve key value attributes. The attributes are store in a generic FAttributeStorage which serialize the value 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 class 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

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function bool

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

 Add a boolean attribute to this node.
Public function bool

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

 Add a double attribute to this node.
Public function bool

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

 Add a float attribute to this node.
Public function bool

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

 Add a guid attribute to this node.
Public function bool

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

 Add a int32 attribute to this node.
Public function bool

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

 Add a FLinearColor attribute to this node.
Public function bool

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

 Add a string attribute to this node.
Public function Const bool

AddTargetNodeUid ( const FString& AssetUid
)

 Add asset node UID relating to this object.
Public function bool

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

 Add a Vector2 attribute to this node.
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 Virtual Const FString Optional, Any node that can import/export an asset should set the proper name we will give to the asset.
Public function Const bool

GetAttribute ( const FString& NodeAttributeKey,
AttributeType& OutValue
)

  
Public function Virtual Const FString UI that inspect node attribute call 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 return an attribute handle for the specified Key.
Public function Const void Use this function to query all the node attribute keys
Public function Virtual Const UE::Interchange::EAttributeTypes

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

 This function return an attribute type for the specified Key.
Public function Const bool

GetBooleanAttribute ( const FString& NodeAttributeKey,
bool& OutValue
)

 Get a boolean attribute from this node. Return false if the attribute do not exist
Public function Const FString Return the display label.
Public function Const bool

GetDoubleAttribute ( const FString& NodeAttributeKey,
double& OutValue
)

 Get a double attribute from this node. Return false if the attribute do not exist
Public function Const bool

GetFloatAttribute ( const FString& NodeAttributeKey,
float& OutValue
)

 Get a float attribute from this node. Return false if the attribute do not exist
Public function Const bool

GetGuidAttribute ( const FString& NodeAttributeKey,
FGuid& OutValue
)

 Get a guid attribute from this node. Return false if the attribute do not exist
Public function Virtual Const FGuid

GetHash ()

 Return a FGuid build from the FSHA1 of all the attribute data contain in the node.
Public function Virtual Const FName Icon name, use to retrieve the brush when we display the node in any UI
Public function Const bool

GetInt32Attribute ( const FString& NodeAttributeKey,
int32& OutValue
)

 Get a int32 attribute from this node. Return false if the attribute do not exist
Public function Virtual Const FString UI that inspect node attribute call this to give a readable name to attribute key
Public function Const bool

GetLinearColorAttribute ( const FString& NodeAttributeKey,
FLinearColor& OutValue
)

 Get a FLinearColor attribute from this node.
Public function Const EInterchangeNodeContainerType Return the node container type which define the purpose of the node (Factory node, translated scene node or translated asset node).
Public function Const FString Return the parent unique id.
Public function Const bool

GetStringAttribute ( const FString& NodeAttributeKey,
FString& OutValue
)

 Get a string attribute from this node. Return false if the attribute do not exist
Public function Const int32 Get number of target assets relating to this object.
Public function Const void

GetTargetNodeUids ( TArray< FString >& OutTargetAssets
)

 Get target assets relating to this object.
Public function Virtual Const FString Return the node type name of the class, we use this when reporting error
Public function Const FString Return the unique id pass in the constructor.
Public function Const bool

GetVector2Attribute ( const FString& NodeAttributeKey,
FVector2f& OutValue
)

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

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

 Return true if the node contain an attribute with the specified Key
Public function 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 bool IsEnable true mean that the node will be import/export, if false it will be discarded.
Public function UE::Interchange::FAttributeStorage::TAttributeHandle< T >

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

 Add an attribute to the node
Public function bool

RemoveAttribute ( const FString& NodeAttributeKey
)

 Remove any attribute from this node.
Public function Const bool

RemoveTargetNodeUid ( const FString& AssetUid
)

 Remove asset node UID relating to this object.
Public function Virtual bool

SetAssetName ( const FString& AssetName
)

 Set the name we want for the imported asset this node represent.
Public function bool

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

  
Public function bool

SetDisplayLabel ( const FString& DisplayName
)

 Change the display label.
Public function bool

SetEnabled ( const bool bIsEnabled
)

 Set the IsEnable attribute to determine if this node should be part of the import/export process
Public function Virtual Const bool UI that inspect node attribute call 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 serialize for a node

Constants

Name Description
HierarchySeparator  

Deprecated Functions

  Type Name Description
Public function bool

SetParentUid ( const FString& ParentUid
)

 This function should not be use - Use UInterchangeBaseNodeContainer::SetNodeParentUid function to create a parent hierarchy. This will ensure the container cache is always in sync

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page