1. Epic GamesDeveloper
  3. Mesh

Mesh

[Mesh](API\Plugins\MutableRuntime\MuR\Mesh) object containing any number of buffers with any number of channels. The buffers can be per-index or per-vertex. The mesh also includes layout information for every texture channel for internal usage, and it can be ignored. The meshes are always assumed to be triangle list primitives.

API > API/Plugins > API/Plugins/MutableRuntime > API/Plugins/MutableRuntime/MuR

Inheritance Hierarchy

References

   
Module MutableRuntime
Header /Engine/Plugins/Mutable/Source/MutableRuntime/Public/MuR/Mesh.h
Include #include "MuR/Mesh.h"

Syntax

class Mesh : public mu::Resource

Remarks

Mesh object containing any number of buffers with any number of channels. The buffers can be per-index or per-vertex. The mesh also includes layout information for every texture channel for internal usage, and it can be ignored. The meshes are always assumed to be triangle list primitives.

Variables

  Type Name Description
Public variable TArray< TPair< EMeshBufferType, FMeshBufferSet > > AdditionalBuffers Additional buffers used for temporary or custom data in different algorithms.
Public variable TArray< Ptr< const mu::PhysicsBody > > AdditionalPhysicsBodies Additional physics bodies referenced by the mesh that don't merge.
Public variable TArray< FBoneName > BoneMap Array containing the bonemaps of all surfaces in the mesh.
Public variable TMemoryTrackedArray< FBonePose > BonePoses This is the pose used by this mesh fragment, used to update the transforms of the final skeleton taking into consideration the meshes being used.
Public variable EMeshFlags Flags This is bit - mask on the EMeshFlags enumeration, marking what static formats are compatible with this one and other properties.
Public variable FMeshBufferSet IndexBuffers  
Public variable uint32 InternalId Non-persistent internal id unique for a mesh generated for a specific state and parameter values.
Public variable TArray< Ptr< const Layout > > Layouts Texture Layout blocks attached to this mesh.
Public variable uint32 MeshIDPrefix Prefix for the unique IDs related to this mesh (vertices and layout blocks).
Public variable Ptr< const PhysicsBody > PhysicsBody  
Public variable uint32 ReferenceID Only valid if the right flags are set, this identifies a referenced mesh.
Public variable Ptr< const Skeleton > Skeleton This skeleton and physics body are not owned and may be used by other meshes, so it cannot be modified once the mesh has been fully created.
Public variable TArray< uint32 > SkeletonIDs Externally provided SkeletonIDs of the skeletons required by this mesh.
Public variable TArray< uint64 > StreamedResources Opaque handle to external resources.
Public variable TArray< FMeshSurface > Surfaces  
Public variable TArray< FString > Tags  
Public variable FMeshBufferSet VertexBuffers  

Destructors

  Type Name Description
Protected function  

~Mesh ()

 Forbidden. Manage with the Ptr<> template.

Functions

  Type Name Description
Public function int32  
Public function void

AddLayout ( Ptr< const Layout > pLayout
)

  
Public function void

AddSkeletonID ( int32 SkeletonID
)

  
Public function void

AddStreamedResource ( uint64 ResourceId
)

  
Public function Const bool  
Public function Const bool Return true if the mesh has unique vertex IDs and they stored in an implicit way.
Public function Const void Check mesh buffer data for possible inconsistencies
Public function Const Ptr< Mesh >

Clone ( EMeshCopyFlags Flags
)

 Clone with flags allowing to not include some parts in the cloned mesh
Public function Const Ptr< Mesh >

Clone ()

 Deep clone this mesh.
Public function void

CopyFrom ( const Mesh& From,
EMeshCopyFlags Flags
)

 Copy form another mesh.
Public function Static Ptr< Mesh >

CreateAsReference ( uint32 ID,
bool bForceLoad
)

 Life cycle.
Public function void Create the surface data if not present.
Public function Const int32

FindBonePose ( const FBoneName& BoneName
)

  
Public function Const Ptr< const PhysicsBody >  
Public function Const const TArray< FBoneName > & Return an array containing the bonemaps of all surfaces in the mesh.
Public function Const int32  
Public function Const const FBoneName &

GetBonePoseId ( int32 BoneIndex
)

  
Public function Const void

GetBonePoseTransform ( int32 BoneIndex,
FTransform3f& Transform
)

 Return a matrix stored per bone. It is a set of 16-float values.
Public function Const EBoneUsageFlags

GetBoneUsageFlags ( int32 BoneIndex
)

  
Public function Const int32  
Public function Const UE::Math::TIntVector3< uint32 >

GetFaceVertexIndices ( int32 f
)

 Compare the vertex attributes to check if they match.
Public function Const uint32

GetId ()

 Get an internal identifier used to reference this mesh in operations like deferred mesh building, or instance updating.
Public function Const const FMeshBufferSet &  
Public function FMeshBufferSet & Index buffers. They are owned by this mesh.
Public function Const int32  
Public function Const const Layout *

GetLayout ( int32 i
)

  
Public function Const int32  
Public function Const Ptr< const PhysicsBody >  
Public function Const uint32 Return the id of the engine referenced mesh. Only valid if IsReference.
Public function Const Ptr< const Skeleton >  
Public function Const int32

GetSkeletonID ( int32 SkeletonIndex
)

  
Public function Const int32  
Public function Const const TArray< uint64 > &  
Public function Const void

GetSurface ( int32 SurfaceIndex,
int32& OutFirstVertex,
int32& OutVertexCount,
int32& OutFirstIndex,
int32& OutIndexCount,
int32& OutFirstBone,
int32& OutBoneCount
)

  
Public function Const int32 Get the number of surfaces defined in this mesh.
Public function Const uint32

GetSurfaceId ( int32 SurfaceIndex
)

 Return an internal id that can be used to match mesh surfaces and instance surfaces.
Public function Const const FString &

GetTag ( int32 tagIndex
)

  
Public function Const int32  
Public function FMeshBufferSet & Vertex buffers. They are owned by this mesh.
Public function Const const FMeshBufferSet &  
Public function Const int32  
Public function Const void

GetVertexMap ( const Mesh& Other,
FVertexMatchMap& VertexMap,
float Tolerance
)

  
Public function Const bool

HasCompatibleFormat ( const Mesh* Other
)

 Return true if the given mesh has the same vertex and index formats, and in the same buffer structure.
Public function Const bool If true, this is a reference that must be resolved at compile time.
Public function Const bool Return true if this is a reference to an engine image.
Public function Const bool

IsSimilar ( const Mesh& Other,
bool bCompareLayouts
)

 Compare the mesh with another one, but ignore internal data like generated vertex indices.
Public function void

Log ( FString& Out,
int32 VertrexLimit
)

 Debug: get a text representation of the mesh
Public function void Ensure the format of an empty mesh includes explicit IDs. The mesh cannot have any vertex data.
Public function void Create an explicit vertex buffer for vertex IDs if they are implicit.
Public function void Change the buffer descriptions so that all buffer indices start at 0 and are in the same order than memory.
Public function Const void Update the flags identifying the mesh format as some of the optimised formats.
Public function Const void  
Public function Static void

Serialise ( const Mesh* InMesh,
OutputArchive& Arch
)

 Serialisation
Public function void

SetBoneMap ( const TArray< FBoneName >& InBoneMap
)

 Set the bonemap of this mesh.
Public function void

SetBonePose ( int32 Index,
const FBoneName& BoneName,
FTransform3f Transform,
EBoneUsageFlags BoneUsageFlags
)

  
Public function void

SetBonePoseCount ( int32 count
)

  
Public function void

SetLayout ( int32 i,
Ptr< const Layout >
)

  
Public function void  
Public function void

SetSkeleton ( Ptr< const Skeleton >
)

  
Public function void

SetTag ( int32 tagIndex,
const FString& Name
)

  
Public function void

SetTagCount ( int32 count
)

  
Public function Static Ptr< Mesh >  
Public function void  

Overridden from Resource

  Type Name Description
Public function Virtual Const int32 Return the size in bytes of all the LODs of the image.

Operators

  Type Name Description
Public function Const bool

operator== ( const Mesh& o
)

  

Classes

  Type Name Description
Public struct FBonePose    
Public struct FVertexMatchMap Make a map from the vertices in this mesh to thefirst matching vertex of the given mesh.  

Typedefs

Name Description
TMemoryTrackedArray  

Constants

Name Description
InvalidVertexId  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page