Class MouseInputScheme
- Namespace
- OmegaEngine.Input
- Assembly
- OmegaEngine.dll
Controls which mouse button does what.
public record MouseInputScheme : IEquatable<MouseInputScheme>
- Inheritance
-
objectMouseInputScheme
- Implements
Constructors
MouseInputScheme(InputAction?, InputAction?, InputAction?)
Controls which mouse button does what.
public MouseInputScheme(InputAction? LeftDrag = null, InputAction? RightDrag = null, InputAction? MiddleDrag = null)
Parameters
LeftDragInputActionHow to handle dragging the mouse while the left button is pressed.
RightDragInputActionHow to handle dragging the mouse while the right button is pressed.
MiddleDragInputActionHow to handle dragging the mouse while the middle button or both the left and the right button are pressed.
MouseInputScheme(MouseInputScheme)
protected MouseInputScheme(MouseInputScheme original)
Parameters
originalMouseInputScheme
Properties
EqualityContract
protected virtual Type EqualityContract { get; }
Property Value
FreeLook
Enables free-look navigation. Left button for rotation, right button for XZ movement. Suitable for first-person navigation scenarios.
public static MouseInputScheme FreeLook { get; }
Property Value
LeftDrag
How to handle dragging the mouse while the left button is pressed.
public InputAction? LeftDrag { get; init; }
Property Value
MiddleDrag
How to handle dragging the mouse while the middle button or both the left and the right button are pressed.
public InputAction? MiddleDrag { get; init; }
Property Value
Orbit
Orbit around a fixed target. Left button for rotation, right button for roll and zoom. Suitable for inspecting a single object or focal point.
public static MouseInputScheme Orbit { get; }
Property Value
Planar
Focuses on movement constrained to a plane. Left button for area selection, right button for XY panning, middle button for rotation and zoom. Ideal for top-down or strategy-style navigation.
public static MouseInputScheme Planar { get; }
Property Value
RightDrag
How to handle dragging the mouse while the right button is pressed.
public InputAction? RightDrag { get; init; }
Property Value
Scene
Scene navigation with full six degrees of freedom. Left button for XY panning, right button for rotation, middle button for roll and zoom. Designed for general-purpose scene inspection.
public static MouseInputScheme Scene { get; }
Property Value
Methods
Deconstruct(out InputAction?, out InputAction?, out InputAction?)
public void Deconstruct(out InputAction? LeftDrag, out InputAction? RightDrag, out InputAction? MiddleDrag)
Parameters
LeftDragInputActionRightDragInputActionMiddleDragInputAction
Equals(MouseInputScheme?)
public virtual bool Equals(MouseInputScheme? other)
Parameters
otherMouseInputScheme
Returns
Equals(object?)
public override bool Equals(object? obj)
Parameters
objobject
Returns
GetHashCode()
public override int GetHashCode()
Returns
PrintMembers(StringBuilder)
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
builderStringBuilder
Returns
ToString()
public override string ToString()
Returns
Operators
operator ==(MouseInputScheme?, MouseInputScheme?)
public static bool operator ==(MouseInputScheme? left, MouseInputScheme? right)
Parameters
leftMouseInputSchemerightMouseInputScheme
Returns
operator !=(MouseInputScheme?, MouseInputScheme?)
public static bool operator !=(MouseInputScheme? left, MouseInputScheme? right)
Parameters
leftMouseInputSchemerightMouseInputScheme