Space(bpy_struct)¶
base class — bpy_struct
subclasses —
SpaceClipEditor
, SpaceConsole
, SpaceDopeSheetEditor
, SpaceFileBrowser
, SpaceGraphEditor
, SpaceImageEditor
, SpaceInfo
, SpaceLogicEditor
, SpaceNLA
, SpaceNodeEditor
, SpaceOutliner
, SpacePreferences
, SpaceProperties
, SpaceSequenceEditor
, SpaceSpreadsheet
, SpaceTextEditor
, SpaceView3D
- class bpy.types.Space(bpy_struct)¶
Space data for a screen area
- show_locked_time¶
Synchronize the visible timeline range with other time-based editors
- Type:
boolean, default False
- show_region_header¶
- Type:
boolean, default False
- type¶
Space data type
- Type:
enum in Space Type Items, default ‘EMPTY’, (readonly)
- classmethod bl_rna_get_subclass(id, default=None)¶
- Parameters:
id (str) – 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 (str) – The RNA type identifier.
- Returns:
The class or default when not found.
- Return type:
- classmethod 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 (Callable[[Any, ...], Any]) – A function that will be called when the region is drawn. It gets the specified arguments as input, it’s return value is ignored.
args (tuple[Any, ...]) – 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
- classmethod 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.