pqSMAdaptor.h

Go to the documentation of this file.

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

   Program: ParaView
   Module:    pqSMAdaptor.h

   Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

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

#ifndef _pqSMAdaptor_h
#define _pqSMAdaptor_h

class vtkSMProperty;
class vtkSMProxy;
class vtkObject;

#include "pqCoreModule.h"
#include "pqSMProxy.h"
#include "vtkVariant.h"
#include <QList>
#include <QPair>
#include <QVariant>

class PQCORE_EXPORT pqSMAdaptor
{
protected:
  // class not instantiated
  pqSMAdaptor();
  ~pqSMAdaptor();

public:
  enum PropertyType
  {
    UNKNOWN,
    PROXY,
    PROXYLIST,
    PROXYSELECTION,
    SELECTION,
    ENUMERATION,
    SINGLE_ELEMENT,
    MULTIPLE_ELEMENTS,
    FILE_LIST,
    COMPOSITE_TREE,
    SIL,
  };

  enum PropertyValueType
  {
    CHECKED,
    UNCHECKED
  };

  static PropertyType getPropertyType(vtkSMProperty* Property);

  static pqSMProxy getProxyProperty(vtkSMProperty* Property, PropertyValueType Type = CHECKED);

  static void addProxyProperty(vtkSMProperty* Property, pqSMProxy Value);
  static void removeProxyProperty(vtkSMProperty* Property, pqSMProxy Value);
  static void setProxyProperty(vtkSMProperty* Property, pqSMProxy Value);
  static void setUncheckedProxyProperty(vtkSMProperty* Property, pqSMProxy Value);
  static void addInputProperty(vtkSMProperty* Property, pqSMProxy Value, int opport);
  static void setInputProperty(vtkSMProperty* Property, pqSMProxy Value, int opport);

  static QList<pqSMProxy> getProxyListProperty(vtkSMProperty* Property);
  static void setProxyListProperty(vtkSMProperty* Property, QList<pqSMProxy> Value);

  static QList<pqSMProxy> getProxyPropertyDomain(vtkSMProperty* Property);

  static QList<QList<QVariant> > getSelectionProperty(
    vtkSMProperty* Property, PropertyValueType Type = CHECKED);
  static QList<QVariant> getSelectionProperty(
    vtkSMProperty* Property, unsigned int Index, PropertyValueType Type = CHECKED);
  static void setSelectionProperty(
    vtkSMProperty* Property, QList<QList<QVariant> > Value, PropertyValueType Type = CHECKED);

  static void setSelectionProperty(
    vtkSMProperty* Property, QList<QVariant> Value, PropertyValueType Type = CHECKED);

  static QList<QVariant> getSelectionPropertyDomain(vtkSMProperty* Property);

  static QVariant getEnumerationProperty(vtkSMProperty* Property, PropertyValueType Type = CHECKED);
  static void setEnumerationProperty(
    vtkSMProperty* Property, QVariant Value, PropertyValueType Type = CHECKED);
  static QList<QVariant> getEnumerationPropertyDomain(vtkSMProperty* Property);

  static QVariant getElementProperty(vtkSMProperty* Property, PropertyValueType Type = CHECKED);
  static void setElementProperty(
    vtkSMProperty* Property, QVariant Value, PropertyValueType Type = CHECKED);
  static QList<QVariant> getElementPropertyDomain(vtkSMProperty* Property);

  static QList<QVariant> getMultipleElementProperty(
    vtkSMProperty* Property, PropertyValueType Type = CHECKED);
  static void setMultipleElementProperty(
    vtkSMProperty* Property, QList<QVariant> Value, PropertyValueType Type = CHECKED);
  static QList<QList<QVariant> > getMultipleElementPropertyDomain(vtkSMProperty* Property);

  static QVariant getMultipleElementProperty(
    vtkSMProperty* Property, unsigned int Index, PropertyValueType Type = CHECKED);
  static void setMultipleElementProperty(
    vtkSMProperty* Property, unsigned int Index, QVariant Value, PropertyValueType Type = CHECKED);

  static QList<QVariant> getMultipleElementPropertyDomain(
    vtkSMProperty* Property, unsigned int Index);

  static QStringList getFileListProperty(vtkSMProperty* Property, PropertyValueType Type = CHECKED);
  static void setFileListProperty(
    vtkSMProperty* Property, QStringList Value, PropertyValueType Type = CHECKED);

  static QList<QString> getDomainTypes(vtkSMProperty* property);

  static void clearUncheckedProperties(vtkSMProperty* property);

  static QVariant convertToQVariant(const vtkVariant& variant);
};

#endif // !_pqSMAdaptor_h