rpfm_lib 4.7.4

This crate contains the basic functionality for interacting with Total War files.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

//---------------------------------------------------------------------------//
// Copyright (c) 2017-2024 Ismael Gutiérrez González. All rights reserved.
//
// This file is part of the Rusted PackFile Manager (RPFM) project,
// which can be found here: https://github.com/Frodo45127/rpfm.
//
// This file is licensed under the MIT license, which can be found here:
// https://github.com/Frodo45127/rpfm/blob/master/LICENSE.
//---------------------------------------------------------------------------//

use getset::*;
use serde_derive::{Serialize, Deserialize};

use std::collections::BTreeMap;

use crate::error::Result;
use crate::binary::{ReadBytes, WriteBytes};
use crate::files::{DecodeableExtraData, Decodeable, EncodeableExtraData, Encodeable, table::{DecodedData, local::TableInMemory, Table}};
use crate::schema::{Definition, Field, FieldType};
use crate::utils::check_size_mismatch;

pub const EXTENSION: &str = ".atlas";

const IMAGE_SIZE: u32 = 4096;

const VERSION: i32 = 1;

#[cfg(test)] mod atlas_test;

//---------------------------------------------------------------------------//
//                              Enum & Structs
//---------------------------------------------------------------------------//

#[derive(PartialEq, Clone, Debug, Default, Getters, MutGetters, Setters, Serialize, Deserialize)]
#[getset(get = "pub", get_mut = "pub", set = "pub")]
pub struct Atlas {
    version: u32,
    unknown: u32,
    entries: Vec<AtlasEntry>,
}

#[derive(PartialEq, Clone, Debug, Default, Getters, MutGetters, Setters, Serialize, Deserialize)]
#[getset(get = "pub", get_mut = "pub", set = "pub")]
pub struct AtlasEntry {
    string1: String,
    string2: String,
    x_1: f32,
    y_1: f32,
    x_2: f32,
    y_2: f32,
    width: f32,
    height: f32,
}

//---------------------------------------------------------------------------//
//                           Implementation
//---------------------------------------------------------------------------//

impl From<TableInMemory> for Atlas {
    fn from(value: TableInMemory) -> Self {
        let entries = value.data()
            .iter()
            .map(|row| AtlasEntry {
                string1: if let DecodedData::StringU8(data) = &row[0] { data.to_string() } else { panic!("WTF?!")},
                string2: if let DecodedData::StringU8(data) = &row[1] { data.to_string() } else { panic!("WTF?!")},
                x_1: if let DecodedData::F32(data) = row[2] { data } else { panic!("WTF?!")},
                y_1: if let DecodedData::F32(data) = row[3] { data } else { panic!("WTF?!")},
                x_2: if let DecodedData::F32(data) = row[4] { data } else { panic!("WTF?!")},
                y_2: if let DecodedData::F32(data) = row[5] { data } else { panic!("WTF?!")},
                width: if let DecodedData::F32(data) = row[6] { data } else { panic!("WTF?!")},
                height: if let DecodedData::F32(data) = row[7] { data } else { panic!("WTF?!")},
            })
            .collect();

        Self {
            version: VERSION as u32,
            unknown: 0,
            entries,
        }
    }
}

impl From<Atlas> for TableInMemory {
    fn from(value: Atlas) -> Self {
        let mut table = Self::new(&Atlas::definition(), None, "");
        let data = value.entries.iter()
            .map(|entry| {
                 vec![
                    DecodedData::StringU8(entry.string1.to_owned()),
                    DecodedData::StringU8(entry.string2.to_owned()),
                    DecodedData::F32(entry.x_1),
                    DecodedData::F32(entry.y_1),
                    DecodedData::F32(entry.x_2),
                    DecodedData::F32(entry.y_2),
                    DecodedData::F32(entry.width),
                    DecodedData::F32(entry.height),
                ]
            })
            .collect::<Vec<_>>();
        let _ = table.set_data(&data);
        table
    }
}

impl Atlas {

    /// This function returns the definition of a Atlas table.
    pub fn definition() -> Definition {
        let mut definition = Definition::new(VERSION, None);
        let fields = vec![
            Field::new("string1".to_owned(), FieldType::StringU8, true, Some("PLACEHOLDER".to_owned()), false, None, None, None, String::new(), 0, 0, BTreeMap::new(), None),
            Field::new("string2".to_owned(), FieldType::StringU8, true, Some("PLACEHOLDER".to_owned()), false, None, None, None, String::new(), 0, 0, BTreeMap::new(), None),
            Field::new("x_1".to_owned(), FieldType::F32, false, Some("0".to_owned()), false, None, None, None, String::new(), 0, 0, BTreeMap::new(), None),
            Field::new("y_1".to_owned(), FieldType::F32, false, Some("0".to_owned()), false, None, None, None, String::new(), 0, 0, BTreeMap::new(), None),
            Field::new("x_2".to_owned(), FieldType::F32, false, Some("0".to_owned()), false, None, None, None, String::new(), 0, 0, BTreeMap::new(), None),
            Field::new("y_2".to_owned(), FieldType::F32, false, Some("0".to_owned()), false, None, None, None, String::new(), 0, 0, BTreeMap::new(), None),
            Field::new("width".to_owned(), FieldType::F32, false, Some("0".to_owned()), false, None, None, None, String::new(), 0, 0, BTreeMap::new(), None),
            Field::new("height".to_owned(), FieldType::F32, false, Some("0".to_owned()), false, None, None, None, String::new(), 0, 0, BTreeMap::new(), None),
        ];
        definition.set_fields(fields);
        definition
    }
}

impl Decodeable for Atlas {

    fn decode<R: ReadBytes>(data: &mut R, _extra_data: &Option<DecodeableExtraData>) -> Result<Self> {
        let version = data.read_u32()?;
        let unknown = data.read_u32()?;

        let mut entries = vec![];

        for _ in 0..data.read_u32()? {

            // The coordinates are stored in percentage of size.
            entries.push(AtlasEntry {
                string1: data.read_string_u16_0padded(512)?,
                string2: data.read_string_u16_0padded(512)?,
                x_1: data.read_f32()? * IMAGE_SIZE as f32,
                y_1: data.read_f32()? * IMAGE_SIZE as f32,
                x_2: data.read_f32()? * IMAGE_SIZE as f32,
                y_2: data.read_f32()? * IMAGE_SIZE as f32,
                width: data.read_f32()?,
                height: data.read_f32()?,
            })
        }

        // Trigger an error if there's left data on the source.
        check_size_mismatch(data.stream_position()? as usize, data.len()? as usize)?;

        Ok(Self {
            version,
            unknown,
            entries
        })
    }
}

impl Encodeable for Atlas {

    fn encode<W: WriteBytes>(&mut self, buffer: &mut W, _extra_data: &Option<EncodeableExtraData>) -> Result<()> {
        buffer.write_u32(self.version)?;
        buffer.write_u32(self.unknown)?;
        buffer.write_u32(self.entries.len() as u32)?;

        for entry in &self.entries {
            buffer.write_string_u16_0padded(&entry.string1, 512, true)?;
            buffer.write_string_u16_0padded(&entry.string2, 512, true)?;
            buffer.write_f32(entry.x_1 / IMAGE_SIZE as f32)?;
            buffer.write_f32(entry.y_1 / IMAGE_SIZE as f32)?;
            buffer.write_f32(entry.x_2 / IMAGE_SIZE as f32)?;
            buffer.write_f32(entry.y_2 / IMAGE_SIZE as f32)?;
            buffer.write_f32(entry.width)?;
            buffer.write_f32(entry.height)?;
        }

        Ok(())
    }
}