SPMeshPreview.h

Go to the documentation of this file.

/*********************************************************\
 *  File: SPMeshPreview.h                                *
 *
 *  Copyright (C) 2002-2012 The PixelLight Team (http://www.pixellight.org/)
 *
 *  This file is part of PixelLight.
 *
 *  PixelLight is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  PixelLight 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 Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with PixelLight. If not, see <http://www.gnu.org/licenses/>.
\*********************************************************/


#ifndef __PLMESH_MESH_SURFACEPAINTER_H__
#define __PLMESH_MESH_SURFACEPAINTER_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include <PLRenderer/SPPreview.h>
#include "PLMesh/PLMesh.h"


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLMesh {


//[-------------------------------------------------------]
//[ Forward declarations                                  ]
//[-------------------------------------------------------]
class Mesh;
class MeshHandler;


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Mesh preview surface painter class
*/
class SPMeshPreview : public PLRenderer::SPPreview {


    //[-------------------------------------------------------]
    //[ RTTI interface                                        ]
    //[-------------------------------------------------------]
    pl_class(PLMESH_RTTI_EXPORT, SPMeshPreview, "PLMesh", PLRenderer::SPPreview, "Mesh preview surface painter class")
        // Constructors
        pl_constructor_1(ParameterConstructor,  PLRenderer::Renderer&,  "Parameter constructor",    "")
    pl_class_end


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Constructor
        *
        *  @param[in] cRenderer
        *    Renderer to use
        */
        PLMESH_API SPMeshPreview(PLRenderer::Renderer &cRenderer);

        /**
        *  @brief
        *    Destructor
        */
        PLMESH_API virtual ~SPMeshPreview();

        /**
        *  @brief
        *    Returns the used mesh
        *
        *  @return
        *    The used mesh, a null pointer if there's no mesh
        */
        PLMESH_API Mesh *GetMesh() const;

        /**
        *  @brief
        *    Sets the used mesh
        *
        *  @param[in] pMesh
        *    Mesh to use, can be a null pointer
        */
        PLMESH_API void SetMesh(Mesh *pMesh = nullptr);


    //[-------------------------------------------------------]
    //[ Private data                                          ]
    //[-------------------------------------------------------]
    private:
        MeshHandler *m_pMeshHandler;    /**< Mesh handler (always valid!) */


    //[-------------------------------------------------------]
    //[ Private virtual PLRenderer::SurfacePainter functions  ]
    //[-------------------------------------------------------]
    private:
        virtual void OnPaint(PLRenderer::Surface &cSurface) override;


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLMesh


#endif // __PLMESH_MESH_SURFACEPAINTER_H__