vtkSMStateLocator.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMStateLocator_h
#define vtkSMStateLocator_h
 
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMMessageMinimal.h"            // needed for vtkSMMessage.
#include "vtkSMObject.h"
#include "vtkWeakPointer.h" // need for observer
 
class vtkSMProxy;
class vtkSMSession;
class vtkUndoStack;
 
class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMStateLocator : public vtkSMObject
{
public:
  static vtkSMStateLocator* New();
  vtkTypeMacro(vtkSMStateLocator, vtkSMObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  vtkSetObjectMacro(ParentLocator, vtkSMStateLocator);
  vtkGetObjectMacro(ParentLocator, vtkSMStateLocator);
 
  void InitGarbageCollector(vtkSMSession*, vtkUndoStack*);
 
  virtual bool FindState(vtkTypeUInt32 globalID, vtkSMMessage* stateToFill, bool useParent = true);
 
  virtual void RegisterState(const vtkSMMessage* state);
 
  virtual void UnRegisterState(vtkTypeUInt32 globalID, bool force);
 
  virtual void UnRegisterAllStates(bool force);
 
  virtual bool IsStateLocal(vtkTypeUInt32 globalID);
 
  virtual bool IsStateAvailable(vtkTypeUInt32 globalID);
 
  virtual void RegisterFullState(vtkSMProxy* proxy);
 
protected:
  vtkSMStateLocator();
  ~vtkSMStateLocator() override;
 
  vtkSMStateLocator* ParentLocator;
  vtkWeakPointer<vtkSMSession> Session;
  vtkWeakPointer<vtkUndoStack> UndoStack;
 
private:
  vtkSMStateLocator(const vtkSMStateLocator&) = delete;
  void operator=(const vtkSMStateLocator&) = delete;
 
  class vtkInternal;
  vtkInternal* Internals;
};
 
#endif