Click or drag to resize
Ab4d.SharpEngine logo

ManualMouseCameraController Class

ManualMouseCameraController is a camera controller that can control the camera by mouse events. Because ManualMouseCameraController is cross-platform it does not provide any actual mouse binding. Therefore user must manually call ProcessMouseDown(Vector2, MouseButtons, KeyboardModifiers), ProcessMouseUp(MouseButtons, KeyboardModifiers), ProcessMouseMove(Vector2, MouseButtons, KeyboardModifiers) and ProcessMouseWheel(Vector2, Single) methods.
Inheritance Hierarchy

Namespace: Ab4d.SharpEngine.Utilities
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 1.0.8740+deb2991acfe86a95cca780cd4f82bcae2805c1a5
Syntax
C#
public class ManualMouseCameraController : CameraController

The ManualMouseCameraController type exposes the following members.

Constructors
Properties
 NameDescription
Public propertyCode exampleMoveCameraConditions Gets or sets conditions from MouseAndKeyboardConditions enum that must be met to move the camera. Default value is MouseAndKeyboardConditions.LeftMouseButtonPressed.
Public propertyCode exampleQuickZoomConditions Gets or sets conditions from MouseAndKeyboardConditions enum that must be met to start quick zooming - quickly zooming in and out with moving the mouse forward and backward. Default value is MouseAndKeyboardConditions.Disabled.
Public propertyCode exampleRotateCameraConditions Gets or sets conditions from MouseAndKeyboardConditions enum that must be met to rotate the camera. Default value is MouseAndKeyboardConditions.LeftMouseButtonPressed.
Top
Methods
 NameDescription
Protected methodIsKeyboardConditionTrue IsKeyboardConditionTrue returns true when the correct keyboard modifier is pressed according to the specified conditions (only keyboard part of the conditions are checked).
Protected methodIsMouseButtonsConditionTrue IsMouseButtonsConditionTrue returns true when the correct mouse button is pressed according to the specified conditions (only mouse part of the conditions are checked; keyboard part is checked in IsKeyboardConditionTrue).
Public methodProcessMouseDown ProcessMouseDown method processes the mouse down event and returns true if the event is handled by this method.
Public methodProcessMouseMove ProcessMouseDown method processes the mouse down event and returns true if the event is handled by this method.
Protected methodProcessMouseMoveInt Protected ProcessMouseMoveInt
Public methodProcessMouseUp ProcessMouseDown method processes the mouse down event and returns true if the event is handled by this method.
Public methodProcessMouseWheel ProcessMouseWheel method processes the mouse wheel event and returns true if the event is handled by this method.
Protected methodStartMouseProcessing StartMouseProcessing is called when the correct mouse button and keyboard is pressed to start rotating or moving the camera.
Top
See Also