Class PointerUserToolState
Represents the user tool state for pointer interactions within a hex terrain environment.
Implements
Inherited Members
Namespace: Fwt.HexTerrains.UserTools.SM.States
Assembly: fwt.hexterrains.dll
Syntax
public class PointerUserToolState : HexTerrainUserToolStateBase, ISmStateRemarks
This class enables pointer-based selection and interaction functionality for terrain editing tools. It is typically used to manage the state and behavior of pointer operations, such as selecting or highlighting terrain cells. Inherits common functionality from HexTerrainUserToolStateBase and configures the terrain cursor for pointer usage.
Constructors
PointerUserToolState(ISmState)
Declaration
public PointerUserToolState(ISmState parent)Parameters
| Type | Name | Description |
|---|---|---|
| ISmState | parent |
Properties
UserToolType
Type identifier for the user tool. Allows state machine to change states based on tool type instead of state index.
Declaration
public override int UserToolType { get; }Property Value
| Type | Description |
|---|---|
| int |
Overrides
Methods
PrepareToRun()
Performs any necessary initialization or setup required before executing the main operation. Called by state machine once when state becomes active. If state is disabled and then enabled again, this method will be called again.
Declaration
public override void PrepareToRun()Overrides
Remarks
Override this method to implement preparation logic specific to the derived class. This method should be called prior to running the core functionality to ensure all prerequisites are met.
PrepareToStop()
Performs any necessary actions to prepare the object for stopping or shutdown. Called when the state is about to be deactivated.
Declaration
public override void PrepareToStop()Overrides
Remarks
Implementations should ensure that all resources are released and any ongoing operations are safely terminated before the object is stopped. This method is typically called prior to disposing or shutting down the object to ensure a clean transition.