Line data    Source code

       1             : 
       2             : /* Copyright (c) 2008-2013, Stefan Eilemann <eile@equalizergraphics.com>
       3             :  *
       4             :  * This library is free software; you can redistribute it and/or modify it under
       5             :  * the terms of the GNU Lesser General Public License version 2.1 as published
       6             :  * by the Free Software Foundation.
       7             :  *
       8             :  * This library is distributed in the hope that it will be useful, but WITHOUT
       9             :  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
      10             :  * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
      11             :  * details.
      12             :  *
      13             :  * You should have received a copy of the GNU Lesser General Public License
      14             :  * along with this library; if not, write to the Free Software Foundation, Inc.,
      15             :  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
      16             :  */
      17             : 
      18             : #ifndef EQSERVER_COMPOUND_LISTENER_H
      19             : #define EQSERVER_COMPOUND_LISTENER_H
      20             : 
      21             : #include "types.h"
      22             : 
      23             : namespace eq
      24             : {
      25             : namespace server
      26             : {
      27             : /** A listener on various compound operations. */
      28         184 : class CompoundListener
      29             : {
      30             : public:
      31         184 :     virtual ~CompoundListener(){}
      32             : 
      33             :     /**
      34             :      * Notify that the compound tree below and including compound is about
      35             :      * to be updated.
      36             :      *
      37             :      * Called on each compound of the tree during update.
      38             :      *
      39             :      * @param compound the root compound of the tree to be updated.
      40             :      * @param frameNumber the new frame number.
      41             :      */
      42           0 :     virtual void notifyUpdatePre( Compound* compound LB_UNUSED,
      43           0 :                                   const uint32_t frameNumber LB_UNUSED ) {}
      44             : 
      45             :     /**
      46             :      * Notify that the compound has a new child.
      47             :      *
      48             :      * @param compound the parent compound.
      49             :      * @param child the child compound.
      50             :      */
      51           0 :     virtual void notifyChildAdded( Compound* compound LB_UNUSED,
      52           0 :                                    Compound* child LB_UNUSED ){}
      53             : 
      54             :     /**
      55             :      * Notify that the compound is about to remove a child.
      56             :      *
      57             :      * @param compound the parent compound.
      58             :      * @param child the child compound.
      59             :      */
      60           0 :     virtual void notifyChildRemove( Compound* compound LB_UNUSED,
      61           0 :                                     Compound* child LB_UNUSED ){}
      62             : };
      63             : }
      64             : }
      65             : #endif // EQSERVER_COMPOUND_LISTENER_H