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
-
objectNavigation
- Implements
Constructors
Navigation(Navigation)
protected Navigation(Navigation original)
Parameters
originalNavigation
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
XNavigationAxisThe action to apply for movement along the X axis.
YNavigationAxisThe action to apply for movement along the Y axis.
ViewportScalingboolWhether to scale the input based on the size of the input area / viewport.
CaptureCursorboolWhether 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
EqualityContract
protected override Type EqualityContract { get; }
Property Value
ViewportScaling
Whether to scale the input based on the size of the input area / viewport.
public bool ViewportScaling { get; init; }
Property Value
X
The action to apply for movement along the X axis.
public NavigationAxis X { get; init; }
Property Value
Y
The action to apply for movement along the Y axis.
public NavigationAxis Y { get; init; }
Property Value
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
XNavigationAxisYNavigationAxisViewportScalingboolCaptureCursorbool
Equals(InputAction?)
public override sealed bool Equals(InputAction? other)
Parameters
otherInputAction
Returns
Equals(Navigation?)
public virtual bool Equals(Navigation? other)
Parameters
otherNavigation
Returns
Equals(object?)
public override bool Equals(object? obj)
Parameters
objobject
Returns
GetHashCode()
public override int GetHashCode()
Returns
PrintMembers(StringBuilder)
protected override bool PrintMembers(StringBuilder builder)
Parameters
builderStringBuilder
Returns
ToString()
public override string ToString()
Returns
Operators
operator ==(Navigation?, Navigation?)
public static bool operator ==(Navigation? left, Navigation? right)
Parameters
leftNavigationrightNavigation
Returns
operator !=(Navigation?, Navigation?)
public static bool operator !=(Navigation? left, Navigation? right)
Parameters
leftNavigationrightNavigation