1. Epic GamesDeveloper
  3. FOutputVertexInterfaceData

FOutputVertexInterfaceData

An output vertex interface with optionally bound data references.

API > API/Plugins > API/Plugins/MetasoundGraphCore

References

   
Module MetasoundGraphCore
Header /Engine/Plugins/Runtime/Metasound/Source/MetasoundGraphCore/Public/MetasoundVertexData.h
Include #include "MetasoundVertexData.h"

Syntax

class FOutputVertexInterfaceData

Remarks

An output vertex interface with optionally bound data references.

Constructors

  Type Name Description
Public function   Construct with an FOutputVertexInterface. This will default to a unfrozen vertex interface.
Public function  

FOutputVertexInterfaceData ( const FOutputVertexInterface& InVertexInterface
)

 Construct with an FOutputVertexInterface. This will default to a frozen vertex interface.

Functions

  Type Name Description
Public function void

AddVertex ( const FOutputDataVertex& InVertex
)

 Add a vertex. VertexInterfaceData must be unfrozen.
Public function Const bool Returns true if all vertices in the FInputVertexInterface are bound to data references.
Public function Const FRangedForConstIteratorType

begin ()

  
Public function FRangedForIteratorType

begin ()

  
Public function void

Bind ( const FOutputVertexInterfaceData& InOutOutputVertexData
)

 Bind vertex data using other vertex data. Slated for deprecation.
Public function void

Bind ( FOutputVertexInterfaceData& InOutOutputVertexData
)

 Bind vertex data using other vertex data.
Public function void

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

 Bind a read vertex from a value reference.
Public function void

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

 Bind a read vertex from a read reference. Slated for deprecation.
Public function void

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

 Bind a read vertex from a read reference.
Public function void

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

 Bind a read vertex from a write reference. Slated for deprecation.
Public function void

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

 Bind a read vertex from a write reference.
Public function void

BindValueVertex ( const FVertexName& InVertexName,
const TDataValueReference< DataType >& InOutDataReference
)

 Bind a value vertex from a value reference.
Public function void

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

 Bind a vertex with a any data reference. Slated for deprecation.
Public function void

BindVertex ( const FVertexName& InVertexName,
FAnyDataReference& InOutDataReference
)

 Bind a vertex with a any data reference.
Public function void

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

 Bind a write vertex from a write reference. Slated for deprecation.
Public function void

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

 Bind a write vertex from a write reference.
Public function FRangedForIteratorType

end ()

  
Public function Const FRangedForConstIteratorType

end ()

  
Public function Const const FAnyDataReference *

FindDataReference ( const FVertexName& InVertexName
)

 Find data reference bound to vertex. Returns a nullptr if no data reference is bound.
Public function Const TDataReadReference< DataType >

GetDataReadReference ( const FVertexName& InVertexName
)

 Get data read reference assuming data is bound and read or write accessible.
Public function Const TDataWriteReference< DataType >

GetDataWriteReference ( const FVertexName& InVertexName
)

 Get data write reference assuming data is bound and write accessible.
Public function Const TDataReadReference< DataType >

GetOrConstructDataReadReference ( const FVertexName& InVertexName,
ConstructorArgTypes&&... ConstructorArgs
)

 Get the bound data read reference if it exists.
Public function Const TDataWriteReference< DataType >

GetOrConstructDataWriteReference ( const FVertexName& InVertexName,
ConstructorArgTypes&&... ConstructorArgs
)

 Get the bound data write reference if it exists.
Public function Const const DataType *

GetValue ( const FVertexName& InVertexName
)

 Returns the current value of a vertex.
Public function Const const FOutputDataVertex &

GetVertex ( const FVertexName& InVertexName
)

 Return the vertex associated with the vertex name.
Public function Const EDataReferenceAccessType

GetVertexDataAccessType ( const FVertexName& InVertexName
)

 Returns the access type of a bound vertex.
Public function Const bool

IsVertexBound ( const FVertexName& InVertexName
)

 Returns true if a vertex with the given vertex name exists and is bound to a data reference.
Public function Const bool Returns true if the vertex interface is frozen.
Public function void

RemoveVertex ( const FVertexName& InVertexName
)

 Remove a vertex. VertexInterfaceData must be unfrozen.
Public function void

Set ( const FDataReferenceCollection& InCollection
)

 Bind a data references to vertices with matching vertex names.
Public function void

SetIsVertexInterfaceFrozen ( bool bInIsVertexInterfaceFrozen
)

 Set whether the vertex interface is frozen or not.
Public function void

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

 Set the value of a vertex.
Public function void

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

 Set a data reference to a vertex, ignoring any existing data bound to the vertex
Public function void

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

 Set a data reference to a vertex, ignoring any existing data bound to the vertex
Public function Const FDataReferenceCollection Converts the vertex data to a data reference collection.

Typedefs

Name Description
FOutputBinding  
FRangedForConstIteratorType  
FRangedForIteratorType  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page