SceneGraph.hh

/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *      Copyright (C) 2001-2009 by Computer Graphics Group, RWTH Aachen      *
 *                           www.openflipper.org                             *
 *                                                                           *
 *---------------------------------------------------------------------------*
 *  This file is part of OpenFlipper.                                        *
 *                                                                           *
 *  OpenFlipper is free software: you can redistribute it and/or modify      *
 *  it under the terms of the GNU Lesser General Public License as           *
 *  published by the Free Software Foundation, either version 3 of           *
 *  the License, or (at your option) any later version with the              *
 *  following exceptions:                                                    *
 *                                                                           *
 *  If other files instantiate templates or use macros                       *
 *  or inline functions from this file, or you compile this file and         *
 *  link it with other files to produce an executable, this file does        *
 *  not by itself cause the resulting executable to be covered by the        *
 *  GNU Lesser General Public License. This exception does not however       *
 *  invalidate any other reasons why the executable file might be            *
 *  covered by the GNU Lesser General Public License.                        *
 *                                                                           *
 *  OpenFlipper is distributed in the hope that it will be useful,           *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *
 *  GNU Lesser General Public License for more details.                      *
 *                                                                           *
 *  You should have received a copy of the GNU LesserGeneral Public          *
 *  License along with OpenFlipper. If not,                                  *
 *  see <http://www.gnu.org/licenses/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
 *   $Revision: 8548 $                                                       *
 *   $Author: moebius $                                                      *
 *   $Date: 2010-02-12 14:40:13 +0100 (Fr, 12. Feb 2010) $                   *
 *                                                                           *
\*===========================================================================*/




//=============================================================================
//
//  CLASS SceneGraph
//
//=============================================================================

#ifndef ACG_SCENEGRAPH_HH
#define ACG_SCENEGRAPH_HH


//== INCLUDES =================================================================

#include "BaseNode.hh"
#include "DrawModes.hh"
#include "../GL/gl.hh"
#include "../Math/VectorT.hh"
#include <float.h>

#include <QMouseEvent>

//== NAMESPACES ===============================================================

namespace ACG {
namespace SceneGraph {


//== CLASS DEFINITION =========================================================

template<bool C, typename T = void>
struct enable_if {
  typedef T type;
};

template<typename T>
struct enable_if<false, T> { };

#define HAS_MEM_FUNC(func) \
    template<typename T, typename Sign>                                               \
    struct has_##func {                                                               \
        template <typename U, U> struct type_check;                                   \
        template <typename _1> static char (& chk(type_check<Sign, &_1::func> *))[1]; \
        template <typename   > static char (& chk(...))[2];                           \
        static bool const value = sizeof(chk<T>(0)) == 1;                             \
    };

HAS_MEM_FUNC(enter)

// if the enter function is implemented
template<typename Action>
typename enable_if<has_enter <Action, void (Action::*) (BaseNode *) >::value, void>::type
if_has_enter(Action &_action, BaseNode *_node) {
  _action.enter (_node);
}

// if the enter function isn't implemented
template<typename Action>
typename enable_if<!has_enter <Action, void (Action::*) (BaseNode *) >::value, void>::type
if_has_enter(Action &, BaseNode *) {
}

HAS_MEM_FUNC(leave)

// if the enter function is implemented
template<typename Action>
typename enable_if<has_leave <Action, void (Action::*) (BaseNode *) >::value, void>::type
if_has_leave(Action &_action, BaseNode *_node) {
  _action.leave (_node);
}

// if the enter function isn't implemented
template<typename Action>
typename enable_if<!has_enter <Action, void (Action::*) (BaseNode *) >::value, void>::type
if_has_leave(Action &, BaseNode *) {
}

//----------------------------------------------------------------------------


template <class Action>
void
traverse( BaseNode* _node, Action& _action )
{
  if (_node)
  {
    BaseNode::StatusMode status(_node->status());
    bool process_children(status != BaseNode::HideChildren);

    // If the subtree is hidden, ignore this node and its children while rendering
    if (status != BaseNode::HideSubtree)
    {

      // If the node itself is hidden, ignore it but continue with its children
      if (_node->status() != BaseNode::HideNode)
      {
        // Executes this nodes enter function (if available)
        if_has_enter (_action, _node);

        // Test rendering order. If NodeFirst, execute this node and the children later.
        if (_node->traverseMode() & BaseNode::NodeFirst)
          process_children &= _action(_node);
      }

      if (process_children)
      {

        BaseNode::ChildIter cIt, cEnd(_node->childrenEnd());

        // Process all children which are not second pass
        for (cIt = _node->childrenBegin(); cIt != cEnd; ++cIt)
          if (~(*cIt)->traverseMode() & BaseNode::SecondPass)
            traverse(*cIt, _action);

        // Process all children which are second pass
        for (cIt = _node->childrenBegin(); cIt != cEnd; ++cIt)
          if ((*cIt)->traverseMode() & BaseNode::SecondPass)
            traverse(*cIt, _action);

      }

      // If the node is not hidden
      if (_node->status() != BaseNode::HideNode)
      {

        // If the children had to be rendered first, we now render the node afterwards
        if (_node->traverseMode() & BaseNode::ChildrenFirst)
          _action(_node);

        // Call the leave function of the node.
        if_has_leave (_action, _node);
      }

    }
  }
}

//---------------------------------------------------------------------------------

template <class Action>
void
traverse_multipass ( BaseNode* _node, Action& _action, const unsigned int& _pass )
{
    // Process node if it exists
    if (_node) {
        BaseNode::StatusMode status(_node->status());
        bool process_children(status != BaseNode::HideChildren);

        // If the subtree is hidden, ignore this node and its children while rendering
        if (status != BaseNode::HideSubtree) {

            // Executes this nodes enter function (if available and active in multipass)
            if ( _node->multipassStatusActive(_pass) )
              if_has_enter(_action, _node);

            // If the node itself is hidden, don't call the action on it.
            // Additionally check if rendering order is node first. otherwise, we will call it after the children.
            // And check if it should be called in this rendering pass.
            if ( (_node->status() != BaseNode::HideNode )  && ( _node->traverseMode() & BaseNode::NodeFirst ) && _node->multipassNodeActive(_pass))
                process_children &= _action(_node);

            if (process_children) {

                BaseNode::ChildIter cIt, cEnd(_node->childrenEnd());

                // Process all children
                for (cIt = _node->childrenBegin(); cIt != cEnd; ++cIt)
                    if (~(*cIt)->traverseMode() & BaseNode::SecondPass)
                        traverse_multipass(*cIt, _action, _pass);

                // Process all children which are second pass
                for (cIt = _node->childrenBegin(); cIt != cEnd; ++cIt)
                    if ((*cIt)->traverseMode() & BaseNode::SecondPass)
                        traverse_multipass(*cIt, _action, _pass);

            }

            
            // If we are in childrenfirst node, the children have been painted andwe now check, if we can draw this node.
            // If its hidden, ignore it.
            // If it should not be rendered in this pass, ignore it too.
            if ( (_node->traverseMode() & BaseNode::ChildrenFirst ) && (_node->status() != BaseNode::HideNode) && _node->multipassNodeActive(_pass) )
                _action(_node);

            // Call the leave function of the node (if available and active in multipass).
            if ( _node->multipassStatusActive(_pass) )
              if_has_leave(_action, _node);

        } // if (status != BaseNode::HideSubtree)
    } // if(node_)
}

//----------------------------------------------------------------------------

template <class Action>
class MetaAction
{
  public:
    MetaAction (Action & _action, GLState& _state, DrawModes::DrawMode _drawMode) :
      action_(_action),
      state_(_state),
      drawMode_(_drawMode)
    {
    }

    bool operator()(BaseNode* _node)
    {
      return action_(_node, state_);
    }

    void enter (BaseNode *_node)
    {
      if ( _node->drawMode() == DrawModes::DEFAULT )
        _node->enter(state_, drawMode_);  
      else
        _node->enter(state_,  _node->drawMode());
    }

    void leave (BaseNode *_node)
    {
      if ( _node->drawMode() == DrawModes::DEFAULT )
        _node->leave(state_, drawMode_);  
      else
        _node->leave(state_,  _node->drawMode());
    }

  private:
    Action  &action_;
    GLState &state_;
    DrawModes::DrawMode drawMode_;

};

//----------------------------------------------------------------------------

template <class Action>
void
traverse( BaseNode*           _node,
          Action&             _action,
          GLState&            _state,
          DrawModes::DrawMode _drawmode=DrawModes::DEFAULT)
{
    MetaAction<Action> action (_action, _state, _drawmode);
    traverse(_node, action);
}

//----------------------------------------------------------------------------

template <class Action>
void
traverse_multipass( BaseNode*           _node,
                    Action&             _action,
                    GLState&            _state,
                    DrawModes::DrawMode _drawmode=DrawModes::DEFAULT)
{
    MetaAction<Action> action (_action, _state, _drawmode);

    // Reset render pass counter
    _state.reset_render_pass();

    // Get max render passes
    unsigned int max_passes = _state.max_render_passes();

    // Render all passes
    for(unsigned int pass = BaseNode::PASS_1; pass <= (BaseNode::PASS_1 + max_passes); ++pass) {

        // Traverse scenegraph
        traverse_multipass (_node, action, pass);
        // Increment render pass counter by 1
        _state.next_render_pass();
    }

    // Reset render pass counter
    _state.reset_render_pass();
}

//--------------------------------------------------------------------------------

class BoundingBoxAction
{
public:

  BoundingBoxAction() :
    bbMin_( FLT_MAX,  FLT_MAX,  FLT_MAX),
    bbMax_(-FLT_MAX, -FLT_MAX, -FLT_MAX),
    state_(false)
  { }

  bool operator()(BaseNode* _node)
  {
    Vec3d bbMin( FLT_MAX,  FLT_MAX,  FLT_MAX);
    Vec3d bbMax(-FLT_MAX, -FLT_MAX, -FLT_MAX);
    _node->boundingBox(bbMin, bbMax);

    if ((bbMin[0] > bbMax[0]) ||
        (bbMin[1] > bbMax[1]) ||
        (bbMin[2] > bbMax[2]))
      return true;

    bbMin_.minimize(state_.modelview().transform_point (bbMin));
    bbMin_.minimize(state_.modelview().transform_point (bbMax));
    bbMax_.maximize(state_.modelview().transform_point (bbMin));
    bbMax_.maximize(state_.modelview().transform_point (bbMax));
    return true;
  }

  void enter (BaseNode *_node)
  {
    _node->enter(state_, DrawModes::DEFAULT);
  }

  void leave (BaseNode *_node)
  {
    _node->leave(state_, DrawModes::DEFAULT);
  }

  const Vec3d& bbMin() const { return bbMin_; }
  const Vec3d& bbMax() const { return bbMax_; }

private:

  Vec3d        bbMin_, bbMax_;
  GLState      state_;
};


//-----------------------------------------------------------------------------


class MultiPassInfoAction
{
public:

  MultiPassInfoAction() :
    statusPasses_(BaseNode::ALLPASSES),
    nodePasses_(BaseNode::ALLPASSES)
  {}

  bool operator()(BaseNode* _node) {

      // Get status pass 
      BaseNode::MultipassBitMask statusPass = _node->multipassStatus();

      // Ignore if set to ALLPASSES as we want to get the real maximum pass number
      if ( statusPass != BaseNode::ALLPASSES) {
        // Convert render pass bit mask to
        // decimal value (0x001011 -> 4)
        // Note: Same as (int)log2(bitmask)
        unsigned int c = 0;
        
        // Skip the first one as this is the ALLPASSES flag
        statusPass = statusPass >> 1;
        
        while( statusPass != 0u ) {
          statusPass = statusPass >> 1;
          ++c;
        }
        statusPasses_ = c > statusPasses_ ? c : statusPasses_;
      }
      
      
      // Get Node pass 
      BaseNode::MultipassBitMask nodePass = _node->multipassNode();
      
      // Ignore if set to ALLPASSES as we want to get the real maximum pass number
      if ( nodePass != BaseNode::ALLPASSES) {
        // Convert render pass bit mask to
        // decimal value (0x001011 -> 4)
        // Note: Same as (int)log2(bitmask)
        unsigned int c = 0;
        
        // Skip the first one as this is the ALLPASSES flag
        nodePass = nodePass >> 1;
        
        while(nodePass != 0u) {
          nodePass = nodePass >> 1;
          ++c;
        }
        nodePasses_ = c > nodePasses_ ? c : nodePasses_;
      }

      return true;
  }

  unsigned int getMaxPasses() const { 
    unsigned int maxpasses = std::max(statusPasses_,nodePasses_);
    
    // if maxpasses is 0 we have all nodes in ALLPASSES mode so we render only once
    return maxpasses == 0 ? 1 : maxpasses; 
  }

  unsigned int getStatusPasses() { return statusPasses_ == 0 ? 1 : statusPasses_; };
  
  unsigned int getNodePasses() { return nodePasses_ == 0 ? 1 : nodePasses_; };

private:

  unsigned int statusPasses_;
  unsigned int nodePasses_;
  
};


//----------------------------------------------------------------------------


class FindNodeAction
{
public:

  FindNodeAction(unsigned int _node_id) :
    node_id_(_node_id), node_ptr_(0)  {}

  bool operator()(BaseNode* _node)
  {
    if (_node->id() == node_id_)
    {
      node_ptr_ = _node;
      return false;
    }
    return true;
  }

  BaseNode*  node_ptr() { return node_ptr_; }

private:

  unsigned int  node_id_;
  BaseNode*     node_ptr_;
};


ACGDLLEXPORT
BaseNode* find_node( BaseNode* _root, unsigned int _node_idx );


//----------------------------------------------------------------------------


class CollectDrawModesAction
{
public:

  CollectDrawModesAction() : drawModes_(DrawModes::NONE) {}

  bool operator()(BaseNode* _node)
  {
    drawModes_ |= _node->availableDrawModes();
    return true;
  }

  DrawModes::DrawMode drawModes() const { return drawModes_; }

private:

  DrawModes::DrawMode drawModes_;
};

//----------------------------------------------------------------------------


class CollectActiveDrawModesAction
{
public:

  CollectActiveDrawModesAction() : drawMode_(DrawModes::NONE) {}

  bool operator()(BaseNode* _node)
  {
    drawMode_ |= _node->drawMode();
    return true;
  }

  DrawModes::DrawMode drawMode() const { return drawMode_; }

private:

  DrawModes::DrawMode drawMode_;
};

//----------------------------------------------------------------------------


class SetDrawModesAction
{
public:

  SetDrawModesAction(DrawModes::DrawMode _mode) : newModes_(_mode) {}

  bool operator()(BaseNode* _node)
  {
    if ( newModes_ == DrawModes::DEFAULT )
      _node->drawMode( DrawModes::DEFAULT );

    DrawModes::DrawMode availableModes = _node->availableDrawModes();

    if ( availableModes & newModes_ )
      _node->drawMode( availableModes & newModes_ );
    else
      _node->drawMode( DrawModes::DEFAULT );

    return true;
  }

private:
  DrawModes::DrawMode newModes_;
};


//----------------------------------------------------------------------------


class DrawAction
{
public:

  DrawAction(DrawModes::DrawMode _drawMode, bool _blending)
    : drawMode_(_drawMode), blending_(_blending) {}

  bool operator()(BaseNode* _node, GLState& _state)
  {
    // draw only if Material status == DrawAction status
    if(_state.blending() == blending_)
    {
      _node->setDirty (false);
      if (_node->drawMode() == DrawModes::DEFAULT)
        _node->draw(_state, drawMode_);
      else
        _node->draw(_state, _node->drawMode());
    }
    return true;
  }

private:

  DrawModes::DrawMode drawMode_;
  bool                blending_;
};


//----------------------------------------------------------------------------


class ACGDLLEXPORT PickAction
{
public:

  PickAction(GLState &_state, PickTarget _target, DrawModes::DrawMode _drawmode) :
    state_(_state),
    pickTarget_(_target),
    drawmode_(_drawmode) {}

  bool operator()(BaseNode* _node);
  
  bool operator()(BaseNode* _node, GLState& _state);

  void enter(BaseNode* _node)
  {
    if (_node->drawMode() == DrawModes::DEFAULT)
        _node->enterPick(state_, pickTarget_, drawmode_);
      else
        _node->enterPick(state_, pickTarget_, _node->drawMode());
  }

  void leave(BaseNode* _node)
  {
    if (_node->drawMode() == DrawModes::DEFAULT)
        _node->leavePick(state_, pickTarget_, drawmode_);
      else
        _node->leavePick(state_, pickTarget_, _node->drawMode());
  }

private:

  GLState             &state_;
  PickTarget          pickTarget_;
  DrawModes::DrawMode drawmode_;
};


//----------------------------------------------------------------------------


class MouseEventAction
{
public:


  MouseEventAction(QMouseEvent* _event) : event_(_event) {}

  bool operator()(BaseNode* _node, GLState& _state)
  {
    _node->mouseEvent(_state, event_);
    return true;
  }

private:

  QMouseEvent* event_;
};

//----------------------------------------------------------------------------


class CheckDirtyAction
{
public:


  CheckDirtyAction() : dirty_(false) {}

  bool operator()(BaseNode* _node)
  {
    dirty_ |= _node->isDirty();
    // don't traverse children if current node is _dirty
    return !dirty_;
  }

  bool isDirty() const { return dirty_; };

private:

  bool dirty_;
};


//=============================================================================
} // namespace SceneGraph
} // namespace ACG
//=============================================================================
#endif // ACG_SCENEGRAPH_HH defined
//=============================================================================