Handles room and entrance selection UI. More...

#include <dungeon_room_selector.h>

Collaboration diagram for yaze::editor::DungeonRoomSelector:

[legend]

Public Member Functions
	DungeonRoomSelector (Rom *rom=nullptr)

void	Draw ()

void	DrawRoomSelector (RoomSelectionIntent single_click_intent=RoomSelectionIntent::kFocusInWorkbench)

void	DrawRoomBrowser (RoomSelectionIntent single_click_intent=RoomSelectionIntent::kFocusInWorkbench)

void	DrawEntranceSelector ()

void	DrawEntranceBrowser ()

void	SetContext (EditorContext ctx)

EditorContext	context () const

void	SetRom (Rom *rom)

Rom *	rom () const

void	SetGameData (zelda3::GameData *game_data)

zelda3::GameData *	game_data () const

void	SetProject (const project::YazeProject *project)

void	set_current_room_id (uint16_t room_id)

int	current_room_id () const

void	set_active_rooms (const ImVector< int > &rooms)

const ImVector< int > &	active_rooms () const

ImVector< int > &	mutable_active_rooms ()

void	set_current_entrance_id (int entrance_id)

int	current_entrance_id () const

void	set_rooms (DungeonRoomStore *rooms)

void	set_entrances (std::array< zelda3::RoomEntrance, zelda3::kNumDungeonEntranceSlots > *entrances)

void	SetRoomSelectedCallback (std::function< void(int)> callback)

void	set_room_selected_callback (std::function< void(int)> callback)

void	SetRoomSelectedWithIntentCallback (std::function< void(int, RoomSelectionIntent)> callback)

void	SetEntranceSelectedCallback (std::function< void(int)> callback)

void	set_entrance_selected_callback (std::function< void(int)> callback)

Static Public Member Functions
static const char *	GetBlocksetGroupName (uint8_t blockset)

Private Types
enum	ViewMode : uint8_t { kViewList = 0 , kViewGrouped = 1 }

enum	EntityTypeFilter : uint8_t { kFilterAll = 0 , kFilterHasSprites = 1 , kFilterHasItems = 2 , kFilterHasObjects = 3 }

Private Member Functions
void	RebuildRoomFilterCache ()

void	RebuildEntranceFilterCache ()

bool	PassesEntityTypeFilter (int room_id) const

void	DrawRoomSelectorInternal (RoomSelectionIntent single_click_intent, bool show_room_id_input)

void	DrawEntranceSelectorInternal (bool show_properties)

void	DrawGroupedRoomList (RoomSelectionIntent single_click_intent)

Private Attributes
Rom *	rom_ = nullptr

zelda3::GameData *	game_data_ = nullptr

const project::YazeProject *	project_ = nullptr

uint16_t	current_room_id_ = 0

int	pending_scroll_room_id_ = -1

int	current_entrance_id_ = 0

ImVector< int >	active_rooms_

DungeonRoomStore *	rooms_ = nullptr

std::array< zelda3::RoomEntrance, zelda3::kNumDungeonEntranceSlots > *	entrances_ = nullptr

std::function< void(int)>	room_selected_callback_

std::function< void(int, RoomSelectionIntent)>	room_intent_callback_

std::function< void(int)>	entrance_selected_callback_

ImGuiTextFilter	room_filter_

ImGuiTextFilter	entrance_filter_

ViewMode	view_mode_ = kViewGrouped

EntityTypeFilter	entity_type_filter_ = kFilterAll

std::vector< int >	filtered_room_indices_

std::vector< int >	filtered_entrance_indices_

std::string	last_room_filter_

std::string	last_entrance_filter_

Detailed Description

Handles room and entrance selection UI.

Definition at line 37 of file dungeon_room_selector.h.

Member Enumeration Documentation

◆ ViewMode

enum yaze::editor::DungeonRoomSelector::ViewMode : uint8_t

private

Enumerator
kViewList
kViewGrouped

Definition at line 142 of file dungeon_room_selector.h.

◆ EntityTypeFilter

enum yaze::editor::DungeonRoomSelector::EntityTypeFilter : uint8_t

private

Enumerator
kFilterAll
kFilterHasSprites
kFilterHasItems
kFilterHasObjects

Definition at line 150 of file dungeon_room_selector.h.

Constructor & Destructor Documentation

◆ DungeonRoomSelector()

yaze::editor::DungeonRoomSelector::DungeonRoomSelector ( Rom * rom = nullptr )

inlineexplicit

Definition at line 39 of file dungeon_room_selector.h.

Member Function Documentation

◆ Draw()

void yaze::editor::DungeonRoomSelector::Draw ( )

Definition at line 30 of file dungeon_room_selector.cc.

References DrawRoomSelector().

Here is the call graph for this function:

◆ DrawRoomSelector()

void yaze::editor::DungeonRoomSelector::DrawRoomSelector ( RoomSelectionIntent single_click_intent = RoomSelectionIntent::kFocusInWorkbench )

Definition at line 36 of file dungeon_room_selector.cc.

References DrawRoomSelectorInternal().

Referenced by Draw(), and yaze::editor::RoomBrowserContent::Draw().

Here is the call graph for this function:

◆ DrawRoomBrowser()

void yaze::editor::DungeonRoomSelector::DrawRoomBrowser ( RoomSelectionIntent single_click_intent = RoomSelectionIntent::kFocusInWorkbench )

Definition at line 41 of file dungeon_room_selector.cc.

References DrawRoomSelectorInternal().

Referenced by yaze::editor::DungeonWorkbenchContent::DrawSidebarContent().

Here is the call graph for this function:

◆ DrawEntranceSelector()

void yaze::editor::DungeonRoomSelector::DrawEntranceSelector ( )

Definition at line 318 of file dungeon_room_selector.cc.

References DrawEntranceSelectorInternal().

Referenced by yaze::editor::DungeonEntranceListPanel::Draw().

Here is the call graph for this function:

◆ DrawEntranceBrowser()

void yaze::editor::DungeonRoomSelector::DrawEntranceBrowser ( )

Definition at line 322 of file dungeon_room_selector.cc.

References DrawEntranceSelectorInternal().

Referenced by yaze::editor::DungeonWorkbenchContent::DrawSidebarContent().

Here is the call graph for this function:

◆ SetContext()

void yaze::editor::DungeonRoomSelector::SetContext ( EditorContext ctx )

inline

Definition at line 50 of file dungeon_room_selector.h.

References yaze::editor::EditorContext::game_data, game_data_, yaze::editor::EditorContext::rom, and rom_.

◆ context()

EditorContext yaze::editor::DungeonRoomSelector::context ( ) const

inline

Definition at line 54 of file dungeon_room_selector.h.

References game_data_, and rom_.

◆ SetRom()

void yaze::editor::DungeonRoomSelector::SetRom ( Rom * rom )

inline

Definition at line 57 of file dungeon_room_selector.h.

References rom(), and rom_.

Referenced by yaze::editor::DungeonEditorV2::RefreshRomBackedState(), and yaze::editor::DungeonEditorV2::SetRom().

Here is the call graph for this function:

◆ rom()

Rom * yaze::editor::DungeonRoomSelector::rom ( ) const

inline

Definition at line 58 of file dungeon_room_selector.h.

References rom_.

Referenced by SetRom().

◆ SetGameData()

void yaze::editor::DungeonRoomSelector::SetGameData ( zelda3::GameData * game_data )

inline

Definition at line 59 of file dungeon_room_selector.h.

References game_data(), and game_data_.

Here is the call graph for this function:

◆ game_data()

zelda3::GameData * yaze::editor::DungeonRoomSelector::game_data ( ) const

inline

Definition at line 60 of file dungeon_room_selector.h.

References game_data_.

Referenced by SetGameData().

◆ SetProject()

void yaze::editor::DungeonRoomSelector::SetProject ( const project::YazeProject * project )

inline

Definition at line 61 of file dungeon_room_selector.h.

References project_.

Referenced by yaze::editor::DungeonEditorV2::Initialize().

◆ set_current_room_id()

void yaze::editor::DungeonRoomSelector::set_current_room_id ( uint16_t room_id )

inline

Definition at line 64 of file dungeon_room_selector.h.

References current_room_id_, and pending_scroll_room_id_.

Referenced by yaze::editor::DungeonEditorV2::OnRoomSelected().

◆ current_room_id()

int yaze::editor::DungeonRoomSelector::current_room_id ( ) const

inline

Definition at line 70 of file dungeon_room_selector.h.

References current_room_id_.

Referenced by yaze::editor::DungeonEditorV2::current_room_id().

◆ set_active_rooms()

void yaze::editor::DungeonRoomSelector::set_active_rooms ( const ImVector< int > & rooms )

inline

Definition at line 72 of file dungeon_room_selector.h.

References active_rooms_.

Referenced by yaze::editor::DungeonEditorV2::Load(), yaze::editor::DungeonEditorV2::OnRoomSelected(), and yaze::editor::DungeonEditorV2::ProcessPendingSwap().

◆ active_rooms()

const ImVector< int > & yaze::editor::DungeonRoomSelector::active_rooms ( ) const

inline

Definition at line 73 of file dungeon_room_selector.h.

References active_rooms_.

Referenced by yaze::editor::DungeonEditorV2::active_rooms().

◆ mutable_active_rooms()

ImVector< int > & yaze::editor::DungeonRoomSelector::mutable_active_rooms ( )

inline

Definition at line 74 of file dungeon_room_selector.h.

References active_rooms_.

Referenced by yaze::editor::DungeonWorkbenchContent::GetEmbeddedDungeonMap().

◆ set_current_entrance_id()

void yaze::editor::DungeonRoomSelector::set_current_entrance_id ( int entrance_id )

inline

Definition at line 77 of file dungeon_room_selector.h.

References current_entrance_id_.

Referenced by yaze::editor::DungeonEditorV2::OnEntranceSelected().

◆ current_entrance_id()

int yaze::editor::DungeonRoomSelector::current_entrance_id ( ) const

inline

Definition at line 80 of file dungeon_room_selector.h.

References current_entrance_id_.

◆ set_rooms()

void yaze::editor::DungeonRoomSelector::set_rooms ( DungeonRoomStore * rooms )

inline

Definition at line 83 of file dungeon_room_selector.h.

References rooms_.

Referenced by yaze::editor::DungeonEditorV2::Load(), and yaze::editor::DungeonEditorV2::RefreshRomBackedState().

◆ set_entrances()

void yaze::editor::DungeonRoomSelector::set_entrances ( std::array< zelda3::RoomEntrance, zelda3::kNumDungeonEntranceSlots > * entrances )

inline

Definition at line 84 of file dungeon_room_selector.h.

References entrances_.

Referenced by yaze::editor::DungeonEditorV2::Load(), and yaze::editor::DungeonEditorV2::RefreshRomBackedState().

◆ SetRoomSelectedCallback()

void yaze::editor::DungeonRoomSelector::SetRoomSelectedCallback ( std::function< void(int)> callback )

inline

Definition at line 90 of file dungeon_room_selector.h.

References room_selected_callback_.

Referenced by yaze::editor::DungeonEditorV2::Load(), yaze::editor::RoomBrowserContent::RoomBrowserContent(), set_room_selected_callback(), and yaze::editor::RoomBrowserContent::SetRoomSelectedCallback().

◆ set_room_selected_callback()

void yaze::editor::DungeonRoomSelector::set_room_selected_callback ( std::function< void(int)> callback )

inline

Definition at line 94 of file dungeon_room_selector.h.

References SetRoomSelectedCallback().

Here is the call graph for this function:

◆ SetRoomSelectedWithIntentCallback()

void yaze::editor::DungeonRoomSelector::SetRoomSelectedWithIntentCallback ( std::function< void(int, RoomSelectionIntent)> callback )

inline

Definition at line 99 of file dungeon_room_selector.h.

References room_intent_callback_.

Referenced by yaze::editor::DungeonEditorV2::Initialize(), and yaze::editor::DungeonEditorV2::Load().

◆ SetEntranceSelectedCallback()

void yaze::editor::DungeonRoomSelector::SetEntranceSelectedCallback ( std::function< void(int)> callback )

inline

Definition at line 105 of file dungeon_room_selector.h.

References entrance_selected_callback_.

Referenced by yaze::editor::DungeonEntranceListPanel::DungeonEntranceListPanel(), yaze::editor::DungeonEditorV2::Load(), set_entrance_selected_callback(), and yaze::editor::DungeonEntranceListPanel::SetEntranceSelectedCallback().

◆ set_entrance_selected_callback()

void yaze::editor::DungeonRoomSelector::set_entrance_selected_callback ( std::function< void(int)> callback )

inline

Definition at line 109 of file dungeon_room_selector.h.

References SetEntranceSelectedCallback().

Here is the call graph for this function:

◆ GetBlocksetGroupName()

const char * yaze::editor::DungeonRoomSelector::GetBlocksetGroupName ( uint8_t blockset )

static

Definition at line 510 of file dungeon_room_selector.cc.

Referenced by DrawGroupedRoomList(), yaze::editor::DungeonWorkbenchContent::DrawInspectorShelfRoom(), and yaze::editor::DungeonCanvasViewer::DrawRoomPropertyTable().

◆ RebuildRoomFilterCache()

void yaze::editor::DungeonRoomSelector::RebuildRoomFilterCache ( )

private

Definition at line 46 of file dungeon_room_selector.cc.

References filtered_room_indices_, yaze::editor::dungeon_project_labels::GetRoomLabel(), yaze::zelda3::kNumberOfRooms, PassesEntityTypeFilter(), project_, and room_filter_.

Referenced by DrawRoomSelectorInternal().

Here is the call graph for this function:

◆ RebuildEntranceFilterCache()

void yaze::editor::DungeonRoomSelector::RebuildEntranceFilterCache ( )

private

Definition at line 282 of file dungeon_room_selector.cc.

References entrance_filter_, entrances_, filtered_entrance_indices_, yaze::zelda3::GetEntranceLabel(), yaze::zelda3::kNumDungeonEntranceSlots, yaze::zelda3::kNumDungeonSpawnPoints, and yaze::zelda3::kNumRegularDungeonEntrances.

Referenced by DrawEntranceSelectorInternal().

Here is the call graph for this function:

◆ PassesEntityTypeFilter()

bool yaze::editor::DungeonRoomSelector::PassesEntityTypeFilter ( int room_id ) const

private

Definition at line 60 of file dungeon_room_selector.cc.

References entity_type_filter_, yaze::editor::DungeonRoomStore::GetIfLoaded(), yaze::zelda3::Room::GetSprites(), kFilterAll, kFilterHasItems, kFilterHasObjects, kFilterHasSprites, rooms_, and yaze::editor::DungeonRoomStore::size().

Referenced by RebuildRoomFilterCache().

Here is the call graph for this function:

◆ DrawRoomSelectorInternal()

void yaze::editor::DungeonRoomSelector::DrawRoomSelectorInternal	(	RoomSelectionIntent	single_click_intent,
		bool	show_room_id_input )

private

Definition at line 82 of file dungeon_room_selector.cc.

References yaze::zelda3::RoomLayerManager::ApplyLayerMerging(), yaze::editor::SelectionChangedEvent::CreateSingle(), current_room_id_, DrawGroupedRoomList(), entity_type_filter_, yaze::editor::ContentRegistry::Context::event_bus(), filtered_room_indices_, yaze::editor::DungeonRoomStore::GetIfLoaded(), yaze::gui::LayoutHelpers::GetMinTouchTarget(), yaze::editor::dungeon_project_labels::GetRoomLabel(), ICON_MD_FOLDER, ICON_MD_LIST, yaze::gui::InputHexWord(), yaze::Rom::is_loaded(), yaze::gui::LayoutHelpers::IsTouchDevice(), kFilterAll, kFilterHasItems, kFilterHasObjects, kFilterHasSprites, yaze::editor::kFocusInWorkbench, yaze::zelda3::kNumberOfRooms, yaze::editor::kOpenStandalone, kViewGrouped, kViewList, last_room_filter_, project_, RebuildRoomFilterCache(), rom_, room_filter_, room_intent_callback_, room_selected_callback_, rooms_, and view_mode_.

Referenced by DrawRoomBrowser(), and DrawRoomSelector().

◆ DrawEntranceSelectorInternal()

void yaze::editor::DungeonRoomSelector::DrawEntranceSelectorInternal ( bool show_properties )

private

◆ DrawGroupedRoomList()

void yaze::editor::DungeonRoomSelector::DrawGroupedRoomList ( RoomSelectionIntent single_click_intent )

private

Member Data Documentation

◆ rom_

Rom* yaze::editor::DungeonRoomSelector::rom_ = nullptr

private

Definition at line 117 of file dungeon_room_selector.h.

Referenced by context(), DrawEntranceSelectorInternal(), DrawRoomSelectorInternal(), rom(), SetContext(), and SetRom().

◆ game_data_

zelda3::GameData* yaze::editor::DungeonRoomSelector::game_data_ = nullptr

private

Definition at line 118 of file dungeon_room_selector.h.

Referenced by context(), game_data(), SetContext(), and SetGameData().

◆ project_

const project::YazeProject* yaze::editor::DungeonRoomSelector::project_ = nullptr

private

Definition at line 119 of file dungeon_room_selector.h.

Referenced by DrawGroupedRoomList(), DrawRoomSelectorInternal(), RebuildRoomFilterCache(), and SetProject().

◆ current_room_id_

uint16_t yaze::editor::DungeonRoomSelector::current_room_id_ = 0

private

Definition at line 120 of file dungeon_room_selector.h.

Referenced by current_room_id(), DrawGroupedRoomList(), DrawRoomSelectorInternal(), and set_current_room_id().

◆ pending_scroll_room_id_

int yaze::editor::DungeonRoomSelector::pending_scroll_room_id_ = -1

private

Definition at line 121 of file dungeon_room_selector.h.

Referenced by DrawGroupedRoomList(), and set_current_room_id().

◆ current_entrance_id_

int yaze::editor::DungeonRoomSelector::current_entrance_id_ = 0

private

Definition at line 122 of file dungeon_room_selector.h.

Referenced by current_entrance_id(), DrawEntranceSelectorInternal(), and set_current_entrance_id().

◆ active_rooms_

ImVector<int> yaze::editor::DungeonRoomSelector::active_rooms_

private

Definition at line 123 of file dungeon_room_selector.h.

Referenced by active_rooms(), mutable_active_rooms(), and set_active_rooms().

◆ rooms_

DungeonRoomStore* yaze::editor::DungeonRoomSelector::rooms_ = nullptr

private

Definition at line 125 of file dungeon_room_selector.h.

Referenced by DrawGroupedRoomList(), DrawRoomSelectorInternal(), PassesEntityTypeFilter(), and set_rooms().

◆ entrances_

std::array<zelda3::RoomEntrance, zelda3::kNumDungeonEntranceSlots>* yaze::editor::DungeonRoomSelector::entrances_ = nullptr

private

Definition at line 127 of file dungeon_room_selector.h.

Referenced by DrawEntranceSelectorInternal(), RebuildEntranceFilterCache(), and set_entrances().

◆ room_selected_callback_

std::function<void(int)> yaze::editor::DungeonRoomSelector::room_selected_callback_

private

Definition at line 130 of file dungeon_room_selector.h.

Referenced by DrawEntranceSelectorInternal(), DrawGroupedRoomList(), DrawRoomSelectorInternal(), and SetRoomSelectedCallback().

◆ room_intent_callback_

std::function<void(int, RoomSelectionIntent)> yaze::editor::DungeonRoomSelector::room_intent_callback_

private

Definition at line 133 of file dungeon_room_selector.h.

Referenced by DrawGroupedRoomList(), DrawRoomSelectorInternal(), and SetRoomSelectedWithIntentCallback().

◆ entrance_selected_callback_

std::function<void(int)> yaze::editor::DungeonRoomSelector::entrance_selected_callback_

private

Definition at line 136 of file dungeon_room_selector.h.

Referenced by DrawEntranceSelectorInternal(), and SetEntranceSelectedCallback().

◆ room_filter_

ImGuiTextFilter yaze::editor::DungeonRoomSelector::room_filter_

private

Definition at line 138 of file dungeon_room_selector.h.

Referenced by DrawRoomSelectorInternal(), and RebuildRoomFilterCache().

◆ entrance_filter_

ImGuiTextFilter yaze::editor::DungeonRoomSelector::entrance_filter_

private

Definition at line 139 of file dungeon_room_selector.h.

Referenced by DrawEntranceSelectorInternal(), and RebuildEntranceFilterCache().

◆ view_mode_

ViewMode yaze::editor::DungeonRoomSelector::view_mode_ = kViewGrouped

private

Definition at line 146 of file dungeon_room_selector.h.

Referenced by DrawRoomSelectorInternal().

◆ entity_type_filter_

EntityTypeFilter yaze::editor::DungeonRoomSelector::entity_type_filter_ = kFilterAll

private

Definition at line 156 of file dungeon_room_selector.h.

Referenced by DrawRoomSelectorInternal(), and PassesEntityTypeFilter().

◆ filtered_room_indices_

std::vector<int> yaze::editor::DungeonRoomSelector::filtered_room_indices_

private

Definition at line 159 of file dungeon_room_selector.h.

Referenced by DrawGroupedRoomList(), DrawRoomSelectorInternal(), and RebuildRoomFilterCache().

◆ filtered_entrance_indices_

std::vector<int> yaze::editor::DungeonRoomSelector::filtered_entrance_indices_

private

Definition at line 160 of file dungeon_room_selector.h.

Referenced by DrawEntranceSelectorInternal(), and RebuildEntranceFilterCache().

◆ last_room_filter_

std::string yaze::editor::DungeonRoomSelector::last_room_filter_

private

Definition at line 161 of file dungeon_room_selector.h.

Referenced by DrawRoomSelectorInternal().

◆ last_entrance_filter_

std::string yaze::editor::DungeonRoomSelector::last_entrance_filter_

private

Definition at line 162 of file dungeon_room_selector.h.

Referenced by DrawEntranceSelectorInternal().

The documentation for this class was generated from the following files:

src/app/editor/dungeon/dungeon_room_selector.h
src/app/editor/dungeon/dungeon_room_selector.cc

	yaze 0.3.2 Link to the Past ROM Editor

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ ViewMode

◆ EntityTypeFilter

Constructor & Destructor Documentation

◆ DungeonRoomSelector()

Member Function Documentation

◆ Draw()

◆ DrawRoomSelector()

◆ DrawRoomBrowser()

◆ DrawEntranceSelector()

◆ DrawEntranceBrowser()

◆ SetContext()

◆ context()

◆ SetRom()

◆ rom()

◆ SetGameData()

◆ game_data()

◆ SetProject()

◆ set_current_room_id()

◆ current_room_id()

◆ set_active_rooms()

◆ active_rooms()

◆ mutable_active_rooms()

◆ set_current_entrance_id()

◆ current_entrance_id()

◆ set_rooms()

◆ set_entrances()

◆ SetRoomSelectedCallback()

◆ set_room_selected_callback()

◆ SetRoomSelectedWithIntentCallback()

◆ SetEntranceSelectedCallback()

◆ set_entrance_selected_callback()

◆ GetBlocksetGroupName()

◆ RebuildRoomFilterCache()

◆ RebuildEntranceFilterCache()

◆ PassesEntityTypeFilter()

◆ DrawRoomSelectorInternal()

◆ DrawEntranceSelectorInternal()

◆ DrawGroupedRoomList()

Member Data Documentation

◆ rom_

◆ game_data_

◆ project_

◆ current_room_id_

◆ pending_scroll_room_id_

◆ current_entrance_id_

◆ active_rooms_

◆ rooms_

◆ entrances_

◆ room_selected_callback_

◆ room_intent_callback_

◆ entrance_selected_callback_

◆ room_filter_

◆ entrance_filter_

◆ view_mode_

◆ entity_type_filter_

◆ filtered_room_indices_

◆ filtered_entrance_indices_

◆ last_room_filter_

◆ last_entrance_filter_