/*=========================================================================

  Program:   ParaView
  Module:    vtkPVRepresentationAnimationHelper.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
/**
 * @class   vtkPVRepresentationAnimationHelper
 * @brief   helper proxy used to animate
 * properties on the representations for any source.
 *
 * vtkPVRepresentationAnimationHelper is helper proxy used to animate
 * properties on the representations for any source. This makes is possible to
 * set up an animation cue that will affect properties on all representations
 * for a source without directly referring to the representation proxies.
*/

#ifndef vtkPVRepresentationAnimationHelper_h
#define vtkPVRepresentationAnimationHelper_h

#include "vtkPVAnimationModule.h" //needed for exports
#include "vtkSMProxy.h"
#include "vtkWeakPointer.h" // needed for vtkWeakPointer.

class VTKPVANIMATION_EXPORT vtkPVRepresentationAnimationHelper : public vtkSMProxy
{
public:
  static vtkPVRepresentationAnimationHelper* New();
  vtkTypeMacro(vtkPVRepresentationAnimationHelper, vtkSMProxy);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  //@{
  /**
   * Don't use directly. Use the corresponding properties intstead.
   */
  void SetVisibility(int);
  void SetOpacity(double);
  void SetSourceProxy(vtkSMProxy* proxy);
  //@}

protected:
  vtkPVRepresentationAnimationHelper();
  ~vtkPVRepresentationAnimationHelper();

  vtkWeakPointer<vtkSMProxy> SourceProxy;

private:
  vtkPVRepresentationAnimationHelper(const vtkPVRepresentationAnimationHelper&) VTK_DELETE_FUNCTION;
  void operator=(const vtkPVRepresentationAnimationHelper&) VTK_DELETE_FUNCTION;
};

#endif
