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

  Program:   ParaView
  Module:    vtkSMVectorProperty.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   vtkSMVectorProperty
 * @brief   abstract superclass for all vector properties
 *
 * vtkSMVectorProperty defines an interface common to all vector properties
 * as well as some common settings. A vector property contains a list
 * of values passed to one or more invocations of a command. How the
 * values are distributed to the different invocations is controlled
 * by several parameters.
*/

#ifndef vtkSMVectorProperty_h
#define vtkSMVectorProperty_h

#include "vtkPVServerManagerCoreModule.h" //needed for exports
#include "vtkSMProperty.h"

class VTKPVSERVERMANAGERCORE_EXPORT vtkSMVectorProperty : public vtkSMProperty
{
public:
  vtkTypeMacro(vtkSMVectorProperty, vtkSMProperty);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  /**
   * Returns the size of the vector.
   */
  virtual unsigned int GetNumberOfElements() = 0;

  /**
   * Sets the size of the vector.
   */
  virtual void SetNumberOfElements(unsigned int num) = 0;

  //@{
  /**
   * API for setting unchecked element values.
   */
  virtual unsigned int GetNumberOfUncheckedElements() = 0;
  virtual void SetNumberOfUncheckedElements(unsigned int num) = 0;
  void ClearUncheckedElements() VTK_OVERRIDE = 0;
  //@}

  //@{
  /**
   * If RepeatCommand is true, the command is invoked multiple times,
   * each time with NumberOfElementsPerCommand values. For example, if
   * RepeatCommand is true, NumberOfElementsPerCommand is 2, the
   * command is SetFoo and the values are 1 2 3 4 5 6, the resulting
   * stream will have:
   * @verbatim
   * * Invoke obj SetFoo 1 2
   * * Invoke obj SetFoo 3 4
   * * Invoke obj SetFoo 5 6
   * @endverbatim
   */
  vtkGetMacro(RepeatCommand, int);
  vtkSetMacro(RepeatCommand, int);
  vtkBooleanMacro(RepeatCommand, int);
  //@}

  //@{
  /**
   * If RepeatCommand is true, the command is invoked multiple times,
   * each time with NumberOfElementsPerCommand values. For example, if
   * RepeatCommand is true, NumberOfElementsPerCommand is 2, the
   * command is SetFoo and the values are 1 2 3 4 5 6, the resulting
   * stream will have:
   * @verbatim
   * * Invoke obj SetFoo 1 2
   * * Invoke obj SetFoo 3 4
   * * Invoke obj SetFoo 5 6
   * @endverbatim
   */
  vtkGetMacro(NumberOfElementsPerCommand, int);
  vtkSetMacro(NumberOfElementsPerCommand, int);
  //@}

  //@{
  /**
   * If UseIndex and RepeatCommand are true, the property will add
   * an index integer before each command. For example, if UseIndex and
   * RepeatCommand are true, NumberOfElementsPerCommand is 2, the
   * command is SetFoo and the values are 5 6 7 8 9 10, the resulting
   * stream will have:
   * @verbatim
   * * Invoke obj SetFoo 0 5 6
   * * Invoke obj SetFoo 1 7 8
   * * Invoke obj SetFoo 2 9 10
   * @endverbatim
   */
  vtkGetMacro(UseIndex, int);
  vtkSetMacro(UseIndex, int);
  vtkBooleanMacro(UseIndex, int);
  //@}

  //@{
  /**
   * Command that can be used to remove all values.
   * Typically used when RepeatCommand = 1. If set, the clean command
   * is called before the main Command.
   */
  vtkSetStringMacro(CleanCommand);
  vtkGetStringMacro(CleanCommand);
  //@}

  /**
   * Copy all property values.
   */
  void Copy(vtkSMProperty* src) VTK_OVERRIDE;

  //@{
  /**
   * If SetNumberCommand is set, it is called before Command
   * with the number of arguments as the parameter.
   */
  vtkSetStringMacro(SetNumberCommand);
  vtkGetStringMacro(SetNumberCommand);
  //@}

  vtkSetStringMacro(InitialString);
  vtkGetStringMacro(InitialString);

  /**
   * Overridden to add support to load defaults from
   * this->GetInformationProperty(), if one exists. If the superclass (which
   * checks for defaults from all domains) doesn't end up picking a default, as
   * a last resort, we check if the property has a non-empty \c information_property.
   * If so, we copy its values to this property as the default.
   */
  bool ResetToDomainDefaults(bool use_unchecked_values = false) VTK_OVERRIDE;

protected:
  vtkSMVectorProperty();
  ~vtkSMVectorProperty() override;

  int RepeatCommand;
  int NumberOfElementsPerCommand;
  int UseIndex;

  char* CleanCommand;
  char* SetNumberCommand;
  char* InitialString;

  /**
   * Set the appropriate ivars from the xml element.
   */
  int ReadXMLAttributes(vtkSMProxy* parent, vtkPVXMLElement* element) VTK_OVERRIDE;

private:
  vtkSMVectorProperty(const vtkSMVectorProperty&) = delete;
  void operator=(const vtkSMVectorProperty&) = delete;
};

#endif
