Allows the user to edit sprites. More...

#include <sprite_editor.h>

Inheritance diagram for yaze::editor::SpriteEditor:

Classes
struct	OAMConfig

Public Member Functions
	SpriteEditor (Rom *rom=nullptr)

void	Initialize () override

absl::Status	Load () override

absl::Status	Update () override

absl::Status	Undo () override

absl::Status	Redo () override

absl::Status	Cut () override

absl::Status	Copy () override

absl::Status	Paste () override

absl::Status	Find () override

absl::Status	Save () override

void	set_rom (Rom *rom)

Rom *	rom () const

Public Member Functions inherited from yaze::editor::Editor
	Editor ()=default

virtual	~Editor ()=default

virtual void	SetDependencies (const EditorDependencies &deps)

virtual void	SetGameData (zelda3::GameData *game_data)

virtual absl::Status	BeginSaveTransaction ()

virtual void	RollbackSaveTransaction ()

virtual void	CommitSaveTransaction ()

virtual std::string	GetUndoDescription () const

virtual std::string	GetRedoDescription () const

const UndoManager &	undo_manager () const

virtual absl::Status	Clear ()

virtual void	ContributeStatus (StatusBar *)

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

Private Member Functions
void	HandleEditorShortcuts ()

void	DrawVanillaSpriteEditor ()

void	DrawSpritesList ()

void	DrawSpriteCanvas ()

void	DrawCurrentSheets ()

void	DrawToolset ()

void	DrawCustomSprites ()

void	DrawCustomSpritesMetadata ()

void	DrawAnimationFrames ()

void	CreateNewZSprite ()

void	LoadZsmFile (const std::string &path)

void	SaveZsmFile (const std::string &path)

void	SaveZsmFileAs ()

void	EnsureCustomSpritePaths ()

const std::string &	GetCurrentZsmPath () const

void	SetCurrentZsmPath (const std::string &path)

void	DrawSpritePropertiesPanel ()

void	DrawBooleanProperties ()

void	DrawStatProperties ()

void	DrawAnimationPanel ()

void	DrawAnimationList ()

void	DrawFrameEditor ()

void	UpdateAnimationPlayback (float delta_time)

void	DrawUserRoutinesPanel ()

void	RenderZSpriteFrame (int frame_index)

void	DrawZSpriteOnCanvas ()

void	LoadSpriteGraphicsBuffer ()

void	LoadSpritePalettes ()

void	RenderVanillaSprite (const zelda3::SpriteOamLayout &layout)

void	LoadSheetsForSprite (const std::array< uint8_t, 4 > &sheets)

SpriteSnapshot	CaptureCurrentSpriteSnapshot () const

void	RestoreFromSnapshot (const SpriteSnapshot &snapshot)

void	BeginUndoTransaction ()

void	CommitUndoTransaction ()

void	MarkSpriteMutated ()

Private Attributes
ImVector< int >	active_sprites_

int	current_sprite_id_ = 0

uint8_t	current_sheets_ [8] = {0x00, 0x0A, 0x06, 0x07, 0x00, 0x00, 0x00, 0x00}

bool	sheets_loaded_ = false

OAMConfig	oam_config_

gfx::Bitmap	oam_bitmap_

gfx::Bitmap	vanilla_preview_bitmap_

bool	vanilla_preview_needs_update_ = true

std::vector< zsprite::ZSprite >	custom_sprites_

std::vector< std::string >	custom_sprite_paths_

int	current_custom_sprite_index_ = -1

bool	zsm_dirty_ = false

bool	animation_playing_ = false

int	current_frame_ = 0

int	current_animation_index_ = 0

float	frame_timer_ = 0.0f

float	last_frame_time_ = 0.0f

int	selected_routine_index_ = -1

int	selected_tile_index_ = -1

bool	show_tile_grid_ = true

gfx::Bitmap	sprite_preview_bitmap_

bool	preview_needs_update_ = true

SpriteDrawer	sprite_drawer_

std::vector< uint8_t >	sprite_gfx_buffer_

gfx::PaletteGroup	sprite_palettes_

bool	gfx_buffer_loaded_ = false

gui::Canvas	sprite_canvas_

gui::Canvas	graphics_sheet_canvas_

bool	undo_snapshot_pending_ = false

bool	sprite_mutated_this_frame_ = false

SpriteSnapshot	undo_before_snapshot_

absl::Status	status_

Rom *	rom_

Additional Inherited Members
Protected Member Functions inherited from yaze::editor::Editor
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 inherited from yaze::editor::Editor
bool	active_ = false

EditorType	type_

EditorDependencies	dependencies_

UndoManager	undo_manager_

Detailed Description

Allows the user to edit sprites.

This class provides functionality for updating the sprite editor, drawing the editor table, drawing the sprite canvas, and drawing the current sheets. Supports both vanilla ROM sprites and custom ZSM format sprites.

Definition at line 44 of file sprite_editor.h.

Constructor & Destructor Documentation

◆ SpriteEditor()

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

inlineexplicit

Definition at line 46 of file sprite_editor.h.

References yaze::editor::kSprite, and yaze::editor::Editor::type_.

Member Function Documentation

◆ Initialize()

void yaze::editor::SpriteEditor::Initialize ( )

overridevirtual

Implements yaze::editor::Editor.

Definition at line 61 of file sprite_editor.cc.

References yaze::editor::Editor::dependencies_, DrawCustomSprites(), yaze::Rom::is_loaded(), yaze::editor::WorkspaceWindowManager::RegisterWindowContent(), rom_, and yaze::editor::EditorDependencies::window_manager.

Here is the call graph for this function:

◆ Load()

absl::Status yaze::editor::SpriteEditor::Load ( )

overridevirtual

Implements yaze::editor::Editor.

Definition at line 82 of file sprite_editor.cc.

◆ Update()

absl::Status yaze::editor::SpriteEditor::Update ( )

overridevirtual

Implements yaze::editor::Editor.

Definition at line 87 of file sprite_editor.cc.

References CommitUndoTransaction(), HandleEditorShortcuts(), last_frame_time_, rom(), sheets_loaded_, status_, and UpdateAnimationPlayback().

Here is the call graph for this function:

◆ Undo()

absl::Status yaze::editor::SpriteEditor::Undo ( )

inlineoverridevirtual

Implements yaze::editor::Editor.

Definition at line 53 of file sprite_editor.h.

References yaze::editor::UndoManager::Undo(), and yaze::editor::Editor::undo_manager_.

Here is the call graph for this function:

◆ Redo()

absl::Status yaze::editor::SpriteEditor::Redo ( )

inlineoverridevirtual

Implements yaze::editor::Editor.

Definition at line 54 of file sprite_editor.h.

References yaze::editor::UndoManager::Redo(), and yaze::editor::Editor::undo_manager_.

Here is the call graph for this function:

◆ Cut()

absl::Status yaze::editor::SpriteEditor::Cut ( )

inlineoverridevirtual

Implements yaze::editor::Editor.

Definition at line 55 of file sprite_editor.h.

◆ Copy()

absl::Status yaze::editor::SpriteEditor::Copy ( )

inlineoverridevirtual

Implements yaze::editor::Editor.

Definition at line 56 of file sprite_editor.h.

◆ Paste()

absl::Status yaze::editor::SpriteEditor::Paste ( )

inlineoverridevirtual

Implements yaze::editor::Editor.

Definition at line 57 of file sprite_editor.h.

◆ Find()

absl::Status yaze::editor::SpriteEditor::Find ( )

inlineoverridevirtual

Implements yaze::editor::Editor.

Definition at line 58 of file sprite_editor.h.

◆ Save()

absl::Status yaze::editor::SpriteEditor::Save ( )

overridevirtual

Implements yaze::editor::Editor.

Definition at line 143 of file sprite_editor.cc.

References current_custom_sprite_index_, custom_sprites_, GetCurrentZsmPath(), SaveZsmFile(), and SaveZsmFileAs().

Here is the call graph for this function:

◆ set_rom()

void yaze::editor::SpriteEditor::set_rom ( Rom * rom )

inline

Definition at line 61 of file sprite_editor.h.

References rom(), and rom_.

Here is the call graph for this function:

◆ rom()

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

inline

Definition at line 62 of file sprite_editor.h.

References rom_.

Referenced by DrawSpritesList(), set_rom(), and Update().

◆ HandleEditorShortcuts()

void yaze::editor::SpriteEditor::HandleEditorShortcuts ( )

private

Definition at line 110 of file sprite_editor.cc.

References animation_playing_, current_frame_, current_sprite_id_, preview_needs_update_, and vanilla_preview_needs_update_.

Referenced by Update().

◆ DrawVanillaSpriteEditor()

void yaze::editor::SpriteEditor::DrawVanillaSpriteEditor ( )

private

Definition at line 164 of file sprite_editor.cc.

References active_sprites_, yaze::gui::BeginThemedTabBar(), current_sprite_id_, DrawCurrentSheets(), DrawSpriteCanvas(), DrawSpritesList(), yaze::gui::EndThemedTabBar(), ICON_MD_ADD, yaze::zelda3::kSpriteDefaultNames, yaze::editor::kSpriteTabBarFlags, yaze::editor::kSpriteTabFlags, and sheets_loaded_.

◆ DrawSpritesList()

void yaze::editor::SpriteEditor::DrawSpritesList ( )

private

Definition at line 337 of file sprite_editor.cc.

References active_sprites_, current_sprite_id_, yaze::gui::GetID(), yaze::util::HexByte(), yaze::zelda3::kSpriteDefaultNames, yaze::Rom::resource_label(), rom(), yaze::project::ResourceLabelManager::SelectableLabelWithNameEdit(), and vanilla_preview_needs_update_.

Referenced by DrawVanillaSpriteEditor().

◆ DrawSpriteCanvas()

void yaze::editor::SpriteEditor::DrawSpriteCanvas ( )

private

Definition at line 221 of file sprite_editor.cc.

References current_sprite_id_, DrawAnimationFrames(), yaze::gui::Canvas::DrawBackground(), yaze::gui::Canvas::DrawBitmap(), yaze::gui::Canvas::DrawContextMenu(), yaze::gui::Canvas::DrawGrid(), yaze::gui::Canvas::DrawOverlay(), yaze::editor::SpriteEditor::OAMConfig::flip_x, yaze::editor::SpriteEditor::OAMConfig::flip_y, yaze::gui::GetID(), yaze::zelda3::SpriteOamRegistry::GetLayout(), yaze::gui::InputHexByte(), yaze::gui::InputHexWord(), yaze::gfx::Bitmap::is_active(), LoadSheetsForSprite(), oam_config_, yaze::editor::SpriteEditor::OAMConfig::palette, yaze::editor::SpriteEditor::OAMConfig::priority, RenderVanillaSprite(), sprite_canvas_, yaze::editor::SpriteEditor::OAMConfig::tile, vanilla_preview_bitmap_, yaze::editor::SpriteEditor::OAMConfig::x, and yaze::editor::SpriteEditor::OAMConfig::y.

Referenced by DrawVanillaSpriteEditor().

◆ DrawCurrentSheets()

void yaze::editor::SpriteEditor::DrawCurrentSheets ( )

private

◆ DrawToolset()

void yaze::editor::SpriteEditor::DrawToolset ( )

private

Definition at line 156 of file sprite_editor.cc.

◆ DrawCustomSprites()

void yaze::editor::SpriteEditor::DrawCustomSprites ( )

private

Definition at line 374 of file sprite_editor.cc.

References DrawCurrentSheets(), DrawCustomSpritesMetadata(), and DrawZSpriteOnCanvas().

Referenced by Initialize().

Here is the call graph for this function:

◆ DrawCustomSpritesMetadata()

void yaze::editor::SpriteEditor::DrawCustomSpritesMetadata ( )

private

◆ DrawAnimationFrames()

void yaze::editor::SpriteEditor::DrawAnimationFrames ( )

private

Definition at line 361 of file sprite_editor.cc.

Referenced by DrawSpriteCanvas().

◆ CreateNewZSprite()

void yaze::editor::SpriteEditor::CreateNewZSprite ( )

private

Definition at line 483 of file sprite_editor.cc.

References animation_playing_, yaze::editor::zsprite::ZSprite::animations, current_animation_index_, current_custom_sprite_index_, current_frame_, custom_sprite_paths_, custom_sprites_, yaze::editor::zsprite::ZSprite::editor, frame_timer_, yaze::editor::zsprite::SubEditor::Frames, preview_needs_update_, yaze::editor::zsprite::ZSprite::Reset(), selected_routine_index_, selected_tile_index_, yaze::editor::zsprite::ZSprite::sprName, and zsm_dirty_.

Referenced by DrawCustomSpritesMetadata().

Here is the call graph for this function:

◆ LoadZsmFile()

void yaze::editor::SpriteEditor::LoadZsmFile ( const std::string & path )

private

Definition at line 507 of file sprite_editor.cc.

References animation_playing_, current_animation_index_, current_custom_sprite_index_, current_frame_, custom_sprite_paths_, custom_sprites_, frame_timer_, yaze::editor::zsprite::ZSprite::Load(), preview_needs_update_, selected_routine_index_, selected_tile_index_, status_, and zsm_dirty_.

Referenced by DrawCustomSpritesMetadata().

Here is the call graph for this function:

◆ SaveZsmFile()

void yaze::editor::SpriteEditor::SaveZsmFile ( const std::string & path )

private

Definition at line 526 of file sprite_editor.cc.

References current_custom_sprite_index_, custom_sprites_, SetCurrentZsmPath(), status_, and zsm_dirty_.

Referenced by DrawCustomSpritesMetadata(), Save(), and SaveZsmFileAs().

Here is the call graph for this function:

◆ SaveZsmFileAs()

void yaze::editor::SpriteEditor::SaveZsmFileAs ( )

private

Definition at line 537 of file sprite_editor.cc.

References current_custom_sprite_index_, SaveZsmFile(), and yaze::util::FileDialogWrapper::ShowSaveFileDialog().

Referenced by DrawCustomSpritesMetadata(), and Save().

Here is the call graph for this function:

◆ EnsureCustomSpritePaths()

void yaze::editor::SpriteEditor::EnsureCustomSpritePaths ( )

private

Definition at line 1379 of file sprite_editor.cc.

References custom_sprite_paths_, and custom_sprites_.

Referenced by SetCurrentZsmPath().

◆ GetCurrentZsmPath()

const std::string & yaze::editor::SpriteEditor::GetCurrentZsmPath ( ) const

private

Definition at line 1385 of file sprite_editor.cc.

References current_custom_sprite_index_, and custom_sprite_paths_.

Referenced by DrawCustomSpritesMetadata(), and Save().

◆ SetCurrentZsmPath()

void yaze::editor::SpriteEditor::SetCurrentZsmPath ( const std::string & path )

private

Definition at line 1395 of file sprite_editor.cc.

References current_custom_sprite_index_, custom_sprite_paths_, and EnsureCustomSpritePaths().

Referenced by SaveZsmFile().

Here is the call graph for this function:

◆ DrawSpritePropertiesPanel()

void yaze::editor::SpriteEditor::DrawSpritePropertiesPanel ( )

private

Definition at line 551 of file sprite_editor.cc.

References current_custom_sprite_index_, custom_sprites_, DrawBooleanProperties(), DrawStatProperties(), and MarkSpriteMutated().

Referenced by DrawCustomSpritesMetadata().

Here is the call graph for this function:

◆ DrawBooleanProperties()

void yaze::editor::SpriteEditor::DrawBooleanProperties ( )

private

Definition at line 623 of file sprite_editor.cc.

References current_custom_sprite_index_, custom_sprites_, and MarkSpriteMutated().

Referenced by DrawSpritePropertiesPanel().

Here is the call graph for this function:

◆ DrawStatProperties()

void yaze::editor::SpriteEditor::DrawStatProperties ( )

private

Definition at line 580 of file sprite_editor.cc.

References current_custom_sprite_index_, custom_sprites_, and MarkSpriteMutated().

Referenced by DrawSpritePropertiesPanel().

Here is the call graph for this function:

◆ DrawAnimationPanel()

void yaze::editor::SpriteEditor::DrawAnimationPanel ( )

private

Definition at line 695 of file sprite_editor.cc.

References animation_playing_, current_animation_index_, current_custom_sprite_index_, current_frame_, custom_sprites_, DrawFrameEditor(), frame_timer_, HOVER_HINT, ICON_MD_ADD, ICON_MD_PLAY_ARROW, ICON_MD_SKIP_NEXT, ICON_MD_SKIP_PREVIOUS, ICON_MD_STOP, MarkSpriteMutated(), and preview_needs_update_.

Referenced by DrawCustomSpritesMetadata().

Here is the call graph for this function:

◆ DrawAnimationList()

void yaze::editor::SpriteEditor::DrawAnimationList ( )

private

◆ DrawFrameEditor()

void yaze::editor::SpriteEditor::DrawFrameEditor ( )

private

Definition at line 800 of file sprite_editor.cc.

References current_custom_sprite_index_, current_frame_, custom_sprites_, HOVER_HINT, ICON_MD_ADD, ICON_MD_DELETE, MarkSpriteMutated(), preview_needs_update_, and selected_tile_index_.

Referenced by DrawAnimationPanel().

Here is the call graph for this function:

◆ UpdateAnimationPlayback()

void yaze::editor::SpriteEditor::UpdateAnimationPlayback ( float delta_time )

private

Definition at line 920 of file sprite_editor.cc.

References animation_playing_, current_animation_index_, current_custom_sprite_index_, current_frame_, custom_sprites_, frame_timer_, and preview_needs_update_.

Referenced by Update().

◆ DrawUserRoutinesPanel()

void yaze::editor::SpriteEditor::DrawUserRoutinesPanel ( )

private

Definition at line 951 of file sprite_editor.cc.

References current_custom_sprite_index_, custom_sprites_, HOVER_HINT, ICON_MD_ADD, MarkSpriteMutated(), and selected_routine_index_.

Referenced by DrawCustomSpritesMetadata().

Here is the call graph for this function:

◆ RenderZSpriteFrame()

void yaze::editor::SpriteEditor::RenderZSpriteFrame ( int frame_index )

private

Definition at line 1193 of file sprite_editor.cc.

References yaze::gfx::SnesPalette::AddColor(), yaze::editor::SpriteDrawer::ClearBitmap(), current_custom_sprite_index_, custom_sprites_, yaze::gui::Canvas::DrawBitmap(), yaze::editor::SpriteDrawer::DrawFrame(), yaze::gui::Canvas::DrawRect(), yaze::editor::internal::EnsureSpritePreviewBitmapReady(), yaze::gui::Canvas::GetConfig(), gfx_buffer_loaded_, yaze::gfx::Bitmap::is_active(), yaze::editor::SpriteDrawer::IsReady(), yaze::gui::kCompositeOutput, LoadSpriteGraphicsBuffer(), LoadSpritePalettes(), yaze::gfx::PaletteGroup::palette(), preview_needs_update_, yaze::gui::CanvasConfig::role, selected_tile_index_, yaze::gfx::Bitmap::SetPalette(), sheets_loaded_, show_tile_grid_, yaze::gfx::SnesPalette::size(), yaze::gfx::PaletteGroup::size(), sprite_canvas_, sprite_drawer_, sprite_gfx_buffer_, sprite_palettes_, sprite_preview_bitmap_, and yaze::gfx::Bitmap::UpdateTexture().

Referenced by DrawZSpriteOnCanvas().

◆ DrawZSpriteOnCanvas()

void yaze::editor::SpriteEditor::DrawZSpriteOnCanvas ( )

private

Definition at line 1285 of file sprite_editor.cc.

References current_custom_sprite_index_, current_frame_, custom_sprites_, yaze::gui::Canvas::DrawBackground(), yaze::gui::Canvas::DrawContextMenu(), yaze::gui::Canvas::DrawGrid(), yaze::gui::Canvas::DrawOverlay(), yaze::gui::GetID(), RenderZSpriteFrame(), and sprite_canvas_.

Referenced by DrawCustomSprites().

◆ LoadSpriteGraphicsBuffer()

void yaze::editor::SpriteEditor::LoadSpriteGraphicsBuffer ( )

private

Definition at line 1011 of file sprite_editor.cc.

References current_sheets_, yaze::gfx::Arena::Get(), gfx_buffer_loaded_, yaze::gfx::Arena::gfx_sheets(), yaze::editor::SpriteDrawer::SetGraphicsBuffer(), sprite_drawer_, and sprite_gfx_buffer_.

Referenced by RenderVanillaSprite(), and RenderZSpriteFrame().

Here is the call graph for this function:

◆ LoadSpritePalettes()

void yaze::editor::SpriteEditor::LoadSpritePalettes ( )

private

Definition at line 1056 of file sprite_editor.cc.

References yaze::gfx::PaletteGroup::AddPalette(), yaze::gfx::PaletteGroup::clear(), yaze::editor::Editor::game_data(), yaze::gfx::PaletteGroupMap::global_sprites, yaze::Rom::is_loaded(), yaze::zelda3::GameData::palette_groups, rom_, yaze::editor::SpriteDrawer::SetPalettes(), yaze::gfx::PaletteGroup::size(), sprite_drawer_, sprite_palettes_, yaze::gfx::PaletteGroupMap::sprites_aux1, yaze::gfx::PaletteGroupMap::sprites_aux2, and yaze::gfx::PaletteGroupMap::sprites_aux3.

Referenced by RenderVanillaSprite(), and RenderZSpriteFrame().

◆ RenderVanillaSprite()

void yaze::editor::SpriteEditor::RenderVanillaSprite ( const zelda3::SpriteOamLayout & layout )

private

Definition at line 1122 of file sprite_editor.cc.

Referenced by DrawSpriteCanvas().

◆ LoadSheetsForSprite()

void yaze::editor::SpriteEditor::LoadSheetsForSprite ( const std::array< uint8_t, 4 > & sheets )

private

Definition at line 1106 of file sprite_editor.cc.

References current_sheets_, gfx_buffer_loaded_, and vanilla_preview_needs_update_.

Referenced by DrawSpriteCanvas().

◆ CaptureCurrentSpriteSnapshot()

SpriteSnapshot yaze::editor::SpriteEditor::CaptureCurrentSpriteSnapshot ( ) const

private

Definition at line 1317 of file sprite_editor.cc.

References yaze::editor::SpriteSnapshot::current_animation_index, current_animation_index_, current_custom_sprite_index_, yaze::editor::SpriteSnapshot::current_frame, current_frame_, custom_sprites_, yaze::editor::SpriteSnapshot::sprite_data, and yaze::editor::SpriteSnapshot::sprite_index.

Referenced by BeginUndoTransaction(), and CommitUndoTransaction().

◆ RestoreFromSnapshot()

void yaze::editor::SpriteEditor::RestoreFromSnapshot ( const SpriteSnapshot & snapshot )

private

Definition at line 1329 of file sprite_editor.cc.

References yaze::editor::SpriteSnapshot::current_animation_index, current_animation_index_, current_custom_sprite_index_, yaze::editor::SpriteSnapshot::current_frame, current_frame_, custom_sprites_, preview_needs_update_, yaze::editor::SpriteSnapshot::sprite_data, yaze::editor::SpriteSnapshot::sprite_index, and zsm_dirty_.

Referenced by CommitUndoTransaction().

◆ BeginUndoTransaction()

void yaze::editor::SpriteEditor::BeginUndoTransaction ( )

private

Definition at line 1342 of file sprite_editor.cc.

References CaptureCurrentSpriteSnapshot(), undo_before_snapshot_, and undo_snapshot_pending_.

Referenced by DrawCustomSpritesMetadata().

Here is the call graph for this function:

◆ CommitUndoTransaction()

void yaze::editor::SpriteEditor::CommitUndoTransaction ( )

private

Definition at line 1350 of file sprite_editor.cc.

References CaptureCurrentSpriteSnapshot(), yaze::editor::UndoManager::Push(), RestoreFromSnapshot(), sprite_mutated_this_frame_, undo_before_snapshot_, yaze::editor::Editor::undo_manager_, and undo_snapshot_pending_.

Referenced by Update().

Here is the call graph for this function:

◆ MarkSpriteMutated()

void yaze::editor::SpriteEditor::MarkSpriteMutated ( )

private

Definition at line 1374 of file sprite_editor.cc.

References sprite_mutated_this_frame_, and zsm_dirty_.

Referenced by DrawAnimationPanel(), DrawBooleanProperties(), DrawFrameEditor(), DrawSpritePropertiesPanel(), DrawStatProperties(), and DrawUserRoutinesPanel().

Member Data Documentation

◆ active_sprites_

ImVector<int> yaze::editor::SpriteEditor::active_sprites_

private

Definition at line 131 of file sprite_editor.h.

Referenced by DrawSpritesList(), and DrawVanillaSpriteEditor().

◆ current_sprite_id_

int yaze::editor::SpriteEditor::current_sprite_id_ = 0

private

Definition at line 132 of file sprite_editor.h.

Referenced by DrawSpriteCanvas(), DrawSpritesList(), DrawVanillaSpriteEditor(), and HandleEditorShortcuts().

◆ current_sheets_

uint8_t yaze::editor::SpriteEditor::current_sheets_[8] = {0x00, 0x0A, 0x06, 0x07, 0x00, 0x00, 0x00, 0x00}

private

Definition at line 133 of file sprite_editor.h.

Referenced by DrawCurrentSheets(), LoadSheetsForSprite(), and LoadSpriteGraphicsBuffer().

◆ sheets_loaded_

bool yaze::editor::SpriteEditor::sheets_loaded_ = false

private

Definition at line 134 of file sprite_editor.h.

Referenced by DrawVanillaSpriteEditor(), RenderVanillaSprite(), RenderZSpriteFrame(), and Update().

◆ oam_config_

OAMConfig yaze::editor::SpriteEditor::oam_config_

private

Definition at line 146 of file sprite_editor.h.

Referenced by DrawSpriteCanvas().

◆ oam_bitmap_

gfx::Bitmap yaze::editor::SpriteEditor::oam_bitmap_

private

Definition at line 147 of file sprite_editor.h.

◆ vanilla_preview_bitmap_

gfx::Bitmap yaze::editor::SpriteEditor::vanilla_preview_bitmap_

private

Definition at line 148 of file sprite_editor.h.

Referenced by DrawSpriteCanvas(), and RenderVanillaSprite().

◆ vanilla_preview_needs_update_

bool yaze::editor::SpriteEditor::vanilla_preview_needs_update_ = true

private

Definition at line 149 of file sprite_editor.h.

Referenced by DrawSpritesList(), HandleEditorShortcuts(), LoadSheetsForSprite(), and RenderVanillaSprite().

◆ custom_sprites_

std::vector<zsprite::ZSprite> yaze::editor::SpriteEditor::custom_sprites_

private

Definition at line 154 of file sprite_editor.h.

Referenced by CaptureCurrentSpriteSnapshot(), CreateNewZSprite(), DrawAnimationPanel(), DrawBooleanProperties(), DrawCustomSpritesMetadata(), DrawFrameEditor(), DrawSpritePropertiesPanel(), DrawStatProperties(), DrawUserRoutinesPanel(), DrawZSpriteOnCanvas(), EnsureCustomSpritePaths(), LoadZsmFile(), RenderZSpriteFrame(), RestoreFromSnapshot(), Save(), SaveZsmFile(), and UpdateAnimationPlayback().

◆ custom_sprite_paths_

std::vector<std::string> yaze::editor::SpriteEditor::custom_sprite_paths_

private

Definition at line 155 of file sprite_editor.h.

Referenced by CreateNewZSprite(), EnsureCustomSpritePaths(), GetCurrentZsmPath(), LoadZsmFile(), and SetCurrentZsmPath().

◆ current_custom_sprite_index_

int yaze::editor::SpriteEditor::current_custom_sprite_index_ = -1

private

◆ zsm_dirty_

bool yaze::editor::SpriteEditor::zsm_dirty_ = false

private

Definition at line 157 of file sprite_editor.h.

Referenced by CreateNewZSprite(), LoadZsmFile(), MarkSpriteMutated(), RestoreFromSnapshot(), and SaveZsmFile().

◆ animation_playing_

bool yaze::editor::SpriteEditor::animation_playing_ = false

private

Definition at line 160 of file sprite_editor.h.

Referenced by CreateNewZSprite(), DrawAnimationPanel(), DrawCustomSpritesMetadata(), HandleEditorShortcuts(), LoadZsmFile(), and UpdateAnimationPlayback().

◆ current_frame_

int yaze::editor::SpriteEditor::current_frame_ = 0

private

Definition at line 161 of file sprite_editor.h.

Referenced by CaptureCurrentSpriteSnapshot(), CreateNewZSprite(), DrawAnimationPanel(), DrawCustomSpritesMetadata(), DrawFrameEditor(), DrawZSpriteOnCanvas(), HandleEditorShortcuts(), LoadZsmFile(), RestoreFromSnapshot(), and UpdateAnimationPlayback().

◆ current_animation_index_

int yaze::editor::SpriteEditor::current_animation_index_ = 0

private

Definition at line 162 of file sprite_editor.h.

Referenced by CaptureCurrentSpriteSnapshot(), CreateNewZSprite(), DrawAnimationPanel(), DrawCustomSpritesMetadata(), LoadZsmFile(), RestoreFromSnapshot(), and UpdateAnimationPlayback().

◆ frame_timer_

float yaze::editor::SpriteEditor::frame_timer_ = 0.0f

private

Definition at line 163 of file sprite_editor.h.

Referenced by CreateNewZSprite(), DrawAnimationPanel(), DrawCustomSpritesMetadata(), LoadZsmFile(), and UpdateAnimationPlayback().

◆ last_frame_time_

float yaze::editor::SpriteEditor::last_frame_time_ = 0.0f

private

Definition at line 164 of file sprite_editor.h.

Referenced by Update().

◆ selected_routine_index_

int yaze::editor::SpriteEditor::selected_routine_index_ = -1

private

Definition at line 167 of file sprite_editor.h.

Referenced by CreateNewZSprite(), DrawCustomSpritesMetadata(), DrawUserRoutinesPanel(), and LoadZsmFile().

◆ selected_tile_index_

int yaze::editor::SpriteEditor::selected_tile_index_ = -1

private

Definition at line 168 of file sprite_editor.h.

Referenced by CreateNewZSprite(), DrawCustomSpritesMetadata(), DrawFrameEditor(), LoadZsmFile(), and RenderZSpriteFrame().

◆ show_tile_grid_

bool yaze::editor::SpriteEditor::show_tile_grid_ = true

private

Definition at line 169 of file sprite_editor.h.

Referenced by RenderZSpriteFrame().

◆ sprite_preview_bitmap_

gfx::Bitmap yaze::editor::SpriteEditor::sprite_preview_bitmap_

private

Definition at line 172 of file sprite_editor.h.

Referenced by RenderZSpriteFrame().

◆ preview_needs_update_

bool yaze::editor::SpriteEditor::preview_needs_update_ = true

private

Definition at line 173 of file sprite_editor.h.

Referenced by CreateNewZSprite(), DrawAnimationPanel(), DrawCurrentSheets(), DrawCustomSpritesMetadata(), DrawFrameEditor(), HandleEditorShortcuts(), LoadZsmFile(), RenderZSpriteFrame(), RestoreFromSnapshot(), and UpdateAnimationPlayback().

◆ sprite_drawer_

SpriteDrawer yaze::editor::SpriteEditor::sprite_drawer_

private

Definition at line 178 of file sprite_editor.h.

Referenced by LoadSpriteGraphicsBuffer(), LoadSpritePalettes(), RenderVanillaSprite(), and RenderZSpriteFrame().

◆ sprite_gfx_buffer_

std::vector<uint8_t> yaze::editor::SpriteEditor::sprite_gfx_buffer_

private

Definition at line 179 of file sprite_editor.h.

Referenced by LoadSpriteGraphicsBuffer(), RenderVanillaSprite(), and RenderZSpriteFrame().

◆ sprite_palettes_

gfx::PaletteGroup yaze::editor::SpriteEditor::sprite_palettes_

private

Definition at line 180 of file sprite_editor.h.

Referenced by LoadSpritePalettes(), RenderVanillaSprite(), and RenderZSpriteFrame().

◆ gfx_buffer_loaded_

bool yaze::editor::SpriteEditor::gfx_buffer_loaded_ = false

private

Definition at line 181 of file sprite_editor.h.

Referenced by DrawCurrentSheets(), LoadSheetsForSprite(), LoadSpriteGraphicsBuffer(), RenderVanillaSprite(), and RenderZSpriteFrame().

◆ sprite_canvas_

gui::Canvas yaze::editor::SpriteEditor::sprite_canvas_

private

Initial value:

{"SpriteCanvas", ImVec2(0x200, 0x200),

gui::CanvasGridSize::k32x32}

yaze::gui::CanvasGridSize::k32x32

@ k32x32

Definition at line 186 of file sprite_editor.h.

Referenced by DrawSpriteCanvas(), DrawZSpriteOnCanvas(), and RenderZSpriteFrame().

◆ graphics_sheet_canvas_

gui::Canvas yaze::editor::SpriteEditor::graphics_sheet_canvas_

private

Initial value:

{"GraphicsSheetCanvas",
                                     ImVec2(0x80 * 2 + 2, 0x40 * 8 + 2),
                                     gui::CanvasGridSize::k16x16}

Definition at line 189 of file sprite_editor.h.

Referenced by DrawCurrentSheets().

◆ undo_snapshot_pending_

bool yaze::editor::SpriteEditor::undo_snapshot_pending_ = false

private

Definition at line 196 of file sprite_editor.h.

Referenced by BeginUndoTransaction(), and CommitUndoTransaction().

◆ sprite_mutated_this_frame_

bool yaze::editor::SpriteEditor::sprite_mutated_this_frame_ = false

private

Definition at line 197 of file sprite_editor.h.

Referenced by CommitUndoTransaction(), and MarkSpriteMutated().

◆ undo_before_snapshot_

SpriteSnapshot yaze::editor::SpriteEditor::undo_before_snapshot_

private

Definition at line 198 of file sprite_editor.h.

Referenced by BeginUndoTransaction(), and CommitUndoTransaction().

◆ status_

absl::Status yaze::editor::SpriteEditor::status_

private

Definition at line 203 of file sprite_editor.h.

Referenced by LoadZsmFile(), SaveZsmFile(), and Update().

◆ rom_

Rom* yaze::editor::SpriteEditor::rom_

private

Definition at line 204 of file sprite_editor.h.

Referenced by Initialize(), LoadSpritePalettes(), rom(), and set_rom().

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

src/app/editor/sprite/sprite_editor.h
src/app/editor/sprite/sprite_editor.cc

	yaze 0.3.2 Link to the Past ROM Editor

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SpriteEditor()

Member Function Documentation

◆ Initialize()

◆ Load()

◆ Update()

◆ Undo()

◆ Redo()

◆ Cut()

◆ Copy()

◆ Paste()

◆ Find()

◆ Save()

◆ set_rom()

◆ rom()

◆ HandleEditorShortcuts()

◆ DrawVanillaSpriteEditor()

◆ DrawSpritesList()

◆ DrawSpriteCanvas()

◆ DrawCurrentSheets()

◆ DrawToolset()

◆ DrawCustomSprites()

◆ DrawCustomSpritesMetadata()

◆ DrawAnimationFrames()

◆ CreateNewZSprite()

◆ LoadZsmFile()

◆ SaveZsmFile()

◆ SaveZsmFileAs()

◆ EnsureCustomSpritePaths()

◆ GetCurrentZsmPath()

◆ SetCurrentZsmPath()

◆ DrawSpritePropertiesPanel()

◆ DrawBooleanProperties()

◆ DrawStatProperties()

◆ DrawAnimationPanel()

◆ DrawAnimationList()

◆ DrawFrameEditor()

◆ UpdateAnimationPlayback()

◆ DrawUserRoutinesPanel()

◆ RenderZSpriteFrame()

◆ DrawZSpriteOnCanvas()

◆ LoadSpriteGraphicsBuffer()

◆ LoadSpritePalettes()

◆ RenderVanillaSprite()

◆ LoadSheetsForSprite()

◆ CaptureCurrentSpriteSnapshot()

◆ RestoreFromSnapshot()

◆ BeginUndoTransaction()

◆ CommitUndoTransaction()

◆ MarkSpriteMutated()

Member Data Documentation

◆ active_sprites_

◆ current_sprite_id_

◆ current_sheets_

◆ sheets_loaded_

◆ oam_config_

◆ oam_bitmap_

◆ vanilla_preview_bitmap_

◆ vanilla_preview_needs_update_

◆ custom_sprites_

◆ custom_sprite_paths_

◆ current_custom_sprite_index_

◆ zsm_dirty_

◆ animation_playing_

◆ current_frame_

◆ current_animation_index_

◆ frame_timer_

◆ last_frame_time_

◆ selected_routine_index_

◆ selected_tile_index_

◆ show_tile_grid_

◆ sprite_preview_bitmap_

◆ preview_needs_update_

◆ sprite_drawer_