1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
|
/*=========================================================================
Program: ParaView
Module: vtkSMPropertyIterator.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 vtkSMPropertyIterator
* @brief iterates over the properties of a proxy
*
* vtkSMPropertyIterator is used to iterate over the properties of a
* proxy. The properties of the root proxies as well as sub-proxies are
* included in the iteration. For sub-proxies, only
* exposed properties are iterated over.
*/
#ifndef vtkSMPropertyIterator_h
#define vtkSMPropertyIterator_h
#include "vtkPVServerManagerCoreModule.h" //needed for exports
#include "vtkSMObject.h"
struct vtkSMPropertyIteratorInternals;
class vtkSMProperty;
class vtkSMProxy;
class VTKPVSERVERMANAGERCORE_EXPORT vtkSMPropertyIterator : public vtkSMObject
{
public:
static vtkSMPropertyIterator* New();
vtkTypeMacro(vtkSMPropertyIterator, vtkSMObject);
virtual void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
/**
* Set the proxy to be used.
*/
virtual void SetProxy(vtkSMProxy* proxy);
//@{
/**
* Return the proxy.
*/
vtkGetObjectMacro(Proxy, vtkSMProxy);
//@}
/**
* Go to the first property.
*/
virtual void Begin();
/**
* Returns true if iterator points past the end of the collection.
*/
virtual int IsAtEnd();
/**
* Move to the next property.
*/
virtual void Next();
/**
* Returns the key (name) at the current iterator position.
*/
virtual const char* GetKey();
/**
* Returns the XMLLabel for self properties and the exposed name for
* sub-proxy properties.
*/
virtual const char* GetPropertyLabel();
/**
* Returns the property at the current iterator position.
*/
virtual vtkSMProperty* GetProperty();
//@{
/**
* If TraverseSubProxies is false, only the properties belonging
* to the root proxy are returned. Default is true.
*/
vtkSetMacro(TraverseSubProxies, int);
vtkGetMacro(TraverseSubProxies, int);
//@}
protected:
vtkSMPropertyIterator();
~vtkSMPropertyIterator();
vtkSMProxy* Proxy;
int TraverseSubProxies;
private:
vtkSMPropertyIteratorInternals* Internals;
vtkSMPropertyIterator(const vtkSMPropertyIterator&) VTK_DELETE_FUNCTION;
void operator=(const vtkSMPropertyIterator&) VTK_DELETE_FUNCTION;
};
#endif
|