vtkSMBoundsDomain.h

Go to the documentation of this file.

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

  Program:   ParaView
  Module:    vtkSMBoundsDomain.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.

=========================================================================*/
#ifndef vtkSMBoundsDomain_h
#define vtkSMBoundsDomain_h

#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMDoubleRangeDomain.h"

class vtkPVDataInformation;
class vtkSMProxyProperty;
class vtkSMArrayRangeDomain;
class vtkSMIntVectorProperty;

class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMBoundsDomain : public vtkSMDoubleRangeDomain
{
public:
  static vtkSMBoundsDomain* New();
  vtkTypeMacro(vtkSMBoundsDomain, vtkSMDoubleRangeDomain);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void Update(vtkSMProperty*) override;

  vtkSetClampMacro(Mode, int, 0, 3);
  vtkGetMacro(Mode, int);

  enum Modes
  {
    NORMAL,
    MAGNITUDE,
    ORIENTED_MAGNITUDE,
    SCALED_EXTENT,
    ARRAY_SCALED_EXTENT,
    APPROXIMATE_CELL_LENGTH,
    DATA_BOUNDS,
    EXTENTS,
    COMPONENT_MAGNITUDE,
  };

  vtkGetMacro(ScaleFactor, double);

  enum Axes
  {
    X_AXIS = 1,
    Y_AXIS = 2,
    Z_AXIS = 4,
    X_AND_Y_AXES = X_AXIS | Y_AXIS,
    Y_AND_Z_AXES = Y_AXIS | Z_AXIS,
    X_AND_Z_AXES = X_AXIS | Z_AXIS,
    X_Y_AND_Z_AXES = X_AXIS | Y_AXIS | Z_AXIS
  };

  vtkGetMacro(AxisFlags, int);

  int SetDefaultValues(vtkSMProperty* property, bool use_unchecked_values) override;

protected:
  vtkSMBoundsDomain();
  ~vtkSMBoundsDomain() override;

  int ReadXMLAttributes(vtkSMProperty* prop, vtkPVXMLElement* element) override;

  // Obtain the data information from the required property with
  // function "Input", if any.
  vtkPVDataInformation* GetInputInformation();

  // Obtain the information for the "AxisFlags" required property.
  vtkSMIntVectorProperty* GetAxisFlagsInformation();

  bool IsAxisEnabled(int axis);

  void SetDomainValues(double bounds[6]);

  void UpdateOriented();

  int Mode;
  double ScaleFactor; // Used only in SCALED_EXTENT and APPROXIMATE_CELL_LENGTH mode.
  int AxisFlags;

private:
  vtkSMBoundsDomain(const vtkSMBoundsDomain&) = delete;
  void operator=(const vtkSMBoundsDomain&) = delete;

  vtkSMArrayRangeDomain* ArrayRangeDomain;
};

#endif