1. Epic GamesDeveloper
  3. FMeshElementContainer

FMeshElementContainer

Class representing a collection of mesh elements, such as vertices or triangles.

API > API/Runtime > API/Runtime/MeshDescription

Inheritance Hierarchy

References

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

Syntax

class FMeshElementContainer

Remarks

Class representing a collection of mesh elements, such as vertices or triangles. It has two purposes: 1) To generate new element IDs on demand, and recycle those which have been discarded. 2) To hold a map of attributes for a given element type and their values.

Variables

  Type Name Description
Protected variable FAttributesSetBase Attributes Attributes associated with this element container
Protected variable TBitArray BitArray A bit array of all indices currently in use
Protected variable int32 NumHoles A count of the number of unused indices in the bit array.

Constructors

  Type Name Description
Public function    
Public function    
Public function   Move constructor which ensures that NumHoles is set correctly in the moved object

Functions

  Type Name Description
Public function int32

Add ()

 Add a new element at the next available index, and return the new ID
Public function void

Compact ( TSparseArray< int32 >& OutIndexRemap
)

 Compacts elements and returns a remapping table
Public function Const int32 Returns the index after the last valid element
Public function Const const FAttributesSetBase &  
Public function FAttributesSetBase & Accessor for attributes
Public function Const FElementIDs Return iterable proxy object from container
Public function Const int32 Returns the first valid ID
Public function void

Insert ( const int32 Index
)

 Inserts a new element with the given index
Public function Const bool

IsValid ( const int32 Index
)

 Returns whether the given ID is valid or not
Public function Const int32

Num ()

 Returns the number of elements in the container
Public function void

Remap ( const TSparseArray< int32 >& IndexRemap
)

 Remaps elements according to the passed remapping table
Public function void

Remove ( const int32 Index
)

 Removes the element with the given ID
Public function void

Reserve ( const int32 Elements
)

 Reserves space for the specified total number of elements
Public function void

Reset ( const int32 Elements
)

 Resets the container, optionally reserving space for elements to be added

Operators

  Type Name Description
Public function FMeshElementContainer & Move assignment operator which ensures that NumHoles is set correctly in the moved object
Public function FMeshElementContainer &  

Classes

  Type Name Description
Public class FElementIDs This is a special type of iterator which returns successive IDs of valid elements, rather than the elements themselves.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page