Servers/ServerManager/vtkSMProperty.h

Go to the documentation of this file.

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

  Program:   ParaView
  Module:    $RCSfile: vtkSMProperty.h,v $

  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 __vtkSMProperty_h
#define __vtkSMProperty_h

#include "vtkSMObject.h"
#include "vtkClientServerID.h" // needed for vtkClientServerID

class vtkClientServerStream;
class vtkPVXMLElement;
class vtkSMDomain;
class vtkSMDomainIterator;
class vtkSMInformationHelper;
class vtkSMProxy;
class vtkSMXMLParser;
//BTX
struct vtkSMPropertyInternals;
//ETX

class VTK_EXPORT vtkSMProperty : public vtkSMObject
{
public:
  static vtkSMProperty* New();
  vtkTypeRevisionMacro(vtkSMProperty, vtkSMObject);
  void PrintSelf(ostream& os, vtkIndent indent);


  vtkSetStringMacro(Command);
  vtkGetStringMacro(Command);


  vtkSetMacro(ImmediateUpdate, int);
  vtkGetMacro(ImmediateUpdate, int);


  vtkSetMacro(UpdateSelf, int);
  vtkGetMacro(UpdateSelf, int);

  vtkSMProperty* GetSubProperty(const char* name);

  int IsInDomains();

  virtual void UnRegister(vtkObjectBase* obj);

  vtkSMDomainIterator* NewDomainIterator();

  vtkSMDomain* GetDomain(const char* name);

  unsigned int GetNumberOfDomains();

  void UpdateDependentDomains();


  static int GetCheckDomains();
  static void SetCheckDomains(int check);


  vtkGetStringMacro(XMLName);


  vtkGetMacro(InformationOnly, int);


  vtkGetObjectMacro(InformationProperty, vtkSMProperty);


  void SetControllerProxy(vtkSMProxy* proxy);
  void SetControllerProperty(vtkSMProperty* property);

  void AddDomain(const char* name, vtkSMDomain* dom);


  vtkSetMacro(Animateable, int);
  vtkGetMacro(Animateable, int);


  vtkSetMacro(Saveable, int);
  vtkGetMacro(Saveable, int);

  virtual void Copy(vtkSMProperty* src);
protected:
  vtkSMProperty();
  ~vtkSMProperty();

  //BTX
  friend class vtkSMProxyManager;
  friend class vtkSMProxy;
  friend class vtkSMSubPropertyIterator;
  friend class vtkSMDomainIterator;
  friend class vtkSMSourceProxy;
  friend class vtkSMDomain;


  virtual void AppendCommandToStream(
    vtkSMProxy*, vtkClientServerStream* stream, vtkClientServerID objectId );


  virtual void UpdateInformation(int serverids, vtkClientServerID objectId);
  //ETX


  virtual int ReadXMLAttributes(vtkSMProxy* parent, 
                                vtkPVXMLElement* element);

  virtual void UpdateAllInputs() {};


  vtkSetStringMacro(XMLName);

  void AddSubProperty(const char* name, vtkSMProperty* proxy);

  void RemoveSubProperty(const char* name);

  vtkSMProperty* NewProperty(const char* name);

  void AddDependent(vtkSMDomain* dom);

  void RemoveAllDependents();

  virtual void SaveState(const char* name, ostream* file, vtkIndent indent);

  void SetInformationHelper(vtkSMInformationHelper* helper);

  char* Command;

  vtkSMPropertyInternals* PInternals;

  int ImmediateUpdate;
  int UpdateSelf;
  int Animateable;
  int Saveable;

  char* XMLName;

  vtkSMDomainIterator* DomainIterator;

  static int CheckDomains;

  // ControllerProxy is pointer to the proxy whose property
  // (ControllerProperty) is mapped to the current property. This is useful
  // for 3DWidgets. The properties of the implicit function proxy
  // controlled by the 3DWidget will have these set to the corresponing
  // property of the 3DWidget. Thus, providing hints about which implicit
  // function property is controlled by which 3DWidget and what property.
  // This goes mostly unnoticed in ParaView, but useful for ARL.  If these
  // are set, then they are saved in the XML during SaveState as a element
  // <ControllerProperty name="propertyname" />. ARL notices such elements
  // and creates a property value dependency among the controlee and the
  // controller property.
  vtkSMProxy* ControllerProxy;
  vtkSMProperty* ControllerProperty;
  
  // Set during xml parsing only. Do not use outside ReadXMLAttributes().
  vtkSMProxy* Proxy;
  void SetProxy(vtkSMProxy* proxy);

  vtkSetMacro(InformationOnly, int);
  int InformationOnly;

  vtkSMInformationHelper* InformationHelper;

  void SetInformationProperty(vtkSMProperty* ip);
  vtkSMProperty* InformationProperty;

private:
  vtkSMProperty(const vtkSMProperty&); // Not implemented
  void operator=(const vtkSMProperty&); // Not implemented
};

#endif

---