reckfellENGINE

EditorDock

Встраиваемый контейнер для редактора.

На этой странице
class EditorDockReckfellSharpEditorНаследует MarginContainer

Встраиваемый контейнер для редактора.

EditorDock это... Container Узел, который может быть пристыкован в одном из слотов редактора. EditorPluginРедактор пришёл с несколькими встроенными доками, такими, как док Сцены, бровь контента и т.д. Вы можете добавить док, используя EditorPlugin.AddDock. Причал может быть адаптирован за счет изменения его свойств.

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Конструкторы1

EditorDockКонструктор
# EditorDock
C#
public EditorDock();

Свойства13

AllowSwitchScreenСвойство
# AllowSwitchScreen
C#
public bool AllowSwitchScreen { get; set; }

Если true и этот док пришвартован к главному экрану, выбрав узел на дереве сцены может отойти от этого дока. Выбранный узел должен быть улажен другим главным экранным доком (2D, 3D) для того, чтобы выключатель мог произойти.

AvailableLayoutsСвойство
# AvailableLayouts
C#
public EditorDock.DockLayout AvailableLayouts { get; set; }

Доступные варианты расположения элементов для этой панели Dock представлены в виде битовой маски. По умолчанию панель Dock поддерживает вертикальное и плавающее расположение элементов.

ClosableСвойство
# Closable
C#
public bool Closable { get; set; }

Если true, панель Dock можно закрыть с помощью кнопки «Закрыть» во всплывающем окне. Панели Dock с включенной опцией EditorDock.Global всегда можно закрыть.

DefaultSlotСвойство
# DefaultSlot
C#
public EditorDock.DockSlot DefaultSlot { get; set; }

Начальное размещение перед AddDock; проверены LeftUl и MainScreen. Это не команда переместить уже открытую панель. В SDK присутствует None=-1, но текущий нативный setter проверяет неотрицательный индекс: не используйте это значение как проверенный способ скрытия.

DockIconСвойство
# DockIcon
C#
public Texture2D DockIcon { get; set; }

Иконка для панели Dock в виде текстуры. Если указано, она переопределит EditorDock.IconName.

DockShortcutСвойство
# DockShortcut
C#
public Shortcut DockShortcut { get; set; }

Быстрая клавиша для открытия док-станции.

ForceShowIconСвойство
# ForceShowIcon
C#
public bool ForceShowIcon { get; set; }

Если true, то на панели Dock всегда будет отображаться значок, независимо от EditorSettings.interface/editor/docks/dock_tab_style или EditorSettings.interface/editor/docks/bottom_dock_tab_style.

GlobalСвойство
# Global
C#
public bool Global { get; set; }

Если true, панель отображается в меню Редактор > Панели редактора и может быть закрыта. Панели, не являющиеся глобальными, также могут быть закрыты с помощью EditorDock.Close или когда EditorDock.Closable имеет значение true.

IconNameСвойство
# IconName
C#
public StringName IconName { get; set; }

Икона дока, как имя от EditorIcons Тип темы в теме редактора. Вы можете найти список доступных значков Вот..

LayoutKeyСвойство
# LayoutKey
C#
public string LayoutKey { get; set; }

Ключ, представляющий эту панель в файле макета редактора. Если поле пустое, будет использоваться отображаемое имя панели.

TitleСвойство
# Title
C#
public string Title { get; set; }

Отображаемый заголовок панели, используемый также GetDockByName. При пустом заголовке используется имя панели. Не считайте переводимый заголовок постоянным идентификатором данных.

TitleColorСвойство
# TitleColor
C#
public Color TitleColor { get; set; }

Цвет заголовка вкладки в доке. Если его прозрачность равна 0.0, будет использоваться цвет шрифта по умолчанию.

TransientСвойство
# Transient
C#
public bool Transient { get; set; }

Если true, панель Dock не открывается и не закрывается автоматически при загрузке макета редактора, а только перемещается. Её также нельзя открыть с помощью сочетания клавиш. Это относится к панелям Dock, которые открываются и закрываются в определённых случаях, например, при выборе узла TileMap или AnimationTree.

Методы33

Closevoid
# Close
C#
public void Close();

Закрывает панель Dock, скрывая соответствующую вкладку.

GetAvailableLayoutsEditorDock.DockLayout
# GetAvailableLayouts
C#
public EditorDock.DockLayout GetAvailableLayouts();
Возвращает EditorDock.DockLayout
GetDefaultSlotEditorDock.DockSlot
# GetDefaultSlot
C#
public EditorDock.DockSlot GetDefaultSlot();
Возвращает EditorDock.DockSlot
GetDockIconTexture2D
# GetDockIcon
C#
public Texture2D GetDockIcon();
Возвращает Texture2D
GetDockShortcutShortcut
# GetDockShortcut
C#
public Shortcut GetDockShortcut();
Возвращает Shortcut
GetForceShowIconbool
# GetForceShowIcon
C#
public bool GetForceShowIcon();
Возвращает bool
GetIconNameStringName
# GetIconName
C#
public StringName GetIconName();
Возвращает StringName
GetLayoutKeystring
# GetLayoutKey
C#
public string GetLayoutKey();
Возвращает string
GetTitlestring
# GetTitle
C#
public string GetTitle();
Возвращает string
GetTitleColorColor
# GetTitleColor
C#
public Color GetTitleColor();
Возвращает Color
IsAllowSwitchScreenbool
# IsAllowSwitchScreen
C#
public bool IsAllowSwitchScreen();
Возвращает bool
IsClosablebool
# IsClosable
C#
public bool IsClosable();
Возвращает bool
IsGlobalbool
# IsGlobal
C#
public bool IsGlobal();
Возвращает bool
IsTransientbool
# IsTransient
C#
public bool IsTransient();
Возвращает bool
MakeVisiblevoid
# MakeVisible
C#
public void MakeVisible();

Просит менеджер открыть панель и сфокусировать её. В проверке MainScreen-панель стала видимой в дереве редактора. Это не доказательство физического отображения окна или успешного пользовательского клика.

Openvoid
# Open
C#
public void Open();

Открывает док-панель. Она появится в последнем использованном слоте док-панели. Если у док-панели нет слота по умолчанию, она будет открыта в плавающем режиме. Примечание: Этот метод не фокусирует док-панель. Если вы хотите открыть и сфокусировать док-панель, используйте EditorDock.MakeVisible.

SetAllowSwitchScreenvoid
# SetAllowSwitchScreen
C#
public void SetAllowSwitchScreen(bool allow);
Параметры
ИмяТипПо умолчанию
allowbool—
SetAvailableLayoutsvoid
# SetAvailableLayouts
C#
public void SetAvailableLayouts(EditorDock.DockLayout layouts);
Параметры
ИмяТипПо умолчанию
layoutsEditorDock.DockLayout—
SetClosablevoid
# SetClosable
C#
public void SetClosable(bool closable);
Параметры
ИмяТипПо умолчанию
closablebool—
SetDefaultSlotvoid
# SetDefaultSlot
C#
public void SetDefaultSlot(EditorDock.DockSlot slot);
Параметры
ИмяТипПо умолчанию
slotEditorDock.DockSlot—
SetDockIconvoid
# SetDockIcon
C#
public void SetDockIcon(Texture2D icon);
Параметры
ИмяТипПо умолчанию
iconTexture2D—
SetDockShortcutvoid
# SetDockShortcut
C#
public void SetDockShortcut(Shortcut shortcut);
Параметры
ИмяТипПо умолчанию
shortcutShortcut—
SetForceShowIconvoid
# SetForceShowIcon
C#
public void SetForceShowIcon(bool force);
Параметры
ИмяТипПо умолчанию
forcebool—
SetGlobalvoid
# SetGlobal
C#
public void SetGlobal(bool global);
Параметры
ИмяТипПо умолчанию
globalbool—
SetIconNamevoid
# SetIconName
C#
public void SetIconName(StringName iconName);
Параметры
ИмяТипПо умолчанию
iconNameStringName—
SetLayoutKeyvoid
# SetLayoutKey
C#
public void SetLayoutKey(string layoutKey);
Параметры
ИмяТипПо умолчанию
layoutKeystring—
SetTitlevoid
# SetTitle
C#
public void SetTitle(string title);
Параметры
ИмяТипПо умолчанию
titlestring—
SetTitleColorvoid
# SetTitleColor
C#
public void SetTitleColor(Color color);
Параметры
ИмяТипПо умолчанию
colorColor—
SetTransientvoid
# SetTransient
C#
public void SetTransient(bool transient);
Параметры
ИмяТипПо умолчанию
transientbool—
_LoadLayoutFromConfigvoid
# _LoadLayoutFromConfig
C#
public virtual void _LoadLayoutFromConfig(ConfigFile config, string section);

Реализуйте этот метод для обработки загрузки макета этой панели Dock. Он эквивалентен методу EditorPlugin._SetWindowLayout. section — это уникальный раздел, основанный на EditorDock.LayoutKey.

Параметры
ИмяТипПо умолчанию
configConfigFile—
sectionstring—
_SaveLayoutToConfigvoid
# _SaveLayoutToConfig
C#
public virtual void _SaveLayoutToConfig(ConfigFile config, string section);

Используйте этот метод, чтобы сохранить планировку дока. EditorPlugin._GetWindowLayout. section является уникальным разделом, основанным на EditorDock.LayoutKey.

Параметры
ИмяТипПо умолчанию
configConfigFile—
sectionstring—
_UpdateLayoutvoid · Устарело
# _UpdateLayout
C#
public virtual void _UpdateLayout(int layout);

Реализуйте этот метод для обработки переключения макета для этой панели DockLayout. layout — одна из констант EditorDock.DockLayout.

###обновленный_лайаут и_лот

Параметры
ИмяТипПо умолчанию
layoutint—
_UpdateLayoutAndSlotvoid
# _UpdateLayoutAndSlot
C#
public virtual void _UpdateLayoutAndSlot(int layout, int slot);

Примените этот метод для работы с компоновкой/переключением слота для этого дока. layout является одним из EditorDock.DockLayout константы и slot является одним из EditorDock.DockSlot один.

Параметры
ИмяТипПо умолчанию
layoutint—
slotint—

Сигналы и события2

ClosedСобытие
# Closed
C#
public event Action Closed;

Док может быть закрыт с помощью кнопки " Закрыть " при входе в док. EditorDock.Close, или в результате изменения компоновки.

OpenedСобытие
# Opened
C#
public event Action Opened;

Вызывается при открытии панели Dock через меню «Редактор > Панели редактора», до того, как она станет видимой.

EditorDock.DockLayout

ЗначениеОписание
All = 7

Разрешается размещать док во всех свободных местах, кроме главного экрана.

Floating = 4

Позволяет сделать док-станцию плавающей (открывается как отдельное окно).

Horizontal = 2

Позволяет расположить док-станцию в горизонтальные слоты внизу.

MainScreen = 8

Разрешает использовать док в качестве главного экрана.

Vertical = 1

Позволяет размещать панель Dock в вертикальных слотах Dock по обеим сторонам редактора.

EditorDock.DockSlot

ЗначениеОписание
Bottom = 8

Нижняя панель.

BottomL = 9

Док слот расположен внизу, под нижней панелью, с левой стороны.

BottomR = 10

Док слот расположен внизу, под нижней панелью, с правой стороны.

LeftBl = 1

Слот для док-станции, левая сторона, внизу слева (в макете по умолчанию пуст).

LeftBr = 3

Док-слот, слева, внизу справа (в стандартной конфигурации включает док-станции файловой системы и истории).

LeftUl = 0

Слот для док-станции, левая сторона, вверху слева (в макете по умолчанию пуст).

LeftUr = 2

Слот док-станции, левая сторона, вверху справа (в макете по умолчанию включены док-станции «Сцена» и «Импорт»).

MainScreen = 11

Главный экран редактора.

Max = 12

Представляет размер перечисления EditorDock.DockSlot.

None = -1

Док-панель закрыта.

RightBl = 5

Слот для док-станции, правая сторона, левый нижний угол (в макете по умолчанию пуст).

RightBr = 7

Слот для док-станции, справа, внизу справа (в макете по умолчанию пуст).

RightUl = 4

Дробовое сечение, справа, с верхней левой стороны (в модели по умолчанию включает инспектора, Signal, и Групповые доки).

RightUr = 6

Слот для док-станции, правая сторона, вверху справа (пустой в макете по умолчанию).

Документация Reckfell EngineНаверх ↑
БЫСТРЫЙ ПЕРЕХОДНачало работыEntity и иерархияC# & .NET 10Сцены и префабы
Руководства и полный API Reckfell K
reckfellENGINE
RECKFELL ACCOUNT

Вход в аккаунт

Войдите в аккаунт Reckfell.

Один аккаунт для всей платформы Reckfell.