Navigation
API > API/Plugins > API/Plugins/GeometryMode
| Name | UGeomModifier |
| Type | class |
| Header File | /Engine/Plugins/Editor/GeometryMode/Source/GeometryMode/Classes/GeomModifier.h |
| Include Path | #include "GeomModifier.h" |
Syntax
UCLASS (Abstract, HideCategories=(Object, GeomModifier))
class UGeomModifier : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UGeomModifier
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UGeomModifier
(
const FObjectInitializer& ObjectInitializer |
GeomModifier.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAppearsInToolbar | uint32 | GeomModifier.h | ||
| bInitialized | uint32 | True if the modifier has been initialized. | GeomModifier.h |
|
| bPendingPivotOffsetUpdate | uint32 | If true, the pivot offset should be updated when the modification ends | GeomModifier.h | |
| bPushButton | uint32 | If true, this modifier should be displayed as a push button instead of a radio button | GeomModifier.h |
|
| Description | FText | A human readable name for this modifier (appears on buttons, menus, etc) | GeomModifier.h |
|
| ToolbarIconName | FName | Icon name for showing this modifier in a toolbar | GeomModifier.h | |
| Tooltip | FText | The tooltip to be displayed for this modifier | GeomModifier.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CachedPolys | TObjectPtr< class UPolys > | Stored state of polys in case the brush state needs to be restroed | GeomModifier.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool Apply() |
Applies the modifier. Does nothing if the editor is not in geometry mode. | GeomModifier.h | |
void CacheBrushState() |
Stores the current state of the brush so that upon faulty operations, the brush may be restored to its previous state | GeomModifier.h | |
bool DoEdgesOverlap() |
GeomModifier.h | ||
virtual void DrawHUD
(
FEditorViewportClient* ViewportClient, |
GeomModifier.h | ||
bool EndModify() |
Ends the modification of geometry data. | GeomModifier.h | |
void EndTrans() |
Handles the stopping of transactions against the selected ABrushes. | GeomModifier.h | |
const FText & GetModifierDescription() |
GeomModifier.h | ||
const FText & GetModifierTooltip() |
GeomModifier.h | ||
virtual void Initialize() |
Gives the individual modifiers a chance to do something the first time they are activated. | GeomModifier.h | |
virtual bool InputDelta
(
FEditorViewportClient* InViewportClient, |
GeomModifier.h | ||
virtual bool InputKey
(
FEditorViewportClient* ViewportClient, |
GeomModifier.h | ||
virtual void Render
(
const FSceneView* View, |
Drawing functions to allow modifiers to have better control over the screen. | GeomModifier.h | |
void RestoreBrushState() |
Restores the brush to its cached state | GeomModifier.h | |
bool StartModify() |
Starts the modification of geometry data. | GeomModifier.h | |
void StartTrans() |
Handles the starting of transactions against the selected ABrushes. | GeomModifier.h | |
void StoreAllCurrentGeomSelections() |
Store the current geom selections for all geom objects | GeomModifier.h | |
void StoreCurrentGeomSelections
(
TArray< struct FGeomSelection >& SelectionArray, |
Store the current geom selections (Edge, Vert and Poly) | GeomModifier.h | |
virtual bool Supports() |
GeomModifier.h | ||
virtual bool SupportsCurrentSelection() |
GeomModifier.h | ||
virtual void Tick
(
FEditorViewportClient* ViewportClient, |
GeomModifier.h | ||
virtual void WasActivated() |
Gives the modifier a chance to initialize it's internal state when activated. | GeomModifier.h | |
virtual void WasDeactivated() |
Gives the modifier a chance to clean up when the user is switching away from it. | GeomModifier.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void GeomError
(
const FString& InErrorMsg |
Interface for displaying error messages. | GeomModifier.h | |
virtual bool OnApply() |
Implements the modifier application. | GeomModifier.h | |
virtual void UpdatePivotOffset() |
Updates the pivot offset of the selected brushes based on the current vertex positions | GeomModifier.h |