vtkSMCollaborationManager.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMCollaborationManager_h
#define vtkSMCollaborationManager_h
 
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMMessageMinimal.h"            // needed for vtkSMMessage
#include "vtkSMRemoteObject.h"
 
class vtkSMProxyLocator;
 
class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMCollaborationManager : public vtkSMRemoteObject
{
public:
  static vtkTypeUInt32 GetReservedGlobalID();
 
  static vtkSMCollaborationManager* New();
  vtkTypeMacro(vtkSMCollaborationManager, vtkSMRemoteObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  vtkTypeUInt32 GetGlobalID() override;
 
  void SetSession(vtkSMSession*) override;
 
  virtual void PromoteToMaster(int clientId);
 
  virtual void FollowUser(int clientId);
 
  int GetFollowedUser();
 
  virtual bool IsMaster();
 
  virtual int GetMasterId();
 
  bool GetDisableFurtherConnections();
 
  virtual int GetUserId();
 
  virtual int GetUserId(int index);
 
  virtual const char* GetUserLabel(int userID);
 
  virtual void SetUserLabel(const char* userName);
 
  virtual void SetUserLabel(int userId, const char* userName);
 
  virtual int GetNumberOfConnectedClients();
 
  void UpdateUserInformations();
 
  int GetServerConnectID();
 
  int GetConnectID();
 
  enum EventType
  {
    CollaborationNotification = 12345,
    UpdateUserName = 12346,
    UpdateUserList = 12347,
    UpdateMasterUser = 12348,
    FollowUserCamera = 12349,
    CameraChanged = 12350,
    LastMessageUpdated = 12351
  };
 
  void SendToOtherClients(vtkSMMessage* msg);
 
  const vtkSMMessage* GetFullState() override;
 
  void LoadState(const vtkSMMessage* msg, vtkSMProxyLocator* locator) override;
 
  void DisableFurtherConnections(bool disable);
 
  void SetConnectID(int connectID);
 
  const char* GetLastReceivedMessage() const;
 
protected:
  vtkSMCollaborationManager();
 
  ~vtkSMCollaborationManager() override;
 
private:
  class vtkInternal;
  vtkInternal* Internal;
 
  vtkSMCollaborationManager(const vtkSMCollaborationManager&) = delete;
  void operator=(const vtkSMCollaborationManager&) = delete;
};
#endif // #ifndef vtkSMCollaborationManager_h