vtkMRMLViewLogic.h

Go to the documentation of this file.

/*==============================================================================
 
  Copyright (c) Kapteyn Astronomical Institute
  University of Groningen, Groningen, Netherlands. All Rights Reserved.
 
  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.
 
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
 
  This file was originally developed by Davide Punzo, Kapteyn Astronomical Institute,
  and was supported through the European Research Council grant nr. 291531.
 
==============================================================================*/
 
#ifndef __vtkMRMLViewLogic_h
#define __vtkMRMLViewLogic_h
 
// MRMLLogic includes
#include "vtkMRMLAbstractLogic.h"
 
// VTK includes
#include <vtkObject.h>
#include <vtkWeakPointer.h>
 
// STD includes
#include <vector>
#include <deque>
 
class vtkMRMLDisplayNode;
class vtkMRMLLinearTransformNode;
class vtkMRMLModelDisplayNode;
class vtkMRMLModelNode;
class vtkMRMLViewNode;
class vtkMRMLCameraNode;
class vtkMRMLVolumeNode;
 
class vtkAlgorithmOutput;
class vtkCollection;
class vtkImageBlend;
class vtkTransform;
class vtkImageData;
class vtkImageReslice;
class vtkTransform;
 
struct SliceLayerInfo;
struct BlendPipeline;

class VTK_MRML_LOGIC_EXPORT vtkMRMLViewLogic : public vtkMRMLAbstractLogic
{
public:
  static vtkMRMLViewLogic* New();
  vtkTypeMacro(vtkMRMLViewLogic, vtkMRMLAbstractLogic);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual void SetName(const char* name);
  virtual const char* GetName() const;

  vtkGetObjectMacro(ViewNode, vtkMRMLViewNode);

  vtkGetObjectMacro(CameraNode, vtkMRMLCameraNode);

  void StartCameraNodeInteraction(unsigned int parameters);

  void EndCameraNodeInteraction();

  void StartViewNodeInteraction(unsigned int parameters);

  void EndViewNodeInteraction();

  vtkMRMLViewNode* AddViewNode(const char* layoutName);

  static vtkMRMLViewNode* GetViewNode(vtkMRMLScene* scene, const char* layoutName);

  static vtkMRMLCameraNode* GetCameraNode(vtkMRMLScene* scene, const char* layoutName);

  vtkGetObjectMacro(DisplayableManagerGroup, vtkObject);
  void SetDisplayableManagerGroup(vtkObject* obj);
 
protected:
  vtkMRMLViewLogic();
  ~vtkMRMLViewLogic() override;
 
  void SetMRMLSceneInternal(vtkMRMLScene* newScene) override;
  void SetViewNode(vtkMRMLViewNode* newViewNode);
  void SetCameraNode(vtkMRMLCameraNode* newCameraNode);
 
  void OnMRMLSceneNodeAdded(vtkMRMLNode* node) override;
  void OnMRMLSceneNodeRemoved(vtkMRMLNode* node) override;
  void UpdateFromMRMLScene() override;
 
  void UpdateMRMLNodes();
 
  // View and camera nodes are looked up from the scene based on the layout name.
  std::string Name;
 
  vtkMRMLViewNode* ViewNode;
  vtkMRMLCameraNode* CameraNode;
  bool UpdatingMRMLNodes;
 
  // Weak reference to the view's displayable manager group.
  //
  // Stored as vtkObject to keep MRMLLogic independent of
  // MRMLDisplayableManager headers. The expected dynamic type is
  // vtkMRMLDisplayableManagerGroup.
  //
  // Set by the layout factories when the view widget is created, and used by
  // vtkSlicerApplicationLogic::GetViewDisplayableManagerByClassName() to
  // resolve managers without Qt. This works because vtkSlicerApplicationLogic
  // lives in SlicerBaseLogic, which can depend on MRMLDisplayableManager.
  //
  // Ownership: the group is owned by the view/widget; this logic holds only a
  // weak pointer. May be nullptr (e.g., headless or before view creation).
  // Type is validated in SetDisplayableManagerGroup().
  vtkWeakPointer<vtkObject> DisplayableManagerGroup;
 
private:
  vtkMRMLViewLogic(const vtkMRMLViewLogic&) = delete;
  void operator=(const vtkMRMLViewLogic&) = delete;
};
 
#endif