Class LegacyMouseInputAdapter

Namespace

Goehler.OrbitalCam

Assembly

Goehler.OrbitalCam.Runtime.dll

Reads mouse input through the Legacy Input Manager and feeds it to the camera. Drag-to-pan, drag-to-rotate, mouse-wheel zoom, and optional edge-scrolling.

[AddComponentMenu("Goehler Studios/Orbital Cam/Input/Legacy Mouse")]
public class LegacyMouseInputAdapter : InputAdapter

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

InputAdapter

LegacyMouseInputAdapter

Inherited Members

InputAdapter.MoveInput

InputAdapter.RotateInput

InputAdapter.ZoomInput

InputAdapter.RotateStepInput

Properties

EdgeScrollInput

Screen-edge scroll direction. X / Y in [-1, 1]. Zero when no edge is active.

public override Vector2 EdgeScrollInput { get; }

Property Value

Vector2

EdgeScrollingMarginPercent

public Vector2 EdgeScrollingMarginPercent { get; set; }

Property Value

Vector2

InvertMouseRotation

public bool InvertMouseRotation { get; set; }

Property Value

bool

InvertMouseTilt

public bool InvertMouseTilt { get; set; }

Property Value

bool

IsAvailable

True when the adapter can produce input. Return false to skip the adapter for this frame (e.g. device missing, focus lost).

public override bool IsAvailable { get; }

Property Value

bool

MouseMovementButton

public MouseButton MouseMovementButton { get; set; }

Property Value

MouseButton

MouseRotationAndTiltButton

public MouseButton MouseRotationAndTiltButton { get; set; }

Property Value

MouseButton

MouseWheelSensitivity

public float MouseWheelSensitivity { get; set; }

Property Value

float

MoveDelta

Pointer-drag move delta in world units, accumulated since the last Sample().

public override Vector3 MoveDelta { get; }

Property Value

Vector3

PointerPosition

Current pointer position in screen pixels. Only meaningful when PointerPositionAvailable is true.

public override Vector2 PointerPosition { get; }

Property Value

Vector2

PointerPositionAvailable

True when PointerPosition is valid (pointer inside the game window, touch active, etc.).

public override bool PointerPositionAvailable { get; }

Property Value

bool

PreventInteractionWhilePointerIsOverUI

public bool PreventInteractionWhilePointerIsOverUI { get; set; }

Property Value

bool

RotateDelta

Pointer-drag rotate delta in degrees, accumulated since the last Sample(). X = rotate, Y = tilt.

public override Vector2 RotateDelta { get; }

Property Value

Vector2

UseEdgeScrollingForMovement

public bool UseEdgeScrollingForMovement { get; set; }

Property Value

bool

UseMouseForMovement

public bool UseMouseForMovement { get; set; }

Property Value

bool

UseMouseForRotation

public bool UseMouseForRotation { get; set; }

Property Value

bool

UseMouseForTilt

public bool UseMouseForTilt { get; set; }

Property Value

bool

UseMouseWheelForZoom

public bool UseMouseWheelForZoom { get; set; }

Property Value

bool

ZoomDelta

Wheel or pinch zoom delta, accumulated since the last Sample().

public override float ZoomDelta { get; }

Property Value

float

Methods

Sample()

Called once per frame by the camera before any axis getter is read. Pull from the device source here and cache results for the getters.

public override void Sample()