CuboidMesh.h

Go to the documentation of this file.

/*

Copyright (c) 2023, Dr Franck P. Vidal (franck.p.vidal@fpvidal.net),
http://www.fpvidal.net/
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

3. Neither the name of the Bangor University nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/


#ifndef __CuboidMesh_h
#define __CuboidMesh_h


//******************************************************************************
//  Include
//******************************************************************************
#ifndef __gVirtualXRayConfig_h
#include "gVirtualXRay/gVirtualXRayConfig.h"
#endif

#include <string>
#include <vector>

#ifndef __PolygonMesh_h
#include "gVirtualXRay/PolygonMesh.h"
#endif


//******************************************************************************
//  namespace
//******************************************************************************
namespace gVirtualXRay {


//==============================================================================
//==============================================================================
template<typename T> class CuboidMesh: public PolygonMesh
//------------------------------------------------------------------------------
{
//******************************************************************************
public:
    //--------------------------------------------------------------------------
    /*
    *   @param aWidth:   the width of the cuboid, i.e. its length along the X-axis (default value: 1 cm)
    *   @param aHeight:  the height of the cuboid, i.e. its length along the Y-axis (default value: 1 cm)
    *   @param aDepth:   the depth of the cuboid, i.e. its length along the Z-axis (default value: 1 cm)
    */
    //--------------------------------------------------------------------------
    CuboidMesh(double aWidth = 1.0 * cm,
      double aHeight = 1.0 * cm,
      double aDepth = 1.0 * cm,
      int anIndexDataType = 0);


    //--------------------------------------------------------------------------
    /*
    *   @param aWidth:   the width of the cuboid, i.e. its length along the X-axis (default value: 1 cm)
    *   @param aHeight:  the height of the cuboid, i.e. its length along the Y-axis (default value: 1 cm)
    *   @param aDepth:   the depth of the cuboid, i.e. its length along the Z-axis (default value: 1 cm)
    */
    //--------------------------------------------------------------------------
    void create(double aWidth = 1.0 * cm,
      double aHeight = 1.0 * cm,
      double aDepth = 1.0 * cm,
      int anIndexDataType = 0);
};


} // namespace gVirtualXRay


//******************************************************************************
#include "CuboidMesh.inl"


#endif // __CuboidMesh_h