BoundingSphere< T > Class Template Reference

BoundingSphere class is a subclass of BoundingVolume class. More...

#include <TAPsBoundingSphere.hpp>

Inheritance diagram for BoundingSphere< T >:

[legend]

Collaboration diagram for BoundingSphere< T >:

[legend]

List of all members.

Public Member Functions
	BoundingSphere (const BoundingSphere &orig)
	Copy Constructor.
	BoundingSphere (int id)
	BoundingSphere ()
	Constructor(s) and Destructor.
virtual T	GetRadius () const
BoundingSphere< T > &	operator= (BoundingSphere< T > const &orig)
virtual void	ScaledBy (T val)
virtual void	SetRadius (T radius)
virtual std::string	StrInfo () const
	Return this object info as a string.
virtual T	TestOverlapWith (BoundingVolume< T > const *const that) const
virtual bool	TestPointLocation (Vector3< T > const *const pvPoint, TransformationSupport< T > const *const pTransform, Vector3< T > *const pvDistance=NULL) const
	Test if a point is inside this sphere bounding volume.
virtual bool	TestPointLocation (Vector3< T > const *const pvPoint, Vector3< T > *const pvDistance=NULL) const
	Test if a point is inside this sphere bounding volume.
virtual	~BoundingSphere ()
Protected Attributes
T	m_tRadius
Friends
std::ostream &	operator<< (std::ostream &output, BoundingSphere< T > const &obj)

---

Detailed Description

template<typename T>
class BoundingSphere< T >

BoundingSphere class is a subclass of BoundingVolume class.

Data:

Center is Vector3<T> inherited from BoundingVolume class.

Radius is scalar.

Sphere is created from the center with the radius.

See also:

TAPsCDLib.hpp for details about Collision Detection implemented in TAPs.

Definition at line 28 of file TAPsBoundingSphere.hpp.

---

Constructor & Destructor Documentation

template<typename T>

BEGIN_NAMESPACE_TAPs BoundingSphere< T >::BoundingSphere

(

)

[inline]

Constructor(s) and Destructor.

BoundingSphere class is a subclass of BoundingVolume class.

Definition at line 22 of file TAPsBoundingSphere.cpp.

    : BoundingVolume<T>( Enum::BOUNDING_SPHERE ),
      m_tRadius( 1 )
{}

template<typename T>

BoundingSphere< T >::BoundingSphere

(

int

id

)

[inline]

Definition at line 28 of file TAPsBoundingSphere.cpp.

    : BoundingVolume<T>( Enum::BOUNDING_SPHERE, id ),
      m_tRadius( 1 )
{}

template<typename T>

BoundingSphere< T >::BoundingSphere

(

const BoundingSphere< T > &

orig

)

[inline]

Copy Constructor.

Definition at line 34 of file TAPsBoundingSphere.cpp.

    : BoundingVolume<T>( orig ),
      m_vCenter( orig.m_vCenter ),
      m_tRadius( orig.m_tRadius )
{
    m_vCenter = orig.m_vCenter;
}

template<typename T>

BoundingSphere< T >::~BoundingSphere

(

)

[inline, virtual]

Definition at line 43 of file TAPsBoundingSphere.cpp.

{}

---

Member Function Documentation

template<typename T>

virtual T BoundingSphere< T >::GetRadius

(

)

const [inline, virtual]

Reimplemented from BoundingVolume< T >.

Definition at line 54 of file TAPsBoundingSphere.hpp.

{return m_tRadius; }

template<typename T>

BoundingSphere<T>& BoundingSphere< T >::operator=

(

BoundingSphere< T > const &

orig

)

[inline]

template<typename T>

void BoundingSphere< T >::ScaledBy

(

T

val

)

[inline, virtual]

Implements BoundingVolume< T >.

Definition at line 75 of file TAPsBoundingSphere.cpp.

{
    assert( 0.0 <= val );
    GetTransform().PreApplyUniformScale( val );
}

template<typename T>

virtual void BoundingSphere< T >::SetRadius

(

T

radius

)

[inline, virtual]

Reimplemented from BoundingVolume< T >.

Definition at line 55 of file TAPsBoundingSphere.hpp.

{ m_tRadius = radius; }

template<typename T>

std::string BoundingSphere< T >::StrInfo

(

)

const [inline, virtual]

Return this object info as a string.

Reimplemented from BoundingVolume< T >.

Definition at line 48 of file TAPsBoundingSphere.cpp.

{
    std::string str = BoundingVolume<T>::StrInfo();
    std::ostringstream ss;
    ss << "  Radius: " << m_tRadius;
    return str + ss.str() + "\n";
}

template<typename T>

T BoundingSphere< T >::TestOverlapWith

(

BoundingVolume< T > const *const

that

)

const [inline, virtual]

This function is inherited from BoundingVolume<T> class

Implements BoundingVolume< T >.

Definition at line 247 of file TAPsBoundingSphere.cpp.

{
    std::cout << "BoundingSphere<T>::TestOverlapWith( BoundingVolume<T> ) -- NOT IMPLEMENTED YET!!!\n";
    return 0;
}

template<typename T>

bool BoundingSphere< T >::TestPointLocation	(	Vector3< T > const *const	pvPoint,
		TransformationSupport< T > const *const	pTransform,
		Vector3< T > *const	pvDistance = NULL
	)			const [inline, virtual]

Test if a point is inside this sphere bounding volume.

This Test Point Location function returns true if the input point input point to the bounding surface in the world (test point) coordinate.

pvDistance is for returning the shortest vector measuring from the input point to the bounding surface.

Therefore, this fn can be used to tell whether the point is inside or outside the bounding volume and how to move it to the surface of the bounding volume with the shortest distance.

Implements BoundingVolume< T >.

Definition at line 159 of file TAPsBoundingSphere.cpp.

{
    bool isThePointInsideTheSphere = false;
    //---------------------------------------------------------------
    TransformationSupport<T> transform; // default ctor is an identity
    if ( pTransform->GetStatusApplyTransformation() ) {
        transform.ReturnMatrixTransform() *= pTransform->GetMatrixTransform();
        // The above statement is equivalent to the below statement
        //transform.ReturnMatrixTransform() = transform.GetMatrixTransform() * pTransform->GetMatrixTransform();
        transform.EnableStatusApplyTransformation();
    }
    if ( GetTransform().GetStatusApplyTransformation() ) {
        transform.ReturnMatrixTransform() *= GetTransform().GetMatrixTransform();
        // The above statement is equivalent to the below statement
        //transform.ReturnMatrixTransform() = transform.GetMatrixTransform() * GetTransform().GetMatrixTransform();
        transform.EnableStatusApplyTransformation();
    }
    //---------------------------------------------------------------
    // In the local coordinate of the bounding sphere, 
    // the sphere's center is at the origin. 
    // The sphere has radius and center.
    //---------------------------------------------------------------
    // Transform pvPoint to the sphere local coordinate
    Vector3<T> location = *pvPoint;
    if ( transform.GetStatusApplyTransformation() ) {
        //location -= GetTransform().GetTranslation();
        //location = GetTransform().GetMatrixRotation().GetInverse() * location;
        location = (transform.GetMatrixTransform().GetInverse() * Vector4<T>(location)).GetVector3();
    }
    // Shift the location of point by the cylinder center
    // i.e. shift the cylinder to the origin (0,0,0)
    location -= GetCenter();
    //---------------------------------------------------------------
    // Now the sphere is centered at the origin.
    // And the input point has been transformed into the sphere coordinate.
    // The test can be performed below.
    T   ptRadius = location.Length();
    //===============================================================
    // If the point is INSIDE the sphere
    //---------------------------------------------------------------
    // If the point is within the sphere radius
    T distance = GetRadius() - ptRadius;
    if ( distance >= 0 ) { 
        if ( pvDistance ) {
            (*pvDistance) = location.Normalized() * distance;
            //-------------------------
            // Now rotate it back by the rotation matrix (from the transform matrix).
            // REMARK: Translation (from the transform matrix) is NOT applied back, 
            //         because pvDistance represents a displacement vector from 
            //         the input point to the sphere surface.
            if ( transform.GetStatusApplyTransformation() ) {
                (*pvDistance) = transform.GetMatrixRotation() * (*pvDistance);
            }
            //-------------------------
            isThePointInsideTheSphere = true;
        }
    }
    //===============================================================
    // If the point is NOT INSIDE the sphere radius
    //---------------------------------------------------------------
    else {
        if ( pvDistance ) {
            (*pvDistance).SetXYZ( 0, 0, 0 );
        }
    }

    /*
    // TEMPORARY CODE
    //---------------------------------------------------------------
    // Transform the pvDistance to the world coordinate
    if ( pvDistance ) {
        if ( !isThePointInsideTheSphere ) {
            (*pvDistance).SetXYZ( 0, 0, 0 );
        }
        else {
        }
    }
    //*/

    //---------------------------------------------------------------
    return isThePointInsideTheSphere;
}

template<typename T>

bool BoundingSphere< T >::TestPointLocation	(	Vector3< T > const *const	pvPoint,
		Vector3< T > *const	pvDistance = NULL
	)			const [inline, virtual]

Test if a point is inside this sphere bounding volume.

This Test Point Location function returns true if the input point (pvPoint) is inside the bounding volume and returns false otherwise.

pvDistance is for returning the shortest vector measuring from the input point to the bounding surface in the world (test point) coordinate.

Therefore, this fn can be used to tell whether the point is inside or outside the bounding volume and how to move it to the surface of the bounding volume with the shortest distance.

Implements BoundingVolume< T >.

Definition at line 86 of file TAPsBoundingSphere.cpp.

{
    bool isThePointInsideTheSphere = false;
    //---------------------------------------------------------------
    // In the local coordinate of the bounding sphere, 
    // the sphere's center is at the origin. 
    // The sphere has radius and center.
    //---------------------------------------------------------------
    // Transform pvPoint to the sphere local coordinate
    Vector3<T> location = *pvPoint;
    if ( GetTransform().GetStatusApplyTransformation() ) {
        //location -= GetTransform().GetTranslation();
        //location = GetTransform().GetMatrixRotation().GetInverse() * location;
        location = (GetTransform().GetMatrixTransform().GetInverse() * Vector4<T>(location)).GetVector3();
    }
    // Shift the location of point by the cylinder center
    // i.e. shift the cylinder to the origin (0,0,0)
    location -= GetCenter();
    //---------------------------------------------------------------
    // Now the sphere is centered at the origin.
    // And the input point has been transformed into the sphere coordinate.
    // The test can be performed below.
    T   ptRadius = location.Length();
    //===============================================================
    // If the point is INSIDE the sphere
    //---------------------------------------------------------------
    // If the point is within the sphere radius
    T distance = GetRadius() - ptRadius;
    if ( distance >= 0 ) { 
        if ( pvDistance ) {
            (*pvDistance) = location.Normalized() * distance;
            //-------------------------
            // Now rotate it back by the rotation matrix (from the transform matrix).
            // REMARK: Translation (from the transform matrix) is NOT applied back, 
            //         because pvDistance represents a displacement vector from 
            //         the input point to the sphere surface.
            if ( GetTransform().GetStatusApplyTransformation() ) {
                (*pvDistance) = GetTransform().GetMatrixRotation() * (*pvDistance);
            }
            //-------------------------
            isThePointInsideTheSphere = true;
        }
    }
    //===============================================================
    // If the point is NOT INSIDE the sphere radius
    //---------------------------------------------------------------
    else {
        if ( pvDistance ) {
            (*pvDistance).SetXYZ( 0, 0, 0 );
        }
    }

    /*
    // TEMPORARY CODE
    //---------------------------------------------------------------
    // Transform the pvDistance to the world coordinate
    if ( pvDistance ) {
        if ( isThePointInsideTheSphere ) {
        }
        else {
            (*pvDistance).SetXYZ( 0, 0, 0 );
        }
    }
    //*/

    //---------------------------------------------------------------
    return isThePointInsideTheSphere;
}

---

Friends And Related Function Documentation

template<typename T>

std::ostream& operator<<	(	std::ostream &	output,
		BoundingSphere< T > const &	obj
	)			[friend]

Definition at line 34 of file TAPsBoundingSphere.hpp.

    {
        output << obj.StrInfo();
        return output;
    }

---

Member Data Documentation

template<typename T>

T BoundingSphere< T >::m_tRadius [protected]

Definition at line 158 of file TAPsBoundingSphere.hpp.

---

The documentation for this class was generated from the following files:

• G:/spunak_xp/Works/TAPs/Include/TAPs/CD/TAPsBoundingSphere.hpp
• G:/spunak_xp/Works/TAPs/Include/TAPs/CD/TAPsBoundingSphere.cpp