Clip Operators

bpy.ops.clip.add_marker(location=(0.0, 0.0))

Place new marker at specified location

Parameters:location (float array of 2 items in [-inf, inf], (optional)) – Location, Location of marker on frame

bpy.ops.clip.add_marker_at_click()

Place new marker at the desired (clicked) position

bpy.ops.clip.add_marker_move(CLIP_OT_add_marker=None, TRANSFORM_OT_translate=None)

Add new marker and move it on movie

Parameters:

• CLIP_OT_add_marker (CLIP_OT_add_marker, (optional)) – Add Marker, Place new marker at specified location
• TRANSFORM_OT_translate (TRANSFORM_OT_translate, (optional)) – Translate, Translate (move) selected items

bpy.ops.clip.add_marker_slide(CLIP_OT_add_marker=None, TRANSFORM_OT_translate=None)

Add new marker and slide it with mouse until mouse button release

Parameters:

• CLIP_OT_add_marker (CLIP_OT_add_marker, (optional)) – Add Marker, Place new marker at specified location
• TRANSFORM_OT_translate (TRANSFORM_OT_translate, (optional)) – Translate, Translate (move) selected items

bpy.ops.clip.apply_solution_scale(distance=0.0)

Apply scale on solution itself to make distance between selected tracks equals to desired

Parameters:distance (float in [-inf, inf], (optional)) – Distance, Distance between selected tracks

bpy.ops.clip.bundles_to_mesh()

Create vertex cloud using coordinates of reconstructed tracks

File:startup/bl_operators/clip.py:277

bpy.ops.clip.camera_preset_add(remove_active=False, name="", use_focal_length=True)

Add or remove a Tracking Camera Intrinsics Preset

Parameters:

• remove_active (boolean, (optional)) – remove_active
• name (string, (optional, never None)) – Name, Name of the preset, used to make the path name
• use_focal_length (boolean, (optional)) – Include Focal Length, Include focal length into the preset

File:

startup/bl_operators/presets.py:54

bpy.ops.clip.change_frame(frame=0)

Interactively change the current frame number

Parameters:frame (int in [-300000, 300000], (optional)) – Frame

bpy.ops.clip.clean_tracks(frames=0, error=0.0, action='SELECT')

Clean tracks with high error values or few frames

Parameters:

• frames (int in [0, inf], (optional)) – Tracked Frames, Effect on tracks which are tracked less than specified amount of frames
• error (float in [0, inf], (optional)) – Reprojection Error, Effect on tracks which have got larger re-projection error
• action (enum in [‘SELECT’, ‘DELETE_TRACK’, ‘DELETE_SEGMENTS’], (optional)) –

  Action, Cleanup action to execute

  • SELECT Select, Select unclean tracks.
  • DELETE_TRACK Delete Track, Delete unclean tracks.
  • DELETE_SEGMENTS Delete Segments, Delete unclean segments of tracks.

bpy.ops.clip.clear_solution()

Clear all calculated data

bpy.ops.clip.clear_track_path(action='REMAINED', clear_active=False)

Clear tracks after/before current position or clear the whole track

Parameters:

• action (enum in [‘UPTO’, ‘REMAINED’, ‘ALL’], (optional)) –

  Action, Clear action to execute

  • UPTO Clear up-to, Clear path up to current frame.
  • REMAINED Clear remained, Clear path at remaining frames (after current).
  • ALL Clear all, Clear the whole path.
• clear_active (boolean, (optional)) – Clear Active, Clear active track only instead of all selected tracks

bpy.ops.clip.constraint_to_fcurve()

Create F-Curves for object which will copy object’s movement caused by this constraint

File:startup/bl_operators/clip.py:502

bpy.ops.clip.copy_tracks()

Copy selected tracks to clipboard

bpy.ops.clip.create_plane_track()

Create new plane track out of selected point tracks

bpy.ops.clip.cursor_set(location=(0.0, 0.0))

Set 2D cursor location

Parameters:location (float array of 2 items in [-inf, inf], (optional)) – Location, Cursor location in normalized clip coordinates

bpy.ops.clip.delete_marker()

Delete marker for current frame from selected tracks

bpy.ops.clip.delete_proxy()

Delete movie clip proxy files from the hard drive

File:startup/bl_operators/clip.py:345

bpy.ops.clip.delete_track()

Delete selected tracks

bpy.ops.clip.detect_features(placement='FRAME', margin=16, threshold=0.5, min_distance=120)

Automatically detect features and place markers to track

Parameters:

• placement (enum in [‘FRAME’, ‘INSIDE_GPENCIL’, ‘OUTSIDE_GPENCIL’], (optional)) –

  Placement, Placement for detected features

  • FRAME Whole Frame, Place markers across the whole frame.
  • INSIDE_GPENCIL Inside grease pencil, Place markers only inside areas outlined with grease pencil.
  • OUTSIDE_GPENCIL Outside grease pencil, Place markers only outside areas outlined with grease pencil.
• margin (int in [0, inf], (optional)) – Margin, Only features further than margin pixels from the image edges are considered
• threshold (float in [0.0001, inf], (optional)) – Threshold, Threshold level to consider feature good enough for tracking
• min_distance (int in [0, inf], (optional)) – Distance, Minimal distance accepted between two features

bpy.ops.clip.disable_markers(action='DISABLE')

Disable/enable selected markers

Parameters:action (enum in [‘DISABLE’, ‘ENABLE’, ‘TOGGLE’], (optional)) –

Action, Disable action to execute

• DISABLE Disable, Disable selected markers.
• ENABLE Enable, Enable selected markers.
• TOGGLE Toggle, Toggle disabled flag for selected markers.

bpy.ops.clip.dopesheet_select_channel(location=(0.0, 0.0), extend=False)

Select movie tracking channel

Parameters:

• location (float array of 2 items in [-inf, inf], (optional)) – Location, Mouse location to select channel
• extend (boolean, (optional)) – Extend, Extend selection rather than clearing the existing selection

bpy.ops.clip.dopesheet_view_all()

Reset viewable area to show full keyframe range

bpy.ops.clip.filter_tracks(track_threshold=5.0)

Filter tracks which has weirdly looking spikes in motion curves

Parameters:track_threshold (float in [-inf, inf], (optional)) – Track Threshold, Filter Threshold to select problematic tracks File:startup/bl_operators/clip.py:197

bpy.ops.clip.frame_jump(position='PATHSTART')

Jump to special frame

Parameters:position (enum in [‘PATHSTART’, ‘PATHEND’, ‘FAILEDPREV’, ‘FAILNEXT’], (optional)) –

Position, Position to jump to

• PATHSTART Path Start, Jump to start of current path.
• PATHEND Path End, Jump to end of current path.
• FAILEDPREV Previous Failed, Jump to previous failed frame.
• FAILNEXT Next Failed, Jump to next failed frame.

bpy.ops.clip.graph_center_current_frame()

Scroll view so current frame would be centered

bpy.ops.clip.graph_delete_curve()

Delete track corresponding to the selected curve

bpy.ops.clip.graph_delete_knot()

Delete curve knots

bpy.ops.clip.graph_disable_markers(action='DISABLE')

Disable/enable selected markers

Parameters:action (enum in [‘DISABLE’, ‘ENABLE’, ‘TOGGLE’], (optional)) –

Action, Disable action to execute

• DISABLE Disable, Disable selected markers.
• ENABLE Enable, Enable selected markers.
• TOGGLE Toggle, Toggle disabled flag for selected markers.

bpy.ops.clip.graph_select(location=(0.0, 0.0), extend=False)

Select graph curves

Parameters:

• location (float array of 2 items in [-inf, inf], (optional)) – Location, Mouse location to select nearest entity
• extend (boolean, (optional)) – Extend, Extend selection rather than clearing the existing selection

bpy.ops.clip.graph_select_all_markers(action='TOGGLE')

Change selection of all markers of active track

Parameters:action (enum in [‘TOGGLE’, ‘SELECT’, ‘DESELECT’, ‘INVERT’], (optional)) –

Action, Selection action to execute

• TOGGLE Toggle, Toggle selection for all elements.
• SELECT Select, Select all elements.
• DESELECT Deselect, Deselect all elements.
• INVERT Invert, Invert selection of all elements.

bpy.ops.clip.graph_select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0, extend=True)

Select curve points using border selection

Parameters:

• gesture_mode (int in [-inf, inf], (optional)) – Gesture Mode
• xmin (int in [-inf, inf], (optional)) – X Min
• xmax (int in [-inf, inf], (optional)) – X Max
• ymin (int in [-inf, inf], (optional)) – Y Min
• ymax (int in [-inf, inf], (optional)) – Y Max
• extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first

bpy.ops.clip.graph_view_all()

View all curves in editor

bpy.ops.clip.hide_tracks(unselected=False)

Hide selected tracks

Parameters:unselected (boolean, (optional)) – Unselected, Hide unselected tracks

bpy.ops.clip.hide_tracks_clear()

Clear hide selected tracks

bpy.ops.clip.join_tracks()

Join selected tracks

bpy.ops.clip.keyframe_delete()

Delete a keyframe from selected tracks at current frame

bpy.ops.clip.keyframe_insert()

Insert a keyframe to selected tracks at current frame

bpy.ops.clip.lock_tracks(action='LOCK')

Lock/unlock selected tracks

Parameters:action (enum in [‘LOCK’, ‘UNLOCK’, ‘TOGGLE’], (optional)) –

Action, Lock action to execute

• LOCK Lock, Lock selected tracks.
• UNLOCK Unlock, Unlock selected tracks.
• TOGGLE Toggle, Toggle locked flag for selected tracks.

bpy.ops.clip.mode_set(mode='TRACKING')

Set the clip interaction mode

Parameters:mode (enum in [‘TRACKING’, ‘MASK’], (optional)) –

Mode

• TRACKING Tracking, Show tracking and solving tools.
• MASK Mask, Show mask editing tools.

bpy.ops.clip.open(directory="", files=None, filter_blender=False, filter_backup=False, filter_image=True, filter_movie=True, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_btx=False, filter_collada=False, filter_folder=True, filemode=9, relative_path=True, display_type='FILE_DEFAULTDISPLAY')

Load a sequence of frames or a movie file

Parameters:

• directory (string, (optional, never None)) – Directory, Directory of the file
• files (bpy_prop_collection of OperatorFileListElement, (optional)) – Files
• filter_blender (boolean, (optional)) – Filter .blend files
• filter_backup (boolean, (optional)) – Filter .blend files
• filter_image (boolean, (optional)) – Filter image files
• filter_movie (boolean, (optional)) – Filter movie files
• filter_python (boolean, (optional)) – Filter python files
• filter_font (boolean, (optional)) – Filter font files
• filter_sound (boolean, (optional)) – Filter sound files
• filter_text (boolean, (optional)) – Filter text files
• filter_btx (boolean, (optional)) – Filter btx files
• filter_collada (boolean, (optional)) – Filter COLLADA files
• filter_folder (boolean, (optional)) – Filter folders
• filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
• relative_path (boolean, (optional)) – Relative Path, Select the file relative to the blend file
• display_type (enum in [‘FILE_DEFAULTDISPLAY’, ‘FILE_SHORTDISPLAY’, ‘FILE_LONGDISPLAY’, ‘FILE_IMGDISPLAY’], (optional)) –

  Display Type

  • FILE_DEFAULTDISPLAY Default, Automatically determine display type for files.
  • FILE_SHORTDISPLAY Short List, Display files as short list.
  • FILE_LONGDISPLAY Long List, Display files as a detailed list.
  • FILE_IMGDISPLAY Thumbnails, Display files as thumbnails.

bpy.ops.clip.paste_tracks()

Paste tracks from clipboard

bpy.ops.clip.prefetch()

Prefetch frames from disk for faster playback/tracking

bpy.ops.clip.properties()

Toggle clip properties panel

bpy.ops.clip.rebuild_proxy()

Rebuild all selected proxies and timecode indices in the background

bpy.ops.clip.refine_markers(backwards=False)

Refine selected markers positions by running the tracker from track’s reference to current frame

Parameters:backwards (boolean, (optional)) – Backwards, Do backwards tracking

bpy.ops.clip.reload()

Reload clip

bpy.ops.clip.select(extend=False, location=(0.0, 0.0))

Select tracking markers

Parameters:

• extend (boolean, (optional)) – Extend, Extend selection rather than clearing the existing selection
• location (float array of 2 items in [-inf, inf], (optional)) – Location, Mouse location in normalized coordinates, 0.0 to 1.0 is within the image bounds

bpy.ops.clip.select_all(action='TOGGLE')

Change selection of all tracking markers

Parameters:action (enum in [‘TOGGLE’, ‘SELECT’, ‘DESELECT’, ‘INVERT’], (optional)) –

Action, Selection action to execute

• TOGGLE Toggle, Toggle selection for all elements.
• SELECT Select, Select all elements.
• DESELECT Deselect, Deselect all elements.
• INVERT Invert, Invert selection of all elements.

bpy.ops.clip.select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0, extend=True)

Select markers using border selection

Parameters:

• gesture_mode (int in [-inf, inf], (optional)) – Gesture Mode
• xmin (int in [-inf, inf], (optional)) – X Min
• xmax (int in [-inf, inf], (optional)) – X Max
• ymin (int in [-inf, inf], (optional)) – Y Min
• ymax (int in [-inf, inf], (optional)) – Y Max
• extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first

bpy.ops.clip.select_circle(x=0, y=0, radius=1, gesture_mode=0)

Select markers using circle selection

Parameters:

• x (int in [-inf, inf], (optional)) – X
• y (int in [-inf, inf], (optional)) – Y
• radius (int in [1, inf], (optional)) – Radius
• gesture_mode (int in [-inf, inf], (optional)) – Gesture Mode

bpy.ops.clip.select_grouped(group='ESTIMATED')

Select all tracks from specified group

Parameters:group (enum in [‘KEYFRAMED’, ‘ESTIMATED’, ‘TRACKED’, ‘LOCKED’, ‘DISABLED’, ‘COLOR’, ‘FAILED’], (optional)) –

Action, Clear action to execute

• KEYFRAMED Keyframed tracks, Select all keyframed tracks.
• ESTIMATED Estimated tracks, Select all estimated tracks.
• TRACKED Tracked tracks, Select all tracked tracks.
• LOCKED Locked tracks, Select all locked tracks.
• DISABLED Disabled tracks, Select all disabled tracks.
• COLOR Tracks with same color, Select all tracks with same color as active track.
• FAILED Failed Tracks, Select all tracks which failed to be reconstructed.

bpy.ops.clip.select_lasso(path=None, deselect=False, extend=True)

Select markers using lasso selection

Parameters:

• path (bpy_prop_collection of OperatorMousePath, (optional)) – Path
• deselect (boolean, (optional)) – Deselect, Deselect rather than select items
• extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first

bpy.ops.clip.set_active_clip()

Undocumented

File:startup/bl_operators/clip.py:212

bpy.ops.clip.set_axis(axis='X')

Set direction of scene axis rotating camera (or its parent if present) and assume selected track lies on real axis, joining it with the origin

Parameters:axis (enum in [‘X’, ‘Y’], (optional)) –

Axis, Axis to use to align bundle along

• X X, Align bundle align X axis.
• Y Y, Align bundle align Y axis.

bpy.ops.clip.set_center_principal()

Set optical center to center of footage

bpy.ops.clip.set_origin(use_median=False)

Set active marker as origin by moving camera (or its parent if present) in 3D space

Parameters:use_median (boolean, (optional)) – Use Median, Set origin to median point of selected bundles

bpy.ops.clip.set_plane(plane='FLOOR')

Set plane based on 3 selected bundles by moving camera (or its parent if present) in 3D space

Parameters:plane (enum in [‘FLOOR’, ‘WALL’], (optional)) –

Plane, Plane to be used for orientation

• FLOOR Floor, Set floor plane.
• WALL Wall, Set wall plane.

bpy.ops.clip.set_scale(distance=0.0)

Set scale of scene by scaling camera (or its parent if present)

Parameters:distance (float in [-inf, inf], (optional)) – Distance, Distance between selected tracks

bpy.ops.clip.set_scene_frames()

Set scene’s start and end frame to match clip’s start frame and length

bpy.ops.clip.set_solution_scale(distance=0.0)

Set object solution scale using distance between two selected tracks

Parameters:distance (float in [-inf, inf], (optional)) – Distance, Distance between selected tracks

bpy.ops.clip.set_solver_keyframe(keyframe='KEYFRAME_A')

Set keyframe used by solver

Parameters:keyframe (enum in [‘KEYFRAME_A’, ‘KEYFRAME_B’], (optional)) – Keyframe, Keyframe to set

bpy.ops.clip.set_viewport_background()

Set current movie clip as a camera background in 3D view-port (works only when a 3D view-port is visible)

File:startup/bl_operators/clip.py:406

bpy.ops.clip.setup_tracking_scene()

Prepare scene for compositing 3D objects into this footage

File:startup/bl_operators/clip.py:970

bpy.ops.clip.slide_marker(offset=(0.0, 0.0))

Slide marker areas

Parameters:offset (float array of 2 items in [-inf, inf], (optional)) – Offset, Offset in floating point units, 1.0 is the width and height of the image

bpy.ops.clip.slide_plane_marker()

Slide plane marker areas

bpy.ops.clip.solve_camera()

Solve camera motion from tracks

bpy.ops.clip.stabilize_2d_add()

Add selected tracks to 2D stabilization tool

bpy.ops.clip.stabilize_2d_remove()

Remove selected track from stabilization

bpy.ops.clip.stabilize_2d_select()

Select tracks which are used for stabilization

bpy.ops.clip.stabilize_2d_set_rotation()

Use active track to compensate rotation when doing 2D stabilization

bpy.ops.clip.tools()

Toggle clip tools panel

bpy.ops.clip.track_color_preset_add(remove_active=False, name="")

Add or remove a Clip Track Color Preset

Parameters:

• remove_active (boolean, (optional)) – remove_active
• name (string, (optional, never None)) – Name, Name of the preset, used to make the path name

File:

startup/bl_operators/presets.py:54

bpy.ops.clip.track_copy_color()

Copy color to all selected tracks

bpy.ops.clip.track_markers(backwards=False, sequence=False, clip="")

Track selected markers

Parameters:

• backwards (boolean, (optional)) – Backwards, Do backwards tracking
• sequence (boolean, (optional)) – Track Sequence, Track marker during image sequence rather than single image
• clip (string, (optional, never None)) – Movie Clip, Movie Clip to be tracked

bpy.ops.clip.track_settings_as_default()

Copy tracking settings from active track to default settings

File:startup/bl_operators/clip.py:1007

bpy.ops.clip.track_settings_to_track()

Copy tracking settings from active track to selected tracks

File:startup/bl_operators/clip.py:1055

bpy.ops.clip.track_to_empty()

Create an Empty object which will be copying movement of active track

File:startup/bl_operators/clip.py:253

bpy.ops.clip.tracking_object_new()

Add new object for tracking

bpy.ops.clip.tracking_object_remove()

Remove object for tracking

bpy.ops.clip.tracking_settings_preset_add(remove_active=False, name="")

Add or remove a motion tracking settings preset

Parameters:

• remove_active (boolean, (optional)) – remove_active
• name (string, (optional, never None)) – Name, Name of the preset, used to make the path name

File:

startup/bl_operators/presets.py:54

bpy.ops.clip.view_all(fit_view=False)

View whole image with markers

Parameters:fit_view (boolean, (optional)) – Fit View, Fit frame to the viewport

bpy.ops.clip.view_ndof()

Use a 3D mouse device to pan/zoom the view

bpy.ops.clip.view_pan(offset=(0.0, 0.0))

Pan the view

Parameters:offset (float array of 2 items in [-inf, inf], (optional)) – Offset, Offset in floating point units, 1.0 is the width and height of the image

bpy.ops.clip.view_selected()

View all selected elements

bpy.ops.clip.view_zoom(factor=0.0)

Zoom in/out the view

Parameters:factor (float in [-inf, inf], (optional)) – Factor, Zoom factor, values higher than 1.0 zoom in, lower values zoom out

bpy.ops.clip.view_zoom_in(location=(0.0, 0.0))

Zoom in the view

Parameters:location (float array of 2 items in [-inf, inf], (optional)) – Location, Cursor location in screen coordinates

bpy.ops.clip.view_zoom_out(location=(0.0, 0.0))

Zoom out the view

Parameters:location (float array of 2 items in [-inf, inf], (optional)) – Location, Cursor location in normalized (0.0-1.0) coordinates

bpy.ops.clip.view_zoom_ratio(ratio=0.0)

Set the zoom ratio (based on clip size)

Parameters:ratio (float in [-inf, inf], (optional)) – Ratio, Zoom ratio, 1.0 is 1:1, higher is zoomed in, lower is zoomed out