TAttributesSet

This is a version of the attributes set container which accesses elements by typesafe IDs.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FAttributesSetBase

TAttributesSet

References

Module

MeshDescription

Header

/Engine/Source/Runtime/MeshDescription/Public/MeshAttributeArray.h

Include

#include "MeshAttributeArray.h"

Syntax

template<typename ElementIDType>
class TAttributesSet : public FAttributesSetBase

Remarks

This is a version of the attributes set container which accesses elements by typesafe IDs. This prevents access of (for example) vertex instance attributes by vertex IDs.

Functions

Name Description

Public function Const

void

 

ForEach

(
    ForEachFunc Func
)

Call the supplied function on each attribute.

Public function

void

 

ForEach

(
    ForEachFunc Func
)

Call the supplied function on each attribute.

Public function

void

 

ForEachByType

(
    ForEachFunc Func
)

Call the supplied function on each attribute that matches the given type.

Public function Const

void

 

ForEachByType

(
    ForEachFunc Func
)

Call the supplied function on each attribute that matches the given type.

Public function Const

T

 

GetAttribute

(
    const ElementIDType ElementID,
    const FName AttributeName,
    const int32 AttributeChannel
)

Get an attribute value for the given element ID.

Public function Const

int32

 

GetAttributeChannelCount

(
    const FName AttributeName
)

Returns the number of indices for the attribute with the given name

Public function

TMeshAttribu...

 

GetAttributesRef

(
    const FName AttributeName
)

Non-const version.

Public function Const

TMeshAttribu...

 

GetAttributesRef

(
    const FName AttributeName
)

Get an attribute array with the given type and name.

Public function

void

 

Insert

(
    const ElementIDType ElementID
)

Inserts a default-initialized value for all attributes of the given ID

Public function

void

 

InsertAttributeChannel

(
    const FName AttributeName,
    const int32 Index
)

Insert a new index for the attribute with the given name

Public function

void

 

Remove

(
    const ElementIDType ElementID
)

Removes all attributes with the given ID

Public function

void

 

RemoveAttributeChannel

(
    const FName AttributeName,
    const int32 Index
)

Remove an existing index from the attribute with the given name

Public function

void

 

SetAttribute

(
    const ElementIDType ElementID,
    const FName AttributeName,
    const int32 AttributeChannel,
    const T& AttributeValue
)

Set an attribute value for the given element ID.

Public function

void

 

SetAttributeChannelCount

(
    const FName AttributeName,
    const int32 NumChannels
)

Sets the number of indices for the attribute with the given name

Deprecated Functions

Name Description

Public function Const

int32

 

GetAttributeIndexCount

(
    const FName AttributeName
)

Please use GetAttributeChannelCount() instead.

Public function Const

int32

 

GetAttributeIndexCount

(
    const FName AttributeName
)

Please use GetAttributeChannelCount() instead.

Public function

void

 

InsertAttributeIndex

(
    const FName AttributeName,
    const int32 Index
)

Please use untemplated InsertAttributeIndexCount() instead.

Public function

void

 

InsertAttributeIndex

(
    const FName AttributeName,
    const int32 Index
)

Please use InsertAttributeChannel() instead.

Public function

void

 

RemoveAttributeIndex

(
    const FName AttributeName,
    const int32 Index
)

Please use RemoveAttributeChannel() instead.

Public function

void

 

RemoveAttributeIndex

(
    const FName AttributeName,
    const int32 Index
)

Please use untemplated RemoveAttributeIndexCount() instead.

Public function

void

 

SetAttributeIndexCount

(
    const FName AttributeName,
    const int32 NumChannels
)

Please use SetAttributeChannelCount() instead.

Public function

void

 

SetAttributeIndexCount

(
    const FName AttributeName,
    const int32 NumIndices
)

Please use untemplated SetAttributeChannelCount() instead.