vtkStreamingVolumeFrame.h

Go to the documentation of this file.

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

Copyright (c) Laboratory for Percutaneous Surgery (PerkLab)
Queen's University, Kingston, ON, Canada. 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 Kyle Sunderland, PerkLab, Queen's University
and was supported through CANARIE's Research Software Program, and Cancer
Care Ontario.

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

#ifndef __vtkStreamingVolumeFrame_h
#define __vtkStreamingVolumeFrame_h

// VTK includes
#include <vtkObject.h>
#include <vtkUnsignedCharArray.h>

// vtkAddon includes
#include "vtkAddon.h"

class VTK_ADDON_EXPORT vtkStreamingVolumeFrame : public vtkObject
{
public:

  static vtkStreamingVolumeFrame* New();
  vtkTypeMacro(vtkStreamingVolumeFrame, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  enum
  {
    IFrame, 
    PFrame, 
    BFrame, 
  };

  vtkSetMacro(FrameType, int);
  vtkGetMacro(FrameType, int);

  void SetFrameData(vtkUnsignedCharArray* frameData);
  vtkUnsignedCharArray* GetFrameData() { return this->FrameData; };

  void SetPreviousFrame(vtkStreamingVolumeFrame* previousFrame);
  vtkStreamingVolumeFrame* GetPreviousFrame() { return this->PreviousFrame; };

  vtkSetVector3Macro(Dimensions, int);
  vtkGetVector3Macro(Dimensions, int);

  vtkSetMacro(NumberOfComponents, int);
  vtkGetMacro(NumberOfComponents, int);

  vtkSetMacro(VTKScalarType, int);
  vtkGetMacro(VTKScalarType, int);

  vtkSetMacro(CodecFourCC, std::string);
  vtkGetMacro(CodecFourCC, std::string);

  bool IsKeyFrame() { return this->FrameType == IFrame; };

protected:
  int                                         Dimensions[3];
  std::string                                 CodecFourCC;
  vtkSmartPointer<vtkUnsignedCharArray>       FrameData;
  int                                         FrameType;
  int                                         NumberOfComponents;
  vtkSmartPointer<vtkStreamingVolumeFrame>    PreviousFrame;
  int                                         VTKScalarType;

protected:
  vtkStreamingVolumeFrame();
  ~vtkStreamingVolumeFrame();

private:
  vtkStreamingVolumeFrame(const vtkStreamingVolumeFrame&);
  void operator=(const vtkStreamingVolumeFrame&);

};
#endif