boundingVolumeFace.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
/******************************************************************************
** $RCSfile: boundingVolumeFace.h,v $ $Revision: 1.3 $ $State: Exp $
******************************************************************************/

// Placed in a separate file, so it can be included in multiple
// headers.  Using a forward declaration in all but one place
// does not seem to work for all compilers.
//

#pragma once

#include <vlutil/vlString.h>


enum DtBoundingVolumeFace
{
   DtFrontFace = 0
   , DtLeftFace
   , DtRightFace
   , DtTopFace
   , DtBottomFace
   , DtBackFace
   , DtInvalidFace // must be last entry
};

inline DtString boundingVolumeFaceString(DtBoundingVolumeFace face)
{
   DtString surface;

   switch (face)
   {
      case DtFrontFace:
         surface = "front";
         break;

      case DtBackFace:
         surface = "rear";
         break;

      case DtLeftFace:
         surface = "left-side";
         break;

      case DtRightFace:
         surface = "right-side";
         break;

      case DtTopFace:
         surface = "top";
         break;

      case DtBottomFace:
         surface = "bottom";
         break;

      default:
         surface = "invalid";
         break;
   }

   return surface;
}

inline DtString boundingVolumeFaceString(int face)
{
   return boundingVolumeFaceString(static_cast<DtBoundingVolumeFace>(face));
}

inline DtString frontFaceString()
{
   return boundingVolumeFaceString(DtFrontFace);
}

inline DtString leftFaceString()
{
   return boundingVolumeFaceString(DtLeftFace);
}

inline DtString rightFaceString()
{
   return boundingVolumeFaceString(DtRightFace);
}

inline DtString topFaceString()
{
   return boundingVolumeFaceString(DtTopFace);
}

inline DtString bottomFaceString()
{
   return boundingVolumeFaceString(DtBottomFace);
}

inline DtString rearFaceString()
{
   return boundingVolumeFaceString(DtBackFace);
}

inline DtString invalidFaceString()
{
   return boundingVolumeFaceString(DtInvalidFace);
}

inline int boundingVolumeFaceSides()
{
   return DtInvalidFace; // since DtInvalidFace is the last enum entry, it is also the num of enum entries
}