ParaView
Public Types | Static Public Member Functions | Protected Member Functions
pqSMAdaptor Class Reference

Translates server manager events into Qt-compatible slots and signals. More...

#include <pqSMAdaptor.h>

List of all members.

Public Types

enum  PropertyType {
  UNKNOWN, PROXY, PROXYLIST, PROXYSELECTION,
  SELECTION, ENUMERATION, SINGLE_ELEMENT, MULTIPLE_ELEMENTS,
  FILE_LIST, FIELD_SELECTION, COMPOSITE_TREE, SIL
}
 enumeration for types of properties this class handles More...
enum  PropertyValueType { CHECKED, UNCHECKED }

Static Public Member Functions

static PropertyType getPropertyType (vtkSMProperty *Property)
 Get the type of the property.
static pqSMProxy getProxyProperty (vtkSMProperty *Property, PropertyValueType Type=CHECKED)
 get the proxy for a property for example, glyph filter accepts a source (proxy) to glyph with
static void addProxyProperty (vtkSMProperty *Property, pqSMProxy Value)
 get the proxy for a property for example, glyph filter accepts a source (proxy) to glyph with
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< pqSMProxygetProxyListProperty (vtkSMProperty *Property)
 get the list of proxies for a property for example, append filter accepts a list of proxies
static void setProxyListProperty (vtkSMProperty *Property, QList< pqSMProxy > Value)
 get the list of proxies for a property for example, append filter accepts a list of proxies
static QList< pqSMProxygetProxyPropertyDomain (vtkSMProperty *Property)
 get the list of possible proxies for a property
static QList< QList< QVariant > > getSelectionProperty (vtkSMProperty *Property, PropertyValueType Type=CHECKED)
 get the pairs of selections for a selection property
static QList< QVariant > getSelectionProperty (vtkSMProperty *Property, unsigned int Index, PropertyValueType Type=CHECKED)
 get the pairs of selections for a selection property
static void setSelectionProperty (vtkSMProperty *Property, QList< QList< QVariant > > Value, PropertyValueType Type=CHECKED)
 set the pairs of selections for a selection property
static void setSelectionProperty (vtkSMProperty *Property, QList< QVariant > Value, PropertyValueType Type=CHECKED)
 used to set the status of an array, for example.
static QList< QVariant > getSelectionPropertyDomain (vtkSMProperty *Property)
 get the possible names for the selection property
static QVariant getEnumerationProperty (vtkSMProperty *Property, PropertyValueType Type=CHECKED)
 get the enumeration for a property
static void setEnumerationProperty (vtkSMProperty *Property, QVariant Value, PropertyValueType Type=CHECKED)
 set the enumeration for a property
static QList< QVariant > getEnumerationPropertyDomain (vtkSMProperty *Property)
 get the possible enumerations (string) for a property
static QVariant getElementProperty (vtkSMProperty *Property, PropertyValueType Type=CHECKED)
 get the single element of a property (integer, string, real, etc..)
static void setElementProperty (vtkSMProperty *Property, QVariant Value, PropertyValueType Type=CHECKED)
 set the single element of a property (integer, string, real, etc..)
static QList< QVariant > getElementPropertyDomain (vtkSMProperty *Property)
 get the range of possible values to set the single element of a property
static QList< QVariant > getMultipleElementProperty (vtkSMProperty *Property, PropertyValueType Type=CHECKED)
 get the multiple elements of a property (integer, string, real, etc..)
static void setMultipleElementProperty (vtkSMProperty *Property, QList< QVariant > Value, PropertyValueType Type=CHECKED)
 set the multiple elements of a property (integer, string, real, etc..)
static QList< QList< QVariant > > getMultipleElementPropertyDomain (vtkSMProperty *Property)
 get the ranges of possible values to set the multiple elements of a property
static QVariant getMultipleElementProperty (vtkSMProperty *Property, unsigned int Index, PropertyValueType Type=CHECKED)
 get one of the multiple elements of a property (integer, string, real, etc..)
static void setMultipleElementProperty (vtkSMProperty *Property, unsigned int Index, QVariant Value, PropertyValueType Type=CHECKED)
 set one of the multiple elements of a property (integer, string, real, etc..)
static QList< QVariant > getMultipleElementPropertyDomain (vtkSMProperty *Property, unsigned int Index)
 get one of the ranges of possible values to set the multiple elements of a property
static QStringList getFileListProperty (vtkSMProperty *Property, PropertyValueType Type=CHECKED)
 get the single element of a property (integer, string, real, etc..)
static void setFileListProperty (vtkSMProperty *Property, QStringList Value, PropertyValueType Type=CHECKED)
 set the single element of a property (integer, string, real, etc..)
static QStringList getFieldSelection (vtkSMProperty *Property, PropertyValueType Type=CHECKED)
static void setFieldSelection (vtkSMProperty *Property, const QStringList &Value, PropertyValueType Type=CHECKED)
static QString getFieldSelectionMode (vtkSMProperty *prop, PropertyValueType Type=CHECKED)
 get/set the field selection mode (point, cell, ...)
static void setFieldSelectionMode (vtkSMProperty *Property, const QString &Value, PropertyValueType Type=CHECKED)
static QList< QString > getFieldSelectionModeDomain (vtkSMProperty *)
static QString getFieldSelectionScalar (vtkSMProperty *Property, PropertyValueType Type=CHECKED)
 get/set the field selection scalar
static void setFieldSelectionScalar (vtkSMProperty *Property, const QString &Value, PropertyValueType Type=CHECKED)
static QList< QString > getFieldSelectionScalarDomain (vtkSMProperty *)
static QList< QPair< QString,
bool > > 
getFieldSelectionScalarDomainWithPartialArrays (vtkSMProperty *)
static QList< QString > getDomainTypes (vtkSMProperty *property)
 Returns a list of domains types for the property.
static void clearUncheckedProperties (vtkSMProperty *property)
 Clears any unchecked values on the property.
static QVariant convertToQVariant (const vtkVariant &variant)
 Converts a vtkVariant into a QVariant.

Protected Member Functions

 pqSMAdaptor ()
 ~pqSMAdaptor ()

Detailed Description

Translates server manager events into Qt-compatible slots and signals.

Definition at line 50 of file pqSMAdaptor.h.


Member Enumeration Documentation

enumeration for types of properties this class handles

Enumerator:
UNKNOWN 
PROXY 
PROXYLIST 
PROXYSELECTION 
SELECTION 
ENUMERATION 
SINGLE_ELEMENT 
MULTIPLE_ELEMENTS 
FILE_LIST 
FIELD_SELECTION 
COMPOSITE_TREE 
SIL 

Definition at line 60 of file pqSMAdaptor.h.

Enumerator:
CHECKED 
UNCHECKED 

Definition at line 76 of file pqSMAdaptor.h.


Constructor & Destructor Documentation

pqSMAdaptor::pqSMAdaptor ( ) [protected]
pqSMAdaptor::~pqSMAdaptor ( ) [protected]

Member Function Documentation

static PropertyType pqSMAdaptor::getPropertyType ( vtkSMProperty Property) [static]

Get the type of the property.

static pqSMProxy pqSMAdaptor::getProxyProperty ( vtkSMProperty Property,
PropertyValueType  Type = CHECKED 
) [static]

get the proxy for a property for example, glyph filter accepts a source (proxy) to glyph with

static void pqSMAdaptor::addProxyProperty ( vtkSMProperty Property,
pqSMProxy  Value 
) [static]

get the proxy for a property for example, glyph filter accepts a source (proxy) to glyph with

static void pqSMAdaptor::removeProxyProperty ( vtkSMProperty Property,
pqSMProxy  Value 
) [static]
static void pqSMAdaptor::setProxyProperty ( vtkSMProperty Property,
pqSMProxy  Value 
) [static]
static void pqSMAdaptor::setUncheckedProxyProperty ( vtkSMProperty Property,
pqSMProxy  Value 
) [static]
static void pqSMAdaptor::addInputProperty ( vtkSMProperty Property,
pqSMProxy  Value,
int  opport 
) [static]
static void pqSMAdaptor::setInputProperty ( vtkSMProperty Property,
pqSMProxy  Value,
int  opport 
) [static]
static QList<pqSMProxy> pqSMAdaptor::getProxyListProperty ( vtkSMProperty Property) [static]

get the list of proxies for a property for example, append filter accepts a list of proxies

static void pqSMAdaptor::setProxyListProperty ( vtkSMProperty Property,
QList< pqSMProxy Value 
) [static]

get the list of proxies for a property for example, append filter accepts a list of proxies

static QList<pqSMProxy> pqSMAdaptor::getProxyPropertyDomain ( vtkSMProperty Property) [static]

get the list of possible proxies for a property

static QList<QList<QVariant> > pqSMAdaptor::getSelectionProperty ( vtkSMProperty Property,
PropertyValueType  Type = CHECKED 
) [static]

get the pairs of selections for a selection property

static QList<QVariant> pqSMAdaptor::getSelectionProperty ( vtkSMProperty Property,
unsigned int  Index,
PropertyValueType  Type = CHECKED 
) [static]

get the pairs of selections for a selection property

static void pqSMAdaptor::setSelectionProperty ( vtkSMProperty Property,
QList< QList< QVariant > >  Value,
PropertyValueType  Type = CHECKED 
) [static]

set the pairs of selections for a selection property

static void pqSMAdaptor::setSelectionProperty ( vtkSMProperty Property,
QList< QVariant >  Value,
PropertyValueType  Type = CHECKED 
) [static]

used to set the status of an array, for example.

note that this method can only be used for properties with vtkSMArraySelectionDomain or vtkSMStringListRangeDomain.

static QList<QVariant> pqSMAdaptor::getSelectionPropertyDomain ( vtkSMProperty Property) [static]

get the possible names for the selection property

static QVariant pqSMAdaptor::getEnumerationProperty ( vtkSMProperty Property,
PropertyValueType  Type = CHECKED 
) [static]

get the enumeration for a property

static void pqSMAdaptor::setEnumerationProperty ( vtkSMProperty Property,
QVariant  Value,
PropertyValueType  Type = CHECKED 
) [static]

set the enumeration for a property

static QList<QVariant> pqSMAdaptor::getEnumerationPropertyDomain ( vtkSMProperty Property) [static]

get the possible enumerations (string) for a property

static QVariant pqSMAdaptor::getElementProperty ( vtkSMProperty Property,
PropertyValueType  Type = CHECKED 
) [static]

get the single element of a property (integer, string, real, etc..)

static void pqSMAdaptor::setElementProperty ( vtkSMProperty Property,
QVariant  Value,
PropertyValueType  Type = CHECKED 
) [static]

set the single element of a property (integer, string, real, etc..)

static QList<QVariant> pqSMAdaptor::getElementPropertyDomain ( vtkSMProperty Property) [static]

get the range of possible values to set the single element of a property

static QList<QVariant> pqSMAdaptor::getMultipleElementProperty ( vtkSMProperty Property,
PropertyValueType  Type = CHECKED 
) [static]

get the multiple elements of a property (integer, string, real, etc..)

static void pqSMAdaptor::setMultipleElementProperty ( vtkSMProperty Property,
QList< QVariant >  Value,
PropertyValueType  Type = CHECKED 
) [static]

set the multiple elements of a property (integer, string, real, etc..)

static QList<QList<QVariant> > pqSMAdaptor::getMultipleElementPropertyDomain ( vtkSMProperty Property) [static]

get the ranges of possible values to set the multiple elements of a property

static QVariant pqSMAdaptor::getMultipleElementProperty ( vtkSMProperty Property,
unsigned int  Index,
PropertyValueType  Type = CHECKED 
) [static]

get one of the multiple elements of a property (integer, string, real, etc..)

static void pqSMAdaptor::setMultipleElementProperty ( vtkSMProperty Property,
unsigned int  Index,
QVariant  Value,
PropertyValueType  Type = CHECKED 
) [static]

set one of the multiple elements of a property (integer, string, real, etc..)

static QList<QVariant> pqSMAdaptor::getMultipleElementPropertyDomain ( vtkSMProperty Property,
unsigned int  Index 
) [static]

get one of the ranges of possible values to set the multiple elements of a property

static QStringList pqSMAdaptor::getFileListProperty ( vtkSMProperty Property,
PropertyValueType  Type = CHECKED 
) [static]

get the single element of a property (integer, string, real, etc..)

static void pqSMAdaptor::setFileListProperty ( vtkSMProperty Property,
QStringList  Value,
PropertyValueType  Type = CHECKED 
) [static]

set the single element of a property (integer, string, real, etc..)

static QStringList pqSMAdaptor::getFieldSelection ( vtkSMProperty Property,
PropertyValueType  Type = CHECKED 
) [static]
static void pqSMAdaptor::setFieldSelection ( vtkSMProperty Property,
const QStringList &  Value,
PropertyValueType  Type = CHECKED 
) [static]
static QString pqSMAdaptor::getFieldSelectionMode ( vtkSMProperty prop,
PropertyValueType  Type = CHECKED 
) [static]

get/set the field selection mode (point, cell, ...)

static void pqSMAdaptor::setFieldSelectionMode ( vtkSMProperty Property,
const QString &  Value,
PropertyValueType  Type = CHECKED 
) [static]
static QList<QString> pqSMAdaptor::getFieldSelectionModeDomain ( vtkSMProperty ) [static]
static QString pqSMAdaptor::getFieldSelectionScalar ( vtkSMProperty Property,
PropertyValueType  Type = CHECKED 
) [static]

get/set the field selection scalar

static void pqSMAdaptor::setFieldSelectionScalar ( vtkSMProperty Property,
const QString &  Value,
PropertyValueType  Type = CHECKED 
) [static]
static QList<QString> pqSMAdaptor::getFieldSelectionScalarDomain ( vtkSMProperty ) [static]
static QList<QPair<QString, bool> > pqSMAdaptor::getFieldSelectionScalarDomainWithPartialArrays ( vtkSMProperty ) [static]
static QList<QString> pqSMAdaptor::getDomainTypes ( vtkSMProperty property) [static]

Returns a list of domains types for the property.

eg. if a property has vtkSMBoundsDomain and vtkSMArrayListDomain then this method will returns ["vtkSMBoundsDomain", "vtkSMArrayListDomain"].

static void pqSMAdaptor::clearUncheckedProperties ( vtkSMProperty property) [static]

Clears any unchecked values on the property.

static QVariant pqSMAdaptor::convertToQVariant ( const vtkVariant variant) [static]

Converts a vtkVariant into a QVariant.


The documentation for this class was generated from the following file: