1. Epic GamesDeveloper
  3. FAttributesSetBase

FAttributesSetBase

This is the container for all attributes and their arrays.

API > API/Runtime > API/Runtime/MeshDescription

Inheritance Hierarchy

References

   
Module MeshDescription
Header /Engine/Source/Runtime/MeshDescription/Public/MeshAttributeArray.h
Include #include "MeshAttributeArray.h"

Syntax

class FAttributesSetBase

Remarks

This is the container for all attributes and their arrays. It wraps a TMap, mapping from attribute name to attribute array. An attribute may be of any arbitrary type; we use a mixture of polymorphism and compile-time templates to handle the different types.

Variables

  Type Name Description
Protected variable TMap< FName, FAttributesSetEntry > Map The actual container
Protected variable int32 NumElements The number of elements in each attribute array

Constructors

  Type Name Description
Public function   Constructor

Functions

  Type Name Description
Public function void

AppendAttributesFrom ( const FAttributesSetBase& OtherAttributesSet
)

  
Public function Const bool

DoesAttributeHaveAllFlags ( const FName AttributeName,
EMeshAttributeFlags AttributeFlags
)

 Determine whether an attribute has all of the given flags
Public function Const bool

DoesAttributeHaveAnyFlags ( const FName AttributeName,
EMeshAttributeFlags AttributeFlags
)

 Determine whether an attribute has any of the given flags
Public function Const void

GetAttributeNames ( TArray< FName, Allocator >& OutAttributeNames
)

 Returns an array of all the attribute names registered
Public function TMeshAttributesRef< int32, typename TMeshAttributesRefType< T >::RefType >

GetAttributesRef ( const FName AttributeName
)

  
Public function Const TMeshAttributesConstRef< int32, typename TMeshAttributesRefType< T >::ConstRefType >

GetAttributesRef ( const FName AttributeName
)

 Get an attribute array with the given type and name.
Public function Const uint32

GetHash ( const FName AttributeName
)

  
Public function Const int32 Gets the number of elements in the attribute set
Public function Const bool

HasAttribute ( const FName AttributeName
)

 Determines whether an attribute exists with the given name
Public function Const bool

HasAttributeOfType ( const FName AttributeName
)

 Determines whether an attribute of the given type exists with the given name
Public function void

Initialize ( const int32 Count
)

 Initializes all attributes to have the given number of elements with the default value
Public function void

Insert ( const int32 Index
)

 Insert a new element at the given index.
Public function TMeshAttributesArray< typename TMeshAttributesRegisterType< T >::RefType >

RegisterAttribute ( const FName AttributeName,
const int32 NumberOfChannels,
const T& Default,
const EMeshAttributeFlags Flags
)

 Register a new simple attribute.
Public function TMeshAttributesArray< typename TMeshAttributesRegisterType< T >::RefType >

RegisterAttribute ( const FName AttributeName,
const int32 NumberOfChannels,
const typename TMeshAttributesRegisterType< T >::RealAttributeType& Default,
const EMeshAttributeFlags Flags
)

 Register a new fixed array attribute.
Public function TMeshAttributesArray< typename TMeshAttributesRegisterType< T >::RefType >

RegisterAttributeInternal ( const FName AttributeName,
const int32 NumberOfChannels,
const typename TMeshAttributesRegisterType< T >::RealAttributeType& Default,
const EMeshAttributeFlags Flags
)

 Register a new attribute name with the given type (must be a member of the AttributeTypes tuple).
Public function TMeshAttributesArray< typename TMeshAttributesRegisterType< T >::RefType >

RegisterIndexAttribute ( const FName AttributeName,
const int32 NumberOfChannels,
const EMeshAttributeFlags Flags
)

 Register a new unbounded array attribute.
Public function void

Remap ( const TSparseArray< int32 >& IndexRemap
)

 Applies the given remapping to the attributes set
Public function void

Remove ( const int32 Index
)

 Remove an element at the given index.
Public function void

SetNumElements ( const int32 Count
)

 Sets all attributes to have the given number of elements, preserving existing values and filling extra elements with the default value
Public function void

UnregisterAttribute ( const FName AttributeName
)

 Unregister an attribute with the given name.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page