Abstract surface painter base class. More...
#include <SurfacePainter.h>
Inheritance diagram for PLRenderer::SurfacePainter:
Protected Member Functions | |
| SurfacePainter (const SurfacePainter &cSource) | |
| Returns the owner renderer. | |
| PLRENDERER_API | SurfacePainter (Renderer &cRenderer) |
| Constructor. | |
| virtual PLRENDERER_API | ~SurfacePainter () |
| Destructor. | |
| virtual PLRENDERER_API bool | OnPaintBegin (Surface &cSurface) |
| Is called when the owner surface is paint process begins. | |
| virtual void | OnPaint (Surface &cSurface)=0 |
| Is called when the owner surface is painted. | |
| virtual PLRENDERER_API void | OnPaintEnd (Surface &cSurface) |
| Is called when the owner surface is paint process ends. | |
Detailed Description
Abstract surface painter base class.
- Note:
- Derived classes should use a 'SP' name prefix (example: SPPreview)
Constructor & Destructor Documentation
| PLRenderer::SurfacePainter::SurfacePainter | ( | const SurfacePainter & | cSource | ) | [protected] |
Returns the owner renderer.
- Returns:
- The owner renderer
Copy constructor (not implemented!)
- Parameters:
-
[in] cSource Source to copy from
| PLRENDERER_API PLRenderer::SurfacePainter::SurfacePainter | ( | Renderer & | cRenderer | ) | [protected] |
Constructor.
- Parameters:
-
[in] cRenderer Renderer to use
| virtual PLRENDERER_API PLRenderer::SurfacePainter::~SurfacePainter | ( | ) | [protected, virtual] |
Destructor.
Member Function Documentation
| virtual PLRENDERER_API bool PLRenderer::SurfacePainter::OnPaintBegin | ( | Surface & | cSurface | ) | [protected, virtual] |
Is called when the owner surface is paint process begins.
- Parameters:
-
[in] cSurface Surface we're painting on
- Returns:
- 'true' if all went fine, else 'false'
| virtual void PLRenderer::SurfacePainter::OnPaint | ( | Surface & | cSurface | ) | [protected, pure virtual] |
Is called when the owner surface is painted.
- Parameters:
-
[in] cSurface Surface we're painting on
Implemented in PLScene::SPScene.
| virtual PLRENDERER_API void PLRenderer::SurfacePainter::OnPaintEnd | ( | Surface & | cSurface | ) | [protected, virtual] |
Is called when the owner surface is paint process ends.
- Parameters:
-
[in] cSurface Surface we're painting on
The documentation for this class was generated from the following file:
