SoOverlayGroup.h

/*=======================================================================
*** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
***                                                                                ***
***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
***                                                                                ***
***                        RESTRICTED RIGHTS LEGEND                                ***
***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
***                                                                                ***
***                   COPYRIGHT (C) 1996-2024 BY FEI S.A.S,                        ***
***                        BORDEAUX, FRANCE                                        ***
***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
 
#pragma once
 
#include <Inventor/nodes/SoGroup.h>
#include <Inventor/nodes/SoSeparator.h>
#include <Inventor/nodes/SoTexture2.h>
#include <Inventor/nodes/SoCallback.h>
#include <Inventor/nodes/SoShaderProgram.h>
#include <Inventor/nodes/SoSwitch.h>
 
class  SoOverlayGroup : public SoGroup
{
  SO_NODE_HEADER( SoOverlayGroup );
 
public:
  SoOverlayGroup();
 
private:
  void doAction( SoAction* action ) override;
  void callback( SoCallbackAction* action ) override;
  void GLRender( SoGLRenderAction* action ) override;
  void getBoundingBox( SoGetBoundingBoxAction* action ) override;
  void getMatrix( SoGetMatrixAction* action ) override;
  void handleEvent( SoHandleEventAction* action ) override;
  void pick( SoPickAction* action ) override;
  void search( SoSearchAction* action ) override;
  void write( SoWriteAction* action ) override;
  void getPrimitiveCount( SoGetPrimitiveCountAction* action ) override;
 
private:
 
  // Specifies whether SoOverlayGroup behavior is enabled or disabled.
  // If disabled, the SoOverlayGroup behaves like an SoGroup.
  // Default is true.
  SoSFBool enabled;
 
  static void initClass();
  static void exitClass();
 
  void addChild( SoNode* child ) override;
  void insertChild( SoNode* child, int newChildIndex ) override;
  SoNode* getChild( int index ) const override;
  int findChild( const SoNode* child ) const override;
  int getNumChildren() const override;
  void removeChild( int index ) override;
  void removeChild( SoNode* child ) override;
  void removeAllChildren() override;
  void replaceChild( int index, SoNode* newChild ) override;
  void replaceChild( SoNode* oldChild, SoNode* newChild ) override;
  SbBool affectsState() const override;
 
  void fieldHasChanged( SoField* field ) override;
 
private:
  ~SoOverlayGroup() override;
  SoNode* buildSceneGraph( SoState* state );
 
private:
 
  SoRef<SoGroup> m_publicChildren;
 
  SoRef<SoSeparator> m_rttScene;
  SoRef<SoSeparator> m_rttRenderTriangle;
 
  std::vector<SoCallback*> m_callbackNodes;
  SoRef<SoCallback> m_updateElementsCallback;
  SoRef<SoCallback> m_rttSetupElementsCallback;
 
  SoRef<SoTexture2> m_depthTexture;
  SoRef<SoTexture2> m_colorTexture;
 
  SoRef<SoShaderProgram> m_shaderProg;
 
  SoRef<SoSwitch> m_useRTTSwitch;
 
  bool m_isTraversed;
};