UGeomModifier

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

GeometryMode

Header

/Engine/Plugins/Editor/GeometryMode/Source/GeometryMode/Classes/GeomModifier.h

Include

#include "GeomModifier.h"

Syntax

UCLASS(Abstract, HideCategories=(Object, GeomModifier))
class UGeomModifier : public UObject

Variables

Name Description

Public variable UProperty

uint32: 1

 

bAppearsInToolbar

Public variable UProperty Category, EditAnywhere

uint32: 1

 

bInitialized

True if the modifier has been initialized.

Public variable UProperty

uint32: 1

 

bPendingPivotOffsetUpdate

If true, the pivot offset should be updated when the modification ends

Public variable UProperty Category, EditAnywhere

uint32: 1

 

bPushButton

If true, this modifier should be displayed as a push button instead of a radio button

Public variable UProperty Category, EditAnywhere

FText

 

Description

A human readable name for this modifier (appears on buttons, menus, etc)

Public variable UProperty

FName

 

ToolbarIconName

Icon name for showing this modifier in a toolbar

Public variable UProperty Category, EditAnywhere

FText

 

Tooltip

The tooltip to be displayed for this modifier

Constructors

Name Description

Public function

UGeomModifier

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

bool

 

Apply()

Applies the modifier. Does nothing if the editor is not in geometry mode.

Public function

void

 

CacheBrushState()

Stores the current state of the brush so that upon faulty operations, the brush may be restored to its previous state

Public function

bool

 

DoEdgesOverlap()

Public function Virtual

void

 

DrawHUD

(
    FEditorViewportClient* Viewpor...,
    FViewport* Viewport,
    const FSceneView* View,
    FCanvas* Canvas
)

Public function

bool

 

EndModify()

Ends the modification of geometry data.

Public function

void

 

EndTrans()

Handles the stopping of transactions against the selected ABrushes.

Protected function

void

 

GeomError

(
    const FString& InErrorMsg
)

Interface for displaying error messages.

Public function Const

const FText ...

 

GetModifierDescription()

Public function Const

const FText ...

 

GetModifierTooltip()

Public function Virtual

void

 

Initialize()

Gives the individual modifiers a chance to do something the first time they are activated.

Public function Virtual

bool

 

InputDelta

(
    FEditorViewportClient* InViewp...,
    FViewport* InViewport,
    FVector& InDrag,
    FRotator& InRot,
    FVector& InScale
)

Public function Virtual

bool

 

InputKey

(
    FEditorViewportClient* Viewpor...,
    FViewport* Viewport,
    FKey Key,
    EInputEvent Event
)

Protected function Virtual

bool

 

OnApply()

Implements the modifier application.

Public function Virtual

void

 

Render

(
    const FSceneView* View,
    FViewport* Viewport,
    FPrimitiveDrawInterface* PDI
)

Drawing functions to allow modifiers to have better control over the screen.

Public function

void

 

RestoreBrushState()

Restores the brush to its cached state

Public function

bool

 

StartModify()

Starts the modification of geometry data.

Public function

void

 

StartTrans()

Handles the starting of transactions against the selected ABrushes.

Public function

void

 

StoreAllCurrentGeomSelections()

Store the current geom selections for all geom objects

Public function

void

 

StoreCurrentGeomSelections

(
    TArray< struct FGeomSelection >& S...,
    FGeomObjectPtr go
)

Store the current geom selections (Edge, Vert and Poly)

Public function Virtual

bool

 

SupportsCurrentSelection()

Public function Virtual

void

 

Tick

(
    FEditorViewportClient* Viewpor...,
    float DeltaTime
)

Protected function Virtual

void

 

UpdatePivotOffset()

Updates the pivot offset of the selected brushes based on the current vertex positions

Public function Virtual

void

 

WasActivated()

Gives the modifier a chance to initialize it's internal state when activated.

Public function Virtual

void

 

WasDeactivated()

Gives the modifier a chance to clean up when the user is switching away from it.

Deprecated Functions

Name Description

Public function Virtual

bool

 

Supports()

Supports has been deprected. Use SupportsCurrentSelection instead