1. Epic GamesDeveloper
  3. TMeshAttributesRef

TMeshAttributesRef

This is the class used to access attribute values.

API > API/Runtime > API/Runtime/MeshDescription

References

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

Syntax

template<typename ElementIDType, typename AttributeType>  
class TMeshAttributesRef

Remarks

This is the class used to access attribute values. It is a proxy object to a TMeshAttributeArraySet<> and should be passed by value. It is valid for as long as the owning FMeshDescription exists.

This is the default implementation which handles simple attributes, i.e. those of a simple type T. There are partial specializations which handle compound attributes below, i.e. those accessed via TArrayView or TAttributeArray

Constructors

  Type Name Description
Public function  

TMeshAttributesRef ( const TMeshAttributesRef< ElementIDType, SrcAttributeType >& InRef
)

 Implicitly construct a TMeshAttributesRef-to-const from a regular one
Public function  

TMeshAttributesRef ( const TMeshAttributesRef< int32, AttributeType >& InRef
)

 Implicitly construct a TMeshAttributesRef from a TMeshAttributesArray
Public function  

TMeshAttributesRef ( const TMeshAttributesRef< int32, SrcAttributeType >& InRef
)

 Implicitly construct a TMeshAttributesRef-to-const from a TMeshAttributesArray
Public function  

TMeshAttributesRef ( BaseArrayType* InArrayPtr,
uint32 InExtent
)

 Constructor taking a pointer to a FMeshAttributeArraySetBase

Functions

  Type Name Description
Public function void

Copy ( TMeshAttributesRef< ElementIDType, const AttributeType > Src,
const int32 DestChannel,
const int32 SrcChannel
)

 Copies the given attribute array and channel to this channel
Public function Const AttributeType

Get ( int32 ElementIndex,
const int32 Channel
)

  
Public function Const AttributeType

Get ( const ElementIDType ElementID,
const int32 Channel
)

 Get the element with the given ID and channel
Public function Const TArrayView< AttributeType >

GetArrayView ( int32 ElementIndex,
const int32 Channel
)

  
Public function Const AttributeType Return default value for this attribute type
Public function Const uint32 Get the extent for this attribute type
Public function Const EMeshAttributeFlags Get the flags for this attribute array set
Public function Const int32 Return number of indices this attribute has
Public function Const int32 Get the number of elements in this attribute array
Public function Const TArrayView< AttributeType >

GetRawArray ( const int32 AttributeChannel
)

  
Public function Const void

InsertChannel ( const int32 Channel
)

 Inserts an attribute channel
Public function Const bool

IsValid ()

 Return whether the reference is valid or not
Public function Const void

RemoveChannel ( const int32 Channel
)

 Removes an attribute channel
Public function Const void

Set ( const ElementIDType ElementID,
const int32 Channel,
const AttributeType& Value
)

 Set the element with the given ID and channel to the provided value
Public function Const void

Set ( const ElementIDType ElementID,
const AttributeType& Value
)

 Set the element with the given ID and index 0 to the provided value
Public function Const void

Set ( int32 ElementIndex,
const AttributeType& Value
)

  
Public function Const void

Set ( int32 ElementIndex,
const int32 Channel,
const AttributeType& Value
)

  
Public function Const void

SetArrayView ( int32 ElementIndex,
const int32 Channel,
TArrayView< const AttributeType > Value
)

  
Public function Const void

SetArrayView ( int32 ElementIndex,
TArrayView< const AttributeType > Value
)

  
Public function Const void

SetNumChannels ( const int32 NumChannels
)

 Sets number of channels this attribute has

Operators

  Type Name Description
Public function Const AttributeType &

operator[] ( const ElementIDType ElementID
)

 Access elements from attribute channel 0
Public function Const AttributeType &

operator[] ( int32 ElementIndex
)

  

Typedefs

Name Description
ArrayType  
BaseArrayType  

Deprecated Functions

  Type Name Description
Public function Const int32 Please use GetNumChannels().
Public function Const void

InsertIndex ( const int32 Index
)

 Please use InsertChannel().
Public function Const void

RemoveIndex ( const int32 Index
)

 Please use RemoveChannel().
Public function Const void

SetNumIndices ( const int32 NumChannels
)

 Please use SetNumChannels().

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page