2024-06-17 11:30:16 +02:00
|
|
|
/*
|
|
|
|
* ImageLocator.h, part of VCMI engine
|
|
|
|
*
|
|
|
|
* Authors: listed in file AUTHORS in main folder
|
|
|
|
*
|
|
|
|
* License: GNU General Public License v2.0 or later
|
|
|
|
* Full text of license available in license.txt file, in main folder
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
|
2024-11-17 19:54:55 +02:00
|
|
|
#include "IImage.h"
|
|
|
|
|
2024-06-17 11:30:16 +02:00
|
|
|
#include "../../lib/filesystem/ResourcePath.h"
|
2024-07-25 12:38:48 +02:00
|
|
|
#include "../../lib/constants/EntityIdentifiers.h"
|
2024-06-17 11:30:16 +02:00
|
|
|
|
|
|
|
struct ImageLocator
|
|
|
|
{
|
|
|
|
std::optional<ImagePath> image;
|
|
|
|
std::optional<AnimationPath> defFile;
|
|
|
|
int defFrame = -1;
|
|
|
|
int defGroup = -1;
|
|
|
|
|
2024-11-17 19:54:55 +02:00
|
|
|
PlayerColor playerColored = PlayerColor::CANNOT_DETERMINE; // FIXME: treat as identical to blue to avoid double-loading?
|
2024-08-27 21:44:11 +02:00
|
|
|
|
2024-06-17 11:30:16 +02:00
|
|
|
bool verticalFlip = false;
|
|
|
|
bool horizontalFlip = false;
|
2024-09-12 16:26:05 +02:00
|
|
|
int8_t scalingFactor = 0; // 0 = auto / use default scaling
|
2024-11-03 14:38:15 +02:00
|
|
|
int8_t preScaledFactor = 1;
|
2024-11-17 19:54:55 +02:00
|
|
|
EImageBlitMode layer = EImageBlitMode::OPAQUE;
|
2024-06-17 11:30:16 +02:00
|
|
|
|
|
|
|
ImageLocator() = default;
|
|
|
|
ImageLocator(const AnimationPath & path, int frame, int group);
|
2024-07-16 21:51:00 +02:00
|
|
|
explicit ImageLocator(const JsonNode & config);
|
|
|
|
explicit ImageLocator(const ImagePath & path);
|
|
|
|
|
2024-06-17 11:30:16 +02:00
|
|
|
bool operator < (const ImageLocator & other) const;
|
2024-07-16 21:51:00 +02:00
|
|
|
bool empty() const;
|
2024-07-25 12:38:48 +02:00
|
|
|
|
|
|
|
ImageLocator copyFile() const;
|
|
|
|
ImageLocator copyFileTransform() const;
|
|
|
|
ImageLocator copyFileTransformScale() const;
|
2024-09-12 22:26:40 +02:00
|
|
|
|
|
|
|
// generates string representation of this image locator
|
|
|
|
// guaranteed to be a valid file path with no extension
|
|
|
|
// but may contain '/' if source file is in directory
|
|
|
|
std::string toString() const;
|
2024-06-17 11:30:16 +02:00
|
|
|
};
|