UPreviewGeometry

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

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

ModelingComponents

Header

/Engine/Plugins/Experimental/MeshModelingToolset/Source/ModelingComponents/Public/Drawing/PreviewGeometryActor.h

Include

#include "Drawing/PreviewGeometryActor.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(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

Name Description

Public variable UProperty

TMap< FString, ...

 

LineSets

LineSetComponents created and owned by the UPreviewGeometry, and added as child components of the ParentActor

Public variable UProperty

APreviewGeometr...

 

ParentActor

Actor created and managed by the UPreviewGeometry

Destructors

Name Description

Public function Virtual

~UPreviewGeometry()

Functions

Name Description

Public function UFunction

ULineSetComp...

 

AddLineSet

(
    const FString& LineSetIdentifier
)

Line SetsCreate a new line set with the given LineSetIdentifier 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

void

 

CreateOrUpdateLineSet

(
    const FString& LineSetIdentifier,
    int32 NumIndices,
    TFunctionRef< voidIndex, TArr...,
    int32 LinesPerIndexHint
)

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

Public function UFunction

void

 

Disconnect()

Remove and destroy preview mesh

Public function UFunction

ULineSetComp...

 

FindLineSet

(
    const FString& LineSetIdentifier
)

Public function Const UFunction

APreviewGeom...

 

GetActor()

Public function UFunction

void

 

RemoveAllLineSets

(
    bool bDestroy
)

Remove all LineSetComponents

Public function UFunction

bool

 

RemoveLineSet

(
    const FString& LineSetIdentifier,
    bool bDestroy
)

Remove the LineSetComponent with the given LineSetIdentifier

Public function UFunction

void

 

SetAllLineSetsMaterial

(
    UMaterialInterface* Material
)

Set the Material of all LineSetComponents

Public function UFunction

bool

 

SetLineSetMaterial

(
    const FString& LineSetIdentifier,
    UMaterialInterface* NewMateria...
)

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

void

 

UpdateAllLineSets

(
    UpdateFuncType UpdateFunc
)

Call UpdateFuncType(ULineSetComponent*) for all existing Line Sets

Public function

void

 

UpdateLineSet

(
    const FString& LineSetIdentifier,
    UpdateFuncType UpdateFunc
)

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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss