PreferencesInput(bpy_struct)

base class — bpy_struct

class bpy.types.PreferencesInput(bpy_struct)

Settings for input devices

drag_threshold

Number of pixels to drag before a drag event is triggered for keyboard and other non mouse/tablet input (otherwise click events are detected)

Type

int in [1, 255], default 30

drag_threshold_mouse

Number of pixels to drag before a tweak/drag event is triggered for mouse/trackpad input (otherwise click events are detected)

Type

int in [1, 255], default 3

drag_threshold_tablet

Number of pixels to drag before a tweak/drag event is triggered for tablet input (otherwise click events are detected)

Type

int in [1, 255], default 10

invert_mouse_zoom

Invert the axis of mouse movement for zooming

Type

boolean, default False

invert_zoom_wheel

Swap the Mouse Wheel zoom direction

Type

boolean, default False

mouse_double_click_time

Time/delay (in ms) for a double click

Type

int in [1, 1000], default 350

mouse_emulate_3_button_modifier

Hold this modifier to emulate the middle mouse button

Type

enum in [‘ALT’, ‘OSKEY’], default ‘ALT’

move_threshold

Number of pixels to before the cursor is considered to have moved (used for cycling selected items on successive clicks)

Type

int in [0, 255], default 2

navigation_mode

Which method to use for viewport navigation

• WALK Walk – Interactively walk or free navigate around the scene.

• FLY Fly – Use fly dynamics to navigate the scene.

Type

enum in [‘WALK’, ‘FLY’], default ‘WALK’

ndof_deadzone

Threshold of initial movement needed from the device’s rest position

Type

float in [0, 1], default 0.1

ndof_fly_helicopter

Device up/down directly controls the Z position of the 3D viewport

Type

boolean, default False

ndof_lock_horizon

Keep horizon level while flying with 3D Mouse

Type

boolean, default True

ndof_orbit_sensitivity

Overall sensitivity of the 3D Mouse for orbiting

Type

float in [0.01, 40], default 4.0

ndof_pan_yz_swap_axis

Pan using up/down on the device (otherwise forward/backward)

Type

boolean, default False

ndof_panx_invert_axis

Type

boolean, default True

ndof_pany_invert_axis

Type

boolean, default True

ndof_panz_invert_axis

Type

boolean, default True

ndof_rotx_invert_axis

Type

boolean, default True

ndof_roty_invert_axis

Type

boolean, default True

ndof_rotz_invert_axis

Type

boolean, default True

ndof_sensitivity

Overall sensitivity of the 3D Mouse for panning

Type

float in [0.01, 40], default 4.0

ndof_show_guide

Display the center and axis during rotation

Type

boolean, default False

ndof_view_navigate_method

Navigation style in the viewport

• FREE Free – Use full 6 degrees of freedom by default.

• ORBIT Orbit – Orbit about the view center by default.

Type

enum in [‘FREE’, ‘ORBIT’], default ‘FREE’

ndof_view_rotate_method

Rotation style in the viewport

• TURNTABLE Turntable – Use turntable style rotation in the viewport.

• TRACKBALL Trackball – Use trackball style rotation in the viewport.

Type

enum in [‘TURNTABLE’, ‘TRACKBALL’], default ‘TRACKBALL’

ndof_zoom_invert

Zoom using opposite direction

Type

boolean, default True

pressure_softness

Adjusts softness of the low pressure response onset using a gamma curve

Type

float in [-inf, inf], default 0.0

pressure_threshold_max

Raw input pressure value that is interpreted as 100% by Blender

Type

float in [0, 1], default 1.0

tablet_api

Select the tablet API to use for pressure sensitivity (may require restarting Blender for changes to take effect)

• AUTOMATIC Automatic – Automatically choose Wintab or Windows Ink depending on the device.

• WINDOWS_INK Windows Ink – Use native Windows Ink API, for modern tablet and pen devices. Requires Windows 8 or newer.

• WINTAB Wintab – Use Wintab driver for older tablets and Windows versions.

Type

enum in [‘AUTOMATIC’, ‘WINDOWS_INK’, ‘WINTAB’], default ‘AUTOMATIC’

use_auto_perspective

Automatically switch between orthographic and perspective when changing from top/front/side views

Type

boolean, default True

use_drag_immediately

Moving things with a mouse drag confirms when releasing the button

Type

boolean, default True

use_emulate_numpad

Main 1 to 0 keys act as the numpad ones (useful for laptops)

Type

boolean, default False

use_mouse_continuous

Let the mouse wrap around the view boundaries so mouse movements are not limited by the screen size (used by transform, dragging of UI controls, etc.)

Type

boolean, default True

use_mouse_depth_navigate

Use the depth under the mouse to improve view pan/rotate/zoom functionality

Type

boolean, default False

use_mouse_emulate_3_button

Emulate Middle Mouse with Alt+Left Mouse

Type

boolean, default False

use_ndof

Type

boolean, default True, (readonly)

use_numeric_input_advanced

When entering numbers while transforming, default to advanced mode for full math expression evaluation

Type

boolean, default False

use_rotate_around_active

Use selection as the pivot point

Type

boolean, default False

use_zoom_to_mouse

Zoom in towards the mouse pointer’s position in the 3D view, rather than the 2D window center

Type

boolean, default False

view_rotate_method

Orbit method in the viewport

• TURNTABLE Turntable – Turntable keeps the Z-axis upright while orbiting.

• TRACKBALL Trackball – Trackball allows you to tumble your view at any angle.

Type

enum in [‘TURNTABLE’, ‘TRACKBALL’], default ‘TURNTABLE’

view_rotate_sensitivity_trackball

Scale trackball orbit sensitivity

Type

float in [0.1, 10], default 1.0

view_rotate_sensitivity_turntable

Rotation amount per pixel to control how fast the viewport orbits

Type

float in [1.74533e-05, 0.261799], default 0.00698132

view_zoom_axis

Axis of mouse movement to zoom in or out on

• VERTICAL Vertical – Zoom in and out based on vertical mouse movement.

• HORIZONTAL Horizontal – Zoom in and out based on horizontal mouse movement.

Type

enum in [‘VERTICAL’, ‘HORIZONTAL’], default ‘VERTICAL’

view_zoom_method

Which style to use for viewport scaling

• CONTINUE Continue – Continuous zooming. The zoom direction and speed depends on how far along the set Zoom Axis the mouse has moved.

• DOLLY Dolly – Zoom in and out based on mouse movement along the set Zoom Axis.

• SCALE Scale – Zoom in and out as if you are scaling the view, mouse movements relative to center.

Type

enum in [‘CONTINUE’, ‘DOLLY’, ‘SCALE’], default ‘DOLLY’

walk_navigation

Settings for walk navigation mode

Type

WalkNavigation, (readonly, never None)

classmethod bl_rna_get_subclass(id, default=None)

Parameters

id (string) – The RNA type identifier.

Returns

The RNA type or default when not found.

Return type

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)

Parameters

id (string) – The RNA type identifier.

Returns

The class or default when not found.

Return type

type

Inherited Properties

bpy_struct.id_data

Inherited Functions

bpy_struct.as_pointer bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.id_properties_clear bpy_struct.id_properties_ensure bpy_struct.id_properties_ui bpy_struct.is_property_hidden bpy_struct.is_property_overridable_library bpy_struct.is_property_readonly bpy_struct.is_property_set

bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.pop bpy_struct.property_overridable_library_set bpy_struct.property_unset bpy_struct.type_recast bpy_struct.values

References

Preferences.inputs