Class PaintFoliageGizmoMode

Foliage painting tool mode.

Inheritance

System.Object

FlaxEditor.Viewport.Modes.EditorGizmoMode

PaintFoliageGizmoMode

Namespace: FlaxEditor.Tools.Foliage

Assembly: FlaxEngine.CSharp.dll

Syntax

public class PaintFoliageGizmoMode : EditorGizmoMode

Constructors

PaintFoliageGizmoMode()

Declaration

public PaintFoliageGizmoMode()

Fields

CurrentBrush

Gets the current brush.

Declaration

public readonly Brush CurrentBrush

Field Value

FlaxEditor.Tools.Foliage.Brush

Gizmo

The foliage painting gizmo.

Declaration

public PaintFoliageGizmo Gizmo

Field Value

PaintFoliageGizmo

Properties

CursorBrushBounds

Gets the world bounds of the brush located at the current cursor position (defined by CursorPosition). Valid only if HasValidHit is set to true.

Declaration

public BoundingBox CursorBrushBounds { get; }

Property Value

BoundingBox

CursorNormal

The last valid cursor hit point normal vector of the brush (in world space).

Declaration

public Vector3 CursorNormal { get; }

Property Value

Vector3

CursorPosition

The last valid cursor position of the brush (in world space).

Declaration

public Vector3 CursorPosition { get; }

Property Value

Vector3

HasValidHit

Flag used to indicate whenever last cursor position of the brush is valid.

Declaration

public bool HasValidHit { get; }

Property Value

System.Boolean

SelectedFoliage

Gets the selected foliage actor (see SceneEditingModule).

Declaration

public Foliage SelectedFoliage { get; }

Property Value

Foliage

Methods

ClearCursor()

Clears the cursor location information cached within the gizmo mode.

Declaration

public void ClearCursor()

Init(IGizmoOwner)

Declaration

public override void Init(IGizmoOwner owner)

Parameters

FlaxEditor.Gizmo.IGizmoOwner owner

Overrides

FlaxEditor.Viewport.Modes.EditorGizmoMode.Init(FlaxEditor.Gizmo.IGizmoOwner)

OnActivated()

Declaration

public override void OnActivated()

Overrides

FlaxEditor.Viewport.Modes.EditorGizmoMode.OnActivated()

SetCursor(ref Vector3, ref Vector3)

Sets the cursor location in the world space. Updates the brush location and cached affected chunks.

Declaration

public void SetCursor(ref Vector3 hitPosition, ref Vector3 hitNormal)

Parameters

Vector3 hitPosition The cursor hit location on the selected foliage.

Vector3 hitNormal The cursor hit location normal vector fot he surface.

Extension Methods

Extensions.ReflectiveCompare<T>(T, T)

Extensions.DeepClone<T>(T)

Extensions.RawClone<T>(T)

See Also

FlaxEditor.Viewport.Modes.EditorGizmoMode