vtkPlusEpiphanVideoSource.h

Go to the documentation of this file.

/*=Plus=header=begin======================================================
  Program: Plus
  Copyright (c) Laboratory for Percutaneous Surgery. All rights reserved.
  See License.txt for details.
=========================================================Plus=header=end*/

#ifndef __vtkPlusEpiphanVideoSource_h
#define __vtkPlusEpiphanVideoSource_h

// Local includes
#include "igsioCommon.h"
#include "vtkPlusDataCollectionExport.h"
#include "vtkPlusDevice.h"

// Epiphan includes
#include <v2u_defs.h>

class vtkPlusDataCollectionExport vtkPlusEpiphanVideoSource : public vtkPlusDevice
{
public:
  static vtkPlusEpiphanVideoSource* New();
  vtkTypeMacro(vtkPlusEpiphanVideoSource, vtkPlusDevice);
  virtual void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  virtual bool IsTracker() const;

  virtual PlusStatus ReadConfiguration(vtkXMLDataElement* config);
  virtual PlusStatus WriteConfiguration(vtkXMLDataElement* config);

  vtkSetStdStringMacro(GrabberLocation);
  vtkGetStdStringMacro(GrabberLocation);

  void SetClipRectangleSize(const std::array<int, 3>& size);
  std::array<int, 3> GetClipRectangleSize() const;

  void SetClipRectangleOrigin(const std::array<int, 3>& origin);
  std::array<int, 3> GetClipRectangleOrigin() const;

  virtual PlusStatus NotifyConfigured();

protected:
  vtkPlusEpiphanVideoSource();
  ~vtkPlusEpiphanVideoSource();

  virtual PlusStatus InternalConnect();

  virtual PlusStatus InternalDisconnect();

  virtual PlusStatus InternalStartRecording();

  virtual PlusStatus InternalStopRecording();

  PlusStatus InternalUpdate();

  vtkSetStdStringMacro(ScaleMode);
  vtkSetStdStringMacro(RotationMode);

protected:
  std::array<int, 3> ClipRectangleOrigin;   // Crop rectangle origin for the grabber (in pixels, done in hardware)
  std::array<int, 3> ClipRectangleSize;     // Crop rectangle size for the grabber (in pixels, done in hardware). If it is (0,0) then the whole frame will be captured.
  std::string GrabberLocation;              // String to specify the framegrabber to connect to (auto-detection is attempted if unspecified)
  void* FrameGrabber;                       // Epiphan Pointer to the grabber
  FrameSizeType FrameSize;                  // Frame size of the captured image, third dimension is set to 1
  US_IMAGE_TYPE CaptureImageType;           // The type of image to capture from the hardware
  V2URect* CropRectangle;                   // Dimensions to request from framegrabber

  std::string RotationMode;
  V2URotationMode Rotation;                 // Rotation of the acquired image
  std::string ScaleMode;
  V2UScaleMode Scale;                       // Scaling of the acquired image

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

#endif