// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
 * @class   vtkEventForwarderCommand
 * @brief   a simple event forwarder command
 *
 * Use vtkEventForwarderCommand to forward an event to a new object.
 * This command will intercept the event, and use InvokeEvent
 * on a 'target' as if that object was the one that invoked the event instead
 * of the object this command was attached to using AddObserver.
 *
 * @sa
 * vtkCommand
 */

#ifndef vtkEventForwarderCommand_h
#define vtkEventForwarderCommand_h

#include "vtkCommand.h"
#include "vtkCommonCoreModule.h" // For export macro

VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONCORE_EXPORT vtkEventForwarderCommand : public vtkCommand
{
public:
  vtkTypeMacro(vtkEventForwarderCommand, vtkCommand);

  static vtkEventForwarderCommand* New() { return new vtkEventForwarderCommand; }

  /**
   * Satisfy the superclass API for callbacks. Recall that the caller is
   * the instance invoking the event; eid is the event id (see
   * vtkCommand.h); and calldata is information sent when the callback
   * was invoked (e.g., progress value in the vtkCommand::ProgressEvent).
   */
  void Execute(vtkObject* caller, unsigned long eid, void* callData) override;

  /**
   * Methods to set and get client and callback information, and the callback
   * function.
   */
  virtual void SetTarget(vtkObject* obj) { this->Target = obj; }
  virtual void* GetTarget() { return this->Target; }

protected:
  vtkObject* Target;

  vtkEventForwarderCommand();
  ~vtkEventForwarderCommand() override = default;
};

VTK_ABI_NAMESPACE_END
#endif /* vtkEventForwarderCommand_h */

// VTK-HeaderTest-Exclude: vtkEventForwarderCommand.h