Navigation
API > API/Plugins > API/Plugins/ModelingComponents
UMeshWireframeComponent draws a mesh wireframe as lines, with line color/thickness varying depending on line type and the configuration settings. Currently can draw:
- all mesh edges
- boundary edges
- UV seam edges
- Normal seam edges
- Color seam edges
Client must provide a IMeshWireframeSourceProvider implementation that provides the edge set, vertices, and edge type
| Name | UMeshWireframeComponent |
| Type | class |
| Header File | /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/Drawing/MeshWireframeComponent.h |
| Include Path | #include "Drawing/MeshWireframeComponent.h" |
Syntax
UCLASS (MinimalAPI)
class UMeshWireframeComponent : public UMeshComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UPrimitiveComponent → UMeshComponent → UMeshWireframeComponent
Implements Interfaces
- IAsyncPhysicsStateProcessor
- IInterface_AssetUserData
- IInterface_AsyncCompilation
- INavRelevantInterface
- IPhysicsComponent
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMeshWireframeComponent() |
Drawing/MeshWireframeComponent.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bEnableBoundaryEdges | bool | Drawing/MeshWireframeComponent.h |
|
|
| bEnableColorSeams | bool | Drawing/MeshWireframeComponent.h |
|
|
| bEnableNormalSeams | bool | Drawing/MeshWireframeComponent.h |
|
|
| bEnableTangentSeams | bool | Drawing/MeshWireframeComponent.h |
|
|
| bEnableUVSeams | bool | Drawing/MeshWireframeComponent.h |
|
|
| bEnableWireframe | bool | Drawing/MeshWireframeComponent.h |
|
|
| BoundaryEdgeColor | FColor | Drawing/MeshWireframeComponent.h |
|
|
| BoundaryEdgeThickness | float | Drawing/MeshWireframeComponent.h |
|
|
| ColorSeamColor | FColor | Drawing/MeshWireframeComponent.h |
|
|
| ColorSeamThickness | float | Drawing/MeshWireframeComponent.h |
|
|
| LineDepthBias | float | Depth bias of the lines, used to offset in depth to avoid z-fighting | Drawing/MeshWireframeComponent.h |
|
| LineDepthBiasSizeScale | float | Target-size depth bias scale. | Drawing/MeshWireframeComponent.h |
|
| NormalSeamColor | FColor | Drawing/MeshWireframeComponent.h |
|
|
| NormalSeamThickness | float | Drawing/MeshWireframeComponent.h |
|
|
| TangentSeamColor | FColor | Drawing/MeshWireframeComponent.h |
|
|
| TangentSeamThickness | float | Drawing/MeshWireframeComponent.h |
|
|
| ThicknessScale | float | Scaling factor applied to the per-edge-type thicknesses defined below | Drawing/MeshWireframeComponent.h |
|
| UVSeamColor | FColor | Drawing/MeshWireframeComponent.h |
|
|
| UVSeamThickness | float | Drawing/MeshWireframeComponent.h |
|
|
| WireframeColor | FColor | Drawing/MeshWireframeComponent.h |
|
|
| WireframeThickness | float | Drawing/MeshWireframeComponent.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| LineMaterial | TObjectPtr< const UMaterialInterface > | Drawing/MeshWireframeComponent.h | ||
| LocalBounds | FBoxSphereBounds | Drawing/MeshWireframeComponent.h | ||
| SourceProvider | TSharedPtr< IMeshWireframeSourceProvider > | Drawing/MeshWireframeComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void SetLineMaterial
(
UMaterialInterface* InLineMaterial |
Specify material which handles lines | Drawing/MeshWireframeComponent.h | |
void SetWireframeSourceProvider
(
TSharedPtr< IMeshWireframeSourceProvider > Provider |
Set the wireframe source | Drawing/MeshWireframeComponent.h | |
void UpdateWireframe() |
Causes the rendered wireframe to be updated from its source. | Drawing/MeshWireframeComponent.h |