ATerrainSection Class Reference

#include <ATerrainSection.h>

Classes
class	ModelNode

Public Types
enum	FLAGS : TUINT32 {   FLAGS_HIGH_LOD_LOADED = BITFLAG( 0 ) , FLAGS_LOW_LOD_LOADED = BITFLAG( 1 ) , FLAGS_HIGH_LOD_LOADING = BITFLAG( 2 ) , FLAGS_LOW_LOD_LOADING = BITFLAG( 3 ) ,   FLAGS_HIGH_LOD_QUEUED = BITFLAG( 4 ) , FLAGS_LOW_LOD_QUEUED = BITFLAG( 5 ) , FLAGS_COLLISION_LOADING = BITFLAG( 10 ) }

Public Member Functions
void	Draw (ATerrainLODType a_eLODType)
void	LoadCollision ()
void	LoadModels (ATerrainLODType a_eLODType)
void	LoadMatlib (ATerrainLODType a_eLODType)
void	UnloadMatlib (ATerrainLODType a_eLODType)
void	DestroyLOD (ATerrainLODType a_eLODType)
void	RemoveFromStreamingQueue ()
TBOOL	IsMatLibLoaded (ATerrainLODType a_eLODType) const
TBOOL	IsLODQueued (ATerrainLODType a_eLODType) const
void	SetLODQueued (ATerrainLODType a_eLODType, TBOOL a_bQueued)
TBOOL	IsLODLoaded (ATerrainLODType a_eLODType) const
void	SetLODLoaded (ATerrainLODType a_eLODType, TBOOL a_bLoaded)
TBOOL	IsLODLoading (ATerrainLODType a_eLODType) const
void	SetLODLoading (ATerrainLODType a_eLODType, TBOOL a_bLoading)
TBOOL	IsLODEmpty (ATerrainLODType a_eLODType) const
void	SetLODEmpty (ATerrainLODType a_eLODType, TBOOL a_bEmpty)
void	GetLODNames (ATerrainLODType a_eLODType, const TCHAR **&a_rLODs, TINT &a_rNumLODs)
void	GetLODBlocks (ATerrainLODType a_eLODType, ATerrainLODBlock **&a_rMemBlocks, TUINT16 &a_rNumMemBlocks)
TINT	GetLODCount (ATerrainLODType a_eLODType)

Friends
class	ATerrainInterface
class	ASectionDoneJob
class	ACollisionDoneJob

Detailed Description

Definition at line 11 of file ATerrainSection.h.

Member Enumeration Documentation

FLAGS

enum ATerrainSection::FLAGS : TUINT32

Enumerator
FLAGS_HIGH_LOD_LOADED
FLAGS_LOW_LOD_LOADED
FLAGS_HIGH_LOD_LOADING
FLAGS_LOW_LOD_LOADING
FLAGS_HIGH_LOD_QUEUED
FLAGS_LOW_LOD_QUEUED
FLAGS_COLLISION_LOADING

Definition at line 50 of file ATerrainSection.h.

    {
        FLAGS_HIGH_LOD_LOADED   = BITFLAG( 0 ),
        FLAGS_LOW_LOD_LOADED    = BITFLAG( 1 ),
        FLAGS_HIGH_LOD_LOADING  = BITFLAG( 2 ),
        FLAGS_LOW_LOD_LOADING   = BITFLAG( 3 ),
        FLAGS_HIGH_LOD_QUEUED   = BITFLAG( 4 ),
        FLAGS_LOW_LOD_QUEUED    = BITFLAG( 5 ),
        FLAGS_COLLISION_LOADING = BITFLAG( 10 )
    };

Member Function Documentation

DestroyLOD()

void ATerrainSection::DestroyLOD

(

ATerrainLODType

a_eLODType

)

Definition at line 241 of file ATerrainSection.cpp.

{
    TASSERT( a_eLODType == ATerrainLODType_High || a_eLODType == ATerrainLODType_Low );
 
    auto pTerrain = ATerrainInterface::GetSingleton();
    TINT iNumLODs = GetLODCount( a_eLODType );
 
    for ( TINT i = 0; i < iNumLODs; i++ )
    {
        if ( m_ppLODModelsData[ a_eLODType ][ i ] )
        {
            pTerrain->DestroyModelData( m_ppLODModelsData[ a_eLODType ][ i ] );
            m_ppLODModelsData[ a_eLODType ][ i ] = TNULL;
        }
    }
 
    UnloadMatlib( a_eLODType );
 
    TUINT32 eNewFlags;
 
    if ( a_eLODType == ATerrainLODType_High )
    {
        if ( m_pCollisionModelData && pTerrain->IsCollisionStreamed() )
        {
            pTerrain->DestroyModelData( m_pCollisionModelData );
            m_pCollisionModelData = TNULL;
        }
 
        for ( TUINT i = 0; i < m_iNumHighMemBlocksUsed; i++ )
        {
            auto pBlock = m_ppHighLODBlocks[ i ];
 
            if ( pBlock )
            {
                m_ppHighLODBlocks[ i ] = TNULL;
                pBlock->Assign( TNULL, ATerrainLODType_None );
            }
        }
 
        eNewFlags = m_eFlags & ~( FLAGS_HIGH_LOD_LOADED | FLAGS_HIGH_LOD_LOADING | FLAGS_HIGH_LOD_QUEUED );
    }
    else
    {
        for ( TUINT i = 0; i < m_iNumLowMemBlocksUsed; i++ )
        {
            auto pBlock = m_ppLowLODBlocks[ i ];
 
            if ( pBlock )
            {
                m_ppLowLODBlocks[ i ] = TNULL;
                pBlock->Assign( TNULL, ATerrainLODType_None );
            }
        }
 
        eNewFlags = m_eFlags & ~( FLAGS_LOW_LOD_LOADED | FLAGS_LOW_LOD_LOADING | FLAGS_LOW_LOD_QUEUED );
    }
 
    m_eFlags = eNewFlags;
    SetLODEmpty( a_eLODType, TFALSE );
}

Draw()

void ATerrainSection::Draw

(

ATerrainLODType

a_eLODType

)

Definition at line 23 of file ATerrainSection.cpp.

{
    TASSERT( a_eLODType != ATerrainLODType_None );
 
    if ( a_eLODType == ATerrainLODType_High && IsLODLoaded( ATerrainLODType_High ) )
    {
        // Draw models of the high LOD
        for ( TINT i = 0; i < m_iNumHighModelFiles; i++ )
        {
            m_ppLODModelsData[ ATerrainLODType_High ][ i ]->Render();
        }
    }
    else
    {
        // High LOD is still loading so let's check if we can render low LOD instead
        if ( IsLODLoaded( ATerrainLODType_Low ) )
        {
            // Draw models of the low LOD
            for ( TINT i = 0; i < m_iNumLowModelFiles; i++ )
            {
                m_ppLODModelsData[ ATerrainLODType_Low ][ i ]->Render();
            }
        }
    }
}

GetLODBlocks()

void ATerrainSection::GetLODBlocks ( ATerrainLODType a_eLODType, ATerrainLODBlock **& a_rMemBlocks, TUINT16 & a_rNumMemBlocks )

inline

Definition at line 108 of file ATerrainSection.h.

    {
        if ( a_eLODType == ATerrainLODType_High )
        {
            a_rMemBlocks    = m_ppHighLODBlocks;
            a_rNumMemBlocks = m_iNumHighMemBlocksUsed;
        }
        else
        {
            a_rMemBlocks    = m_ppLowLODBlocks;
            a_rNumMemBlocks = m_iNumLowMemBlocksUsed;
        }
    }

GetLODCount()

TINT ATerrainSection::GetLODCount ( ATerrainLODType a_eLODType )

inline

Definition at line 122 of file ATerrainSection.h.

    {
        return ( a_eLODType == ATerrainLODType_High ) ? m_iNumHighModelFiles : m_iNumLowModelFiles;
    }

GetLODNames()

void ATerrainSection::GetLODNames ( ATerrainLODType a_eLODType, const TCHAR **& a_rLODs, TINT & a_rNumLODs )

inline

Definition at line 94 of file ATerrainSection.h.

    {
        if ( a_eLODType == ATerrainLODType_High )
        {
            a_rLODs    = m_pszHighModelFiles;
            a_rNumLODs = m_iNumHighModelFiles;
        }
        else
        {
            a_rLODs    = m_pszLowModelFiles;
            a_rNumLODs = m_iNumLowModelFiles;
        }
    }

IsLODEmpty()

TBOOL ATerrainSection::IsLODEmpty ( ATerrainLODType a_eLODType ) const

inline

Definition at line 91 of file ATerrainSection.h.

{ return ( m_eFlags & ( 64 << ( a_eLODType & 0x1f ) ) ); }

IsLODLoaded()

TBOOL ATerrainSection::IsLODLoaded ( ATerrainLODType a_eLODType ) const

inline

Definition at line 84 of file ATerrainSection.h.

{ return m_eFlags & ( 1 << ( a_eLODType ) ); }

IsLODLoading()

TBOOL ATerrainSection::IsLODLoading ( ATerrainLODType a_eLODType ) const

inline

Definition at line 87 of file ATerrainSection.h.

{ return m_eFlags & ( 1 << ( a_eLODType + ATerrainLODType_NUMOF ) ); }

IsLODQueued()

TBOOL ATerrainSection::IsLODQueued ( ATerrainLODType a_eLODType ) const

inline

Definition at line 81 of file ATerrainSection.h.

{ return ( m_eFlags & ( 16 << a_eLODType ) ); }

IsMatLibLoaded()

TBOOL ATerrainSection::IsMatLibLoaded

(

ATerrainLODType

a_eLODType

)

const

Definition at line 322 of file ATerrainSection.cpp.

{
    TASSERT( a_eLODType == ATerrainLODType_High || a_eLODType == ATerrainLODType_Low );
 
    if ( a_eLODType == ATerrainLODType_High )
    {
        return m_pMatLibHigh != TNULL;
    }
    else
    {
        return m_pMatLibLow != TNULL;
    }
}

LoadCollision()

void ATerrainSection::LoadCollision

(

)

Definition at line 49 of file ATerrainSection.cpp.

{
    auto pTerrain = ATerrainInterface::GetSingleton();
 
    if ( m_szCollisionFilename[ 0 ] != '\0' )
    {
        auto pBlock = ( !pTerrain->IsCollisionStreamed() ) ?
            pTerrain->GetVIS()->m_pPersistantTerrainBlock :
            m_ppHighLODBlocks[ m_iCollisionMemBlockID ];
 
        m_pCollisionModelData = new ( pBlock->GetMemBlock() ) ModelNode();
 
        auto pTRB = new ( pBlock->GetMemBlock() ) TTRB();
        pBlock->SetupTRB( pTRB, pBlock );
 
        auto pModelLoaderJob = pTerrain->GetFreeModelLoaderJob();
        pModelLoaderJob->InitJob(
            &m_pCollisionModelData->m_ModelRef,
            pTRB,
            m_szCollisionFilename,
            pTerrain->IsCollisionStreamed()
        );
 
        auto pCollisionJob = pTerrain->GetFreeCollisionLoaderJob();
        pCollisionJob->InitJob( this, TFALSE );
 
        AAssetStreaming::GetSingleton()->AddMainThreadJob( pModelLoaderJob );
        AAssetStreaming::GetSingleton()->AddMainThreadJob( pCollisionJob );
        m_eFlags |= FLAGS_COLLISION_LOADING;
    }
}

LoadMatlib()

void ATerrainSection::LoadMatlib

(

ATerrainLODType

a_eLODType

)

Definition at line 164 of file ATerrainSection.cpp.

{
    TASSERT( a_eLODType == ATerrainLODType_High || a_eLODType == ATerrainLODType_Low );
 
    TUINT8             uiAllocAtBlock;
    ATerrainLODBlock** ppBlocks;
 
    if ( a_eLODType == ATerrainLODType_High )
    {
        if ( m_szHighMatLibFilename[ 0 ] == '\0' ) return;
        uiAllocAtBlock = m_iHighMatLibMemBlockID;
        ppBlocks       = m_ppHighLODBlocks;
    }
    else
    {
        if ( m_szLowMatLibFilename[ 0 ] == '\0' ) return;
        uiAllocAtBlock = m_iLowMatLibMemBlockID;
        ppBlocks       = m_ppLowLODBlocks;
    }
 
    auto pBlock     = ppBlocks[ uiAllocAtBlock ];
    auto pMatlibJob = ATerrainInterface::GetSingleton()->GetFreeMatlibLoaderJob();
 
    if ( a_eLODType == ATerrainLODType_High )
    {
        m_pMatLibHighTRB = new ( pBlock->GetMemBlock() ) TTRB();
        pBlock->SetupTRB( m_pMatLibHighTRB, pBlock );
 
        pMatlibJob->InitJob( m_szHighMatLibFilename, m_pMatLibHighTRB, m_pMatLibHigh, pBlock->GetMemBlock() );
    }
    else
    {
        m_pMatLibLowTRB = new ( pBlock->GetMemBlock() ) TTRB();
        pBlock->SetupTRB( m_pMatLibLowTRB, pBlock );
 
        pMatlibJob->InitJob( m_szLowMatLibFilename, m_pMatLibLowTRB, m_pMatLibLow, pBlock->GetMemBlock() );
    }
 
    AAssetStreaming::GetSingleton()->AddMainThreadJob( pMatlibJob );
}

LoadModels()

void ATerrainSection::LoadModels

(

ATerrainLODType

a_eLODType

)

Definition at line 81 of file ATerrainSection.cpp.

{
    TASSERT( a_eLODType == ATerrainLODType_High || a_eLODType == ATerrainLODType_Low );
 
    auto pTerrain = ATerrainInterface::GetSingleton();
 
    if ( !IsLODLoading( a_eLODType ) && !IsLODLoaded( a_eLODType ) )
    {
        const TCHAR** ppLODNames;
        TINT          iNumLODs;
        GetLODNames( a_eLODType, ppLODNames, iNumLODs );
 
        if ( iNumLODs == 0 && m_szCollisionFilename[ 0 ] == '\0' )
        {
            SetLODQueued( a_eLODType, TFALSE );
            SetLODEmpty( a_eLODType, TTRUE );
            SetLODLoaded( a_eLODType, TTRUE );
        }
        else
        {
            ATerrainLODBlock** ppLODBlocks;
            TUINT16            uiNumMemBlocks;
            GetLODBlocks( a_eLODType, ppLODBlocks, uiNumMemBlocks );
 
            TUINT8* pLODToBlock = ( a_eLODType == ATerrainLODType_High ) ? m_pHighLODToBlock : m_pLowLODToBlock;
 
            for ( TINT i = 0; i < uiNumMemBlocks; i++ )
            {
                if ( ppLODBlocks[ i ] == TNULL )
                {
                    ppLODBlocks[ i ] = pTerrain->AllocateLODBlock( a_eLODType, this );
 
                    if ( ppLODBlocks[ i ] == TNULL )
                    {
                        TASSERT( TFALSE, "Couldn't allocated new LOD block!" );
                        return;
                    }
 
                    ppLODBlocks[ i ]->m_bIsUnused = TFALSE;
                }
            }
 
            if ( a_eLODType == ATerrainLODType_High && pTerrain->IsCollisionStreamed() )
            {
                LoadCollision();
            }
 
            LoadMatlib( a_eLODType );
 
            for ( TINT i = 0; i < iNumLODs; i++ )
            {
                if ( m_ppLODModelsData[ a_eLODType ][ i ] == TNULL )
                {
                    auto pBlock     = ppLODBlocks[ pLODToBlock[ i ] ];
                    auto pModelData = new ( pBlock->GetMemBlock() ) ModelNode();
 
                    auto pTRB = new ( pBlock->GetMemBlock() ) TTRB();
                    pBlock->SetupTRB( pTRB, pBlock );
                    m_ppLODModelsData[ a_eLODType ][ i ] = pModelData;
 
                    auto pModelLoaderJob = pTerrain->GetFreeModelLoaderJob();
                    pModelLoaderJob->InitJob(
                        &pModelData->m_ModelRef,
                        pTRB,
                        ppLODNames[ i ],
                        TTRUE
                    );
 
                    AAssetStreaming::GetSingleton()->AddMainThreadJob( pModelLoaderJob );
                }
            }
 
            auto pSectionJob = pTerrain->GetFreeSectionLoaderJob();
            pSectionJob->InitJob( this, a_eLODType );
 
            AAssetStreaming::GetSingleton()->AddMainThreadJob( pSectionJob );
 
            SetLODQueued( a_eLODType, TFALSE );
            SetLODLoading( a_eLODType, TTRUE );
        }
    }
}

RemoveFromStreamingQueue()

void ATerrainSection::RemoveFromStreamingQueue

(

)

Definition at line 302 of file ATerrainSection.cpp.

{
    for ( TINT i = 0; i < ATerrainLODType_NUMOF; i++ )
    {
        if ( IsLODQueued( i ) )
        {
            ATerrainLODBlock** ppLODBlocks;
            TUINT16            uiNumLODBlocks;
            GetLODBlocks( i, ppLODBlocks, uiNumLODBlocks );
 
            for ( TINT k = 0; k < uiNumLODBlocks; k++ )
            {
                ppLODBlocks[ k ]->Assign( TNULL, ATerrainLODType_None );
            }
 
            SetLODQueued( i, TFALSE );
        }
    }
}

SetLODEmpty()

void ATerrainSection::SetLODEmpty	(	ATerrainLODType	a_eLODType,
		TBOOL	a_bEmpty )

Definition at line 378 of file ATerrainSection.cpp.

{
    TASSERT( a_eLODType == ATerrainLODType_High || a_eLODType == ATerrainLODType_Low );
 
    if ( a_bEmpty )
    {
        m_eFlags |= ( 64 << a_eLODType );
    }
    else
    {
        m_eFlags &= ~( 64 << a_eLODType );
    }
}

SetLODLoaded()

void ATerrainSection::SetLODLoaded	(	ATerrainLODType	a_eLODType,
		TBOOL	a_bLoaded )

Definition at line 350 of file ATerrainSection.cpp.

{
    TASSERT( a_eLODType == ATerrainLODType_High || a_eLODType == ATerrainLODType_Low );
 
    if ( a_bLoaded )
    {
        m_eFlags |= ( 1 << ( a_eLODType ) );
    }
    else
    {
        m_eFlags &= ~( 1 << ( a_eLODType ) );
    }
}

SetLODLoading()

void ATerrainSection::SetLODLoading	(	ATerrainLODType	a_eLODType,
		TBOOL	a_bLoading )

Definition at line 364 of file ATerrainSection.cpp.

{
    TASSERT( a_eLODType == ATerrainLODType_High || a_eLODType == ATerrainLODType_Low );
 
    if ( a_bLoading )
    {
        m_eFlags |= ( 1 << ( a_eLODType + ATerrainLODType_NUMOF ) );
    }
    else
    {
        m_eFlags &= ~( 1 << ( a_eLODType + ATerrainLODType_NUMOF ) );
    }
}

SetLODQueued()

void ATerrainSection::SetLODQueued	(	ATerrainLODType	a_eLODType,
		TBOOL	a_bQueued )

Definition at line 336 of file ATerrainSection.cpp.

{
    TASSERT( a_eLODType == ATerrainLODType_High || a_eLODType == ATerrainLODType_Low );
 
    if ( a_bQueued )
    {
        m_eFlags |= ( 16 << a_eLODType );
    }
    else
    {
        m_eFlags &= ~( 16 << a_eLODType );
    }
}

UnloadMatlib()

void ATerrainSection::UnloadMatlib

(

ATerrainLODType

a_eLODType

)

Definition at line 205 of file ATerrainSection.cpp.

{
    TASSERT( a_eLODType == ATerrainLODType_High || a_eLODType == ATerrainLODType_Low );
 
    if ( a_eLODType == ATerrainLODType_High )
    {
        if ( m_pMatLibHigh )
        {
            AMaterialLibraryManager::GetSingleton()->UnloadTexturesOfLibrary( m_pMatLibHigh );
            m_pMatLibHigh->Destroy();
            m_pMatLibHigh = TNULL;
        }
 
        if ( m_pMatLibHighTRB )
        {
            delete m_pMatLibHighTRB;
            m_pMatLibHighTRB = TNULL;
        }
    }
    else
    {
        if ( m_pMatLibLow )
        {
            AMaterialLibraryManager::GetSingleton()->UnloadTexturesOfLibrary( m_pMatLibLow );
            m_pMatLibLow->Destroy();
            m_pMatLibLow = TNULL;
        }
 
        if ( m_pMatLibLowTRB )
        {
            delete m_pMatLibLowTRB;
            m_pMatLibLowTRB = TNULL;
        }
    }
}

Friends And Related Symbol Documentation

ACollisionDoneJob

friend class ACollisionDoneJob

friend

Definition at line 63 of file ATerrainSection.h.

ASectionDoneJob

friend class ASectionDoneJob

friend

Definition at line 62 of file ATerrainSection.h.

ATerrainInterface

friend class ATerrainInterface

friend

Definition at line 61 of file ATerrainSection.h.

---

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

• D:/_dev/OpenBarnyard/Source/OpenBarnyard/Source/Terrain/ATerrainSection.h
• D:/_dev/OpenBarnyard/Source/OpenBarnyard/Source/Terrain/ATerrainSection.cpp