TAPsBoundingVolume.hpp

Go to the documentation of this file.

/******************************************************************************
TAPsBoundingVolume.hpp
******************************************************************************/
/******************************************************************************
SUKITTI PUNAK   (08/21/2006)
UPDATE          (09/07/2010)
******************************************************************************/
#ifndef TAPs_BOUNDING_VOLUME_HPP
#define TAPs_BOUNDING_VOLUME_HPP

#include "../Core/TAPsLib.hpp"
// Inheritance
//#include "../Support/TAPsColDetSupport.hpp"           // Is A
#include "../Support/TAPsPhysicsSupport.hpp"            // Is A
// Association
#include "../Support/TAPsTransformationSupport.hpp"     // Has A

BEGIN_NAMESPACE_TAPs
//=============================================================================
template <typename T>
class BoundingVolume {
//=============================================================================
// Member Functions
public:
    //-------------------------------------------------------------------------
    // Output Operator <<
    friend std::ostream & operator<< ( std::ostream &output, BoundingVolume<T> const &obj )
    {
        output << obj.StrInfo();
        return output;
    }
    //-------------------------------------------------------------------------
    BoundingVolume  ( Enum::CD type );
    BoundingVolume  ( Enum::CD type, int id );
    BoundingVolume  ( const BoundingVolume<T> & orig );
    virtual ~BoundingVolume ();
    //-------------------------------------------------------------------------
    virtual std::string StrInfo () const;
    //-------------------------------------------------------------------------
    inline BoundingVolume<T> & operator= ( BoundingVolume<T> const & orig );
    //-------------------------------------------------------------------------
    // Get/Set Fn(s)
    inline int  GetID () const;
    inline void SetID ( int id );
    inline std::string const & GetName () const;
    inline void SetName ( std::string const & name );
    inline Enum::CD GetType () const;

    PhysicsSupport<T> const & GetPhysicsSupport () const    { return *m_pPhysicsSupport; }
    void SetPhysicsSupport ( PhysicsSupport<T> * pPhysicsSupport )  { m_pPhysicsSupport = pPhysicsSupport; }

    //-------------------------------------------------------------------------
    inline virtual Vector3<T>   GetCenter () const { return m_vCenter; }
    inline virtual void         GetCenter ( T &x, T &y, T &z ) const { x = m_vCenter[0]; y = m_vCenter[1]; z = m_vCenter[2]; }
    inline virtual void         SetCenter ( Vector3<T> const & center ) { m_vCenter = center; }
    inline virtual void         SetCenter ( T x, T y, T z ) { m_vCenter.SetXYZ( x, y, z ); }
    inline virtual T            GetRadius () const {return 0; }
    inline virtual void         SetRadius ( T radius ) {}
    inline virtual T            GetWidth () const {return 0; }
    inline virtual void         SetWidth ( T width ) {}
    inline virtual T            GetHeight () const {return 0; }
    inline virtual void         SetHeight ( T height ) {}
    inline virtual T            GetDepth () const {return 0; }
    inline virtual void         SetDepth ( T depth ) {}
    //-------------------------------------------------------------------------
protected:
//  inline void SetType ( Enum::CD type ) { m_eType = type; }
public:
    //-------------------------------------------------------------------------
    inline TransformationSupport<T> const & GetTransform () const   { return m_Transform; }
    inline TransformationSupport<T> &       GetTransform ()         { return m_Transform; }
    inline void SetTransform ( TransformationSupport<T> const & trx )   { m_Transform = trx; }
    //-------------------------------------------
    // Scale the bounding volume
    virtual void ScaledBy ( T val ) = 0;
    //-------------------------------------------------------------------------

    virtual bool TestPointLocation ( 
        Vector3<T> const & point,
        Vector3<T> * const pvDistance = NULL 
    ) const = 0;

    virtual bool TestPointLocation ( 
        Vector3<T> const & point,
        TransformationSupport<T> const * const pTransform, 
        Vector3<T> * const pvDistance = NULL 
    ) const = 0;

    //-------------------------------------------------------------------------

    virtual bool TestSphereLocation ( 
        Vector3<T> const & sphereCenter,
        T   sphereRadius,
        Vector3<T> * const pvDistance = NULL 
    ) const = 0;

    virtual bool TestSphereLocation ( 
        Vector3<T> const & sphereCenter,
        T   sphereRadius,
        TransformationSupport<T> const * const pTransform, 
        Vector3<T> * const pvDistance = NULL 
    ) const = 0;

    //-------------------------------------------------------------------------
    virtual T TestOverlapWith ( BoundingVolume<T> const * const that ) const = 0;
    //-------------------------------------------------------------------------
//  virtual T TestOverlapWith ( BVHNode<T> const * const that ) const;
    //-------------------------------------------------------------------------
//  virtual T TestOverlapWithTillLeafNodes ( BVHNode<T> const * const that ) const;
    //-------------------------------------------------------------------------
/*
protected:
    // returning minus means overlap
    // returning zero  means contact
    // returning plus  means separate
    //=========================================================================
    // Binary Spheres
    //-------------------------------------------------------------------------
    inline virtual T TestOverlapSphereWithSphere ( BVHNode<T> const * const that ) const;
    inline virtual T TestOverlapSphereWithSphere ( BVHNode<T> const * const that, 
                                            Matrix4x4<T> const & thatTransform ) const;
    inline virtual T TestOverlapSphereWithSphere ( Matrix4x4<T> const & thisTransform, 
                                            BVHNode<T> const * const that ) const;
    inline virtual T TestOverlapSphereWithSphere ( Matrix4x4<T> const & thisTransform, 
                                            BVHNode<T> const * const that, 
                                            Matrix4x4<T> const & thatTransform ) const;
    //-------------------------------------------------------------------------
    // No Primitive-Primitive Intersection Test
    // Stop at Leaf-Leaf-Node Intersection Test
    inline virtual T TestOverlapSphereWithSphereTillLeafNodes ( BVHNode<T> const * const that ) const;
    inline virtual T TestOverlapSphereWithSphereTillLeafNodes ( BVHNode<T> const * const that, 
                                            Matrix4x4<T> const & thatTransform ) const;
    inline virtual T TestOverlapSphereWithSphereTillLeafNodes ( Matrix4x4<T> const & thisTransform, 
                                            BVHNode<T> const * const that ) const;
    inline virtual T TestOverlapSphereWithSphereTillLeafNodes ( Matrix4x4<T> const & thisTransform, 
                                            BVHNode<T> const * const that, 
                                            Matrix4x4<T> const & thatTransform ) const;
//*/
    //=========================================================================
    //-------------------------------------------------------------------------
    // With OpenGL
#if defined(__gl_h_) || defined(__GL_H__)
public:
    virtual void DrawByOpenGL ( 
                GLenum drawStyle = GLU_LINE, 
                Vector4<T> color = Vector4<T>( 0.77, 0.85, 0.75, 0.75 ) 
    ) = 0;

    virtual void Draw ( 
                GLenum drawStyle = GLU_LINE, 
                Vector4<T> color = Vector4<T>( 0.77, 0.85, 0.75, 0.75 ) 
    ) = 0;
    //-------------------------------------------------------------------------
    //=========================================================================
    //---------------------------------------------------------------
    //static GLuint m_uiDisplayList;        //!< for OpenGL drawing
#endif
//=============================================================================
//-----------------------------------------------------------------------------
// Data Members  --------------------------------------------------------------
protected:
    //--------------------------------------------------------------------
    // Data Members
    static int      m_iTotal;   
    Enum::CD        m_eType;    
    int             m_iID;      
    std::string     m_strName;  

    Vector3<T>      m_vCenter;  
    //-------------------------------------------------------------------------
    TransformationSupport<T>    m_Transform;    
    PhysicsSupport<T> *     m_pPhysicsSupport;  
    //--------------------------------------------------------------------
    //-------------------------------------------------------------------------
}; // END CLASS BoundingVolume
//=============================================================================
END_NAMESPACE_TAPs
//-----------------------------------------------------------------------------
// Include definition if TAPs_USE_EXPORT is not defined
//#if !defined( TAPs_USE_EXPORT )
    #include "TAPsBoundingVolume.cpp"
//#endif
//-----------------------------------------------------------------------------
#endif
//34567890123456789012345678901234567890123456789012345678901234567890123456789
//--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----