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
|
/*
* GNU AFFERO GENERAL PUBLIC LICENSE
* Version 3, 19 November 2007
* Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
* Everyone is permitted to copy and distribute verbatim copies
* of this license document, but changing it is not allowed.
*/
using System;
using SixLabors.ImageSharp;
using SixLabors.ImageSharp.PixelFormats;
namespace PrusaSL1Reader
{
/// <summary>
/// Slicer file format representation interface
/// </summary>
public interface IFileFormat
{
/// <summary>
/// Gets the valid file extensions for this <see cref="FileFormat"/>
/// </summary>
FileExtension[] FileExtensions { get; }
/// <summary>
/// Gets the input file path loaded into this <see cref="FileFormat"/>
/// </summary>
string FileFullPath { get; set; }
/// <summary>
/// Gets the image width resolution
/// </summary>
uint ResolutionX { get; }
/// <summary>
/// Gets the image height resolution
/// </summary>
uint ResolutionY { get; }
/// <summary>
/// Gets the thumbnails count present in this file format
/// </summary>
byte ThumbnailsCount { get; }
/// <summary>
/// Gets the thumbnails for this <see cref="FileFormat"/>
/// </summary>
Image<Rgba32>[] Thumbnails { get; set; }
FileFormat.PrintParameterModifier[] PrintParameterModifiers { get; }
/// <summary>
/// Number of layers present in this file
/// </summary>
uint LayerCount { get; }
ushort InitialLayerCount { get; }
float InitialExposureTime { get; }
float LayerExposureTime { get; }
float PrintTime { get; }
float UsedMaterial { get; }
float MaterialCost { get; }
string MaterialName { get; }
string MachineName { get; }
/// <summary>
/// Layer Height in mm
/// </summary>
float LayerHeight { get; }
float TotalHeight { get; }
/// <summary>
/// Get all configuration objects with properties and values
/// </summary>
object[] Configs { get; }
object GetValueFromPrintParameterModifier(FileFormat.PrintParameterModifier modifier);
bool SetValueFromPrintParameterModifier(FileFormat.PrintParameterModifier modifier, object value);
bool SetValueFromPrintParameterModifier(FileFormat.PrintParameterModifier modifier, string value);
/// <summary>
/// If this file is valid to read
/// </summary>
bool IsValid { get; }
/// <summary>
/// Begin encode to an output file
/// </summary>
/// <param name="fileFullPath">Output file</param>
void BeginEncode(string fileFullPath);
/// <summary>
/// Insert a layer image to be encoded
/// </summary>
/// <param name="image"></param>
/// <param name="layerIndex"></param>
void InsertLayerImageEncode(Image<Gray8> image, uint layerIndex);
/// <summary>
/// Finish the encoding procedure
/// </summary>
void EndEncode();
/// <summary>
/// Decode a slicer file
/// </summary>
/// <param name="fileFullPath"></param>
void Decode(string fileFullPath);
/// <summary>
/// Extract contents to a folder
/// </summary>
/// <param name="path">Path to folder where content will be extracted</param>
/// <param name="emptyFirst">Empty target folder first</param>
/// <param name="genericConfigExtract"></param>
/// <param name="genericLayersExtract"></param>
void Extract(string path, bool emptyFirst = true, bool genericConfigExtract = false,
bool genericLayersExtract = false);
/// <summary>
/// Saves current configuration on input file
/// </summary>
void Save();
/// <summary>
/// Saves current configuration on a copy
/// </summary>
/// <param name="filePath">File path to save copy as, use null to overwrite active file (Same as <see cref="Save"/>)</param>
void SaveAs(string filePath = null);
/// <summary>
/// Gets a image from layer
/// </summary>
/// <param name="layerIndex">The layer index</param>
/// <returns>Returns a image</returns>
Image<Gray8> GetLayerImage(uint layerIndex);
/// <summary>
/// Get height in mm from layer height
/// </summary>
/// <param name="layerNum">The layer height</param>
/// <returns>The height in mm</returns>
float GetHeightFromLayer(uint layerNum);
/// <summary>
/// Clears all definitions and properties, it also dispose valid candidates
/// </summary>
void Clear();
/// <summary>
/// Converts this file type to another file type
/// </summary>
/// <param name="to">Target file format</param>
/// <param name="fileFullPath">Output path file</param>
/// <returns>True if convert succeed, otherwise false</returns>
bool Convert(Type to, string fileFullPath);
/// <summary>
/// Converts this file type to another file type
/// </summary>
/// <param name="to">Target file format</param>
/// <param name="fileFullPath">Output path file</param>
/// <returns>True if convert succeed, otherwise false</returns>
bool Convert(FileFormat to, string fileFullPath);
}
}
|
