1. Epic GamesDeveloper
  3. UPreviewGeometry

UPreviewGeometry

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

API > API/Plugins > API/Plugins/ModelingComponents

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

   
Name UPreviewGeometry
Type class
Header File /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/Drawing/PreviewGeometryActor.h
Include Path #include "Drawing/PreviewGeometryActor.h"

Syntax

UCLASS (MinimalAPI, Transient)  
class UPreviewGeometry : public UObject

Inheritance Hierarchy

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UPreviewGeometry()

   Drawing/PreviewGeometryActor.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
LineSets TMap< FString, TObjectPtr< ULineSetComponent > > LineSetComponents created and owned by the UPreviewGeometry, and added as child components of the ParentActor Drawing/PreviewGeometryActor.h  
ParentActor TObjectPtr< APreviewGeometryActor > Actor created and managed by the UPreviewGeometry Drawing/PreviewGeometryActor.h  
PointSets TMap< FString, TObjectPtr< UPointSetComponent > > PointSetComponents created and owned by the UPreviewGeometry, and added as child components of the ParentActor Drawing/PreviewGeometryActor.h  
TriangleSets TMap< FString, TObjectPtr< UTriangleSetComponent > > TriangleSetComponents created and owned by the UPreviewGeometry, and added as child components of the ParentActor Drawing/PreviewGeometryActor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

ULineSetComponent * AddLineSet ( const FString& LineSetIdentifier
)

 Line Sets Create a new line set with the given LineSetIdentifier and return it Drawing/PreviewGeometryActor.h  

UPointSetComponent * AddPointSet ( const FString& PointSetIdentifier
)

 Point Sets Create a new point set with the given PointSetIdentifier and return it Drawing/PreviewGeometryActor.h  

UTriangleSetComponent * AddTriangleSet ( const FString& TriangleSetIdentifier
)

 Triangle Sets Create a new triangle set with the given TriangleSetIdentifier and return it Drawing/PreviewGeometryActor.h  

void CreateInWorld ( UWorld* World,
const FTransform& WithTransform
)

 Create preview mesh in the World with the given transform Drawing/PreviewGeometryActor.h  

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) Drawing/PreviewGeometryActor.h  

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) Drawing/PreviewGeometryActor.h  

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) Drawing/PreviewGeometryActor.h  

void Disconnect()

 Remove and destroy preview mesh Drawing/PreviewGeometryActor.h  

ULineSetComponent * FindLineSet ( const FString& LineSetIdentifier
)

   Drawing/PreviewGeometryActor.h  

UPointSetComponent * FindPointSet ( const FString& PointSetIdentifier
)

   Drawing/PreviewGeometryActor.h  

UTriangleSetComponent * FindTriangleSet ( const FString& TriangleSetIdentifier
)

   Drawing/PreviewGeometryActor.h  

APreviewGeometryActor * GetActor()

   Drawing/PreviewGeometryActor.h  

FTransform GetTransform()

 Get the current transform on the preview Drawing/PreviewGeometryActor.h  

void RemoveAllLineSets ( bool bDestroy
)

 Remove all LineSetComponents Drawing/PreviewGeometryActor.h  

void RemoveAllPointSets ( bool bDestroy
)

 Remove all PointSetComponents Drawing/PreviewGeometryActor.h  

void RemoveAllTriangleSets ( bool bDestroy
)

 Remove all TriangleSetComponents Drawing/PreviewGeometryActor.h  

bool RemoveLineSet ( const FString& LineSetIdentifier,
bool bDestroy
)

 Remove the LineSetComponent with the given LineSetIdentifier Drawing/PreviewGeometryActor.h  

bool RemovePointSet ( const FString& PointSetIdentifier,
bool bDestroy
)

 Remove the PointSetComponent with the given PointSetIdentifier Drawing/PreviewGeometryActor.h  

bool RemoveTriangleSet ( const FString& TriangleSetIdentifier,
bool bDestroy
)

 Remove the TriangleSetComponent with the given TriangleSetIdentifier Drawing/PreviewGeometryActor.h  

void SetAllLineSetsMaterial ( UMaterialInterface* Material
)

 Set the Material of all LineSetComponents Drawing/PreviewGeometryActor.h  

void SetAllPointSetsMaterial ( UMaterialInterface* Material
)

 Set the Material of all PointSetComponents Drawing/PreviewGeometryActor.h  

void SetAllVisible ( bool bVisible
)

 Set visibility state of the preview mesh Drawing/PreviewGeometryActor.h  

bool SetLineSetMaterial ( const FString& LineSetIdentifier,
UMaterialInterface* NewMaterial
)

 Set the Material of the LineSetComponent with the given LineSetIdentifier Drawing/PreviewGeometryActor.h  

bool SetLineSetVisibility ( const FString& LineSetIdentifier,
bool bVisible
)

 Set the visibility of the LineSetComponent with the given LineSetIdentifier Drawing/PreviewGeometryActor.h  

bool SetPointSetMaterial ( const FString& PointSetIdentifier,
UMaterialInterface* NewMaterial
)

 Set the Material of the PointSetComponent with the given PointSetIdentifier Drawing/PreviewGeometryActor.h  

bool SetPointSetVisibility ( const FString& PointSetIdentifier,
bool bVisible
)

 Set the visibility of the PointSetComponent with the given PointSetIdentifier Drawing/PreviewGeometryActor.h  

void SetTransform ( const FTransform& UseTransform
)

 Set the transform on the preview mesh Drawing/PreviewGeometryActor.h  

void UpdateAllLineSets ( UpdateFuncType UpdateFunc
)

 Call UpdateFuncType(ULineSetComponent*) for all existing Line Sets Drawing/PreviewGeometryActor.h  

void UpdateAllPointSets ( UpdateFuncType UpdateFunc
)

 Call UpdateFuncType(UPointSetComponent*) for all existing Point Sets Drawing/PreviewGeometryActor.h  

void UpdateAllTriangleSets ( UpdateFuncType UpdateFunc
)

 Call UpdateFunc for all existing Triangle Sets Drawing/PreviewGeometryActor.h  

void UpdateLineSet ( const FString& LineSetIdentifier,
UpdateFuncType UpdateFunc
)

 Line Set Utilities Find the identified line set and call UpdateFuncType(ULineSetComponent*) Drawing/PreviewGeometryActor.h  

void UpdatePointSet ( const FString& PointSetIdentifier,
UpdateFuncType UpdateFunc
)

 Point Set Utilities Find the identified point set and call UpdateFuncType(UPointSetComponent*) Drawing/PreviewGeometryActor.h  

void UpdateTriangleSet ( const FString& TriangleSetIdentifier,
UpdateFuncType UpdateFunc
)

 Triangle Set Utilities Find the identified triangle set and call UpdateFuncType(UTriangleSetComponent*) Drawing/PreviewGeometryActor.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void OnCreated()

 Called at the end of CreateInWorld() to allow subclasses to add additional setup Drawing/PreviewGeometryActor.h  

virtual void OnDisconnected()

 Called at the beginning of Disconnect() to allow subclasses to perform additional cleanup Drawing/PreviewGeometryActor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page