plugins.finalcutpro.timeline.mousezoom

Allows you to zoom in or out of a Final Cut Pro timeline using the mechanical scroll wheel on your mouse or the Touch Pad on the Magic Mouse when holding down the OPTION modifier key.

Special Thanks: Iain Anderson (@funwithstuff) for all his incredible testing!

API Overview

Variables - Configurable values

customModifier
enabled
numberOfTouchDevices
offset
sensitivity
threshold

Functions - API calls offered directly by the extension

findMagicMouses
start
stop
update

API Documentation

Variables

customModifier


Signature	`plugins.finalcutpro.timeline.mousezoom.customModifier <cp.prop: boolean>`
Type	Variable
Description	Should Mouse Zoom be inverted?
Notes	None
Source	src/plugins/finalcutpro/timeline/mousezoom.lua line 83

enabled


Signature	`plugins.finalcutpro.timeline.mousezoom.enabled <cp.prop: boolean>`
Type	Variable
Description	Toggles the Enable Proxy Menu Icon
Notes	None
Source	src/plugins/finalcutpro/timeline/mousezoom.lua line 73

numberOfTouchDevices


Signature	`plugins.finalcutpro.timeline.mousezoom.numberOfTouchDevices -> number`
Type	Variable
Description	Number of Touch Devices Detected.
Notes	None
Source	src/plugins/finalcutpro/timeline/mousezoom.lua line 41

offset


Signature	`plugins.finalcutpro.timeline.mousezoom.offset -> number`
Type	Variable
Description	Offset Value used in difference calculations.
Notes	None
Source	src/plugins/finalcutpro/timeline/mousezoom.lua line 46

sensitivity


Signature	`plugins.finalcutpro.timeline.mousezoom.sensitivity <cp.prop: string>`
Type	Variable
Description	Sensitivity Level
Notes	None
Source	src/plugins/finalcutpro/timeline/mousezoom.lua line 88

threshold


Signature	`plugins.finalcutpro.timeline.mousezoom.threshold -> number`
Type	Variable
Description	Threshold Value used in difference calculations.
Notes	None
Source	src/plugins/finalcutpro/timeline/mousezoom.lua line 51

Functions

findMagicMouses


Signature	`plugins.finalcutpro.timeline.mousezoom.findMagicMouses() -> none`
Type	Function
Description	Find Magic Mouse Devices and adds them to a table.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/timeline/mousezoom.lua line 226

start


Signature	`plugins.finalcutpro.timeline.mousezoom.start() -> none`
Type	Function
Description	Enables the ability to zoon a timeline using your mouse scroll wheel and the OPTION modifier key.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/timeline/mousezoom.lua line 454

stop


Signature	`plugins.finalcutpro.timeline.mousezoom.stop() -> none`
Type	Function
Description	Disables the ability to zoom a timeline using your mouse scroll wheel and the OPTION modifier key.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/timeline/mousezoom.lua line 163

update


Signature	`plugins.finalcutpro.timeline.mousezoom.update() -> none`
Type	Function
Description	Checks to see whether or not we should enable the timeline zoom watchers.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/timeline/mousezoom.lua line 56