SNBitmap3D.h

Go to the documentation of this file.

/*********************************************************\
 *  File: SNBitmap3D.h                                   *
 *
 *  Copyright (C) 2002-2011 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 __PLSCENE_SCENENODE_BITMAP3D_H__
#define __PLSCENE_SCENENODE_BITMAP3D_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include "PLScene/Scene/SceneNodes/SNBitmap.h"


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLScene {


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    3D bitmap scene node
*
*  @note
*    - It's NOT recommended to use this scene node for example to create dense vegetation on a terrain!
*    - The axis aligned bounding box is centered around zero and each axis has a length of 1
*    - The bitmap is drawn on the x/y plane and 'looks' into the positive z axis
*/
class SNBitmap3D : public SNBitmap {


    //[-------------------------------------------------------]
    //[ RTTI interface                                        ]
    //[-------------------------------------------------------]
    pl_class(PLS_RTTI_EXPORT, SNBitmap3D, "PLScene", PLScene::SNBitmap, "3D bitmap scene node")
        // Attributes
        pl_attribute(PositionOffset,    PLMath::Vector3,    PLMath::Vector3::Zero,  ReadWrite,  GetSet, "Position offset (scene node space)",   "")
        // Constructors
        pl_constructor_0(DefaultConstructor,    "Default constructor",  "")
    pl_class_end


    //[-------------------------------------------------------]
    //[ Public RTTI get/set functions                         ]
    //[-------------------------------------------------------]
    public:
        PLS_API const PLMath::Vector3 &GetPositionOffset() const;
        PLS_API void SetPositionOffset(const PLMath::Vector3 &vValue);


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Default constructor
        */
        PLS_API SNBitmap3D();

        /**
        *  @brief
        *    Destructor
        */
        PLS_API virtual ~SNBitmap3D();


    //[-------------------------------------------------------]
    //[ Private functions                                     ]
    //[-------------------------------------------------------]
    private:
        /**
        *  @brief
        *    Draws the bitmap shape
        *
        *  @param[in] cRenderer
        *    The used renderer
        *  @param[in] cVisNode
        *    Used visibility node
        */
        void DrawShape(PLRenderer::Renderer &cRenderer, const VisNode &cVisNode);


    //[-------------------------------------------------------]
    //[ Private data                                          ]
    //[-------------------------------------------------------]
    private:
        PLMath::Vector3 m_vPositionOffset;  /**< Position offset (scene node space) */


    //[-------------------------------------------------------]
    //[ Public virtual SceneNode functions                    ]
    //[-------------------------------------------------------]
    public:
        PLS_API virtual void DrawSolid(PLRenderer::Renderer &cRenderer, const VisNode *pVisNode = nullptr) override;
        PLS_API virtual void DrawTransparent(PLRenderer::Renderer &cRenderer, const VisNode *pVisNode = nullptr) override;


    //[-------------------------------------------------------]
    //[ Private virtual SceneNode functions                   ]
    //[-------------------------------------------------------]
    private:
        virtual void UpdateAABoundingBox() override;


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLScene


#endif // __PLSCENE_SCENENODE_BITMAP3D_H__