"L. Spiro Engine"
Public Member Functions | Protected Attributes

lsp::CKDop Class Reference

A k-DOP is a bounding box of any number of planes. More...

#include <LSPKDop.h>

List of all members.

Public Member Functions

LSE_INLINE LSE_CALLCTOR CKDop (LSUINT32 _ui32AllocPlanes)
LSE_INLINE CPlane3 &LSE_CALL operator[] (LSUINT32 _ui32I)
LSE_INLINE const CPlane3 &LSE_CALL operator[] (LSUINT32 _ui32I) const
LSE_INLINE LSUINT32 LSE_CALL TotalPlanes () const
LSE_INLINE LSBOOL LSE_CALL AddPlane (const CPlane3 &_pPlane)
LSE_INLINE LSVOID LSE_CALL Reset ()
LSE_INLINE LSVOID LSE_CALL ResetNoDealloc ()

Protected Attributes

CSVectorPoD< CPlane3 > m_pPlanes

Detailed Description

A k-DOP is a bounding box of any number of planes.

Class CKDop Description: A k-DOP is a bounding box of any number of planes.


Member Function Documentation

LSE_INLINE LSBOOL LSE_CALL lsp::CKDop::AddPlane ( const CPlane3 &  _pPlane)

Add a plane.

Parameters:
_pPlaneThe plane to add.
Returns:
Returns false if a memory failure prevents the adding of the plane.
LSE_INLINE CPlane3 &LSE_CALL lsp::CKDop::operator[] ( LSUINT32  _ui32I)

Give array access.

Parameters:
_ui32IThe index of the plane to retrieve.
Returns:
Returns the plane at the given index, which must be valid.
LSE_INLINE const CPlane3 &LSE_CALL lsp::CKDop::operator[] ( LSUINT32  _ui32I) const

Give array access.

Parameters:
_ui32IThe index of the plane to retrieve.
Returns:
Returns the plane at the given index, which must be valid.
LSE_INLINE LSVOID LSE_CALL lsp::CKDop::Reset ( )

Reset the list of planes. Deallocates all memory used by this class.

LSE_INLINE LSVOID LSE_CALL lsp::CKDop::ResetNoDealloc ( )

Reset the list of planes. Does not perform deallocation.

LSE_INLINE LSUINT32 LSE_CALL lsp::CKDop::TotalPlanes ( ) const

Get the total number of planes in this k-DOP.

Returns:
Returns the number of planes in the k-DOP.

Member Data Documentation

CSVectorPoD<CPlane3> lsp::CKDop::m_pPlanes [protected]

The dynamically growable array of planes.


The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator