 | |
Mouse | |
The MouseCameraController type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ClosedHandCursor | Gets a predefined cursor that shows a closed hand. |
| EventsSourceElement | Gets or sets the element where the mouse events are subscribed. If the property is not set, Viewport3D element on the TargetCamera is used as event source. |
| EventsSourceElementName | Gets or sets the name of the element where the mouse events are subscribed. |
| EventsSourceElementRotationChange | Gets or sets a double value that specifies for how many degrees the camera is rotates when the mouse moves from one side of the EventsSourceElement to another size. The default value is 270. |
| IsAttitudeRotationEnabled | Gets or sets a Boolean that specifies if attitude rotation (around x axis) is enabled. Default value is true. |
| IsCameraAnimationStoppedOnUserAction | Gets or sets a boolean that specifies if camera animation that is running with AnimationController is stopped if user start rotating or moving the camera with mouse or touch. If false then animation is not stopped and this prevents user from rotating or moving the camera with mouse or touch. Default value is true. This value does not have any effect on camera rotation that is started with StartRotation(Double, Double) method. |
| IsConcurrentTouchZoomEnabled | Gets or sets a boolean that specifies if scaling with pinch while rotating the camera with touch is enabled (requires .Net 4 version of Ab3d.PowerToys to work). Default value is true. |
| IsHeadingRotationEnabled | Gets or sets a Boolean that specifies if heading rotation (when changing the mouse in x direction) is enabled. Default value is true. |
| IsMouseWheelZoomEnabled | Gets or sets if zooming (moving camera forward and backward) by mouse wheel is enabled |
| IsRotateCursorShownOnMouseOver | Gets or sets a boolean that specifies if RotationCursor is shown if UsedMouseButton is set to Left and mouse is over the EventsSourceElement. Default value is true. |
| IsRotationDirectionAdjusted | Gets or sets Boolean that specifies if rotation direction is based on current mouse position and attitude angle. When false (by default), moving the mouse to the right always increases the heading regardless of mouse position and attitude angle. When true, the rotation direction is based on the current mouse position in the 3D scene and current attitude angle. |
| IsTouchEnabled | Gets a boolean that specifies if any of IsTouchRotateEnabled or IsTouchMoveEnabled or IsTouchZoomEnabled is enabled. |
| IsTouchMoveEnabled | Gets or sets a boolean that specifies if moving the camera with touch is enabled (requires .Net 4 version of Ab3d.PowerToys to work). Default value is false. |
| IsTouchRotateEnabled | Gets or sets a boolean that specifies if rotating the camera with touch is enabled (requires .Net 4 version of Ab3d.PowerToys to work). Default value is true. |
| IsTouchZoomEnabled | Gets or sets a boolean that specifies if zooming the camera with multi-touch pinch is enabled (requires .Net 4 version of Ab3d.PowerToys to work). Default value is true. |
| IsXAxisInverted | Gets or sets if x axis (heading) is inverted. Default value is false. |
| IsXMovementEnabled | Gets or sets a Boolean that specifies if movement the mouse in x direction is processed by this MouseCameraController. Default value is true. |
| IsYAxisInverted | Gets or sets if y axis (attitude) is inverted. Default value is false. |
| IsYMovementEnabled | Gets or sets a Boolean that specifies if movement the mouse in y direction is processed by this MouseCameraController. Default value is true. |
| MaxCameraDistance | Gets or sets a double value that when set to a value that is not double.NaN, than it specifies the maximum Distance of the camera or the maximum CameraWidth when OrthographicCamera is used. This property can be set to a reasonable number to prevent float imprecision when the camera distance is very big. Default value is double.NaN. |
| MouseMoveThreshold | Gets or sets a double value that specifies how much user needs to move the mouse before rotation, movement or quick zoom are started. Until mouse is moved for the specified amount, the MouseCameraController does not handle mouse events so they can be get for other processing (for example to handle mouse click). When 0 (by default), then rotation, movement or quick zoom are started immediately when the correct mouse buttons and keyboard modifiers are pressed (no mouse movement needed). |
| MouseWheelDistanceChangeFactor | Gets or sets a double value that specifies a value that used when zooming with mouse wheel. When zooming out the Camera's Distance or CameraWidth is multiplied with this value. When zooming in the Camera's Distance or CameraWidth is divided with this value. Default value is 1.05. Bigger value increases the speed of zooming with mouse wheel. The value should be bigger then 1. |
 | MoveCameraConditions | Gets or sets conditions from MouseAndKeyboardConditions enum that must be met to move the camera. Default value is MouseAndKeyboardConditions.RightMouseButtonPressed and MouseAndKeyboardConditions.AltKey. |
| MovementCursor | Gets or sets a Cursor that is used when the mouse is moving the Ab3d.Camera. |
| MoveOnlyHorizontally | When true he camera moving is restricted only to horizontal (XZ) plane. This means that the camera cannot be moved up and down. Default value is false that moves the camera based on the current look and up direction. |
| OpenedHandCursor | Gets a predefined cursor that shows an open hand. |
| QuickZoomConditions | Gets or sets conditions from MouseCameraControllerMouseAndKeyboardConditions 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. |
| QuickZoomCursor | Gets or sets a Cursor that is used when user is using quick zooming. Default value is Cursors.ScrollNS. |
| QuickZoomMaxFactorScreenDistance | QuickZoomZoomOutFactor is used when QuickZoomConditions are satisfied and defines the zoom out speed. The QuickZoomMaxFactorScreenDistance defines how much the mouse needs to travel in the forward or backward direction to reach the QuickZoomMaxZoomInFactor or QuickZoomZoomOutFactor. Default value is 200. |
| QuickZoomMaxZoomInFactor | QuickZoomMaxZoomInFactor is used when QuickZoomConditions are satisfied and defines the maximum zoom in factor. The maximum zoom in factor is reached when the user moves the mouse for the QuickZoomMaxFactorScreenDistance distance in the forward direction. If user moves the mouse farther away the zooming is not performed any more. Default value is 20 and means that the max zoom in factor is 20x - the Camera.Distance will be reduced to its 0.05 (1/20) initial value. |
| QuickZoomZoomOutFactor | QuickZoomZoomOutFactor is used when QuickZoomConditions are satisfied and defines the zoom out speed. The property defines the zoom out factor that is used when the mouse travels for the QuickZoomMaxFactorScreenDistance amount in the backwards mouse direction. Zoom out does not stop at this zoom factor as with zooming in (see QuickZoomMaxZoomInFactor). Default value is 10 and means that the zoom out factor is 10x - the Camera.Distance will be increased to 10 times its initial value after the mouse moves for the QuickZoomMaxFactorScreenDistance amount in the backwards mouse direction. |
| RotateAroundMousePosition | Gets or sets a Boolean that specifies if TargetPositionCamera or FreeCamera is rotated around a 3D position that is "behind" current mouse position. When RotateAroundMousePosition is true and user starts cameras rotation, MouseCameraController sets the TargetPositionCamera.RotationCenterPosition or FreeCamera.RotationCenterPosition property. Default value is false. |
| RotateCameraConditions | Gets or sets conditions from MouseAndKeyboardConditions enum that must be met to rotate the camera. Default value is MouseAndKeyboardConditions.RightMouseButtonPressed. |
| RotateCursorLeft | Gets a predefined cursor that can be used while rotating the camera with the mouse. |
| RotateCursorRight | Gets a predefined cursor that can be used while rotating the camera with the mouse. This is the default cursor that is used by the MouseCameraController. |
| RotationCenterAdorner | Gets or sets a CameraTargetPositionAdorner that is used to show the position around which the camera is rotating. This adorner is shown only when ShowRotationCenterMarker is set to true. When this property is not set, a new instance of CameraTargetPositionAdorner is used. |
| RotationCursor | Gets or sets a Cursor that is used when the mouse is rotating the Ab3d.Camera. |
| RotationEasingFunction | Gets or sets a delegate that specifies the easing functions used to calculate the rotation inertia. |
| RotationInertiaRatio | Gets or sets a double that specifies how strong the camera rotation inertial is. When set to 0 (or negative value), camera does not have any inertia. Default value is 1. Values bigger than 1, increase the time it takes to stop the camera. |
| ShowQuickZoomMarker | Gets or sets a Boolean that specifies if RotationCenterAdorner is shown at the position that represents the quick zoom target on the 2D screen. Default value is true. |
| ShowRotationCenterMarker | Gets or sets a Boolean that specifies if RotationCenterAdorner is shown at the position around which the camera is rotating. If RotationCenterAdorner is not specified, a new instance of CameraTargetPositionAdorner is created and set to the RotationCenterAdorner property. Default value is false. |
| UsedMouseButton | Obsolete. Gets or sets a MouseButton that specifies on which mouse button will be used to rotate and move the camera. Default value is Right mouse button. UsedMouseButton is obsolete. Please use the RotateCameraConditions and the MoveCameraConditions properties instead. |
| UseMousePositionForMovementSpeed | When true then the camera movement speed is determined by the distance to the 3D object behind the mouse. When no 3D object is behind the mouse or when UseMousePositionForMovementSpeed is set to false, then movement speed is determined by the distance from the camera to the TargetPosition is used. Default value is true. |
| ZoomMode | Gets or sets a value from a MouseCameraControllerCameraZoomMode enum that specifies the location into which camera is zoomed. Note that MousePosition and CameraRotationCenterPosition work only for TargetPositionCamera and FreeCamera. Default value is Viewport3DCenter. |
See Also