vtkImageImport.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkImageImport_h
#define vtkImageImport_h
 
#include "vtkIOImageModule.h" // For export macro
#include "vtkImageAlgorithm.h"
 
VTK_ABI_NAMESPACE_BEGIN
class VTKIOIMAGE_EXPORT vtkImageImport : public vtkImageAlgorithm
{
public:
  static vtkImageImport* New();
  vtkTypeMacro(vtkImageImport, vtkImageAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void CopyImportVoidPointer(void* ptr, vtkIdType size);


  void SetImportVoidPointer(void* ptr);
  void* GetImportVoidPointer() { return this->ImportVoidPointer; }

  void SetImportVoidPointer(void* ptr, int save);


  vtkSetMacro(DataScalarType, int);
  void SetDataScalarTypeToDouble() { this->SetDataScalarType(VTK_DOUBLE); }
  void SetDataScalarTypeToFloat() { this->SetDataScalarType(VTK_FLOAT); }
  void SetDataScalarTypeToInt() { this->SetDataScalarType(VTK_INT); }
  void SetDataScalarTypeToShort() { this->SetDataScalarType(VTK_SHORT); }
  void SetDataScalarTypeToUnsignedShort() { this->SetDataScalarType(VTK_UNSIGNED_SHORT); }
  void SetDataScalarTypeToUnsignedChar() { this->SetDataScalarType(VTK_UNSIGNED_CHAR); }
  vtkGetMacro(DataScalarType, int);
  const char* GetDataScalarTypeAsString()
  {
    return vtkImageScalarTypeNameMacro(this->DataScalarType);
  }



  vtkSetMacro(NumberOfScalarComponents, int);
  vtkGetMacro(NumberOfScalarComponents, int);


  vtkSetVector6Macro(DataExtent, int);
  vtkGetVector6Macro(DataExtent, int);
  void SetDataExtentToWholeExtent() { this->SetDataExtent(this->GetWholeExtent()); }


  vtkSetVector3Macro(DataSpacing, double);
  vtkGetVector3Macro(DataSpacing, double);


  vtkSetVector3Macro(DataOrigin, double);
  vtkGetVector3Macro(DataOrigin, double);


  vtkSetVectorMacro(DataDirection, double, 9);
  vtkGetVectorMacro(DataDirection, double, 9);


  vtkSetVector6Macro(WholeExtent, int);
  vtkGetVector6Macro(WholeExtent, int);

  int RequestUpdateExtent(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int ComputePipelineMTime(vtkInformation* request, vtkInformationVector** inInfoVec,
    vtkInformationVector* outInfoVec, int requestFromOutputPort, vtkMTimeType* mtime) override;


  vtkSetStringMacro(ScalarArrayName);
  vtkGetStringMacro(ScalarArrayName);


  typedef void (*UpdateInformationCallbackType)(void*);
  typedef int (*PipelineModifiedCallbackType)(void*);
  typedef int* (*WholeExtentCallbackType)(void*);
  typedef double* (*SpacingCallbackType)(void*);
  typedef double* (*OriginCallbackType)(void*);
  typedef double* (*DirectionCallbackType)(void*);
  typedef const char* (*ScalarTypeCallbackType)(void*);
  typedef int (*NumberOfComponentsCallbackType)(void*);
  typedef void (*PropagateUpdateExtentCallbackType)(void*, int*);
  typedef void (*UpdateDataCallbackType)(void*);
  typedef int* (*DataExtentCallbackType)(void*);
  typedef void* (*BufferPointerCallbackType)(void*);


  vtkSetMacro(UpdateInformationCallback, UpdateInformationCallbackType);
  vtkGetMacro(UpdateInformationCallback, UpdateInformationCallbackType);


  vtkSetMacro(PipelineModifiedCallback, PipelineModifiedCallbackType);
  vtkGetMacro(PipelineModifiedCallback, PipelineModifiedCallbackType);


  vtkSetMacro(WholeExtentCallback, WholeExtentCallbackType);
  vtkGetMacro(WholeExtentCallback, WholeExtentCallbackType);


  vtkSetMacro(SpacingCallback, SpacingCallbackType);
  vtkGetMacro(SpacingCallback, SpacingCallbackType);


  vtkSetMacro(OriginCallback, OriginCallbackType);
  vtkGetMacro(OriginCallback, OriginCallbackType);


  vtkSetMacro(DirectionCallback, DirectionCallbackType);
  vtkGetMacro(DirectionCallback, DirectionCallbackType);


  vtkSetMacro(ScalarTypeCallback, ScalarTypeCallbackType);
  vtkGetMacro(ScalarTypeCallback, ScalarTypeCallbackType);


  vtkSetMacro(NumberOfComponentsCallback, NumberOfComponentsCallbackType);
  vtkGetMacro(NumberOfComponentsCallback, NumberOfComponentsCallbackType);


  vtkSetMacro(PropagateUpdateExtentCallback, PropagateUpdateExtentCallbackType);
  vtkGetMacro(PropagateUpdateExtentCallback, PropagateUpdateExtentCallbackType);


  vtkSetMacro(UpdateDataCallback, UpdateDataCallbackType);
  vtkGetMacro(UpdateDataCallback, UpdateDataCallbackType);


  vtkSetMacro(DataExtentCallback, DataExtentCallbackType);
  vtkGetMacro(DataExtentCallback, DataExtentCallbackType);


  vtkSetMacro(BufferPointerCallback, BufferPointerCallbackType);
  vtkGetMacro(BufferPointerCallback, BufferPointerCallbackType);


  vtkSetMacro(CallbackUserData, void*);
  vtkGetMacro(CallbackUserData, void*);


  int InvokePipelineModifiedCallbacks();
  void InvokeUpdateInformationCallbacks();
  void InvokeExecuteInformationCallbacks();
  void InvokeExecuteDataCallbacks();
  void LegacyCheckWholeExtent();
 
protected:
  vtkImageImport();
  ~vtkImageImport() override;
 
  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  void* ImportVoidPointer;
  int SaveUserArray;
 
  int NumberOfScalarComponents;
  int DataScalarType;
 
  int WholeExtent[6];
  int DataExtent[6];
  double DataSpacing[3];
  double DataOrigin[3];
  double DataDirection[9];
 
  char* ScalarArrayName;
  void* CallbackUserData;
 
  UpdateInformationCallbackType UpdateInformationCallback;
  PipelineModifiedCallbackType PipelineModifiedCallback;
  WholeExtentCallbackType WholeExtentCallback;
  SpacingCallbackType SpacingCallback;
  OriginCallbackType OriginCallback;
  DirectionCallbackType DirectionCallback;
  ScalarTypeCallbackType ScalarTypeCallback;
  NumberOfComponentsCallbackType NumberOfComponentsCallback;
  PropagateUpdateExtentCallbackType PropagateUpdateExtentCallback;
  UpdateDataCallbackType UpdateDataCallback;
  DataExtentCallbackType DataExtentCallback;
  BufferPointerCallbackType BufferPointerCallback;
 
  void ExecuteDataWithInformation(vtkDataObject* d, vtkInformation* outInfo) override;
 
private:
  vtkImageImport(const vtkImageImport&) = delete;
  void operator=(const vtkImageImport&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif