lsp::CCappedKDop< _uMax > Class Template Reference

A k-DOP with a maximum number of planes when performance is needed. More...

#include <LSPCappedKDop.h>

List of all members.

Public Member Functions
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 ()
Protected Attributes
CPlane3	m_pPlanes [_uMax]
LSUINT32	m_ui32Total

---

Detailed Description

template<unsigned _uMax>
class lsp::CCappedKDop< _uMax >

A k-DOP with a maximum number of planes when performance is needed.

Class CCappedKDop Description: A capped k-DOP is a k-DOP with a maximum number of planes. This stores enough planes to hold the maximum, so allocations are avoided, making this the choice for a limited number of planes in high-performance situations.

---

Member Function Documentation

template<unsigned _uMax>

LSE_INLINE LSBOOL LSE_CALL lsp::CCappedKDop< _uMax >::AddPlane

(

const CPlane3 &

_pPlane

)

[inline]

Add a plane.

Parameters:

_pPlane

The plane to add.

Returns:

Returns false if a memory failure prevents the adding of the plane.

template<unsigned _uMax>

LSE_INLINE CPlane3& LSE_CALL lsp::CCappedKDop< _uMax >::operator[]

(

LSUINT32

_ui32I

)

[inline]

Give array access.

Parameters:

_ui32I

The index of the plane to retrieve.

Returns:

Returns the plane at the given index, which must be valid.

template<unsigned _uMax>

LSE_INLINE const CPlane3& LSE_CALL lsp::CCappedKDop< _uMax >::operator[]

(

LSUINT32

_ui32I

)

const [inline]

Give array access.

Parameters:

_ui32I

The index of the plane to retrieve.

Returns:

Returns the plane at the given index, which must be valid.

template<unsigned _uMax>

LSE_INLINE LSVOID LSE_CALL lsp::CCappedKDop< _uMax >::Reset

(

)

[inline]

Reset the list of planes. Very fast.

template<unsigned _uMax>

LSE_INLINE LSUINT32 LSE_CALL lsp::CCappedKDop< _uMax >::TotalPlanes

(

)

const [inline]

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

Returns:

Returns the number of planes in the k_DOP.

---

Member Data Documentation

template<unsigned _uMax>

CPlane3 lsp::CCappedKDop< _uMax >::m_pPlanes[_uMax] [protected]

The array of planes.

template<unsigned _uMax>

LSUINT32 lsp::CCappedKDop< _uMax >::m_ui32Total [protected]

The actual total of planes.

---

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

• F:/My Projects/LSEngine/Modules/LSPhysicsLib/Src/BoundingBoxes/LSPCappedKDop.h