Navigation
API > API/Plugins > API/Plugins/InterchangeNodes
Represents a file that contains volume data in the form of (potentially multiple) grids, which are represented as UInterchangeVolumeGridNode dependencies
| Name | UInterchangeVolumeNode |
| Type | class |
| Header File | /Engine/Plugins/Interchange/Runtime/Source/Nodes/Public/InterchangeVolumeNode.h |
| Include Path | #include "InterchangeVolumeNode.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType)
class UInterchangeVolumeNode : public UInterchangeBaseNode
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInterchangeBaseNode → UInterchangeVolumeNode
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UInterchangeVolumeNode() |
InterchangeVolumeNode.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| GridDependencies | UE::Interchange::TArrayAttributeHelper< FString > | InterchangeVolumeNode.h | ||
| IndexInVolumeAnimation | UE::Interchange::TArrayAttributeHelper< int32 > | InterchangeVolumeNode.h | ||
| Macro_CustomAnimationIDKey | const UE::Interchange::FAttributeKey | InterchangeVolumeNode.h | ||
| Macro_CustomFileNameKey | const UE::Interchange::FAttributeKey | InterchangeVolumeNode.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddCustomFrameIndexInAnimation
(
int32 Index |
Adds a frame index for which this volume is displayed within the animation that it belongs to, if any | InterchangeVolumeNode.h |
|
bool AddCustomGridDependency
(
const FString& DependencyUid |
Sets the Node ID of an UInterchangeVolumeGridNode dependency | InterchangeVolumeNode.h |
|
bool GetCustomAnimationID
(
FString& AttributeValue |
Gets an identifier that is shared by all volume nodes that correspond to the same animation (i.e. every volume node within the animation will have the same AnimationID) | InterchangeVolumeNode.h |
|
bool GetCustomFileName
(
FString& AttributeValue |
Gets the filename of the file with volume data (e.g. "C:/MyFolder/File.vdb"). | InterchangeVolumeNode.h |
|
void GetCustomFrameIndexInAnimation
(
int32 IndexIndex, |
Gets one of the frame indices for which this volume is displayed within the animation that it belongs to, if any | InterchangeVolumeNode.h |
|
void GetCustomFrameIndicesInAnimation
(
TArray< int32 >& OutAnimationIndices |
Get the frame indices for which this volume is displayed within the animation that it belongs to, if any (e.g. if this had [2, 3] then frames 2 and 3 of the animation with AnimationID should display this volume) | InterchangeVolumeNode.h |
|
void GetCustomGridDependecies
(
TArray< FString >& OutDependencies |
Gets the Node IDs of UInterchangeVolumeGridNodes declared as dependencies by this volume node | InterchangeVolumeNode.h |
|
int32 GetCustomGridDependeciesCount() |
Gets the number of UInterchangeVolumeGridNodes declared as dependencies by this volume node (in other words, returns the number of volume grids contained in this file) | InterchangeVolumeNode.h |
|
void GetCustomGridDependency
(
const int32 Index, |
Gets the Node ID of an UInterchangeVolumeGridNode dependency | InterchangeVolumeNode.h |
|
bool RemoveCustomFrameIndexInAnimation
(
int32 Index |
Removes a frame index for which this volume is displayed within the animation that it belongs to, if any | InterchangeVolumeNode.h |
|
bool RemoveCustomGridDependency
(
const FString& DependencyUid |
Removes the Node ID of an UInterchangeVolumeGridNode dependency | InterchangeVolumeNode.h |
|
bool SetCustomAnimationID
(
const FString& AttributeValue |
Sets an identifier that is shared by all volume nodes that correspond to the same animation (i.e. every volume node within the animation will have the same AnimationID) | InterchangeVolumeNode.h |
|
bool SetCustomFileName
(
const FString& AttributeValue |
Sets the filename of the file with volume data (e.g. "C:/MyFolder/File.vdb"). | InterchangeVolumeNode.h |
|
Overridden from UInterchangeBaseNode
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FString GetTypeName() |
InterchangeVolumeNode.h |