class CameraControlDrag in Tinman.AddOns.Components

An implementation of the ICameraControl interface that controls the camera by dragging the mouse.

sealed class

CameraControlDrag

extends

CameraControlBase

Remarks

Left:
Picks a world anchor and moves the camera so that the anchor stays at the mouse cursor.

Right:
Picks a world anchor and rotates around the world up-vector (yaw) and the camera side vector (pitch).

Public / Attributes

Anchor

Returns current world-space anchor point.

public override property	Anchor { get }
type	Vec3D
value		The current anchor point or Undefined is this camera control is not active.
overrides	CameraControlBase.Anchor

Remarks:

This property is purely informational and has no functional relevance.

MouseCursor

The mouse cursor that is most appropriate for the current state of this camera control.

public override property	MouseCursor { get }
type	MouseCursor
value		The mouse cursor.
overrides	CameraControlBase.MouseCursor

Remarks:

This property is purely informational and has no functional relevance.

ShouldCaptureMouse

Should the mouse be captured, because this input consumer only processes relative input?

public override property	ShouldCaptureMouse { get }
type	bool
value		true if the mouse should be captured, false if not.
overrides	CameraControlBase.ShouldCaptureMouse

See also:

IApplicationWindow.MouseCaptured

View

The ICameraViewport object that provides the view into the world.

public virtual property	View { get set }
type	ICameraViewport
value		The viewport object. If null, the camera control will be disabled.
inherited	CameraControlBase.View

World

The ICameraWorld object that provides the world.

public virtual property	World { get set }
type	ICameraWorld
value		The world object. If null, the camera control will be disabled.
inherited	CameraControlBase.World

Public / Constructors

CameraControlDrag

Creates a new instance of CameraControlDrag.

public constructor

CameraControlDrag ()

Public / Methods

Cancel

Stops the current camera control gesture.

public override method	Cancel ()
overrides	CameraControlBase.Cancel

ConsumeInput

Consumes the given user input event.

public override method	ConsumeInput (InputEvent inputEvent)
type	bool
params	inputEvent		The user input event.
returns			true if the input event has been consumed, false if not.
overrides	CameraControlBase.ConsumeInput

Remarks:

Input events are provided to an IInputConsumer object only if it has the input focus (see FocusGained and FocusLost). Mouse events are provided when the mouse cursor is inside of the input bounds (MouseEnter and MouseLeave). The Closing event can be provided at any time.

1. FocusGained: gained input focus
2. Keyboard events:
   • Pressed: key has been pressed down.
   • Released: key has been released.
   • Clicked: key has been clicked.
   • Character: a character has been typed.
3. Mouse events:
   1. MouseEnter
   2. Mouse events:
      • Pressed
      • Released
      • Clicked
      • MouseMove
   3. MouseLeave
4. FocusLost: lost input focus
5. Closing: user request to shut down

InputAttach

Attaches this input consumer to the given input state object.

public virtual method	InputAttach (IInputState input)
params	input	[not-null]	The input state object.
inherited	CameraControlBase.InputAttach

Remarks:

The input state object provides a snapshot of the input keys and buttons. It should not be used to detect up/down/click events.

InputDetach

Detached this input consumer from its input state object.

public virtual method	InputDetach ()
inherited	CameraControlBase.InputDetach

UpdateFrameTime

This method is called once per application frame.

public override method	UpdateFrameTime (float32 time)
type	bool
params	time	[>0]	The amount of time that has elapsed since the last frame, in seconds.
returns			true if the object needs to be presented again, false if the current presentation is still valid.
overrides	CameraControlBase.UpdateFrameTime