GeometryStage.hpp

Go to the documentation of this file.

/*
 *  Copyright (C) 2010 - 2016 Leonid Kostrykin
 *
 *  Chair of Medical Engineering (mediTEC)
 *  RWTH Aachen University
 *  Pauwelsstr. 20
 *  52074 Aachen
 *  Germany
 * 
 * 
 *  Copyright (C) 2021 - 2025 Leonid Kostrykin
 * 
 */
 
#ifndef GEOMETRYSTAGE_H_6014714286
#define GEOMETRYSTAGE_H_6014714286
 
#include <LibCarna/base/FrameRenderer.hpp>
#include <LibCarna/base/RenderStage.hpp>
#include <LibCarna/base/RenderQueue.hpp>
#include <LibCarna/base/GeometryFeature.hpp>
#include <LibCarna/base/math.hpp>
#include <memory>
#include <map>
 
namespace LibCarna
{
 
namespace base
{
 
 
 
// ----------------------------------------------------------------------------------
// GeometryStage
// ----------------------------------------------------------------------------------
 
template< typename RenderableCompare >
class GeometryStage : public RenderStage
{
 
    typedef GeometryFeature::ManagedInterface VideoResource;
 
    Node* root;
    std::size_t passesRendered;
    std::map< GeometryFeature*, VideoResource* > acquiredFeatures;
 
protected:
 
    RenderQueue< RenderableCompare > rq;
 
public:
 
    GeometryStage
        ( unsigned int geometryType
        , unsigned int geometryTypeMask = RenderQueue< RenderableCompare >::EXACT_MATCH_GEOMETRY_TYPE_MASK );
        
    const unsigned int geometryType;     
    const unsigned int geometryTypeMask; 
 
    virtual ~GeometryStage();
 
    virtual void prepareFrame( Node& root ) override;
 
    virtual void renderPass( const math::Matrix4f& viewTransform, RenderTask& rt, const Viewport& vp ) override;
 
    std::size_t renderedPassesCount() const;
    
    template< typename GeometryFeatureType >
    typename GeometryFeatureType::ManagedInterface& videoResource( GeometryFeatureType& geometryFeature ) const;
    
    template< typename GeometryFeatureType >
    const typename GeometryFeatureType::ManagedInterface& videoResource( const GeometryFeatureType& geometryFeature ) const;
 
protected:
 
    void activateGLContext() const;
    
    virtual void buildRenderQueues( Node& root, const math::Matrix4f& viewTransform );
 
    virtual void rewindRenderQueues();
 
    virtual void updateRenderQueues( const math::Matrix4f& viewTransform );
 
    virtual void render( const Renderable& renderable ) = 0;
 
}; // GeometryStage
 
 
template< typename RenderableCompare >
GeometryStage< RenderableCompare >::GeometryStage( unsigned int geometryType, unsigned int geometryTypeMask )
    : root( nullptr )
    , passesRendered( 0 )
    , rq( geometryType, geometryTypeMask )
    , geometryType( geometryType )
    , geometryTypeMask( geometryTypeMask )
{
}
 
 
template< typename RenderableCompare >
GeometryStage< RenderableCompare >::~GeometryStage()
{
    activateGLContext();
    std::for_each( acquiredFeatures.begin(), acquiredFeatures.end(),
        [&]( const std::pair< GeometryFeature*, VideoResource* >& entry )
        {
            if( entry.second != nullptr )
            {
                delete entry.second;
            }
        }
    );
}
 
 
template< typename RenderableCompare >
void GeometryStage< RenderableCompare >::activateGLContext() const
{
    if( isInitialized() )
    {
        renderer().glContext().makeCurrent();
    }
}
 
 
template< typename RenderableCompare >
void GeometryStage< RenderableCompare >::prepareFrame( Node& root )
{
    RenderStage::prepareFrame( root );
    this->root = &root;
    this->passesRendered = 0;
}
 
 
template< typename RenderableCompare >
std::size_t GeometryStage< RenderableCompare >::renderedPassesCount() const
{
    return passesRendered;
}
 
 
template< typename RenderableCompare >
void GeometryStage< RenderableCompare >::buildRenderQueues( Node& root, const math::Matrix4f& viewTransform )
{
    rq.build( root, viewTransform );
}
 
 
template< typename RenderableCompare >
void GeometryStage< RenderableCompare >::rewindRenderQueues()
{
    rq.rewind();
}
 
 
template< typename RenderableCompare >
void GeometryStage< RenderableCompare >::updateRenderQueues( const math::Matrix4f& viewTransform )
{
    rq.updateModelViewTransforms( viewTransform );
}
 
 
template< typename RenderableCompare >
void GeometryStage< RenderableCompare >::renderPass( const math::Matrix4f& viewTransform, RenderTask& rt, const Viewport& vp )
{
    const bool isFirstPass = passesRendered == 0;
    
    /* Maintain the render queues.
     */
    if( isFirstPass )
    {
        buildRenderQueues( *root, viewTransform );
    }
    else
    {
        rewindRenderQueues();
        if( isViewTransformFixed() )
        {
            updateRenderQueues( viewTransform );
        }
    }
 
    std::set< GeometryFeature* > usedFeatures;
    while( !rq.isEmpty() )
    {
        const Renderable& renderable = rq.poll();
        if( isFirstPass )
        {
            renderable.geometry().visitFeatures( [&]( GeometryFeature& gf, unsigned int role )
                {
                    /* Denote that the geometry feature was used.
                     */
                    usedFeatures.insert( &gf );
 
                    /* Check whether video resources need to be acquired.
                     */
                    if( acquiredFeatures.find( &gf ) == acquiredFeatures.end() )
                    {
                        VideoResource* const vr = gf.acquireVideoResource();
                        acquiredFeatures[ &gf ] = vr;
                    }
                }
            );
        }
        render( renderable );
    }
    if( isFirstPass )
    {
        /* Release unused video resources.
         */
        for( auto itr = acquiredFeatures.begin(); itr != acquiredFeatures.end(); )
        {
            if( usedFeatures.find( itr->first ) == usedFeatures.end() )
            {
                if( itr->second != nullptr )
                {
                    delete itr->second;
                }
                acquiredFeatures.erase( itr++ );
            }
            else
            {
                ++itr;
            }
        }
    }
}
 
 
template< typename RenderableCompare >
template< typename GeometryFeatureType >
typename GeometryFeatureType::ManagedInterface& GeometryStage< RenderableCompare >
    ::videoResource( GeometryFeatureType& gf ) const
{
    const auto itr = acquiredFeatures.find( &gf );
    LIBCARNA_ASSERT( itr != acquiredFeatures.end() );
    return static_cast< typename GeometryFeatureType::ManagedInterface& >( *itr->second );
}
 
 
template< typename RenderableCompare >
template< typename GeometryFeatureType >
const typename GeometryFeatureType::ManagedInterface& GeometryStage< RenderableCompare >
    ::videoResource( const GeometryFeatureType& gf ) const
{
    return videoResource( const_cast< GeometryFeatureType& >( gf ) );
}
 
 
 
}  // namespace LibCarna :: base
 
}  // namespace LibCarna
 
#endif // GEOMETRYSTAGE_H_6014714286