Class PaintFoliageGizmo

Gizmo for painting with foliage. Managed by the PaintFoliageGizmoMode.

System.Object
FlaxEditor.Gizmo.GizmoBase
PaintFoliageGizmo
Namespace: FlaxEditor.Tools.Foliage
Assembly: FlaxEngine.CSharp.dll
Syntax
public sealed class PaintFoliageGizmo : GizmoBase

Constructors

PaintFoliageGizmo(IGizmoOwner, PaintFoliageGizmoMode)

Initializes a new instance of the PaintFoliageGizmo class.

Declaration
public PaintFoliageGizmo(IGizmoOwner owner, PaintFoliageGizmoMode mode)
Parameters
FlaxEditor.Gizmo.IGizmoOwner owner

The owner.
PaintFoliageGizmoMode mode

The mode.

Fields

Mode

The parent mode.

Declaration
public readonly PaintFoliageGizmoMode Mode
Field Value
PaintFoliageGizmoMode

Properties

IsControllingMouse

Declaration
public override bool IsControllingMouse { get; }
Property Value
System.Boolean

Overrides
FlaxEditor.Gizmo.GizmoBase.IsControllingMouse

IsPainting

Gets a value indicating whether gizmo tool is painting the foliage.

Declaration
public bool IsPainting { get; }
Property Value
System.Boolean

Methods

Draw(ref RenderContext)

Declaration
public override void Draw(ref RenderContext renderContext)
Parameters
RenderContext renderContext

Overrides
FlaxEditor.Gizmo.GizmoBase.Draw(FlaxEngine.RenderContext)

Update(Single)

Declaration
public override void Update(float dt)
Parameters
System.Single dt

Overrides
FlaxEditor.Gizmo.GizmoBase.Update(System.Single)

Events

PaintEnded

Occurs when foliage paint has been ended.

Declaration
public event Action PaintEnded
Event Type
System.Action

PaintStarted

Occurs when foliage paint has been started.

Declaration
public event Action PaintStarted
Event Type
System.Action

Extension Methods

See Also

FlaxEditor.Gizmo.GizmoBase