yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes | List of all members
yaze::zelda3::ObjectTileEditor Class Reference

Captures and edits the tile8 composition of dungeon objects. More...

#include <object_tile_editor.h>

Collaboration diagram for yaze::zelda3::ObjectTileEditor:
Collaboration graph
[legend]

Public Member Functions

 ObjectTileEditor (Rom *rom)
 
absl::StatusOr< ObjectTileLayout > CaptureObjectLayout (int16_t object_id, const Room &room, const gfx::PaletteGroup &palette)
 
absl::StatusOr< ObjectTileLayout > CaptureObjectLayout (int16_t object_id, const Room &room, const gfx::PaletteGroup &palette, uint8_t object_size)
 
absl::StatusOr< ObjectTileLayout > CaptureEditableObjectLayout (int16_t object_id, const Room &room, const gfx::PaletteGroup &palette)
 
absl::StatusOr< ObjectTileLayout > LoadCustomObjectLayout (int16_t object_id, int subtype)
 
absl::Status RenderLayoutToBitmap (const ObjectTileLayout &layout, gfx::Bitmap &bitmap, const uint8_t *room_gfx_buffer, const gfx::PaletteGroup &palette)
 
absl::Status BuildTile8Atlas (gfx::Bitmap &atlas, const uint8_t *room_gfx_buffer, const gfx::PaletteGroup &palette, int display_palette=2, std::optional< int16_t > custom_object_id=std::nullopt, uint16_t retained_attributes=0)
 
absl::Status WriteBack (ObjectTileLayout &layout)
 
absl::StatusOr< ObjectTileWritePlan > BuildStandardWritePlan (const ObjectTileLayout &layout) const
 
absl::Status ApplyStandardWritePlan (const ObjectTileWritePlan &plan)
 
absl::StatusOr< ObjectTileSourceImpact > AnalyzeStandardTileSourceImpact (const ObjectTileLayout &layout) const
 

Static Public Member Functions

static bool IsEditableStandardObject (int16_t object_id)
 

Static Public Attributes

static constexpr int kAtlasTilesPerRow = 16
 
static constexpr int kAtlasTileRows = 64
 
static constexpr int kAtlasTileCount = kAtlasTilesPerRow * kAtlasTileRows
 
static constexpr int kAtlasWidthPx = kAtlasTilesPerRow * 8
 
static constexpr int kAtlasHeightPx = kAtlasTileRows * 8
 

Private Attributes

Rom * rom_
 

Detailed Description

Captures and edits the tile8 composition of dungeon objects.

Uses ObjectDrawer's trace_only mode to capture every WriteTile8 call, producing an editable ObjectTileLayout. Supports rendering previews and writing changes back to ROM or custom .bin files.

Definition at line 197 of file object_tile_editor.h.

Constructor & Destructor Documentation

◆ ObjectTileEditor()

yaze::zelda3::ObjectTileEditor::ObjectTileEditor ( Rom * rom)
explicit

Definition at line 263 of file object_tile_editor.cc.

Member Function Documentation

◆ CaptureObjectLayout() [1/2]

absl::StatusOr< ObjectTileLayout > yaze::zelda3::ObjectTileEditor::CaptureObjectLayout ( int16_t object_id,
const Room & room,
const gfx::PaletteGroup & palette )

Definition at line 315 of file object_tile_editor.cc.

References CaptureObjectLayout(), and yaze::zelda3::DefaultRoomObjectSizeForPlacement().

Referenced by CaptureEditableObjectLayout(), CaptureObjectLayout(), yaze::editor::DungeonObjectSelector::DrawObjectAssetBrowser(), and yaze::editor::DungeonObjectSelector::GetOrCreatePreview().

Here is the call graph for this function:

◆ CaptureObjectLayout() [2/2]

absl::StatusOr< ObjectTileLayout > yaze::zelda3::ObjectTileEditor::CaptureObjectLayout ( int16_t object_id,
const Room & room,
const gfx::PaletteGroup & palette,
uint8_t object_size )

Definition at line 321 of file object_tile_editor.cc.

References yaze::zelda3::CanonicalRoomObjectSize(), yaze::zelda3::ObjectDrawer::ClearTraceCollector(), yaze::zelda3::ObjectTileLayout::custom_filename, yaze::zelda3::ObjectTileLayout::custom_subtype, yaze::zelda3::ObjectDrawer::DrawObject(), yaze::zelda3::RoomObject::EnsureTilesLoaded(), yaze::zelda3::Room::floor1(), yaze::zelda3::Room::floor2(), yaze::zelda3::ObjectTileLayout::FromTraces(), yaze::core::FeatureFlags::get(), yaze::zelda3::CustomObjectManager::Get(), yaze::zelda3::ObjectGeometry::Get(), yaze::zelda3::Room::get_gfx_buffer(), yaze::zelda3::CustomObjectManager::GetObjectInternal(), yaze::zelda3::Room::id(), yaze::zelda3::ObjectTileLayout::is_custom, yaze::Rom::is_loaded(), yaze::zelda3::ObjectGeometry::ResolveAnchor(), yaze::zelda3::CustomObjectManager::ResolveFilename(), rom_, yaze::zelda3::RoomObject::SetRom(), yaze::zelda3::ObjectDrawer::SetRoomFloorGraphics(), yaze::zelda3::ObjectDrawer::SetTraceCollector(), yaze::zelda3::RoomObject::size_, yaze::zelda3::ObjectTileLayout::source_provenance, and yaze::zelda3::ObjectTileLayout::tile_data_address.

◆ CaptureEditableObjectLayout()

absl::StatusOr< ObjectTileLayout > yaze::zelda3::ObjectTileEditor::CaptureEditableObjectLayout ( int16_t object_id,
const Room & room,
const gfx::PaletteGroup & palette )

Definition at line 396 of file object_tile_editor.cc.

References yaze::zelda3::ObjectTileLayout::bounds_height, yaze::zelda3::ObjectTileLayout::bounds_width, CaptureObjectLayout(), yaze::zelda3::ObjectTileLayout::cells, yaze::zelda3::ObjectTileSourceProvenance::descriptor_pc_address, yaze::zelda3::ObjectTileSourceProvenance::expected_descriptor_word, yaze::zelda3::ObjectTileSourceSpan::expected_words, yaze::zelda3::CustomObjectManager::Get(), yaze::zelda3::CustomObjectManager::GetTilePatterns(), yaze::zelda3::ObjectTileLayout::is_custom, yaze::Rom::is_loaded(), IsEditableStandardObject(), yaze::zelda3::kRoomObjectTileAddress, yaze::zelda3::ObjectTileSourceProvenance::object_id, yaze::zelda3::ObjectTileLayout::object_id, yaze::zelda3::ObjectTileLayout::pattern_source, yaze::zelda3::ObjectTileSourceSpan::pc_address, yaze::Rom::ReadWord(), rom_, yaze::Rom::size(), yaze::zelda3::ObjectTileLayout::source_provenance, yaze::zelda3::ObjectTileSourceProvenance::spans, and yaze::zelda3::ObjectTileLayout::tile_data_address.

◆ LoadCustomObjectLayout()

absl::StatusOr< ObjectTileLayout > yaze::zelda3::ObjectTileEditor::LoadCustomObjectLayout ( int16_t object_id,
int subtype )

Definition at line 265 of file object_tile_editor.cc.

References ASSIGN_OR_RETURN, yaze::zelda3::ObjectTileLayout::bounds_height, yaze::zelda3::ObjectTileLayout::bounds_width, yaze::zelda3::ObjectTileLayout::cells, yaze::zelda3::ObjectTileLayout::custom_filename, yaze::zelda3::ObjectTileLayout::custom_resolved_path, yaze::zelda3::ObjectTileLayout::custom_source_bytes, yaze::zelda3::ObjectTileLayout::custom_subtype, yaze::zelda3::CustomObjectManager::Get(), yaze::zelda3::CustomObject::GetBoundingBox(), yaze::zelda3::ObjectTileLayout::is_custom, yaze::zelda3::LoadCustomObjectAsset(), yaze::zelda3::CustomObjectAsset::object, yaze::zelda3::ObjectTileLayout::object_id, yaze::zelda3::ObjectTileLayout::origin_tile_x, yaze::zelda3::ObjectTileLayout::origin_tile_y, yaze::zelda3::ObjectTileLayout::Cell::original_word, yaze::zelda3::ObjectTileLayout::Cell::rel_x, yaze::zelda3::ObjectTileLayout::Cell::rel_y, yaze::zelda3::CustomObjectAsset::resolved_path, yaze::zelda3::CustomObjectManager::RuntimeSubtypeCountForObject(), yaze::zelda3::CustomObjectAsset::source_bytes, yaze::zelda3::ObjectTileLayout::tile_data_address, yaze::zelda3::ObjectTileLayout::Cell::tile_info, yaze::zelda3::CustomObject::tiles, yaze::gfx::WordToTileInfo(), and yaze::zelda3::ObjectTileLayout::Cell::write_index.

◆ IsEditableStandardObject()

bool yaze::zelda3::ObjectTileEditor::IsEditableStandardObject ( int16_t object_id)
static

Definition at line 392 of file object_tile_editor.cc.

Referenced by yaze::editor::DungeonCanvasViewer::BuildSelectionContextMenuItems(), BuildStandardWritePlan(), CaptureEditableObjectLayout(), yaze::editor::DungeonObjectSelector::DrawObjectContextMenu(), yaze::editor::ObjectTileEditorPanel::OpenForObject(), and yaze::editor::DungeonEditorV2::OpenObjectTileEditorForObject().

◆ RenderLayoutToBitmap()

absl::Status yaze::zelda3::ObjectTileEditor::RenderLayoutToBitmap ( const ObjectTileLayout & layout,
gfx::Bitmap & bitmap,
const uint8_t * room_gfx_buffer,
const gfx::PaletteGroup & palette )

Definition at line 516 of file object_tile_editor.cc.

References yaze::zelda3::ObjectTileLayout::bounds_height, yaze::zelda3::ObjectTileLayout::bounds_width, yaze::zelda3::ObjectTileLayout::cells, yaze::gfx::Bitmap::Create(), yaze::zelda3::CustomObjectRuntimeTileWord(), yaze::zelda3::ObjectDrawer::DrawTileToBitmap(), yaze::gfx::PaletteGroup::empty(), yaze::zelda3::ObjectTileLayout::is_custom, yaze::zelda3::ObjectTileLayout::object_id, rom_, yaze::gfx::Bitmap::SetPalette(), yaze::gfx::Bitmap::surface(), yaze::gfx::TileInfoToWord(), yaze::gfx::Bitmap::UpdateSurfacePixels(), and yaze::gfx::WordToTileInfo().

Referenced by yaze::editor::DungeonObjectSelector::GetOrCreatePreview().

◆ BuildTile8Atlas()

absl::Status yaze::zelda3::ObjectTileEditor::BuildTile8Atlas ( gfx::Bitmap & atlas,
const uint8_t * room_gfx_buffer,
const gfx::PaletteGroup & palette,
int display_palette = 2,
std::optional< int16_t > custom_object_id = std::nullopt,
uint16_t retained_attributes = 0 )

Definition at line 566 of file object_tile_editor.cc.

References yaze::gfx::Bitmap::Create(), yaze::zelda3::CustomObjectRuntimeTileWord(), yaze::zelda3::ObjectDrawer::DrawTileToBitmap(), yaze::gfx::PaletteGroup::empty(), yaze::gfx::TileInfo::id_, kAtlasHeightPx, kAtlasTileCount, kAtlasTilesPerRow, kAtlasWidthPx, yaze::gfx::PaletteGroup::palette_ref(), rom_, yaze::gfx::Bitmap::SetPalette(), yaze::gfx::Bitmap::surface(), and yaze::gfx::Bitmap::UpdateSurfacePixels().

◆ WriteBack()

absl::Status yaze::zelda3::ObjectTileEditor::WriteBack ( ObjectTileLayout & layout)

Definition at line 621 of file object_tile_editor.cc.

References ApplyStandardWritePlan(), BuildStandardWritePlan(), yaze::zelda3::ObjectTileLayout::cells, yaze::zelda3::ObjectTileLayout::custom_filename, yaze::zelda3::ObjectTileLayout::custom_resolved_path, yaze::zelda3::ObjectTileLayout::custom_source_bytes, yaze::zelda3::ObjectTileLayout::custom_subtype, yaze::zelda3::CustomObjectManager::Get(), yaze::zelda3::ObjectTileLayout::HasModifications(), yaze::zelda3::ObjectTileLayout::is_custom, yaze::zelda3::ObjectTileLayout::object_id, yaze::zelda3::PublishCustomObjectBinary(), yaze::zelda3::CustomObjectManager::RuntimeSubtypeCountForObject(), yaze::gfx::TileInfoToWord(), and yaze::zelda3::CustomObject::tiles.

◆ BuildStandardWritePlan()

absl::StatusOr< ObjectTileWritePlan > yaze::zelda3::ObjectTileEditor::BuildStandardWritePlan ( const ObjectTileLayout & layout) const

Definition at line 675 of file object_tile_editor.cc.

References yaze::zelda3::ObjectTileLayout::bounds_height, yaze::zelda3::ObjectTileLayout::bounds_width, yaze::zelda3::ObjectTileLayout::cells, yaze::zelda3::ObjectTileLayout::is_custom, yaze::Rom::is_loaded(), IsEditableStandardObject(), yaze::zelda3::kRoomObjectTileAddress, yaze::zelda3::ObjectTileLayout::object_id, yaze::zelda3::ObjectTileLayout::pattern_source, yaze::zelda3::ObjectTileWritePlan::pattern_source_, yaze::zelda3::ObjectTileWritePlan::preconditions_, yaze::Rom::ReadWord(), RETURN_IF_ERROR, rom_, yaze::Rom::size(), yaze::zelda3::ObjectTileLayout::source_provenance, yaze::gfx::TileInfoToWord(), yaze::zelda3::ObjectTileWritePlan::write_ranges_, and yaze::zelda3::ObjectTileWritePlan::writes_.

Referenced by AnalyzeStandardTileSourceImpact(), and WriteBack().

◆ ApplyStandardWritePlan()

absl::Status yaze::zelda3::ObjectTileEditor::ApplyStandardWritePlan ( const ObjectTileWritePlan & plan)

Definition at line 869 of file object_tile_editor.cc.

References yaze::Rom::AdvanceObjectTileRevision(), yaze::Transaction::Commit(), yaze::Rom::dirty(), yaze::zelda3::CustomObjectManager::Get(), yaze::Rom::is_loaded(), yaze::zelda3::ObjectTileWritePlan::pattern_source_, yaze::zelda3::ObjectTileWritePlan::preconditions_, yaze::zelda3::PublishDungeonTilePatterns(), yaze::Rom::ReadWord(), yaze::zelda3::CustomObjectManager::ReloadAll(), RETURN_IF_ERROR, rom_, yaze::Rom::set_dirty(), yaze::Rom::size(), yaze::zelda3::ObjectTileWritePlan::write_ranges_, yaze::zelda3::ObjectTileWritePlan::writes_, and yaze::Transaction::WriteWord().

Referenced by WriteBack().

◆ AnalyzeStandardTileSourceImpact()

absl::StatusOr< ObjectTileSourceImpact > yaze::zelda3::ObjectTileEditor::AnalyzeStandardTileSourceImpact ( const ObjectTileLayout & layout) const

Definition at line 1014 of file object_tile_editor.cc.

References yaze::zelda3::ObjectTileSourceImpact::affected_objects, BuildStandardWritePlan(), yaze::zelda3::ObjectTileLayout::is_custom, yaze::Rom::is_loaded(), yaze::zelda3::kLightableTorchDraw, yaze::zelda3::kRoomObjectTileAddress, yaze::zelda3::kTorchLightingChange, yaze::zelda3::ObjectTileSourceImpactEntry::object_id, yaze::zelda3::ObjectTileSourceImpactEntry::overlapping_ranges, yaze::zelda3::ObjectTileRuntimeConsumerImpactEntry::overlapping_ranges, yaze::zelda3::ObjectParser::ResolveTileReadRanges(), rom_, yaze::zelda3::ObjectTileSourceImpact::runtime_consumers, yaze::Rom::size(), and yaze::zelda3::ObjectTileLayout::source_provenance.

Here is the call graph for this function:

Member Data Documentation

◆ kAtlasTilesPerRow

constexpr int yaze::zelda3::ObjectTileEditor::kAtlasTilesPerRow = 16
staticconstexpr

Definition at line 199 of file object_tile_editor.h.

Referenced by BuildTile8Atlas(), and yaze::editor::ObjectTileEditorPanel::DrawSourceSheet().

◆ kAtlasTileRows

constexpr int yaze::zelda3::ObjectTileEditor::kAtlasTileRows = 64
staticconstexpr

Definition at line 200 of file object_tile_editor.h.

Referenced by yaze::editor::ObjectTileEditorPanel::DrawSourceSheet().

◆ kAtlasTileCount

constexpr int yaze::zelda3::ObjectTileEditor::kAtlasTileCount = kAtlasTilesPerRow * kAtlasTileRows
staticconstexpr

Definition at line 201 of file object_tile_editor.h.

Referenced by BuildTile8Atlas().

◆ kAtlasWidthPx

constexpr int yaze::zelda3::ObjectTileEditor::kAtlasWidthPx = kAtlasTilesPerRow * 8
staticconstexpr

Definition at line 202 of file object_tile_editor.h.

Referenced by BuildTile8Atlas(), and yaze::editor::ObjectTileEditorPanel::DrawSourceSheet().

◆ kAtlasHeightPx

constexpr int yaze::zelda3::ObjectTileEditor::kAtlasHeightPx = kAtlasTileRows * 8
staticconstexpr

Definition at line 203 of file object_tile_editor.h.

Referenced by BuildTile8Atlas(), and yaze::editor::ObjectTileEditorPanel::DrawSourceSheet().

◆ rom_

Rom* yaze::zelda3::ObjectTileEditor::rom_
private

Definition at line 262 of file object_tile_editor.h.

Referenced by AnalyzeStandardTileSourceImpact(), ApplyStandardWritePlan(), BuildStandardWritePlan(), BuildTile8Atlas(), CaptureEditableObjectLayout(), CaptureObjectLayout(), and RenderLayoutToBitmap().

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