Table of Contents

Class Navigation

Namespace
OmegaEngine.Input
Assembly
OmegaEngine.dll

A navigation action mapping two input axes to degrees-of-freedom.

public record Navigation : InputAction, IEquatable<InputAction>, IEquatable<Navigation>
Inheritance
object
Navigation
Implements

Constructors

Navigation(Navigation)

protected Navigation(Navigation original)

Parameters

original Navigation

Navigation(NavigationAxis, NavigationAxis, bool, bool)

A navigation action mapping two input axes to degrees-of-freedom.

public Navigation(NavigationAxis X, NavigationAxis Y, bool ViewportScaling = false, bool CaptureCursor = true)

Parameters

X NavigationAxis

The action to apply for movement along the X axis.

Y NavigationAxis

The action to apply for movement along the Y axis.

ViewportScaling bool

Whether to scale the input based on the size of the input area / viewport.

CaptureCursor bool

Whether to capture and hide the mouse cursor. Only relevant for mouse input.

Properties

CaptureCursor

Whether to capture and hide the mouse cursor. Only relevant for mouse input.

public bool CaptureCursor { get; init; }

Property Value

bool

EqualityContract

protected override Type EqualityContract { get; }

Property Value

Type

ViewportScaling

Whether to scale the input based on the size of the input area / viewport.

public bool ViewportScaling { get; init; }

Property Value

bool

X

The action to apply for movement along the X axis.

public NavigationAxis X { get; init; }

Property Value

NavigationAxis

Y

The action to apply for movement along the Y axis.

public NavigationAxis Y { get; init; }

Property Value

NavigationAxis

Methods

Deconstruct(out NavigationAxis, out NavigationAxis, out bool, out bool)

public void Deconstruct(out NavigationAxis X, out NavigationAxis Y, out bool ViewportScaling, out bool CaptureCursor)

Parameters

X NavigationAxis
Y NavigationAxis
ViewportScaling bool
CaptureCursor bool

Equals(InputAction?)

public override sealed bool Equals(InputAction? other)

Parameters

other InputAction

Returns

bool

Equals(Navigation?)

public virtual bool Equals(Navigation? other)

Parameters

other Navigation

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected override bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Operators

operator ==(Navigation?, Navigation?)

public static bool operator ==(Navigation? left, Navigation? right)

Parameters

left Navigation
right Navigation

Returns

bool

operator !=(Navigation?, Navigation?)

public static bool operator !=(Navigation? left, Navigation? right)

Parameters

left Navigation
right Navigation

Returns

bool