mirror of
https://github.com/vcmi/vcmi.git
synced 2025-02-05 13:04:54 +02:00
65 lines
1.9 KiB
C++
65 lines
1.9 KiB
C++
/*
|
|
* MapRenderer.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
|
|
|
|
#include "../../lib/ConstTransitivePtr.h"
|
|
|
|
VCMI_LIB_NAMESPACE_BEGIN
|
|
|
|
class int3;
|
|
class Point;
|
|
class ObjectInstanceID;
|
|
class CGObjectInstance;
|
|
struct TerrainTile;
|
|
struct CGPath;
|
|
|
|
VCMI_LIB_NAMESPACE_END
|
|
|
|
class IMapRendererContext
|
|
{
|
|
public:
|
|
virtual ~IMapRendererContext() = default;
|
|
|
|
using ObjectsVector = std::vector< ConstTransitivePtr<CGObjectInstance> >;
|
|
|
|
/// returns dimensions of current map
|
|
virtual int3 getMapSize() const = 0;
|
|
|
|
/// returns true if chosen coordinates exist on map
|
|
virtual bool isInMap(const int3 & coordinates) const = 0;
|
|
|
|
/// returns tile by selected coordinates. Coordinates MUST be valid
|
|
virtual const TerrainTile & getMapTile(const int3 & coordinates) const = 0;
|
|
|
|
/// returns vector of all objects present on current map
|
|
virtual ObjectsVector getAllObjects() const = 0;
|
|
|
|
/// returns specific object by ID, or nullptr if not found
|
|
virtual const CGObjectInstance * getObject( ObjectInstanceID objectID ) const = 0;
|
|
|
|
/// returns path of currently active hero, or nullptr if none
|
|
virtual const CGPath * currentPath() const = 0;
|
|
|
|
/// returns true if specified tile is visible in current context
|
|
virtual bool isVisible(const int3 & coordinates) const = 0;
|
|
|
|
/// returns how long should each frame of animation be visible, in milliseconds
|
|
virtual uint32_t getAnimationPeriod() const = 0;
|
|
|
|
/// returns total animation time since creation of this context
|
|
virtual uint32_t getAnimationTime() const = 0;
|
|
|
|
/// returns size of ouput tile, in pixels. 32x32 for "standard" map, may be smaller for world view mode
|
|
virtual Point getTileSize() const = 0;
|
|
|
|
/// if true, map grid should be visible on map
|
|
virtual bool showGrid() const = 0;
|
|
};
|