scummvm/engines/nancy/renderobject.h
fracturehill a29cdd43c0 NANCY: Make RenderObject non-abstract
Made RenderObject non-abstract so it can be used in some simple cases without the need for subclassing.
2021-04-15 15:12:00 +03:00

87 lines
3.0 KiB
C++

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef NANCY_RENDEROBJECT_H
#define NANCY_RENDEROBJECT_H
#include "graphics/managed_surface.h"
namespace Nancy {
class NancyEngine;
class GraphicsManager;
// Loosely equivalent to the original engine's ZRenderStructs.
// A subclass of this will be automatically updated and drawn from the graphics manager,
// but initialization needs to be done manually. Objects are expected to know which
// object is below them at creation.
class RenderObject {
friend class GraphicsManager;
public:
RenderObject(uint16 zOrder);
RenderObject(RenderObject &redrawFrom, uint16 zOrder);
RenderObject(RenderObject &redrawFrom, uint16 zOrder, Graphics::ManagedSurface &surface, const Common::Rect &srcBounds, const Common::Rect &destBounds);
virtual ~RenderObject();
virtual void init(); // Does not get called automatically
virtual void registerGraphics(); // Does not get called automatically
virtual void updateGraphics() {}
void moveTo(Common::Point position);
void setVisible(bool visible);
void setTransparent(bool isTransparent);
bool hasMoved() const { return _previousScreenPosition != _screenPosition; }
Common::Rect getScreenPosition() const;
Common::Rect getPreviousScreenPosition() const;
// Given a screen-space rect, convert it to the source surface's local space
Common::Rect convertToLocal(const Common::Rect &screen) const;
// Given a local space rect, convert it to screen space
Common::Rect convertToScreen(const Common::Rect &rect) const;
Common::Rect getBounds() const { return Common::Rect(_drawSurface.w, _drawSurface.h); }
Graphics::ManagedSurface _drawSurface;
Common::Rect _screenPosition;
protected:
// Z order and blit type are extracted directly from the corresponding
// ZRenderStruct from the original engine
uint16 getZOrder() const { return _z; }
// Needed for proper handling of objects inside the viewport
virtual bool isViewportRelative() const { return false; }
RenderObject *_redrawFrom;
bool _needsRedraw;
bool _isVisible;
uint16 _z;
Common::Rect _previousScreenPosition;
};
} // End of namespace Nancy
#endif // NANCY_RENDEROBJECT_H