DNA_workspace_types.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "DNA_ID.h"
#include "DNA_asset_types.h"
#include "DNA_viewer_path_types.h"
 
#ifdef __cplusplus
namespace blender::bke {
struct WorkSpaceRuntime;
}
using WorkSpaceRuntimeHandle = blender::bke::WorkSpaceRuntime;
#else
typedef struct WorkSpaceRuntimeHandle WorkSpaceRuntimeHandle;
#endif

enum {
  TOOLREF_FLAG_FALLBACK_KEYMAP = (1 << 0),
  TOOLREF_FLAG_USE_BRUSHES = (1 << 1),
};
 
#
#
typedef struct bToolRef_Runtime {
  int cursor;

  char keymap[64];
  char gizmo_group[64];
  char data_block[64];
  int brush_type;

  char keymap_fallback[64];

  char op[64];

  int index;
  int flag;
} bToolRef_Runtime;

typedef struct bToolRef {
  struct bToolRef *next, *prev;
  char idname[64];

  char idname_fallback[64];

  char idname_pending[64];

  short tag;

  short space_type;
  int mode;

  IDProperty *properties;

  bToolRef_Runtime *runtime;
} bToolRef;

typedef struct WorkSpaceLayout {
  struct WorkSpaceLayout *next, *prev;
 
  struct bScreen *screen;
  /* The name of this layout, we override the RNA name of the screen with this
   * (but not ID name itself) */
  char name[/*MAX_NAME*/ 64];
} WorkSpaceLayout;

typedef struct wmOwnerID {
  struct wmOwnerID *next, *prev;
  char name[128];
} wmOwnerID;
 
typedef struct WorkSpace {
#ifdef __cplusplus
  static constexpr ID_Type id_type = ID_WS;
#endif
 
  ID id;

  ListBase layouts;
  /* Store for each hook (so for each window) which layout has
   * been activated the last time this workspace was visible. */
  ListBase hook_layout_relations;
 
  /* Feature tagging (use for addons) */
  ListBase owner_ids;

  ListBase tools;

  struct Scene *pin_scene;
 
  /* Scene that is used by the sequence editors in this workspace. */
  struct Scene *sequencer_scene;
 
  char _pad[4];
 
  int object_mode;

  int flags;

  int order;

  WorkSpaceRuntimeHandle *runtime;

  AssetLibraryReference asset_library_ref;

  ViewerPath viewer_path;
} WorkSpace;

typedef struct WorkSpaceDataRelation {
  struct WorkSpaceDataRelation *next, *prev;

  void *parent;
  void *value;

  int parentid;
  char _pad_0[4];
} WorkSpaceDataRelation;

typedef struct WorkSpaceInstanceHook {
  WorkSpace *active;
  struct WorkSpaceLayout *act_layout;

  WorkSpace *temp_workspace_store;
  struct WorkSpaceLayout *temp_layout_store;
} WorkSpaceInstanceHook;
 
typedef enum eWorkSpaceFlags {
  WORKSPACE_USE_FILTER_BY_ORIGIN = (1 << 1),
  WORKSPACE_USE_PIN_SCENE = (1 << 2),
  /* Used for syncing time between sequencer scene strips and the active scene. */
  WORKSPACE_SYNC_SCENE_TIME = (1 << 3),
} eWorkSpaceFlags;