Navigation
API > API/Plugins > API/Plugins/HairModelingToolset
Inheritance Hierarchy
- UObject
- IInputBehaviorSource
- UInteractiveTool
- USingleSelectionTool
- UMeshSurfacePointTool
- UGroomCardsEditorTool
References
| Module | HairModelingToolset |
| Header | /Engine/Plugins/Experimental/HairModelingToolset/Source/HairModelingToolset/Public/GroomCardsEditorTool.h |
| Include | #include "GroomCardsEditorTool.h" |
Syntax
UCLASS ()
class UGroomCardsEditorTool :
public UMeshSurfacePointTool ,
public IClickBehaviorTarget
Variables
| Type | Name | Description | |
|---|---|---|---|
| TPimplPtr< FGroomCardEdit > | ActiveCardEdit | ||
| int32 | ActiveCardGroupID | ||
| FMeshVertexChangeBuilder * | ActiveVertexChange | ||
| bool | bActiveCardEditUpdated | ||
| bool | bCurveUpdatePending | ||
| bool | bSelectionStateDirty | ||
| bool | bSetupValid | ||
| bool | bVisualizationChanged | ||
| bool | bWasTopologyEdited | ||
| TObjectPtr< UPolygonSelectionMechanic > | CardMeshSelectionMechanic | ||
| TObjectPtr< USpaceCurveDeformationMechanic > | ControlPointsMechanic | ||
| int32 | CurrentOperationTimestamp | ||
| TSharedPtr< FSpaceCurveSource > | CurveSourceAdapter | ||
| TPimplPtr< FEditableGroomCardSet > | EditableCardSet | ||
| TObjectPtr< UEditGroomCardsToolActions > | EditActions | ||
| TObjectPtr< UGroomCardsInfoToolProperties > | InfoProperties | ||
| TObjectPtr< UMaterialInterface > | MeshMaterial | ||
| int32 | ModifiedTopologyCounter | ||
| FDelegateHandle | OnPreviewMeshChangedHandle | ||
| EEditGroomCardsToolActions | PendingAction | ||
| TObjectPtr< UPreviewGeometry > | PreviewGeom | ||
| TObjectPtr< UPreviewMesh > | PreviewMesh | ||
| TObjectPtr< USelectGroomCardsToolActions > | SelectActions | ||
| TLazyObjectPtr< AGroomActor > | TargetGroom | ||
| UWorld * | TargetWorld | ||
| TUniquePtr< FGroupTopology > | Topology | ||
| TObjectPtr< UMaterialInterface > | UVMaterial |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | |||
| void | |||
| void | ApplyGroomCardEdit
(
const FGroomCardEdit& Edit, |
||
| void | BeginCardEdit
(
int32 CardGroupID |
||
| void | |||
| bool | CheckInOperation
(
int32 Timestamp |
||
| void | |||
| void | CompleteMeshEditChange
(
const FText& TransactionLabel, |
||
| void | EndCardEdit () |
||
| void | |||
| void | |||
| void | |||
| void | |||
| void | |||
| void | RequestAction
(
EEditGroomCardsToolActions ActionType |
Actions API | |
| void | RestoreCardEdit
(
const FGroomCardEdit* RestoreEdit |
||
| void | |||
| void | |||
| void |
Overridden from UMeshSurfacePointTool
| Type | Name | Description | |
|---|---|---|---|
| bool | HitTest
(
const FRay& Ray, |
UMeshSurfacePointTool API. | |
| void | OnBeginDrag
(
const FRay& Ray |
This function is called when the user begins a click-drag-release interaction | |
| void | OnCancelDrag () |
This function is called when the user's drag is cancelled, for example due to the whole tool being shut down. | |
| void | 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
| Type | Name | Description | |
|---|---|---|---|
| bool | CanAccept () |
||
| bool | HasAccept () |
||
| bool | HasCancel () |
||
| void | OnTick
(
float DeltaTime |
Allow the Tool to do any necessary processing on Tick | |
| void | Render
(
IToolsContextRenderAPI* RenderAPI |
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
| Type | Name | Description | |
|---|---|---|---|
| FInputRayHit | CanBeginClickDragSequence
(
const FInputDeviceRay& PressPos |
IClickDragBehaviorTarget API. |
Overridden from IHoverBehaviorTarget
| Type | Name | Description | |
|---|---|---|---|
| void | OnEndHover () |
Terminate active hover sequence | |
| bool | OnUpdateHover
(
const FInputDeviceRay& DevicePos |
Update active hover sequence with new input position |
Overridden from IClickBehaviorTarget
| Type | Name | Description | |
|---|---|---|---|
| FInputRayHit | IsHitByClick
(
const FInputDeviceRay& ClickPos |
IClickBehaviorTarget API. | |
| void | OnClicked
(
const FInputDeviceRay& ClickPos |
Notify Target that click ocurred |