Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. UStaticMeshToolTarget

UStaticMeshToolTarget

A tool target backed by a static mesh asset that can provide and take a mesh description.

API > API/Plugins > API/Plugins/ModelingComponentsEditorOnly > API/Plugins/ModelingComponentsEditorOnly/ToolTargets

Inheritance Hierarchy

References

   
Module ModelingComponentsEditorOnly
Header /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponentsEditorOnly/Public/ToolTargets/StaticMeshToolTarget.h
Include #include "ToolTargets/StaticMeshToolTarget.h"

Syntax

UCLASS (Transient)  
class UStaticMeshToolTarget :  
    public UToolTarget ,  
    public IMeshDescriptionCommitter ,  
    public IMeshDescriptionProvider ,  
    public IMaterialProvider ,  
    public IStaticMeshBackedTarget ,  
    public IDynamicMeshProvider ,  
    public IDynamicMeshCommitter

Remarks

A tool target backed by a static mesh asset that can provide and take a mesh description.

This is a special tool target that refers to the underlying asset (in this case a static mesh), rather than indirectly through a component. This type of target is used in cases, such as opening an asset through the content browser, when there is no component available.

Variables

  Type Name Description
Protected variable checks of whether the UStaticMesh is alive  
Protected variable EMeshLODIdentifier EditingLOD  
Protected variable checks of whether the UStaticMesh is and the LODcheck does not guard against a generated EMeshLODIde... EditingLOD  
Protected variable TWeakObjectPtr< UStaticMesh > StaticMesh  

Functions

  Type Name Description
Protected function Static bool

CommitMaterialSetUpdate ( UStaticMesh* SkeletalMesh,
const FComponentMaterialSet& MaterialSet,
bool bApplyToAsset
)

  
Protected function Static void

CommitMeshDescription ( UStaticMesh* StaticMesh,
const FCommitter& Committer,
EMeshLODIdentifier EditingLODIn
)

  
Protected function Static TArray< EMeshLODIdentifier >

GetAvailableLODs ( const UStaticMesh* StaticMesh,
bool bSkipAutoGenerated
)

  
Public function Virtual Const EMeshLODIdentifier  
Protected function Static void

GetMaterialSet ( const UStaticMesh* StaticMesh,
FComponentMaterialSet& MaterialSetOut,
bool bPreferAssetMaterials
)

  
Public function Static const FMeshDescription *

GetMeshDescriptionWithScaleApplied ( UStaticMesh* Mesh,
int32 UseLOD,
FMeshDescriptionCache& Cache
)

 Helper to get the mesh description with build scale applied, using/updating the cache as needed
Protected function Static EMeshLODIdentifier

GetValidEditingLOD ( const UStaticMesh* StaticMesh,
EMeshLODIdentifier RequestedEditingLOD
)

  
Protected function Static bool

HasNonGeneratedLOD ( const UStaticMesh* StaticMesh,
EMeshLODIdentifier MeshLOD
)

 Returns true if the mesh has a non-generated LOD of the requested level. Interprets EMeshLODIdentifier::Default as LOD0
Protected function Const checks of whether the UStaticMesh is and the LOD check does not guard against a generated

LOD ( which " "tools should not edit
)

  
Public function Static TArray< int32 >

MapSectionToMaterialID ( const UStaticMesh* Mesh,
EMeshLODIdentifier EditingLOD
)

 Helper to get the material mapping returned by GetPolygonGroupToMaterialIndexMap for any static mesh
Public function Virtual void

SetEditingLOD ( EMeshLODIdentifier RequestedEditingLOD
)

 Configure active LOD to edit.

Overridden from UToolTarget

  Type Name Description
Public function Virtual Const bool

IsValid ()

 UToolTarget.

Overridden from IMeshDescriptionCommitter

  Type Name Description
Public function Virtual bool Commits the given FMeshDescription.
Public function Virtual bool

CommitMeshDescription ( const FMeshDescription& Mesh,
const FCommitMeshParameters& CommitParams
)

 Commits the given FMeshDescription.
Public function Virtual void

CommitMeshDescription ( const FCommitter& Committer,
const FCommitMeshParameters& CommitParams
)

 IMeshDescritpionCommitter implementation.
Public function Virtual Const TArray< int32 >  

Overridden from IMeshDescriptionProvider

  Type Name Description
Public function Virtual Const TArray< EMeshLODIdentifier >

GetAvailableLODs ( bool bSkipAutoGenerated
)

 For providers that have LODs (i.e. if SupportsLODs returns true), returns an array of all available LODs.
Public function Virtual FMeshDescription Returns an empty mesh description appropriate for the provider, i.e. configured with appropriate mesh attributes but otherwise devoid of topology or element data.
Public function Virtual const FMeshDescription *

GetMeshDescription ( const FGetMeshParameters& GetMeshParams
)

 IMeshDescriptionProvider implementation.
Public function Virtual Const EMeshLODIdentifier For providers that have LODs (i.e. if SupportsLODs returns true), returns the LOD that GetMeshDescription/etc will return.
Public function Virtual Const bool  

Overridden from IMaterialProvider

  Type Name Description
Public function Virtual bool

CommitMaterialSetUpdate ( const FComponentMaterialSet& MaterialSet,
bool bApplyToAsset
)

 Commit an update to the material set.
Public function Virtual Const UMaterialInterface *

GetMaterial ( int32 MaterialIndex
)

 Get pointer to a Material provided by this Source
Public function Virtual Const void

GetMaterialSet ( FComponentMaterialSet& MaterialSetOut,
bool bPreferAssetMaterials
)

 Get material set provided by this source
Public function Virtual Const int32 IMaterialProvider implementation.

Overridden from IStaticMeshBackedTarget

  Type Name Description
Public function Virtual Const UStaticMesh * IStaticMeshBackedTarget.

Overridden from IDynamicMeshProvider

  Type Name Description
Public function Virtual UE::Geometry::FDynamicMesh3

GetDynamicMesh ( const FGetMeshParameters& InGetMeshParams
)

 Gives a copy of a dynamic mesh for tools to operate on.
Public function Virtual UE::Geometry::FDynamicMesh3 IDynamicMeshProvider.

Overridden from IDynamicMeshCommitter

  Type Name Description
Public function Virtual void

CommitDynamicMesh ( const UE::Geometry::FDynamicMesh3& Mesh,
const FDynamicMeshCommitInfo& CommitInfo
)

 IDynamicMeshCommitter.
Public function Virtual void  

Classes

  Type Name Description
Public struct FCachedMeshDescription Helper struct to cache mesh descriptions, so we can provide the const ptr GetMeshDescription API while still handling the Build Scale  

Typedefs

Name Description
FMeshDescriptionCache  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page