DNA_space_types.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "DNA_asset_types.h"
#include "DNA_color_types.h" /* for Histogram */
#include "DNA_defs.h"
#include "DNA_image_types.h" /* ImageUser */
#include "DNA_listBase.h"
#include "DNA_movieclip_types.h" /* MovieClipUser */
#include "DNA_node_types.h"      /* for bNodeInstanceKey */
#include "DNA_outliner_types.h"  /* for TreeStoreElem */
#include "DNA_space_enums.h"
/* Hum ... Not really nice... but needed for spacebuts. */
#include "DNA_view2d_types.h"
#include "DNA_viewer_path_types.h"
 
struct BLI_mempool;
struct FileLayout;
struct FileList;
struct FileSelectParams;
struct Histogram;
struct ID;
struct Image;
struct Mask;
struct MovieClip;
struct MovieClipScopes;
struct Scopes;
struct Script;
struct SpaceGraph;
struct Text;
struct bDopeSheet;
struct bGPdata;
struct bNodeTree;
struct wmOperator;
struct wmTimer;
 
#ifdef __cplusplus
namespace blender::asset_system {
class AssetRepresentation;
}
using AssetRepresentationHandle = blender::asset_system::AssetRepresentation;
#else
typedef struct AssetRepresentationHandle AssetRepresentationHandle;
#endif

typedef struct SpaceProperties_Runtime SpaceProperties_Runtime;
 
#ifdef __cplusplus
namespace blender::ed::space_node {
struct SpaceNode_Runtime;
}  // namespace blender::ed::space_node
using SpaceNode_Runtime = blender::ed::space_node::SpaceNode_Runtime;
 
namespace blender::ed::outliner {
struct SpaceOutliner_Runtime;
}  // namespace blender::ed::outliner
using SpaceOutliner_Runtime = blender::ed::outliner::SpaceOutliner_Runtime;
 
namespace blender::ed::vse {
struct SpaceSeq_Runtime;
}  // namespace blender::ed::vse
using SpaceSeq_Runtime = blender::ed::vse::SpaceSeq_Runtime;
 
namespace blender::ed::text {
struct SpaceText_Runtime;
}  // namespace blender::ed::text
using SpaceText_Runtime = blender::ed::text::SpaceText_Runtime;
 
namespace blender::ed::spreadsheet {
struct SpaceSpreadsheet_Runtime;
struct SpreadsheetColumnRuntime;
}  // namespace blender::ed::spreadsheet
using SpaceSpreadsheet_Runtime = blender::ed::spreadsheet::SpaceSpreadsheet_Runtime;
using SpreadsheetColumnRuntime = blender::ed::spreadsheet::SpreadsheetColumnRuntime;
#else
typedef struct SpaceNode_Runtime SpaceNode_Runtime;
typedef struct SpaceOutliner_Runtime SpaceOutliner_Runtime;
typedef struct SpaceSeq_Runtime SpaceSeq_Runtime;
typedef struct SpaceText_Runtime SpaceText_Runtime;
typedef struct SpaceSpreadsheet_Runtime SpaceSpreadsheet_Runtime;
typedef struct SpreadsheetColumnRuntime SpreadsheetColumnRuntime;
#endif

typedef struct SpaceFile_Runtime SpaceFile_Runtime;
 
/* -------------------------------------------------------------------- */

typedef struct SpaceLink {
  struct SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
} SpaceLink;

 
/* -------------------------------------------------------------------- */

typedef struct SpaceInfo {
  SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
  /* End 'SpaceLink' header. */
 
  char rpt_mask;
  char _pad[7];
} SpaceInfo;

 
/* -------------------------------------------------------------------- */

typedef struct SpaceProperties {
  DNA_DEFINE_CXX_METHODS(SpaceProperties)
 
  SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
  /* End 'SpaceLink' header. */

  View2D v2d DNA_DEPRECATED;
 
  /* For different kinds of property editors (exposed in the space type selector). */
  short space_subtype;

  short mainb, mainbo, mainbuser;
  uint32_t visible_tabs;
  short preview;
  char flag;
 
  /* eSpaceButtons_OutlinerSync */
  char outliner_sync;

  void *path;
  int pathflag, dataicon;
  ID *pinid;
 
  void *texuser;
 
  /* Doesn't necessarily need to be a pointer, but runtime structs are still written to files. */
  struct SpaceProperties_Runtime *runtime;
} SpaceProperties;

 
/* -------------------------------------------------------------------- */

typedef struct SpaceOutliner {
  SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
  /* End 'SpaceLink' header. */

  View2D v2d DNA_DEPRECATED;
 
  ListBase tree;

  struct BLI_mempool *treestore;
 
  char search_string[64];
 
  short flag;
  short outlinevis;
  short lib_override_view_mode;
  short storeflag;
  char search_flags;
  char _pad[6];

  char sync_select_dirty;
 
  int filter;
  char filter_state;
  char show_restrict_flags;
  short filter_id_type;
 
  SpaceOutliner_Runtime *runtime;
} SpaceOutliner;

 
/* -------------------------------------------------------------------- */
 
typedef struct SpaceGraph_Runtime {
  char flag;
  char _pad[7];
  ListBase ghost_curves;
} SpaceGraph_Runtime;

typedef struct SpaceGraph {
  SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
  /* End 'SpaceLink' header. */

  View2D v2d DNA_DEPRECATED;

  struct bDopeSheet *ads;

  short mode;
  /* Snapping now lives on the Scene. */
  short autosnap DNA_DEPRECATED;
  int flag;

  float cursorTime;
  float cursorVal;
  int around;
  char _pad[4];
 
  SpaceGraph_Runtime runtime;
} SpaceGraph;

 
/* -------------------------------------------------------------------- */

typedef struct SpaceNla {
  struct SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
  /* End 'SpaceLink' header. */
 
  /* Snapping now lives on the Scene. */
  short autosnap DNA_DEPRECATED;
  short flag;
  char _pad[4];
 
  struct bDopeSheet *ads;
  View2D v2d DNA_DEPRECATED;
} SpaceNla;

 
/* -------------------------------------------------------------------- */
 
typedef struct SequencerPreviewOverlay {
  int flag;
  char _pad0[4];
} SequencerPreviewOverlay;
 
typedef struct SequencerTimelineOverlay {
  int flag;
  char _pad0[4];
} SequencerTimelineOverlay;
 
typedef struct SequencerCacheOverlay {
  int flag;
  char _pad0[4];
} SequencerCacheOverlay;

typedef struct SpaceSeq {
  SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
  /* End 'SpaceLink' header. */

  View2D v2d DNA_DEPRECATED;

  float xof DNA_DEPRECATED, yof DNA_DEPRECATED;
  short mainb; /* eSpaceSeq_RegionType; strange name for view type (image, histogram, ...). */
  short render_size; /* eSpaceSeq_Proxy_RenderSize. */
  short chanshown;
  short zebra; /* Show overexposed. 0=disabled; otherwise as percentage of "pure white". */
  int flag;
  float zoom DNA_DEPRECATED;
  char view;
  char overlay_frame_type;
  char draw_flag;
  char gizmo_flag;
  char _pad[4];

  float cursor[2];

  struct bGPdata *gpd;
 
  struct SequencerPreviewOverlay preview_overlay;
  struct SequencerTimelineOverlay timeline_overlay;
  struct SequencerCacheOverlay cache_overlay;

  char multiview_eye;
  char _pad2[7];
 
  SpaceSeq_Runtime *runtime;
} SpaceSeq;
 
typedef struct MaskSpaceInfo {
  /* **** mask editing **** */
  struct Mask *mask;
  /* draw options */
  char draw_flag;
  char draw_type;
  char overlay_mode;
  char _pad3[1];
  float blend_factor;
} MaskSpaceInfo;

 
/* -------------------------------------------------------------------- */

typedef struct FileSelectParams {
  char title[96];
  char dir[/*FILE_MAX_LIBEXTRA*/ 1282];
  char file[/*FILE_MAXFILE*/ 256];
 
  char renamefile[/*FILE_MAXFILE*/ 256];
  short rename_flag;
  char _pad[4];
  const ID *rename_id;
  void *_pad3;

  char filter_glob[/*FILE_MAXFILE*/ 256];

  char filter_search[64];
  uint64_t filter_id;

  int active_file;
  int highlight_file;
  int sel_first;
  int sel_last;
  unsigned short thumbnail_size;
  unsigned short list_thumbnail_size;
  unsigned short list_column_size;
 
  /* short */
  short type; /* eFileSelectType */
  short flag;
  short sort;
  short display;
  char details_flags;
  char _pad1;

  int filter;

  short recursion_level;
 
  char _pad2[2];
} FileSelectParams;

typedef struct FileAssetSelectParams {
  FileSelectParams base_params;
 
  AssetLibraryReference asset_library_ref;
  short asset_catalog_visibility; /* eFileSel_Params_AssetCatalogVisibility */
  char _pad[6];
  bUUID catalog_id;
 
  short import_method; /* eFileAssetImportMethod */
  short import_flags;  /* eFileImportFlags */
  char _pad2[4];
} FileAssetSelectParams;

typedef struct FileFolderHistory {
  struct FileFolderLists *next, *prev;

  char browse_mode; /* eFileBrowse_Mode */
  char _pad[7];

  ListBase folders_prev;
  ListBase folders_next;
} FileFolderHistory;

typedef struct SpaceFile {
  SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
  /* End 'SpaceLink' header. */

  char browse_mode; /* eFileBrowse_Mode */
  char _pad1[1];
 
  short tags;
 
  int scroll_offset;

  FileSelectParams *params;
  FileAssetSelectParams *asset_params;
 
  void *_pad2;

  struct FileList *files;

  ListBase *folders_prev;
  ListBase *folders_next;

  ListBase folder_histories; /* FileFolderHistory */

  struct wmOperator *op;
 
  struct wmTimer *smoothscroll_timer;
  struct wmTimer *previews_timer;
 
  struct FileLayout *layout;
 
  short recentnr, bookmarknr;
  short systemnr, system_bookmarknr;
 
  SpaceFile_Runtime *runtime;
} SpaceFile;
 
/* ***** Related to file browser, but never saved in DNA, only here to help with RNA. ***** */
 
#
#
typedef struct FileDirEntry {
  struct FileDirEntry *next, *prev;
 
  uint32_t uid; /* FileUID */
  /* Name needs freeing if FILE_ENTRY_NAME_FREE is set. Otherwise this is a direct pointer to a
   * name buffer. */
  const char *name;
 
  uint64_t size;
  int64_t time;
 
  struct {
    /* Temp caching of UI-generated strings. */
    char size_str[16];
    char datetime_str[16 + 8];
  } draw_data;

  int typeflag;
  int blentype;
 
  /* Path to item that is relative to current folder root. To get the full path, use
   * #filelist_file_get_full_path() */
  char *relpath;
  char *redirection_path;

  ID *id;
  AssetRepresentationHandle *asset;
 
  /* The icon_id for the preview image. */
  int preview_icon_id;
 
  short flags;
  /* eFileAttributes defined in BLI_fileops.h */
  int attributes;
} FileDirEntry;

#
#
typedef struct FileDirEntryArr {
  ListBase entries;
  int entries_num;
  int entries_filtered_num;
 
  char root[/*FILE_MAX*/ 1024];
} FileDirEntryArr;

 
/* -------------------------------------------------------------------- */
 
/* Image/UV Editor */
 
typedef struct SpaceImageOverlay {
  int flag;
  float passepartout_alpha;
} SpaceImageOverlay;
 
typedef struct SpaceImage {
  SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
  /* End 'SpaceLink' header. */
 
  struct Image *image;
  struct ImageUser iuser;

  struct Scopes scopes;
  struct Histogram sample_line_hist;

  struct bGPdata *gpd;

  float cursor[2];
  float xof, yof;
  float zoom;
  float centx, centy;

  char mode;
  /* Storage for sub-space types. */
  char mode_prev;
 
  char pin;
 
  char pixel_round_mode;
 
  char lock;
  char dt_uv;
  char dt_uvstretch;
  char around;
 
  char gizmo_flag;
 
  char grid_shape_source;
  char _pad1[6];
 
  int flag;
 
  float uv_opacity;
  float uv_face_opacity;
  char _pad2[4];
 
  float stretch_opacity;
 
  int tile_grid_shape[2];
  int custom_grid_subdiv[2];
 
  MaskSpaceInfo mask_info;
  SpaceImageOverlay overlay;
} SpaceImage;

 
/* -------------------------------------------------------------------- */

typedef struct SpaceText {
  SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
  /* End 'SpaceLink' header. */
 
  struct Text *text;

  int top;

  int left;
  char _pad1[4];
 
  short flags;

  short lheight;
 
  int tabnumber;
 
  /* Booleans */
  char wordwrap;
  char doplugins;
  char showlinenrs;
  char showsyntax;
  char line_hlight;
  char overwrite;
  char live_edit;
  char _pad2[1];
 
  char findstr[/*ST_MAX_FIND_STR*/ 256];
  char replacestr[/*ST_MAX_FIND_STR*/ 256];

  short margin_column;
  char _pad3[2];

  SpaceText_Runtime *runtime;
} SpaceText;

 
/* -------------------------------------------------------------------- */

typedef struct Script {
  ID id;
 
  void *py_draw;
  void *py_event;
  void *py_button;
  void *py_browsercallback;
  void *py_globaldict;
 
  int flags, lastspace;
  char scriptname[/*FILE_MAX*/ 1024];
  char scriptarg[/*FILE_MAXFILE*/ 256];
} Script;
#define SCRIPT_SET_NULL(_script) \
  _script->py_draw = _script->py_event = _script->py_button = _script->py_browsercallback = \
      _script->py_globaldict = NULL; \
  _script->flags = 0

typedef struct SpaceScript {
  SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
  /* End 'SpaceLink' header. */
 
  struct Script *script;
 
  short flags, menunr;
  char _pad1[4];
 
  void *but_refs;
} SpaceScript;

 
/* -------------------------------------------------------------------- */
 
typedef struct bNodeTreePath {
  struct bNodeTreePath *next, *prev;
 
  struct bNodeTree *nodetree;
  bNodeInstanceKey parent_key;
  char _pad[4];
  float view_center[2];
 
  char node_name[/*MAX_NAME*/ 64];
  char display_name[/*MAX_NAME*/ 64];
} bNodeTreePath;
 
typedef struct SpaceNodeOverlay {
  /* eSpaceNodeOverlay_Flag */
  int flag;
  /* eSpaceNodeOverlay_preview_shape */
  int preview_shape;
} SpaceNodeOverlay;
 
typedef struct SpaceNode {
  SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
  /* End 'SpaceLink' header. */

  View2D v2d DNA_DEPRECATED;

  struct ID *id, *from;
 
  short flag;

  char insert_ofs_dir;
  char _pad1;

  float xof, yof;
  float zoom;

  ListBase treepath;
 
  /* The tree farthest down in the group hierarchy. */
  struct bNodeTree *edittree;
 
  struct bNodeTree *nodetree;
 
  /* tree type for the current node tree */
  char tree_idname[64];
  int treetype DNA_DEPRECATED;

  short texfrom;
  char shaderfrom;
  char node_tree_sub_type;

  struct bNodeTree *selected_node_group;

  struct bGPdata *gpd;
 
  char gizmo_flag;
  char _pad2[7];
 
  SpaceNodeOverlay overlay;
 
  SpaceNode_Runtime *runtime;
} SpaceNode;

 
/* -------------------------------------------------------------------- */

typedef struct ConsoleLine {
  struct ConsoleLine *next, *prev;
 
  /* Keep these 3 vars so as to share free, realloc functions. */
  int len_alloc;
  int len;
  char *line;
 
  int cursor;
  int type;
} ConsoleLine;

typedef struct SpaceConsole {
  SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
  /* End 'SpaceLink' header. */
 
  /* Space variables. */

  ListBase scrollback;
  ListBase history;
  char prompt[256];
  char language[32];
 
  int lheight;

  int history_index;

  int sel_start;
  int sel_end;
} SpaceConsole;

 
/* -------------------------------------------------------------------- */
 
typedef struct SpaceUserPref {
  SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
  /* End 'SpaceLink' header. */
 
  char _pad1[7];
  char filter_type;
  char filter[64];
} SpaceUserPref;

 
/* -------------------------------------------------------------------- */
 
typedef struct SpaceClipOverlay {
  /* eSpaceClipOverlay_Flag */
  int flag;
  char _pad0[4];
} SpaceClipOverlay;

typedef struct SpaceClip {
  SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
  /* End 'SpaceLink' header. */
 
  char gizmo_flag;
  char _pad1[3];

  float xof, yof;
  float xlockof, ylockof;
  float zoom;

  struct MovieClipUser user;
  struct MovieClip *clip;
  struct MovieClipScopes scopes;

  int flag;
  short mode;
  short view;

  int path_length;
 
  /* current stabilization data */
  float loc[2], scale, angle;
  char _pad[4];
  float stabmat[4][4], unistabmat[4][4];

  int postproc_flag;
 
  /* grease pencil */
  short gpencil_src;
  char _pad2[2];

  int around;
  char _pad4[4];

  float cursor[2];
 
  MaskSpaceInfo mask_info;
  struct SpaceClipOverlay overlay;
} SpaceClip;

 
/* -------------------------------------------------------------------- */
 
typedef struct SpaceTopBar {
  SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
  /* End 'SpaceLink' header. */
} SpaceTopBar;

 
/* -------------------------------------------------------------------- */
 
typedef struct SpaceStatusBar {
  SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
  /* End 'SpaceLink' header. */
} SpaceStatusBar;

 
/* -------------------------------------------------------------------- */
 
typedef struct SpreadsheetColumnID {
  char *name;
} SpreadsheetColumnID;
 
typedef struct SpreadsheetColumn {
  SpreadsheetColumnID *id;

  uint8_t data_type;
  char _pad0[3];
  uint32_t flag;
  float width;

  uint32_t last_used;

  char *display_name;
 
  SpreadsheetColumnRuntime *runtime;
 
#ifdef __cplusplus
  bool is_available() const
  {
    return !(flag & SPREADSHEET_COLUMN_FLAG_UNAVAILABLE);
  }
#endif
} SpreadsheetColumn;
 
typedef struct SpreadsheetInstanceID {
  int reference_index;
 
#ifdef __cplusplus
  uint64_t hash() const;
  friend bool operator==(const SpreadsheetInstanceID &a, const SpreadsheetInstanceID &b);
  friend bool operator!=(const SpreadsheetInstanceID &a, const SpreadsheetInstanceID &b);
#endif
} SpreadsheetInstanceID;
 
typedef struct SpreadsheetTableID {
  int type;
} SpreadsheetTableID;
 
typedef struct SpreadsheetBundlePathElem {
  char *identifier;
#ifdef __cplusplus
  friend bool operator==(const SpreadsheetBundlePathElem &a, const SpreadsheetBundlePathElem &b);
  friend bool operator!=(const SpreadsheetBundlePathElem &a, const SpreadsheetBundlePathElem &b);
#endif
} SpreadsheetBundlePathElem;
 
typedef enum SpreadsheetClosureInputOutput {
  SPREADSHEET_CLOSURE_NONE = 0,
  SPREADSHEET_CLOSURE_INPUT = 1,
  SPREADSHEET_CLOSURE_OUTPUT = 2,
} SpreadsheetClosureInputOutput;
 
typedef struct SpreadsheetTableIDGeometry {
  SpreadsheetTableID base;
  char _pad0[4];
  ViewerPath viewer_path;
 
  int viewer_item_identifier;
 
  int bundle_path_num;
  SpreadsheetBundlePathElem *bundle_path;

  int8_t closure_input_output;
 
  char _pad3[7];

  SpreadsheetInstanceID *instance_ids;
  int instance_ids_num;
  uint8_t geometry_component_type;
  uint8_t attribute_domain;
  uint8_t object_eval_state;
  char _pad1[5];
  int layer_index;
} SpreadsheetTableIDGeometry;
 
typedef struct SpreadsheetTable {
  SpreadsheetTableID *id;
  SpreadsheetColumn **columns;
  int num_columns;
  uint32_t flag;
  uint32_t last_used;

  uint32_t column_use_clock;
} SpreadsheetTable;
 
typedef struct SpaceSpreadsheet {
  SpaceLink *next, *prev;
  ListBase regionbase;
  char spacetype;
  char link_flag;
  char _pad0[6];
  /* End 'SpaceLink' header. */

  SpreadsheetTable **tables;
  int num_tables;
  char _pad1[3];

  uint8_t filter_flag;

  ListBase row_filters;

  SpreadsheetTableIDGeometry geometry_id;
 
  /* eSpaceSpreadsheet_Flag. */
  uint32_t flag;
  uint32_t table_use_clock;

  int active_viewer_path_index;
  char _pad2[4];
 
  SpaceSpreadsheet_Runtime *runtime;
} SpaceSpreadsheet;
 
typedef struct SpreadsheetRowFilter {
  struct SpreadsheetRowFilter *next, *prev;
 
  char column_name[/*MAX_NAME*/ 64];
 
  /* eSpreadsheetFilterOperation. */
  uint8_t operation;
  /* eSpaceSpreadsheet_RowFilterFlag. */
  uint8_t flag;
 
  char _pad0[6];
 
  int value_int;
  int value_int2[2];
  int value_int3[3];
  char *value_string;
  float value_float;
  float threshold;
  float value_float2[2];
  float value_float3[3];
  float value_color[4];
  char _pad1[4];
} SpreadsheetRowFilter;