MeshCreatorTorus.h

Go to the documentation of this file.

/*********************************************************\
 *  File: MeshCreatorTorus.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_MESHCREATOR_TORUS_H__
#define __PLMESH_MESHCREATOR_TORUS_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include <PLMath/Vector3.h>
#include "PLMesh/Creator/MeshCreator.h"


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


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Torus mesh creator class
*
*  @note
*    - Can also be used as chamfer cylinder
*/
class MeshCreatorTorus : public MeshCreator {


    //[-------------------------------------------------------]
    //[ RTTI interface                                        ]
    //[-------------------------------------------------------]
    pl_class(PLMESH_RTTI_EXPORT, MeshCreatorTorus, "PLMesh", PLMesh::MeshCreator, "Torus mesh creator class")
        // Attributes
        pl_attribute(Radius,    float,              0.5f,                   ReadWrite,  DirectValue,    "Torus radius",     "")
        pl_attribute(Width,     float,              0.2f,                   ReadWrite,  DirectValue,    "Torus width",      "")
        pl_attribute(Sides,     PLCore::uint32,     20,                     ReadWrite,  DirectValue,    "Number of sides",  "")
        pl_attribute(Rings,     PLCore::uint32,     20,                     ReadWrite,  DirectValue,    "Number of rings",  "")
        pl_attribute(Offset,    PLMath::Vector3,    PLMath::Vector3::Zero,  ReadWrite,  DirectValue,    "Offset to center", "")
        // Constructors
        pl_constructor_0(DefaultConstructor,    "Default constructor",  "")
    pl_class_end


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

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


    //[-------------------------------------------------------]
    //[ Private virtual MeshCreator functions                 ]
    //[-------------------------------------------------------]
    private:
        virtual Mesh *Create(Mesh &cMesh, PLCore::uint32 nLODLevel = 0, bool bStatic = true) const override;


};


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


#endif // __PLMESH_MESHCREATOR_TORUS_H__