1. Epic GamesDeveloper
  3. FInputVertexInterfaceData

FInputVertexInterfaceData

An input vertex interface with optionally bound data references.

API > API/Plugins > API/Plugins/MetasoundGraphCore

An input vertex interface with optionally bound data references.

   
Name FInputVertexInterfaceData
Type class
Header File /Engine/Plugins/Runtime/Metasound/Source/MetasoundGraphCore/Public/MetasoundVertexData.h
Include Path #include "MetasoundVertexData.h"

Syntax

class FInputVertexInterfaceData

Constructors

Name Remarks Include Path Unreal Specifiers

FInputVertexInterfaceData ( const FInputVertexInterface& InVertexInterface
)

 Construct with an FInputVertexInterface. MetasoundVertexData.h  
Construct with an FInputVertexInterface. MetasoundVertexData.h  

Typedefs

Name Type Remarks Include Path
FInputBinding VertexDataPrivate::FInputBinding   MetasoundVertexData.h
FRangedForConstIteratorType typename TArray< FInputBinding >::RangedForConstIteratorType   MetasoundVertexData.h
FRangedForIteratorType typename TArray< FInputBinding >::RangedForIteratorType   MetasoundVertexData.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Bindings TArray< FInputBinding >   MetasoundVertexData.h  
bIsVertexInterfaceFrozen bool   MetasoundVertexData.h  
SubInterfaces TArray< VertexPrivate::FSubInterfaceLayout >   MetasoundVertexData.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddVertex ( const FInputDataVertex& InVertex
)

 Add a vertex. VertexInterfaceData must be unfrozen. MetasoundVertexData.h  

bool AreAllVerticesBound()

 Returns true if all vertices in the FInputVertexInterface are bound to data references. MetasoundVertexData.h  

FRangedForConstIteratorType begin ()

   MetasoundVertexData.h  

FRangedForIteratorType begin ()

   MetasoundVertexData.h  

void Bind ( const FInputVertexInterfaceData& InOutInputVertexData
)

 Bind vertex data using other vertex data. MetasoundVertexData.h  

void Bind ( FInputVertexInterfaceData& InOutInputVertexData
)

 Bind vertex data using other vertex data. MetasoundVertexData.h  

void BindReadVertex ( const FVertexName& InVertexName,
const TDataReadReference< DataType >& InOutDataReference
)

 Bind a read vertex from a read reference. MetasoundVertexData.h  

void BindReadVertex ( const FVertexName& InVertexName,
TDataWriteReference< DataType >& InOutDataReference
)

 Bind a read vertex from a write reference. MetasoundVertexData.h  

void BindReadVertex ( const FVertexName& InVertexName,
TDataReadReference< DataType >& InOutDataReference
)

 Bind a read vertex from a read reference. MetasoundVertexData.h  

void BindSubInterfaceReadVertices ( const FName& InSubInterfaceName,
const FName& InVertexName,
RangeType& InOutDataReferences
)

 Bind the vertices of a sub interface vertex as read references MetasoundVertexData.h  

void BindSubInterfaceVertices ( const FName& InSubInterfaceName,
const FName& InVertexName,
RangeType& InOutDataReferences
)

 Bind the vertices of a sub interface vertex. MetasoundVertexData.h  

void BindSubInterfaceWriteVertices ( const FName& InSubInterfaceName,
const FName& InVertexName,
RangeType& InOutDataReferences
)

 Bind the vertices of a sub interface vertex as write references MetasoundVertexData.h  

void BindVertex ( const FVertexName& InVertexName,
FAnyDataReference& InOutDataReference
)

 Bind a vertex with a any data reference. MetasoundVertexData.h  

void BindVertex ( const FVertexName& InVertexName,
DataReferenceType& InOutDataReference
)

 Bind a vertex with a a data reference. MetasoundVertexData.h  

void BindVertex ( const FVertexName& InVertexName,
const FAnyDataReference& InOutDataReference
)

 Bind a vertex with a any data reference. MetasoundVertexData.h  

void BindWriteVertex ( const FVertexName& InVertexName,
const TDataWriteReference< DataType >& InOutDataReference
)

 Bind a write vertex from a write reference. MetasoundVertexData.h  

void BindWriteVertex ( const FVertexName& InVertexName,
TDataWriteReference< DataType >& InOutDataReference
)

 Bind a write vertex from a write reference. MetasoundVertexData.h  

bool Contains ( const FVertexName& InVertexName
) const

 Returns true if a vertex exists with the provided name. MetasoundVertexData.h  

FRangedForIteratorType end ()

   MetasoundVertexData.h  

FRangedForConstIteratorType end ()

   MetasoundVertexData.h  

const FAnyDataReference * FindDataReference ( const FVertexName& InVertexName
) const

 Find data reference bound to vertex. Returns a nullptr if no data reference is bound. MetasoundVertexData.h  

TArray< const FAnyDataReference * > FindSubInterfaceReferences ( const FName& InSubInterfaceName,
const FVertexName& InVertexName
) const

 Find data references bound to the sub interface vertices. MetasoundVertexData.h  

TDataReadReference< DataType > GetDataReadReference ( const FVertexName& InVertexName
) const

 Get data read reference assuming data is bound and read or write accessible. MetasoundVertexData.h  

TDataWriteReference< DataType > GetDataWriteReference ( const FVertexName& InVertexName
) const

 Get data write reference assuming data is bound and write accessible. MetasoundVertexData.h  

uint32 GetNumSubInterfaceInstances ( const FName& InSubInterfaceName
) const

 Return the number of instances of a particular sub interface. MetasoundVertexData.h  

TDataReadReference< DataType > GetOrConstructDataReadReference ( const FVertexName& InVertexName,
ConstructorArgTypes&&... ConstructorArgs
) const

 Get the bound data read reference if it exists. MetasoundVertexData.h  

TDataWriteReference< DataType > GetOrConstructDataWriteReference ( const FVertexName& InVertexName,
ConstructorArgTypes&&... ConstructorArgs
) const

 Get the bound data write reference if it exists. MetasoundVertexData.h  

TDataReadReference< DataType > GetOrCreateDefaultDataReadReference ( const FVertexName& InVertexName,
const FOperatorSettings& InSettings
) const

 Get the bound data read reference if it exists. MetasoundVertexData.h  

TDataValueReference< DataType > GetOrCreateDefaultDataValueReference ( const FVertexName& InVertexName,
const FOperatorSettings& InSettings
) const

 Gets the value of the bound data reference if it exists. MetasoundVertexData.h  

TDataWriteReference< DataType > GetOrCreateDefaultDataWriteReference ( const FVertexName& InVertexName,
const FOperatorSettings& InSettings
) const

 Get the bound data write reference if it exists. MetasoundVertexData.h  

TArray< DataReferenceType > GetOrCreateDefaultSubInterfaceAs ( const FName& InSubInterfaceName,
const FVertexName& InVertexName,
const FOperatorSettings& InSettings
) const

 Get or create an array of data references for all instances of a sub interface vertex. MetasoundVertexData.h  

TArray< TDataReadReference< DataType > > GetOrCreateDefaultSubInterfaceDataReadReferences ( const FName& InSubInterfaceName,
const FVertexName& InVertexName,
const FOperatorSettings& InSettings
) const

 Get or create an array of data read references for all instances of a sub interface vertex. MetasoundVertexData.h  

TArray< TDataWriteReference< DataType > > GetOrCreateDefaultSubInterfaceDataWriteReferences ( const FName& InSubInterfaceName,
const FVertexName& InVertexName,
const FOperatorSettings& InSettings
) const

 Get or create an array of data write references for all instances of a sub interface vertex. MetasoundVertexData.h  

TArray< DataType > GetOrCreateDefaultSubInterfaceValues ( const FName& InSubInterfaceName,
const FVertexName& InVertexName,
const FOperatorSettings& InSettings
) const

 Get or create an array of values for all instances of a sub interface vertex. MetasoundVertexData.h  

DataType GetOrCreateDefaultValue ( const FVertexName& InVertexName,
const FOperatorSettings& InSettings
) const

 Gets the value of the bound data reference if it exists. MetasoundVertexData.h  

const DataType * GetValue ( const FVertexName& InVertexName
) const

 Returns the current value of a vertex. MetasoundVertexData.h  

const FInputDataVertex & GetVertex ( const FVertexName& InVertexName
) const

 Return the vertex associated with the vertex name. MetasoundVertexData.h  

EDataReferenceAccessType GetVertexDataAccessType ( const FVertexName& InVertexName
) const

 Returns the access type of a bound vertex. MetasoundVertexData.h  

bool IsVertexBound ( const FVertexName& InVertexName
) const

 Returns true if a vertex with the given vertex name exists and is bound to a data reference. MetasoundVertexData.h  

bool IsVertexInterfaceFrozen()

 Returns true if the vertex interface is frozen. MetasoundVertexData.h  

void RemoveVertex ( const FVertexName& InVertexName
)

 Remove a vertex. VertexInterfaceData must be unfrozen. MetasoundVertexData.h  

void Set ( const FDataReferenceCollection& InCollection
)

 Set a data references to vertices with matching vertex names. MetasoundVertexData.h  

void SetDefaultLiteral ( const FVertexName& InVertexName,
const FLiteral& InLiteral
)

 Set the default literal used to create default values. MetasoundVertexData.h  

void SetIsVertexInterfaceFrozen ( bool bInIsVertexInterfaceFrozen
)

 Set whether the vertex interface is frozen or not. MetasoundVertexData.h  

void SetSubInterfaceValues ( const FName& InSubInterfaceName,
const FName& InVertexName,
const RangeType& InValues
)

 Bind the vertices of a sub interface vertex as value references MetasoundVertexData.h  

void SetValue ( const FVertexName& InVertexName,
const DataType& InValue
)

 Set the value of a vertex. MetasoundVertexData.h  

void SetVertex ( const FVertexName& InVertexName,
const FAnyDataReference& InDataReference
)

 Sets a vertex to use a data reference, ignoring any existing data bound to the vertex. MetasoundVertexData.h  

void SetVertex ( const FVertexName& InVertexName,
FAnyDataReference&& InDataReference
)

 Sets a vertex to use a data reference, ignoring any existing data bound to the vertex. MetasoundVertexData.h  

FDataReferenceCollection ToDataReferenceCollection()

 Convert vertex data to a data reference collection. MetasoundVertexData.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page