/*
//
//  Copyright 2010 SRI International
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit is distributed in the hope that it
//  will be useful, but WITHOUT ANY WARRANTY; without even the implied
//  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 5436 $
//
//  $LastChangedDate: 2018-12-10 19:01:20 -0800 (Mon, 10 Dec 2018) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkDeviceUniformVolumeArray_h_included_
#define __cmtkDeviceUniformVolumeArray_h_included_

#include <cmtkconfig.h>

#include "cmtkDeviceArray.h"

#include <Base/cmtkUniformVolume.h>

namespace
cmtk
{

/** \addtogroup GPU */
//@{

/// Representation of a uniform volume as 3D texture in device memory.
class DeviceUniformVolumeArray
{
public:
  /// This class.
  typedef DeviceUniformVolumeArray Self;

  /// Smart pointer to this class.
  typedef SmartPointer<Self> SmartPtr;

  /// Create device representation of volume object.
  static Self::SmartPtr Create( const UniformVolume& volume )
  {
    return Self::SmartPtr( new Self( volume ) );
  }

  /// Get volume array on device.
  DeviceArray::SmartPtr& GetDeviceArrayPtr()
  {
    return this->m_DeviceArrayPointer;
  }
  
private:
  /// Constructor.
  DeviceUniformVolumeArray( const UniformVolume& volume );

  /// Device array pointer.
  DeviceArray::SmartPtr m_DeviceArrayPointer;
};

} // namespace cmtk

#endif // #ifndef __cmtkDeviceUniformVolumeArray_h_included_
