vtkAnimationCue.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkAnimationCue_h
#define vtkAnimationCue_h
 
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"
 
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONCORE_EXPORT vtkAnimationCue : public vtkObject
{
public:
  vtkTypeMacro(vtkAnimationCue, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkAnimationCue* New();
 
  // Structure passed on every event invocation.
  // Depending upon the cue time mode, these times are either
  // normalized [0,1] or relative to the scene that contains the cue.
  // All this information is also available by asking the cue
  // directly for it within the handler. Thus, this information can
  // be accessed in wrapped languages.
  class AnimationCueInfo
  {
  public:
    double StartTime;
    double EndTime;
    double AnimationTime; // valid only in AnimationCueTickEvent handler
    double DeltaTime;     // valid only in AnimationCueTickEvent handler
    double ClockTime;     // valid only in AnimationCueTickEvent handler
  };


  virtual void SetTimeMode(int mode);
  vtkGetMacro(TimeMode, int);
  void SetTimeModeToRelative() { this->SetTimeMode(TIMEMODE_RELATIVE); }
  void SetTimeModeToNormalized() { this->SetTimeMode(TIMEMODE_NORMALIZED); }


  vtkSetMacro(StartTime, double);
  vtkGetMacro(StartTime, double);


  vtkSetMacro(EndTime, double);
  vtkGetMacro(EndTime, double);

  virtual void Tick(double currenttime, double deltatime, double clocktime);

  virtual void Initialize();

  virtual void Finalize();


  vtkGetMacro(AnimationTime, double);


  vtkGetMacro(DeltaTime, double);


  vtkGetMacro(ClockTime, double);
 
  enum TimeCodes
  {
    TIMEMODE_NORMALIZED = 0,
    TIMEMODE_RELATIVE = 1
  };
 
  enum class PlayDirection
  {
    BACKWARD,
    FORWARD,
  };


  vtkSetEnumMacro(Direction, PlayDirection);
  vtkGetEnumMacro(Direction, PlayDirection);
 
protected:
  vtkAnimationCue();
  ~vtkAnimationCue() override;
 
  enum
  {
    UNINITIALIZED = 0,
    INACTIVE,
    ACTIVE
  };
 
  double StartTime;
  double EndTime;
  int TimeMode;
  PlayDirection Direction = PlayDirection::FORWARD;
 
  // These are set when the AnimationCueTickEvent event
  // is fired. Thus giving access to the information in
  // the AnimationCueInfo struct in wrapped languages.
  double AnimationTime;
  double DeltaTime;
  double ClockTime;

  int CueState;


  virtual void StartCueInternal();
  virtual void TickInternal(double currenttime, double deltatime, double clocktime);
  virtual void EndCueInternal();


  virtual bool CheckStartCue(double currenttime);
  virtual bool CheckEndCue(double currenttime);
 
private:
  vtkAnimationCue(const vtkAnimationCue&) = delete;
  void operator=(const vtkAnimationCue&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif