SoProgressIndicator.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-2019 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
#pragma once
 
#include <Inventor/SbEventArg.h>
#include <Inventor/SbEventHandler.h>
 
class  SoProgressIndicator
{
 
public:
  SoProgressIndicator() {};
 
  virtual ~SoProgressIndicator() {};
 
  struct  TaskEventArg : public SbEventArg
  {
    TaskEventArg(SoNode* src, const SbString& eventName, unsigned int numTasks, unsigned int numTasksDone, unsigned int numSubTasks );
    ~TaskEventArg();
 
    SoNode* getSource() const;
 
    const SbString& getEventName() const;
 
    /* @return number of tasks that will be done by the SoNode. */
    unsigned int getNumTasks() const;
 
    /* @return total number of tasks done since the beginning. */
    unsigned int getNumTasksDone() const;
 
    /* @return number of subtasks that will be executed during this task. */
    unsigned int getNumSubTasks() const;
 
  private:
    unsigned int m_numTasksDone;
 
  private:
    SoNode* m_src;
    SbString* m_eventName; // unique
    unsigned int m_numTasks;
    unsigned int m_numSubTasks;
  };
 
  struct  SubTaskEventArg : public SbEventArg
  {
    SubTaskEventArg(SoNode* src, const SbString& eventName, unsigned int numSubTasks, unsigned int numSubTasksDone, unsigned int numSteps);
 
    ~SubTaskEventArg();
 
    SoNode* getSource() const;
 
    const SbString& getEventName() const;
 
    /* @return number of subtask that will be done by the parent task. */
    unsigned int getNumSubTasks() const;
 
    /* @return total number of subtasks done since task beginning. */
    unsigned int getNumSubTasksDone() const;
 
    /* @return number of steps(iterations) that will be executed during this subtask. */
    unsigned int getNumSteps() const;
 
  private:
    unsigned int m_numSubTasksDone;
 
  private:
    SoNode* m_src;
    SbString* m_eventName; // unique
    unsigned int m_numSubTasks;
    unsigned int m_numSteps;
  };
 
  struct  StepEventArg : public SbEventArg
  {
    StepEventArg(SoNode* src, const SbString& eventName, unsigned int numSteps, unsigned int numStepsDone);
 
    ~StepEventArg();
 
    SoNode* getSource() const;
 
    const SbString& getEventName() const;
 
    /* @return number of steps that will be done by the parent subtask. */
    unsigned int getNumSteps() const;
 
    /* @return total number of steps(iterations) done since subtask beginning. */
    unsigned int getNumStepsDone() const;
 
  private:
    unsigned int m_numStepsDone;
 
  private:
    SoNode* m_src;
    SbString* m_eventName; // unique
    unsigned int m_numSteps;
  };
 
  SbEventHandler<TaskEventArg&> onBeginTask;
 
  SbEventHandler<TaskEventArg&> onEndTask;
 
  SbEventHandler<SubTaskEventArg&> onBeginSubTask;
 
  SbEventHandler<SubTaskEventArg&> onEndSubTask;
 
  SbEventHandler<StepEventArg&> onEndStep;
};