pqCollaborationManager.h

Go to the documentation of this file.

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

   Program: ParaView
   Module:    pqCollaborationManager.h

   Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=========================================================================*/
#ifndef _pqCollaborationManager_h
#define _pqCollaborationManager_h

#include "pqCoreModule.h"
#include "vtkSMMessageMinimal.h"
#include <QObject>

class vtkObject;
class pqServer;
class pqView;
class pqPipelineSource;
class vtkSMCollaborationManager;
class QSignalMapper;
class QMouseEvent;

class PQCORE_EXPORT pqCollaborationManager : public QObject
{
  Q_OBJECT
  typedef QObject Superclass;

public:
  pqCollaborationManager(QObject* parent);
  ~pqCollaborationManager() override;

  vtkSMCollaborationManager* activeCollaborationManager();

signals:
  void triggerChatMessage(pqServer* server, int userId, QString& msgContent);

  void triggerStateClientOnlyMessage(pqServer* origin, vtkSMMessage* msg);

  void triggeredMasterUser(int);
  void triggeredMasterChanged(bool);
  void triggeredUserName(int, QString&);
  void triggeredUserListChanged();

  void triggerFollowCamera(int);

public slots:
  void onServerAdded(pqServer*);
  void onServerRemoved(pqServer*);

  void onChatMessage(pqServer* server, int userId, QString& msgContent);

  void updateEnabledState();

  void updateMousePointerLocation(QMouseEvent* e);

  void sendMousePointerLocationToOtherClients();

  void sendChartViewBoundsToOtherClients();

  void attachMouseListenerTo3DViews();

  void enableMousePointerSharing(bool);

  void disableFurtherConnections(bool disable);

  void setConnectID(int connectID);

private slots:
  void onClientMessage(pqServer* server, vtkSMMessage* msg);

  void onChartViewChange(vtkTypeUInt32 gid, double* bounds);

  void showMousePointer(vtkTypeUInt32 viewId, double x, double y, int ratioToUse);

private:
  Q_DISABLE_COPY(pqCollaborationManager)

  class pqInternals;
  pqInternals* Internals;
};

#endif // !_pqCollaborationManager_h