yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
yaze::editor::Editor Class Referenceabstract

Interface for editor classes. More...

#include <editor.h>

Inherited by yaze::editor::AgentEditor, yaze::editor::AssemblyEditor, yaze::editor::DungeonEditorV2, yaze::editor::GraphicsEditor, yaze::editor::MemoryEditor, yaze::editor::MessageEditor, yaze::editor::MusicEditor, yaze::editor::OverworldEditor, yaze::editor::PaletteEditor, yaze::editor::PlanningEditor, yaze::editor::ScreenEditor, yaze::editor::SettingsPanel, and yaze::editor::SpriteEditor.

Collaboration diagram for yaze::editor::Editor:

Public Member Functions

 Editor ()=default
 
virtual ~Editor ()=default
 
virtual void SetDependencies (const EditorDependencies &deps)
 
virtual void SetGameData (zelda3::GameData *game_data)
 
virtual void Initialize ()=0
 
virtual absl::Status Load ()=0
 
virtual absl::Status Save ()=0
 
virtual absl::Status BeginSaveTransaction ()
 
virtual void RollbackSaveTransaction ()
 
virtual void CommitSaveTransaction ()
 
virtual void PrepareForSessionTeardown ()
 
virtual absl::Status Update ()=0
 
virtual absl::Status Cut ()=0
 
virtual absl::Status Copy ()=0
 
virtual absl::Status Paste ()=0
 
virtual absl::Status Undo ()=0
 
virtual absl::Status Redo ()=0
 
virtual std::string GetUndoDescription () const
 
virtual std::string GetRedoDescription () const
 
const UndoManager & undo_manager () const
 
virtual absl::Status Find ()=0
 
virtual absl::Status Clear ()
 
virtual bool CanUndo () const
 
virtual bool CanRedo () const
 
virtual bool CanCut () const
 
virtual bool CanCopy () const
 
virtual bool CanPaste () const
 
virtual bool CanFind () const
 
virtual void ContributeStatus (StatusBar *)
 
virtual EditorContextSnapshot BuildContextSnapshot () const
 
EditorType type () const
 
bool * active ()
 
void set_active (bool active)
 
void toggle_active ()
 
virtual bool IsRomLoaded () const
 
virtual std::string GetRomStatus () const
 
Rom * rom () const
 
zelda3::GameData * game_data () const
 
project::YazeProject * project () const
 
core::VersionManager * version_manager () const
 
EditorContext context () const
 
bool HasContext () const
 

Protected Member Functions

std::string MakePanelTitle (const std::string &base_title) const
 
std::string MakeWindowId (const std::string &base_id) const
 
template<typename T >
absl::StatusOr< T > SafeRomAccess (std::function< T()> accessor, const std::string &operation="") const
 

Protected Attributes

bool active_ = false
 
EditorType type_
 
EditorDependencies dependencies_
 
UndoManager undo_manager_
 

Detailed Description

Interface for editor classes.

Provides basic editing operations that each editor should implement.

Definition at line 249 of file editor.h.

Constructor & Destructor Documentation

◆ Editor()

yaze::editor::Editor::Editor ( )
default

◆ ~Editor()

virtual yaze::editor::Editor::~Editor ( )
virtualdefault

Member Function Documentation

◆ SetDependencies()

◆ SetGameData()

virtual void yaze::editor::Editor::SetGameData ( zelda3::GameData * game_data)
inlinevirtual

◆ Initialize()

◆ Load()

◆ Save()

◆ BeginSaveTransaction()

◆ RollbackSaveTransaction()

virtual void yaze::editor::Editor::RollbackSaveTransaction ( )
inlinevirtual

◆ CommitSaveTransaction()

virtual void yaze::editor::Editor::CommitSaveTransaction ( )
inlinevirtual

◆ PrepareForSessionTeardown()

virtual void yaze::editor::Editor::PrepareForSessionTeardown ( )
inlinevirtual

◆ Update()

◆ Cut()

◆ Copy()

◆ Paste()

◆ Undo()

◆ Redo()

◆ GetUndoDescription()

virtual std::string yaze::editor::Editor::GetUndoDescription ( ) const
inlinevirtual

Definition at line 296 of file editor.h.

References yaze::editor::UndoManager::GetUndoDescription(), and undo_manager_.

Referenced by yaze::editor::MenuOrchestrator::OnUndo().

Here is the call graph for this function:

◆ GetRedoDescription()

virtual std::string yaze::editor::Editor::GetRedoDescription ( ) const
inlinevirtual

Definition at line 299 of file editor.h.

References yaze::editor::UndoManager::GetRedoDescription(), and undo_manager_.

Referenced by yaze::editor::MenuOrchestrator::OnRedo().

Here is the call graph for this function:

◆ undo_manager()

const UndoManager & yaze::editor::Editor::undo_manager ( ) const
inline

Definition at line 303 of file editor.h.

References undo_manager_.

◆ Find()

◆ Clear()

virtual absl::Status yaze::editor::Editor::Clear ( )
inlinevirtual

Reimplemented in yaze::editor::OverworldEditor.

Definition at line 307 of file editor.h.

◆ CanUndo()

◆ CanRedo()

virtual bool yaze::editor::Editor::CanRedo ( ) const
inlinevirtual

◆ CanCut()

◆ CanCopy()

◆ CanPaste()

◆ CanFind()

virtual bool yaze::editor::Editor::CanFind ( ) const
inlinevirtual

Reimplemented in yaze::editor::MessageEditor.

Definition at line 324 of file editor.h.

Referenced by yaze::editor::MenuOrchestrator::CurrentEditorCanFind().

◆ ContributeStatus()

virtual void yaze::editor::Editor::ContributeStatus ( StatusBar * )
inlinevirtual

◆ BuildContextSnapshot()

◆ type()

◆ active()

◆ set_active()

void yaze::editor::Editor::set_active ( bool active)
inline

Definition at line 346 of file editor.h.

References active(), and active_.

Here is the call graph for this function:

◆ toggle_active()

void yaze::editor::Editor::toggle_active ( )
inline

Definition at line 347 of file editor.h.

References active_.

◆ IsRomLoaded()

virtual bool yaze::editor::Editor::IsRomLoaded ( ) const
inlinevirtual

Reimplemented in yaze::editor::DungeonEditorV2, and yaze::editor::OverworldEditor.

Definition at line 350 of file editor.h.

Referenced by SafeRomAccess().

◆ GetRomStatus()

virtual std::string yaze::editor::Editor::GetRomStatus ( ) const
inlinevirtual

Reimplemented in yaze::editor::DungeonEditorV2, and yaze::editor::OverworldEditor.

Definition at line 351 of file editor.h.

◆ rom()

◆ game_data()

zelda3::GameData * yaze::editor::Editor::game_data ( ) const
inline

Definition at line 357 of file editor.h.

References dependencies_, and yaze::editor::EditorDependencies::game_data.

Referenced by yaze::editor::SpriteEditor::ApplySpritesetToSheets(), yaze::editor::PaletteEditor::BeginSaveTransaction(), yaze::editor::PaletteEditor::CanRedo(), yaze::editor::PaletteEditor::CanUndo(), yaze::editor::GraphicsEditor::DecompressImportData(), yaze::editor::GraphicsEditor::DecompressSuperDonkey(), yaze::editor::PaletteEditor::DrawControlPanel(), yaze::editor::ScreenEditor::DrawDungeonMapsRoomGfx(), yaze::editor::ScreenEditor::DrawInventoryMenuEditor(), yaze::editor::ScreenEditor::DrawMenuTilemapEditor(), yaze::editor::PaletteEditor::DrawPaletteGroup(), yaze::editor::SpriteEditor::DrawSpritesetPicker(), yaze::editor::ScreenEditor::DrawTitleScreenEditor(), yaze::editor::DungeonEditorV2::HandleDungeonPaletteChanged(), yaze::editor::GraphicsEditor::Initialize(), yaze::editor::DungeonEditorV2::Load(), yaze::editor::GraphicsEditor::Load(), yaze::editor::ScreenEditor::Load(), yaze::editor::PaletteEditor::Load(), yaze::editor::SpriteEditor::Load(), yaze::editor::ScreenEditor::LoadBinaryGfx(), yaze::editor::SpriteEditor::LoadSpriteGraphicsBuffer(), yaze::editor::SpriteEditor::LoadSpritePalettes(), yaze::editor::DungeonEditorV2::OnRoomSelected(), yaze::editor::ScreenEditor::OpenDungeonMapTileGraphics(), yaze::editor::SpriteEditor::OpenSelectedOamGraphics(), yaze::editor::ScreenEditor::PrepareDungeonMapSave(), yaze::editor::GraphicsEditor::PrepareGraphicsSave(), yaze::editor::PaletteEditor::Redo(), yaze::editor::ScreenEditor::RefreshDungeonMapGraphicsFromSession(), yaze::editor::SpriteEditor::RefreshSpritePreviewGraphics(), yaze::editor::MessageEditor::ResolveFontPalette(), yaze::editor::ScreenEditor::RestoreFromSnapshot(), yaze::editor::PaletteEditor::Save(), SetGameData(), yaze::editor::DungeonEditorV2::SetGameData(), yaze::editor::GraphicsEditor::SetGameData(), yaze::editor::MessageEditor::SetGameData(), yaze::editor::OverworldEditor::SetGameData(), yaze::editor::PaletteEditor::SetGameData(), and yaze::editor::PaletteEditor::Undo().

◆ project()

project::YazeProject * yaze::editor::Editor::project ( ) const
inline

Definition at line 358 of file editor.h.

References dependencies_, and yaze::editor::EditorDependencies::project.

Referenced by yaze::editor::SpriteEditor::BindOracleBehaviorProfile(), yaze::editor::SpriteEditor::CheckCurrentSpriteSource(), yaze::editor::SpriteEditor::CurrentPreviewLayout(), yaze::editor::SpriteEditor::DrawFrameTileWarnings(), yaze::editor::ScreenEditor::DrawMenuTilemapEditor(), yaze::editor::PlanningEditor::DrawNoPlan(), yaze::editor::SpriteEditor::DrawSpriteCatalog(), yaze::editor::GraphicsEditor::EditProject(), yaze::editor::MessageEditor::ExpandedInspectionRange(), yaze::editor::SpriteEditor::ExportCurrentSpriteBehavior(), yaze::editor::MessageEditor::HasMessageSourceLayout(), yaze::editor::GraphicsEditor::Initialize(), yaze::editor::SpriteEditor::LoadZsmFile(), yaze::editor::DungeonEditorV2::PlanPendingRoomStreamRanges(), yaze::editor::GraphicsEditor::PrepareGraphicsSave(), yaze::editor::SpriteEditor::RefreshCatalogIfChanged(), yaze::editor::PaletteEditor::RefreshPaletteCatalogIfChanged(), yaze::editor::AssemblyEditor::RefreshSelectedZ3DisassemblyMetadata(), yaze::editor::PaletteEditor::ReloadPaletteCatalog(), yaze::editor::SpriteEditor::ReloadProjectSpriteAssets(), yaze::editor::SpriteEditor::ReloadSpriteCatalog(), yaze::editor::SpriteEditor::SaveZsmFile(), yaze::editor::GraphicsEditor::set_rom(), yaze::editor::GraphicsEditor::SetGameData(), yaze::editor::MusicEditor::SetProject(), yaze::editor::SettingsPanel::SetProject(), and yaze::editor::PlanningEditor::SyncWithProject().

◆ version_manager()

core::VersionManager * yaze::editor::Editor::version_manager ( ) const
inline

Definition at line 359 of file editor.h.

References dependencies_, and yaze::editor::EditorDependencies::version_manager.

◆ context()

◆ HasContext()

bool yaze::editor::Editor::HasContext ( ) const
inline

Definition at line 365 of file editor.h.

References dependencies_, and yaze::editor::EditorDependencies::HasContext().

Here is the call graph for this function:

◆ MakePanelTitle()

std::string yaze::editor::Editor::MakePanelTitle ( const std::string & base_title) const
inlineprotected

Definition at line 374 of file editor.h.

References dependencies_, and yaze::editor::EditorDependencies::session_id.

◆ MakeWindowId()

std::string yaze::editor::Editor::MakeWindowId ( const std::string & base_id) const
inlineprotected

Definition at line 382 of file editor.h.

References dependencies_, and yaze::editor::EditorDependencies::session_id.

◆ SafeRomAccess()

template<typename T >
absl::StatusOr< T > yaze::editor::Editor::SafeRomAccess ( std::function< T()> accessor,
const std::string & operation = "" ) const
inlineprotected

Definition at line 391 of file editor.h.

References IsRomLoaded().

Here is the call graph for this function:

Member Data Documentation

◆ active_

bool yaze::editor::Editor::active_ = false
protected

◆ type_

◆ dependencies_

EditorDependencies yaze::editor::Editor::dependencies_
protected

Definition at line 370 of file editor.h.

Referenced by yaze::editor::DungeonEditorV2::ApplyDoorConnection(), yaze::editor::PaletteEditor::ApplyPanelDependencies(), yaze::editor::AgentEditor::ApplyUserSettingsDefaults(), yaze::editor::DungeonEditorV2::BuildContextSnapshot(), yaze::editor::OverworldEditor::BuildContextSnapshot(), yaze::editor::OverworldEditor::ClearSelectedItem(), yaze::editor::DungeonEditorV2::ConfigureMinecartProjectCallbacks(), yaze::editor::DungeonEditorV2::ConfigureViewerUndoHooks(), context(), yaze::editor::DungeonEditorV2::ContributeStatus(), yaze::editor::OverworldEditor::Copy(), yaze::editor::DungeonEditorV2::CreateObjectCoveragePanel(), yaze::editor::OverworldEditor::DeleteSelectedItem(), yaze::editor::AssemblyEditor::DrawBuildOutput(), yaze::editor::AgentEditor::DrawConfigurationPanel(), yaze::editor::PaletteEditor::DrawControlPanel(), yaze::editor::AgentEditor::DrawFeatureFlagPanel(), yaze::editor::AssemblyEditor::DrawFileBrowser(), yaze::editor::MessageEditor::DrawFindBar(), yaze::editor::AgentEditor::DrawManifestPanel(), yaze::editor::MessageEditor::DrawMessageSourceSync(), yaze::editor::OverworldCanvasRenderer::DrawOverworldCanvas(), yaze::editor::PaletteEditor::DrawPaletteCatalog(), yaze::editor::PlanningEditor::DrawPlanHeader(), yaze::editor::DungeonEditorV2::DrawRoomPanels(), yaze::editor::DungeonEditorV2::DrawRoomTab(), yaze::editor::OverworldEditor::DrawScratchSpacePattern(), yaze::editor::SpriteEditor::DrawSpriteCanvas(), yaze::editor::AgentEditor::DrawSramViewerPanel(), yaze::editor::OverworldEditor::DuplicateSelectedItem(), yaze::editor::GraphicsEditor::EditProject(), yaze::editor::DungeonEditorV2::EnsureMinecartTrackEditorPanel(), yaze::editor::MessageEditor::ExpandedInspectionRange(), game_data(), yaze::editor::DungeonEditorV2::GetDungeonRenderContextCensus(), yaze::editor::DungeonEditorV2::GetStandaloneViewerForRoom(), yaze::editor::OverworldEditor::GetWorkbench(), yaze::editor::DungeonEditorV2::HandleObjectPlaced(), yaze::editor::OverworldEditor::HandleTile16Edit(), HasContext(), yaze::editor::MessageEditor::HasMessageSourceLayout(), yaze::editor::SpriteEditor::ImportCatalogDraw(), yaze::editor::AgentEditor::Initialize(), yaze::editor::AssemblyEditor::Initialize(), yaze::editor::DungeonEditorV2::Initialize(), yaze::editor::GraphicsEditor::Initialize(), yaze::editor::ScreenEditor::Initialize(), yaze::editor::MessageEditor::Initialize(), yaze::editor::MusicEditor::Initialize(), yaze::editor::OverworldEditor::Initialize(), yaze::editor::PaletteEditor::Initialize(), yaze::editor::PlanningEditor::Initialize(), yaze::editor::SpriteEditor::Initialize(), yaze::editor::OverworldEditor::InitInteractionCoordinator(), yaze::editor::DungeonEditorV2::IsWorkbenchWorkflowEnabled(), yaze::editor::PaletteEditor::JumpToPalette(), yaze::editor::AssemblyEditor::JumpToReference(), yaze::editor::AssemblyEditor::JumpToSymbolDefinition(), yaze::editor::DungeonEditorV2::Load(), yaze::editor::OverworldEditor::Load(), yaze::editor::PaletteEditor::Load(), MakePanelTitle(), MakeWindowId(), yaze::editor::AgentEditor::MaybeAutoDetectLocalProviders(), yaze::editor::MessageEditor::MessageEditor(), yaze::editor::MessageEditor::MessageSourceIncomingPath(), yaze::editor::OverworldEditor::NudgeSelectedItem(), yaze::editor::DungeonEditorV2::OnRoomSelected(), yaze::editor::ScreenEditor::OpenDungeonMapTileGraphics(), yaze::editor::DungeonEditorV2::OpenGraphicsEditorForObject(), yaze::editor::OverworldEditor::OpenGraphicsForTile16Quadrant(), yaze::editor::GraphicsEditor::OpenInContext(), yaze::editor::OverworldEditor::OpenMapPropertiesWindow(), yaze::editor::MessageEditor::OpenMessageById(), yaze::editor::DungeonEditorV2::OpenObjectTileEditorForObject(), yaze::editor::SpriteEditor::OpenSelectedOamGraphics(), yaze::editor::MusicEditor::OpenSong(), yaze::editor::MusicEditor::OpenSongPianoRoll(), yaze::editor::PlanningEditor::OpenTarget(), yaze::editor::DungeonEditorV2::OpenWindow(), yaze::editor::OverworldEditor::OverworldEditor(), yaze::editor::OverworldEditor::Paste(), yaze::editor::DungeonEditorV2::PlanPendingRoomStreamRanges(), yaze::editor::DungeonEditorV2::PreflightObjectMutation(), yaze::editor::DungeonEditorV2::PreflightPotItemPlacement(), yaze::editor::DungeonEditorV2::PreflightRoomTransfer(), yaze::editor::DungeonEditorV2::PreflightStreamMutation(), yaze::editor::OverworldCanvasRenderer::PrepareContextMenu(), yaze::editor::MessageEditor::PreviewMessageSource(), yaze::editor::DungeonEditorV2::ProcessPendingStandaloneToolWindow(), yaze::editor::DungeonEditorV2::ProcessPendingSwap(), project(), yaze::editor::MessageEditor::PublishMessageSource(), yaze::editor::DungeonEditorV2::Redo(), yaze::editor::SpriteEditor::RefreshCatalogIfChanged(), yaze::editor::AgentEditor::RefreshModelCache(), yaze::editor::PaletteEditor::RefreshPaletteCatalogIfChanged(), yaze::editor::PaletteEditor::RefreshPanelReferences(), yaze::editor::DungeonEditorV2::RefreshRomBackedState(), yaze::editor::AssemblyEditor::RefreshSelectedZ3DisassemblyMetadata(), yaze::editor::PaletteEditor::ReloadPaletteCatalog(), yaze::editor::SpriteEditor::ReloadSpriteCatalog(), yaze::editor::DungeonEditorV2::ReloadWaterFillZones(), yaze::editor::OverworldEditor::RenameProjectResourceLabelWithUndo(), yaze::editor::MessageEditor::ResolveCanonicalBundlePath(), yaze::editor::DungeonEditorV2::ResolveDungeonRenderContextForRoom(), yaze::editor::MessageEditor::ResolveExpandedMessageBaseId(), yaze::editor::AssemblyEditor::ResolveZ3DisasmOutputDir(), yaze::editor::AssemblyEditor::ResolveZ3DisasmRomPath(), rom(), yaze::editor::AssemblyEditor::RunProjectGraphQueryInDrawer(), yaze::editor::DungeonEditorV2::Save(), yaze::editor::OverworldEditor::Save(), yaze::editor::PaletteEditor::Save(), yaze::editor::OverworldEditor::SelectItemByIdentity(), yaze::editor::DungeonEditorV2::SetAgentMode(), SetDependencies(), SetGameData(), yaze::editor::DungeonEditorV2::SetGameData(), yaze::editor::DungeonEditorV2::SetWorkbenchWorkflowMode(), yaze::editor::OverworldEditor::SyncProjectGraphicsPreview(), yaze::editor::OverworldEditor::ToggleItemListWindow(), yaze::editor::OverworldEditor::ToggleTile16EditorWindow(), yaze::editor::DungeonEditorV2::Undo(), yaze::editor::OverworldEditor::Update(), yaze::editor::DungeonEditorV2::Update(), yaze::editor::MusicEditor::Update(), version_manager(), and yaze::editor::DungeonEditorV2::WireViewerPanelCallbacks().

◆ undo_manager_

UndoManager yaze::editor::Editor::undo_manager_
protected

Definition at line 371 of file editor.h.

Referenced by yaze::editor::DungeonEditorV2::ApplyMinecartCollisionBatch(), yaze::editor::DungeonEditorV2::ApplyMinecartCollisionStamp(), yaze::editor::DungeonEditorV2::ApplyMinecartTrackEdit(), yaze::editor::OverworldEditor::ApplyOverworldPropertyEdit(), yaze::editor::OverworldEditor::ApplyOverworldPropertyEdits(), yaze::editor::DungeonEditorV2::ApplyRoomTransfer(), CanRedo(), CanUndo(), yaze::editor::DungeonEditorV2::CanUndo(), yaze::editor::MessageEditor::CanUndo(), yaze::editor::MusicEditor::CanUndo(), yaze::editor::ScreenEditor::CommitDungeonMapUndo(), yaze::editor::ScreenEditor::CommitTile16CompUndo(), yaze::editor::SpriteEditor::CommitUndoTransaction(), yaze::editor::ScreenEditor::DrawDungeonMapsTabs(), yaze::editor::ScreenEditor::DrawInventoryToolset(), yaze::editor::ScreenEditor::DrawMenuTilemapEditor(), yaze::editor::DungeonEditorV2::DrawRoomTab(), yaze::editor::DungeonEditorV2::EditChest(), yaze::editor::DungeonEditorV2::EditRoomGraphicsSheet(), yaze::editor::DungeonEditorV2::EditRoomMetadataBatch(), yaze::editor::DungeonEditorV2::FinalizeCollisionUndoAction(), yaze::editor::DungeonEditorV2::FinalizeEntityUndoAction(), yaze::editor::OverworldEditor::FinalizePaintOperation(), yaze::editor::MusicEditor::FinalizePendingUndo(), yaze::editor::DungeonEditorV2::FinalizeUndoAction(), yaze::editor::DungeonEditorV2::FinalizeWaterFillUndoAction(), GetRedoDescription(), GetUndoDescription(), yaze::editor::DungeonEditorV2::Initialize(), yaze::editor::GraphicsEditor::Initialize(), yaze::editor::OverworldEditor::Load(), yaze::editor::OverworldEditor::OverworldEditor(), yaze::editor::OverworldEditor::PushItemUndoAction(), yaze::editor::DungeonEditorV2::PushSelectionUndoBatch(), yaze::editor::DungeonEditorV2::RecordEntrancePropertyEdit(), yaze::editor::DungeonEditorV2::RecordSpawnPropertyEdit(), yaze::editor::DungeonEditorV2::Redo(), yaze::editor::GraphicsEditor::Redo(), yaze::editor::ScreenEditor::Redo(), yaze::editor::MusicEditor::Redo(), yaze::editor::OverworldEditor::Redo(), yaze::editor::SpriteEditor::Redo(), yaze::editor::DungeonEditorV2::RefreshRomBackedState(), yaze::editor::OverworldEditor::RenameProjectResourceLabelWithUndo(), yaze::editor::GraphicsEditor::ReorderSourcePalette(), yaze::editor::DungeonEditorV2::RepairEntranceCamera(), yaze::editor::ScreenEditor::ResetRomBackedStateForLoad(), yaze::editor::DungeonEditorV2::Undo(), yaze::editor::GraphicsEditor::Undo(), yaze::editor::ScreenEditor::Undo(), yaze::editor::MusicEditor::Undo(), yaze::editor::OverworldEditor::Undo(), yaze::editor::SpriteEditor::Undo(), and undo_manager().


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