1. Epic GamesDeveloper
  3. UPreviewGeometry

UPreviewGeometry

[UPreviewGeometry](API\Plugins\ModelingComponents\Drawing\UPreviewGeometry) creates and manages an [APreviewGeometryActor](API\Plugins\ModelingComponents\Drawing\APreviewGeometryActor) and a set of preview geometry Components.

API > API/Plugins > API/Plugins/ModelingComponents > API/Plugins/ModelingComponents/Drawing

Inheritance Hierarchy

References

   
Module ModelingComponents
Header /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/Drawing/PreviewGeometryActor.h
Include #include "Drawing/PreviewGeometryActor.h"

Syntax

UCLASS (Transient)  
class UPreviewGeometry : public UObject

Remarks

UPreviewGeometry creates and manages an APreviewGeometryActor and a set of preview geometry Components. Preview geometry Components are identified by strings.

Variables

  Type Name Description
Public variable UProperty TMap< FString, TObjectPtr< ULineSetComponent > > LineSets LineSetComponents created and owned by the UPreviewGeometry, and added as child components of the ParentActor
Public variable UProperty TObjectPtr< APreviewGeometryActor > ParentActor Actor created and managed by the UPreviewGeometry
Public variable UProperty TMap< FString, TObjectPtr< UPointSetComponent > > PointSets PointSetComponents created and owned by the UPreviewGeometry, and added as child components of the ParentActor
Public variable UProperty TMap< FString, TObjectPtr< UTriangleSetComponent > > TriangleSets TriangleSetComponents created and owned by the UPreviewGeometry, and added as child components of the ParentActor

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function UFunction ULineSetComponent *

AddLineSet ( const FString& LineSetIdentifier
)

 Line Sets Create a new line set with the given LineSetIdentifier and return it
Public function UFunction UPointSetComponent *

AddPointSet ( const FString& PointSetIdentifier
)

 Point Sets Create a new point set with the given PointSetIdentifier and return it
Public function UFunction UTriangleSetComponent *

AddTriangleSet ( const FString& TriangleSetIdentifier
)

 Triangle Sets Create a new triangle set with the given TriangleSetIdentifier and return it
Public function UFunction void

CreateInWorld ( UWorld* World,
const FTransform& WithTransform
)

 Create preview mesh in the World with the given transform
Public function ULineSetComponent *

CreateOrUpdateLineSet ( const FString& LineSetIdentifier,
int32 NumIndices,
TFunctionRef< void(int32 Index, TArray< FRenderableLine >&LinesOut)> LineGenFunc,
int32 LinesPerIndexHint
)

 Add a set of lines produced by calling LineGenFunc for each index in range [0,NumIndices)
Public function void

CreateOrUpdatePointSet ( const FString& PointSetIdentifier,
int32 NumIndices,
TFunctionRef< void(int32 Index, TArray< FRenderablePoint >&PointsOut)> PointGenFunc,
int32 PointsPerIndexHint
)

 Add a set of points produced by calling PointGenFunc for each index in range [0,NumIndices)
Public function UTriangleSetComponent *

CreateOrUpdateTriangleSet ( const FString& TriangleSetIdentifier,
int32 NumIndices,
TFunctionRef< void(int32 Index, TArray< FRenderableTriangle >&TrianglesOut)> TriangleGenFunc,
int32 TrianglesPerIndexHint
)

 Add a set of triangles produced by calling TriangleGenFunc for each index in range [0,NumIndices)
Public function UFunction void Remove and destroy preview mesh
Public function UFunction ULineSetComponent *

FindLineSet ( const FString& LineSetIdentifier
)

  
Public function UFunction UPointSetComponent *

FindPointSet ( const FString& PointSetIdentifier
)

  
Public function UFunction UTriangleSetComponent *

FindTriangleSet ( const FString& TriangleSetIdentifier
)

  
Public function Const UFunction APreviewGeometryActor *  
Public function Const FTransform Get the current transform on the preview
Protected function Virtual void Called at the end of CreateInWorld() to allow subclasses to add additional setup
Protected function Virtual void Called at the beginning of Disconnect() to allow subclasses to perform additional cleanup
Public function UFunction void

RemoveAllLineSets ( bool bDestroy
)

 Remove all LineSetComponents
Public function UFunction void

RemoveAllPointSets ( bool bDestroy
)

 Remove all PointSetComponents
Public function UFunction void

RemoveAllTriangleSets ( bool bDestroy
)

 Remove all TriangleSetComponents
Public function UFunction bool

RemoveLineSet ( const FString& LineSetIdentifier,
bool bDestroy
)

 Remove the LineSetComponent with the given LineSetIdentifier
Public function UFunction bool

RemovePointSet ( const FString& PointSetIdentifier,
bool bDestroy
)

 Remove the PointSetComponent with the given PointSetIdentifier
Public function UFunction bool

RemoveTriangleSet ( const FString& TriangleSetIdentifier,
bool bDestroy
)

 Remove the TriangleSetComponent with the given TriangleSetIdentifier
Public function UFunction void

SetAllLineSetsMaterial ( UMaterialInterface* Material
)

 Set the Material of all LineSetComponents
Public function UFunction void

SetAllPointSetsMaterial ( UMaterialInterface* Material
)

 Set the Material of all PointSetComponents
Public function void

SetAllVisible ( bool bVisible
)

 Set visibility state of the preview mesh
Public function UFunction bool

SetLineSetMaterial ( const FString& LineSetIdentifier,
UMaterialInterface* NewMaterial
)

 Set the Material of the LineSetComponent with the given LineSetIdentifier
Public function UFunction bool

SetLineSetVisibility ( const FString& LineSetIdentifier,
bool bVisible
)

 Set the visibility of the LineSetComponent with the given LineSetIdentifier
Public function UFunction bool

SetPointSetMaterial ( const FString& PointSetIdentifier,
UMaterialInterface* NewMaterial
)

 Set the Material of the PointSetComponent with the given PointSetIdentifier
Public function UFunction bool

SetPointSetVisibility ( const FString& PointSetIdentifier,
bool bVisible
)

 Set the visibility of the PointSetComponent with the given PointSetIdentifier
Public function void

SetTransform ( const FTransform& UseTransform
)

 Set the transform on the preview mesh
Public function void

UpdateAllLineSets ( UpdateFuncType UpdateFunc
)

 Call UpdateFuncType(ULineSetComponent*) for all existing Line Sets
Public function void

UpdateAllPointSets ( UpdateFuncType UpdateFunc
)

 Call UpdateFuncType(UPointSetComponent*) for all existing Point Sets
Public function void

UpdateAllTriangleSets ( UpdateFuncType UpdateFunc
)

 Call UpdateFunc for all existing Triangle Sets
Public function void

UpdateLineSet ( const FString& LineSetIdentifier,
UpdateFuncType UpdateFunc
)

 Line Set Utilities Find the identified line set and call UpdateFuncType(ULineSetComponent*)
Public function void

UpdatePointSet ( const FString& PointSetIdentifier,
UpdateFuncType UpdateFunc
)

 Point Set Utilities Find the identified point set and call UpdateFuncType(UPointSetComponent*)
Public function void

UpdateTriangleSet ( const FString& TriangleSetIdentifier,
UpdateFuncType UpdateFunc
)

 Triangle Set Utilities Find the identified triangle set and call UpdateFuncType(UTriangleSetComponent*)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page