Choose your operating system:
Windows
macOS
Linux
| UObjectBase
|
Module |
|
Header |
/Engine/Source/Runtime/Engine/Classes/Engine/StaticMesh.h |
Include |
#include "Engine/StaticMesh.h" |
class UStaticMesh :
public UStreamableRenderAsset,
public IInterface_CollisionDataProvider,
public IInterface_AssetUserData,
public IInterface_AsyncCompilation
A StaticMesh is a piece of geometry that consists of a static set of polygons. Static Meshes can be translated, rotated, and scaled, but they cannot have their vertices animated in any way. As such, they are more efficient to render than other types of geometry such as USkeletalMesh, and they are often the basic building block of levels created in the engine.
Name | Description | ||
---|---|---|---|
|
TObjectPtr< cla... |
AssetImportData |
Importing data and options used for this mesh |
|
AssetUserData |
Array of user data stored with the asset |
|
|
TUniquePtr< FSt... |
AsyncTask |
|
|
uint8: 1 |
bAllowCPUAccess |
If true, will keep geometry data CPU-accessible in cooked builds, rather than uploading to GPU memory and releasing it from CPU memory. |
|
uint8: 1 |
bAutoComputeLODScreenSize |
If true, the screen sizees at which LODs swap are computed automatically. |
|
bCustomizedCollision |
If the user has modified collision in any way or has custom collision imported. |
|
|
uint8: 1 |
bDoFastBuild |
|
|
uint8: 1 |
bGenerateMeshDistanceField |
Whether to generate a distance field for this mesh, which can be used by DistanceField Indirect Shadows. |
|
uint8: 1 |
bHasNavigationData |
If true, mesh will have NavCollision property with additional data for navmesh generation and usage. |
|
uint8: 1 |
bRenderingResourcesInitialized |
Tracks whether InitResources has been called, and rendering resources are initialized. |
|
uint8: 1 |
bRequiresLODDistanceConversion |
If true on post load we need to calculate Display Factors from the loaded LOD distances. |
|
uint8: 1 |
bRequiresLODScreenSizeConversion |
If true on post load we need to calculate resolution independent Display Factors from the loaded LOD screen sizes. |
|
uint8: 1 |
bSupportGpuUniformlyDistributedSampling |
If true, a GPU buffer containing required data for uniform mesh surface sampling will be created at load time. |
|
uint8: 1 |
bSupportPhysicalMaterialMasks |
If true, complex collision data will store UVs and face remap table for use when performing PhysicalMaterialMask lookups in cooked builds. |
|
uint8: 1 |
bSupportRayTracing |
If true, a ray tracing acceleration structure will be built for this mesh and it may be used in ray tracing effects |
|
uint8: 1 |
bSupportUniformlyDistributedSampling |
Mesh supports uniformly distributed sampling in constant time. |
|
BuildCacheAutomationTestGuid |
This transient guid is use by the automation framework to modify the DDC key to force a build. |
|
|
TObjectPtr< cla... |
ComplexCollisionMesh |
|
|
float |
DistanceFieldSelfShadowBias |
Useful for reducing self shadowing from distance field methods when using world position offset to animate the mesh's vertices. |
|
EditorCameraPosition |
The stored camera position to use as a default for the static mesh editor |
|
|
ElementToIgnoreForTexFactor |
Index of an element to ignore while gathering streaming texture factors. |
|
|
ImportVersion |
The last import version |
|
|
LODForCollision |
Specifies which mesh LOD to use for complex (per-poly) collision. |
|
|
LODGroup |
The LOD group to which this mesh belongs. |
|
|
MaterialRemapIndexPerImportVersion |
||
|
MinQualityLevelLOD |
PerQuality override. |
|
|
NaniteSettings |
Settings related to building Nanite data. |
|
|
NumStreamedLODs |
If non-negative, specify the maximum number of streamed LODs. |
|
|
OnExtendedBoundsChanged |
||
|
OnMeshChanged |
||
|
ReleaseResourcesFence |
A fence which is used to keep track of the rendering thread releasing the static mesh resources. |
|
|
Sockets |
Array of named socket locations, set up in editor and used as a shortcut instead of specifying everything explicitly to AttachComponent in the StaticMeshComponent. |
|
|
TSharedPtr< cla... |
SpeedTreeWind |
Data that is only available if this static mesh is an imported SpeedTree |
|
TObjectPtr< cla... |
ThumbnailInfo |
Information for thumbnail rendering |
Name | Description | |
---|---|---|
|
UStaticMesh ( |
|
|
UStaticMesh ( |
Default constructor |
Name | Description | |
---|---|---|
|
~UStaticMesh() |
Name | Description | ||
---|---|---|---|
|
AddMaterial ( |
Adds a new material and return its slot name |
|
|
AddSocket ( |
Add a socket object in this StaticMesh. |
|
|
FStaticMeshS... |
AddSourceModel() |
SourceModels API. |
|
AddUVChannel ( |
Adds an empty UV channel at the end of the existing channels on the given LOD of a StaticMesh. |
|
|
AreRenderingResourcesInitialized() |
||
|
BatchBuild |
Rebuilds renderable data for a batch of static meshes. |
|
|
BroadcastNavCollisionChange() |
||
|
Build |
Rebuilds renderable data for this static mesh, automatically made async if enabled. |
|
|
BuildFromMeshDescription ( |
Builds a LOD resource from a MeshDescription |
|
|
BuildFromMeshDescriptions ( |
Builds static mesh render buffers from a list of MeshDescriptions, one per LOD. |
|
|
BuildFromStaticMeshDescriptions ( |
Builds static mesh LODs from the array of StaticMeshDescriptions passed in |
|
|
CacheDerivedData() |
Caches derived renderable data. |
|
|
CalculateExtendedBounds() |
Calculates the extended bounds |
|
|
CancelAllPendingStreamingActions() |
Cancels any pending static mesh streaming actions if possible. |
|
|
CanLODsShareStaticLighting() |
Returns true if LODs of this static mesh may share texture lightmaps. |
|
|
CheckLightMapUVs |
Static: Processes the specified static mesh for light map UV problems |
|
|
ClearHiResMeshDescription() |
||
|
ClearMeshDescription ( |
Clears the cached mesh description for the given LOD. that this does not empty the bulk data. |
|
|
ClearMeshDescriptions() |
Clears cached mesh descriptions for all LODs. |
|
|
CloneHiResMeshDescription ( |
||
|
CloneMeshDescription ( |
Clone the MeshDescription associated to the LODIndex. |
|
|
CommitHiResMeshDescription ( |
||
|
CommitMeshDescription ( |
Serialize the mesh description into its more optimized form. |
|
|
CreateBodySetup() |
Create BodySetup for this staticmesh if it doesn't have one Create BodySetup for this staticmesh |
|
|
FMeshDescrip... |
CreateHiResMeshDescription ( |
|
|
FMeshDescrip... |
CreateHiResMeshDescription() |
|
|
FMeshDescrip... |
CreateMeshDescription ( |
|
|
FMeshDescrip... |
CreateMeshDescription ( |
|
|
CreateNavCollision ( |
Calculates navigation collision for caching |
|
|
UStaticMeshD... |
CreateStaticMeshDescription ( |
Create an empty StaticMeshDescription object, to describe a static mesh at runtime |
|
EnforceLightmapRestrictions ( |
Make sure the Lightmap UV point on a valid UVChannel |
|
|
UStaticMeshS... |
FindSocket ( |
Find a socket object in this StaticMesh by name. |
|
GenerateLodsInPackage() |
||
|
UAssetImport... |
GetAssetImportData() |
Get AssetImportData for the static mesh |
|
UBodySetup &... |
GetBodySetup() |
|
|
GetBodySetupName() |
||
|
GetBoundingBox() |
Returns the bounding box, in local space including bounds extension(s), of the StaticMesh asset |
|
|
FBoxSphereBo... |
GetBounds() |
Returns the number of bounds of the mesh. |
|
GetDefaultMinLOD() |
||
|
GetEnableLODStreaming ( |
Get whether this mesh should use LOD streaming for the given platform. |
|
|
const FBoxSp... |
GetExtendedBounds() |
|
|
FMeshDescrip... |
GetHiResMeshDescription() |
|
|
const FStati... |
GetHiResSourceModel() |
|
|
FStaticMeshS... |
GetHiResSourceModel() |
|
|
const FGuid ... |
GetLightingGuid() |
|
|
GetLightMapCoordinateIndex() |
||
|
GetLightMapCoordinateIndexName() |
||
|
GetLightMapResolution() |
||
|
GetLightMapResolutionName() |
||
|
float |
GetLightmapUVDensity() |
|
|
GetLightmapUVVersion() |
||
|
const FStati... |
GetLODForExport ( |
Returns the render data to use for exporting the specified LOD. |
|
GetLODGroups |
Retrieves the names of all LOD groups. |
|
|
GetLODGroupsDisplayNames |
Retrieves the localized display names of all LOD groups. |
|
|
UMaterialInt... |
GetMaterial ( |
Gets a Material given a Material Index and an LOD number |
|
GetMaterialBox ( |
Returns the material bounding box. Computed from all lod-section using the material index. |
|
|
GetMaterialIndex ( |
Gets a Material index given a slot name |
|
|
GetMaterialIndexFromImportedMaterialSlotName ( |
||
|
FMeshDescrip... |
GetMeshDescription ( |
Return the MeshDescription associate to the LODIndex. |
|
GetMinimumLODForPlatform ( |
||
|
GetMinimumLODForPlatforms |
||
|
GetMinimumLODForQualityLevel ( |
||
|
GetMinimumLODForQualityLevels |
||
|
const FPerPl... |
GetMinLOD() |
|
|
GetMinLODIdx() |
Choose either PerPlatform or PerQuality override. |
|
|
GetMipDataPackagePath ( |
||
|
UNavCollisio... |
GetNavCollision() |
|
|
const FVecto... |
GetNegativeBoundsExtension() |
|
|
GetNegativeBoundsExtensionName() |
||
|
GetNumLODs() |
Returns the number of LODs used by the mesh. |
|
|
GetNumNaniteTriangles() |
Returns the number of triangles of the Nanite representation of this mesh. |
|
|
GetNumNaniteVertices() |
Returns the number of vertices of the Nanite representation of this mesh. |
|
|
GetNumSections ( |
Returns number of Sections that this StaticMesh has, in the supplied LOD (LOD 0 is the highest) |
|
|
GetNumSectionsWithCollision() |
Return the number of sections of the StaticMesh with collision enabled |
|
|
GetNumSourceModels() |
||
|
GetNumTexCoords ( |
Returns the number of tex coords for the specified LOD. |
|
|
GetNumTriangles ( |
Returns the number of triangles for the specified LOD. |
|
|
GetNumUVChannels ( |
Returns the number of UV channels for the given LOD of a StaticMesh. |
|
|
GetNumVertices ( |
Returns the number of vertices for the specified LOD. |
|
|
FOnExtendedB... |
GetOnExtendedBoundsChanged() |
|
|
FOnMeshChang... |
GetOnMeshChanged() |
|
|
const FMeshS... |
GetOriginalSectionInfoMap() |
|
|
FMeshSection... |
GetOriginalSectionInfoMap() |
|
|
FStaticMeshR... |
GetPlatformStaticMeshRenderData ( |
Get a static mesh render data for requested platform. |
|
const FVecto... |
GetPositiveBoundsExtension() |
|
|
GetPositiveBoundsExtensionName() |
||
|
const FPerQu... |
GetQualityLevelMinLOD() |
|
|
FMeshReducti... |
GetReductionSettings ( |
Get a copy of the reduction settings for a specified LOD index. |
|
FStaticMeshR... |
GetRenderData() |
|
|
const FStati... |
GetRenderData() |
|
|
FMeshSection... |
GetSectionInfoMap() |
|
|
const FMeshS... |
GetSectionInfoMap() |
|
|
GetSectionInfoMapName() |
||
|
FStaticMeshS... |
GetSourceModel ( |
|
|
const FStati... |
GetSourceModel ( |
|
|
const TArray... |
GetSourceModels() |
|
|
GetStaticMaterials() |
||
|
const TArray... |
GetStaticMaterials() |
|
|
GetStaticMaterialsName() |
||
|
UStaticMeshD... |
GetStaticMeshDescription ( |
Return a new StaticMeshDescription referencing the MeshDescription of the given LOD |
|
const FMeshU... |
GetUVChannelData ( |
Returns the UV channel data for a given material index. |
|
GetVertexColorData |
Returns vertex color data by position. |
|
|
HasValidNaniteData() |
Returns true if thee mesh has valid Nanite render data. |
|
|
HasValidRenderData |
Returns true if the mesh has data that can be rendered. |
|
|
InitResources() |
Initialize the static mesh's render resources. Initializes the static mesh's render resources. |
|
|
InsertUVChannel |
Inserts an empty UV channel at the specified channel index on the given LOD of a StaticMesh. |
|
|
IsAsyncTaskComplete() |
||
|
IsHiResMeshDescriptionValid() |
||
|
IsMeshDescriptionValid ( |
||
|
IsMinLodQualityLevelEnable() |
Check the QualitLevel property is enabled for MinLod. |
|
|
IsNavigationRelevant() |
||
|
IsReductionActive ( |
Return true if the reduction settings are setup to reduce a LOD |
|
|
IsSourceModelValid ( |
||
|
LoadHiResMeshDescription ( |
||
|
MarkAsNotHavingNavigationData() |
Configures this SM as bHasNavigationData = false and clears stored NavCollision |
|
|
ModifyAllMeshDescriptions ( |
Performs a Modify on StaticMeshDescription objects for all LODs |
|
|
ModifyHiResMeshDescription ( |
Performs a Modify on the hi-res StaticMeshDescription |
|
|
ModifyMeshDescription |
Performs a Modify on the StaticMeshDescription object pertaining to the given LODIndex |
|
|
FStaticMeshS... |
MoveHiResSourceModel() |
|
|
MoveSourceModels() |
||
|
OnLodStrippingQualityLevelChanged ( |
||
|
FOnPostMeshB... |
OnPostMeshBuild() |
Get multicast delegate broadcast after mesh building |
|
FOnPreMeshBu... |
OnPreMeshBuild() |
Get multicast delegate broadcast prior to mesh building |
|
PrepareDerivedDataForActiveTargetPlatforms() |
Caches derived renderable for cooked platforms currently active. |
|
|
ReleaseResources() |
Releases the static mesh's render resources. |
|
|
RemoveSocket ( |
Remove a socket object in this StaticMesh by providing it's pointer. |
|
|
RemoveSourceModel ( |
||
|
RemoveUVChannel |
Removes the UV channel at the specified channel index on the given LOD of a StaticMesh. |
|
|
RemoveVertexColors() |
Removes all vertex colors from this mesh and rebuilds it (Editor only |
|
|
RequestUpdateCachedRenderState() |
||
|
SetAssetImportData ( |
Set AssetImportData for the static mesh |
|
|
SetBodySetup ( |
||
|
SetExtendedBounds ( |
||
|
SetHiResSourceModel ( |
||
|
SetLightingGuid ( |
||
|
SetLightMapCoordinateIndex ( |
||
|
SetLightMapResolution ( |
||
|
SetLightmapUVDensity ( |
||
|
SetLODGroup |
||
|
SetMaterial ( |
Sets a Material given a Material Index |
|
|
SetMinimumLODForPlatform |
||
|
SetMinimumLODForPlatforms |
||
|
SetMinLOD ( |
||
|
SetMinLODIdx ( |
||
|
SetNavCollision |
||
|
SetNegativeBoundsExtension ( |
||
|
SetNumSourceModels ( |
||
|
SetPositiveBoundsExtension ( |
||
|
SetQualityLevelMinLOD ( |
||
|
SetRenderData ( |
||
|
SetSourceModels ( |
||
|
SetStaticMaterials ( |
||
|
SetUVChannel ( |
Sets the texture coordinates at the specified UV channel index on the given LOD of a StaticMesh. |
|
|
SetVertexColorData |
Sets vertex color data by position. |
|
|
TryCancelAsyncTasks() |
Try to cancel any pending async tasks. |
|
|
UpdateUVChannelData ( |
Update missing material UV channel data used for texture streaming. |
Name | Description | ||
---|---|---|---|
|
CalcCumulativeLODSize ( |
||
|
DoesMipDataExist ( |
||
|
FIoFilenameH... |
GetMipIoFilenameHash ( |
|
|
EStreamableR... |
GetRenderAssetType() |
|
|
HasPendingRenderResourceInitialization() |
Also returns false if the render resource is non existent, to prevent stalling on an event that will never complete. |
|
|
StreamIn |
Loads mips from disk to memory. Only usable if the asset is streamable. |
|
|
StreamOut ( |
Unload some mips from memory. Only usable if the asset is streamable. |
Name | Description | ||
---|---|---|---|
|
BeginCacheForCookedPlatformData ( |
Starts caching of platform specific data for the target platform Called when cooking before serialization so that object can prepare platform specific data Not called during normal loading of objects |
|
|
BeginDestroy() |
Called before destroying the object. |
|
|
ClearAllCachedCookedPlatformData() |
Clear all cached cooked platform data |
|
|
ClearCachedCookedPlatformData ( |
Clears cached cooked platform data for specific platform |
|
|
GetAssetRegistryTagMetadata ( |
Gathers a collection of asset registry tag metadata |
|
|
GetAssetRegistryTags ( |
Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects |
|
|
GetDesc() |
Returns a one line description of an object for viewing in the thumbnail view of the generic browser |
|
|
GetResourceSizeEx ( |
Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific). |
|
|
IsCachedCookedPlatformDataLoaded ( |
Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData |
|
|
IsPostLoadThreadSafe() |
Called during async load to determine if PostLoad can be called on the loading thread. |
|
|
IsReadyForFinishDestroy() |
Called to check if the object is ready for FinishDestroy. |
|
|
PostDuplicate ( |
Called after duplication & serialization and before PostLoad. |
|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
PostEditUndo() |
Called after applying a transaction to the object. |
|
|
PostInitProperties() |
Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
|
|
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
|
PreEditChange ( |
This is called when a property is about to be modified externally |
|
|
Serialize ( |
||
|
WillNeverCacheCookedPlatformDataAgain() |
All caching has finished for this object (all IsCachedCookedPlatformDataLoaded functions have finished for all platforms) |
Name | Description | ||
---|---|---|---|
|
CanBeClusterRoot() |
Called after load to determine if the object can be a cluster root |
Name | Description | ||
---|---|---|---|
|
ContainsPhysicsTriMeshData ( |
Interface for checking if the implementing objects contains triangle mesh collision data |
|
|
GetMeshId ( |
An optional string identifying the mesh data. |
|
|
GetPhysicsTriMeshData ( |
Interface for retrieving triangle mesh collision data from the implementing object |
|
|
PollAsyncPhysicsTriMeshData ( |
Poll for availability of asynchronously-populated triangle mesh collision data |
|
|
WantsNegXTriMesh() |
Do we want to create a negative version of this mesh |
Name | Description | ||
---|---|---|---|
|
AddAssetUserData ( |
||
|
const TArray... |
GetAssetUserDataArray() |
|
|
UAssetUserDa... |
GetAssetUserDataOfClass ( |
|
|
RemoveUserDataOfClass ( |
Name | Description | ||
---|---|---|---|
|
IsCompiling() |
Returns whether or not the asset is currently being compiled |
Name |
Description |
|
---|---|---|
|
FBuildMeshDescriptionsLODParams |
|
|
FBuildMeshDescriptionsParams |
Structure that defines parameters passed into the build mesh description function |
|
FCommitMeshDescriptionParams |
Structure that defines parameters passed into the commit mesh description function |
Name |
Description |
---|---|
FOnExtendedBoundsChanged |
Notification when bounds changed |
FOnMeshChanged |
Notification when anything changed |
Name |
Description |
---|---|
MinimumAutoLODPixelError |
Name | Description | ||
---|---|---|---|
|
uint8: 1 |
bStripComplexCollisionForConsole_DEPRECATED |
If true, strips unwanted complex collision data aka kDOP tree when cooking for consoles. |
|
TObjectPtr< cla... |
EditableMesh_DEPRECATED |
|
|
ExtendedBounds |
This must be protected for async build, always use the accessors even internally. |
|
|
LightMapCoordinateIndex |
Please do not access this member directly; use UStaticMesh::GetLightMapCoordinateIndex() or UStaticMesh::SetLightMapCoordinateIndex(). |
|
|
LightMapResolution |
Please do not access this member directly; use UStaticMesh::GetLightMapResolution() or UStaticMesh::SetLightMapResolution(). |
|
|
Materials_DEPRECATED |
Materials used by this static mesh. Individual sections index in to this array. |
|
|
MinLOD |
Please do not access this member directly; use UStaticMesh::GetMinLOD() or UStaticMesh::SetMinLOD(). |
|
|
NegativeBoundsExtension |
Please do not access this member directly; use UStaticMesh::GetNegativeBoundsExtension() or UStaticMesh::SetNegativeBoundsExtension. |
|
|
PositiveBoundsExtension |
Please do not access this member directly; use UStaticMesh::GetPositiveBoundsExtension() or UStaticMesh::SetPositiveBoundsExtension. |
|
|
SourceFilePath_DEPRECATED |
Path to the resource used to construct this static mesh |
|
|
SourceFileTimestamp_DEPRECATED |
Date/Time-stamp of the file from the last import |
Name | Description | ||
---|---|---|---|
|
GetMipDataFilename |
Use GetMipDataPackagePath instead |
|
|
IsBuiltAtRuntime() |
IsBuiltAtRuntime() is no longer used. |
|
|
RegisterMeshAttributes ( |
Please use FStaticMeshAttributes::Register to do this. |
|
|
SetIsBuiltAtRuntime ( |
SetIsBuiltAtRuntime() is no longer used. |