Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > MeshModelingToolsEditorOnly > Hair > UGroomCardsEditorTool

Light Theme

Dark Theme

UGroomCardsEditorTool

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractiveTool

USingleSelectionTool

UMeshSurfacePointTool

UGroomCardsEditorTool

References

Module	MeshModelingToolsEditorOnly
Header	/Engine/Plugins/Experimental/MeshModelingToolset/Source/MeshModelingToolsEditorOnly/Public/Hair/GroomCardsEditorTool.h
Include	#include "Hair/GroomCardsEditorTool.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UGroomCardsEditorTool :
public UMeshSurfacePointTool,
public IClickBehaviorTarget

Variables

		Name	Description
	TPimplPtr< FGro...	ActiveCardEdit
	int32	ActiveCardGroupID
	FMeshVertexChan...	ActiveVertexChange
	IToolsContextAs...	AssetAPI
	bool	bActiveCardEditUpdated
	bool	bCurveUpdatePending
	bool	bSelectionStateDirty
	bool	bSetupValid
	bool	bVisualizationChanged
	bool	bWasTopologyEdited
	UPolygonSelecti...	CardMeshSelectionMechanic
	USpaceCurveDefo...	ControlPointsMechanic
	int32	CurrentOperationTimestamp
	TSharedPtr< FSp...	CurveSourceAdapter
	TPimplPtr< FEdi...	EditableCardSet
	UEditGroomCards...	EditActions
	UGroomCardsInfo...	InfoProperties
	UMaterialInterf...	MeshMaterial
	int32	ModifiedTopologyCounter
	FDelegateHandle	OnPreviewMeshChangedHandle
	EEditGroomCards...	PendingAction
	UPreviewGeometr...	PreviewGeom
	UPreviewMesh &#...	PreviewMesh
	USelectGroomCar...	SelectActions
	TLazyObjectPtr<...	TargetGroom
	UWorld *	TargetWorld
	TUniquePtr< FGr...	Topology
	UMaterialInterf...	UVMaterial

Constructors

	Name	Description
	UGroomCardsEditorTool()

Functions

	Name	Description
void	AfterTopologyEdit()
void	ApplyDeleteAction()
void	ApplyGroomCardEdit ( const FGroomCardEdit& Edit, bool bIsRevert )
void	BeginCardEdit ( int32 CardGroupID )
void	BeginMoveChange()
bool	CheckInOperation ( int32 Timestamp )
void	CompleteActiveCardEditAndEmitChanges()
void	CompleteMeshEditChange ( const FText& TransactionLabel, TUniquePtr< FToolCommandChange > Ed..., const FGroupTopologySelection& Out... )
void	EndCardEdit()
void	EndMoveChange()
void	InitializeMesh()
void	OnPreviewMeshChanged()
void	OnSelectionModifiedEvent()
void	RecomputeTopology()
void	RequestAction ( EEditGroomCardsToolActions ActionTy... )	Actions API
void	RestoreCardEdit ( const FGroomCardEdit* RestoreE... )
void	SetAssetAPI ( IToolsContextAssetAPI* InAsset... )
void	SetWorld ( UWorld* World )
void	UpdateLineSet()
void	UpdateOnCurveEdit()

Overridden from UMeshSurfacePointTool

	Name	Description
bool	HitTest ( const FRay& Ray, FHitResult& OutHit )	UMeshSurfacePointTool API.
void	OnBeginDrag ( const FRay& Ray )	This function is called when the user begins a click-drag-release interaction
void	OnEndDrag ( const FRay& Ray )	This function is called when the user releases the button driving a click-drag-release interaction
void	OnUpdateDrag ( const FRay& Ray )	This function is called each frame that the user is in a click-drag-release interaction

Overridden from UInteractiveTool

	Name	Description
bool	CanAccept()
bool	HasAccept()
bool	HasCancel()
void	OnTick ( float DeltaTime )	Action support/system
void	Render ( IToolsContextRenderAPI* Render... )	Allow the Tool to do any custom drawing (ie via PDI/RHI)
void	Setup()	Register InputBehaviors, etc
void	Shutdown ( EToolShutdownType ShutdownType )	Called by ToolManager to shut down the Tool

Overridden from IClickDragBehaviorTarget

		Name	Description
	FInputRayHit	CanBeginClickDragSequence ( const FInputDeviceRay& PressPos )	IClickDragBehaviorTarget API.

Overridden from IHoverBehaviorTarget

		Name	Description
	void	OnEndHover()	Terminate active hover sequence
	bool	OnUpdateHover ( const FInputDeviceRay& DevicePos )	Update active hover sequence with new input position

Overridden from IClickBehaviorTarget

		Name	Description
	FInputRayHit	IsHitByClick ( const FInputDeviceRay& ClickPos )	IClickBehaviorTarget API.
	void	OnClicked ( const FInputDeviceRay& ClickPos )	Notify Target that click ocurred

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

Take our survey

Dismiss