Extras/CDTestFramework/Opcode/OPC_Model.h

   1 /*
   2  *      OPCODE - Optimized Collision Detection
   3  * http://www.codercorner.com/Opcode.htm
   4  *
   5  * Copyright (c) 2001-2008 Pierre Terdiman,  pierre@codercorner.com
   6
   7 This software is provided 'as-is', without any express or implied warranty.
   8 In no event will the authors be held liable for any damages arising from the use of this software.
   9 Permission is granted to anyone to use this software for any purpose,
  10 including commercial applications, and to alter it and redistribute it freely,
  11 subject to the following restrictions:
  12
  13 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
  14 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
  15 3. This notice may not be removed or altered from any source distribution.
  16 */
  17
  18 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  19 /**
  20  *      Contains code for OPCODE models.
  21  *      \file           OPC_Model.h
  22  *      \author         Pierre Terdiman
  23  *      \date           March, 20, 2001
  24  */
  25 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  26
  27 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  28 // Include Guard
  29 #ifndef __OPC_MODEL_H__
  30 #define __OPC_MODEL_H__
  31
  32         class OPCODE_API Model : public BaseModel
  33         {
  34                 public:
  35                 // Constructor/Destructor
  36                                                                                                 Model();
  37                 virtual                                                                 ~Model();
  38
  39                 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  40                 /**
  41                  *      Builds a collision model.
  42                  *      \param          create          [in] model creation structure
  43                  *      \return         true if success
  44                  */
  45                 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  46                 override(BaseModel)     bool                            Build(const OPCODECREATE& create);
  47
  48 #ifdef __MESHMERIZER_H__
  49                 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  50                 /**
  51                  *      Gets the collision hull.
  52                  *      \return         the collision hull if it exists
  53                  */
  54                 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  55                 inline_ const           CollisionHull*          GetHull()               const   { return mHull;         }
  56 #endif // __MESHMERIZER_H__
  57
  58                 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  59                 /**
  60                  *      Gets the number of bytes used by the tree.
  61                  *      \return         amount of bytes used
  62                  */
  63                 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
  64                 override(BaseModel)     udword                          GetUsedBytes()  const;
  65
  66                 private:
  67 #ifdef __MESHMERIZER_H__
  68                                                         CollisionHull*          mHull;                  //!< Possible convex hull
  69 #endif // __MESHMERIZER_H__
  70                 // Internal methods
  71                                                         void                            Release();
  72         };
  73
  74 #endif //__OPC_MODEL_H__