SpaceClipEditor(Space)
base classes — bpy_struct
, Space
- class bpy.types.SpaceClipEditor(Space)
Clip editor space data
- annotation_source
Where the annotation comes from
CLIP
Clip – Show annotation data-block which belongs to movie clip.TRACK
Track – Show annotation data-block which belongs to active track.
- Type
enum in [‘CLIP’, ‘TRACK’], default ‘CLIP’
- clip_user
Parameters defining which frame of the movie clip is displayed
- Type
MovieClipUser
, (readonly, never None)
- cursor_location
2D cursor location for this view
- Type
float array of 2 items in [-inf, inf], default (0.0, 0.0)
- lock_selection
Lock viewport to selected markers during playback
- Type
boolean, default False
- lock_time_cursor
Lock curves view to time cursor during playback and tracking
- Type
boolean, default False
- mask_display_type
Display type for mask splines
OUTLINE
Outline – Display white edges with black outline.DASH
Dash – Display dashed black-white edges.BLACK
Black – Display black edges.WHITE
White – Display white edges.
- Type
enum in [‘OUTLINE’, ‘DASH’, ‘BLACK’, ‘WHITE’], default ‘OUTLINE’
- mask_overlay_mode
Overlay mode of rasterized mask
ALPHACHANNEL
Alpha Channel – Show alpha channel of the mask.COMBINED
Combined – Combine space background image with the mask.
- Type
enum in [‘ALPHACHANNEL’, ‘COMBINED’], default ‘ALPHACHANNEL’
- mode
Editing context being displayed
TRACKING
Tracking – Show tracking and solving tools.MASK
Mask – Show mask editing tools.
- Type
enum in [‘TRACKING’, ‘MASK’], default ‘TRACKING’
- path_length
Length of displaying path, in frames
- Type
int in [0, inf], default 20
- pivot_point
Pivot center for rotation/scaling
BOUNDING_BOX_CENTER
Bounding Box Center – Pivot around bounding box center of selected object(s).CURSOR
2D Cursor – Pivot around the 2D cursor.INDIVIDUAL_ORIGINS
Individual Origins – Pivot around each object’s own origin.MEDIAN_POINT
Median Point – Pivot around the median point of selected objects.
- Type
enum in [‘BOUNDING_BOX_CENTER’, ‘CURSOR’, ‘INDIVIDUAL_ORIGINS’, ‘MEDIAN_POINT’], default ‘MEDIAN_POINT’
- scopes
Scopes to visualize movie clip statistics
- Type
MovieClipScopes
, (readonly)
- show_annotation
Show annotations for this view
- Type
boolean, default True
- show_blue_channel
Show blue channel in the frame
- Type
boolean, default False
- show_bundles
Show projection of 3D markers into footage
- Type
boolean, default False
- show_disabled
Show disabled tracks from the footage
- Type
boolean, default False
- show_filters
Show filters for graph editor
- Type
boolean, default False
- show_graph_frames
Show curve for per-frame average error (camera motion should be solved first)
- Type
boolean, default True
Include channels from objects/bone that aren’t visible
- Type
boolean, default False
- show_graph_only_selected
Only include channels relating to selected objects and data
- Type
boolean, default False
- show_graph_tracks_error
Display the reprojection error curve for selected tracks
- Type
boolean, default False
- show_graph_tracks_motion
Display the speed curves (in “x” direction red, in “y” direction green) for the selected tracks
- Type
boolean, default True
- show_green_channel
Show green channel in the frame
- Type
boolean, default False
- show_grid
Show grid showing lens distortion
- Type
boolean, default False
- show_marker_pattern
Show pattern boundbox for markers
- Type
boolean, default True
- show_marker_search
Show search boundbox for markers
- Type
boolean, default False
- show_mask_overlay
- Type
boolean, default False
- show_mask_smooth
- Type
boolean, default False
- show_metadata
Show metadata of clip
- Type
boolean, default False
- show_names
Show track names and status
- Type
boolean, default False
- show_red_channel
Show red channel in the frame
- Type
boolean, default False
- show_region_hud
- Type
boolean, default False
- show_region_toolbar
- Type
boolean, default False
- show_region_ui
- Type
boolean, default False
- show_seconds
Show timing in seconds not frames
- Type
boolean, default False
- show_stable
Show stable footage in editor (if stabilization is enabled)
- Type
boolean, default False
- show_tiny_markers
Show markers in a more compact manner
- Type
boolean, default False
- show_track_path
Show path of how track moves
- Type
boolean, default True
- use_grayscale_preview
Display frame in grayscale mode
- Type
boolean, default False
- use_manual_calibration
Use manual calibration helpers
- Type
boolean, default False
- use_mute_footage
Mute footage and show black background instead
- Type
boolean, default False
- view
Type of the clip editor view
CLIP
Clip – Show editing clip preview.GRAPH
Graph – Show graph view for active element.DOPESHEET
Dopesheet – Dopesheet view for tracking data.
- Type
enum in [‘CLIP’, ‘GRAPH’, ‘DOPESHEET’], default ‘CLIP’
- 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
- draw_handler_add(callback, args, region_type, draw_type)
Add a new draw handler to this space type. It will be called every time the specified region in the space type will be drawn. Note: All arguments are positional only for now.
- Parameters
callback (function) – A function that will be called when the region is drawn. It gets the specified arguments as input.
args (tuple) – Arguments that will be passed to the callback.
region_type (str) – The region type the callback draws in; usually
WINDOW
. (bpy.types.Region.type
)draw_type (str) – Usually
POST_PIXEL
for 2D drawing andPOST_VIEW
for 3D drawing. In some casesPRE_VIEW
can be used.BACKDROP
can be used for backdrops in the node editor.
- Returns
Handler that can be removed later on.
- Return type
object
- draw_handler_remove(handler, region_type)
Remove a draw handler that was added previously.
- Parameters
handler (object) – The draw handler that should be removed.
region_type (str) – Region type the callback was added to.
Inherited Properties
Inherited Functions