vtkMRMLLayerDMPythonUtil.h

Go to the documentation of this file.

/*==============================================================================
 
  Program: 3D Slicer
 
  Copyright (c) Kitware SAS
 
  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 Thibault Pelletier, Kitware SAS,
  and was partially funded by ANR grants ANR-22-CE45-0034 and ANR-18-RHUS-005.
 
==============================================================================*/
 
#ifndef __vtkMRMLLayerDMPythonUtil_h
#define __vtkMRMLLayerDMPythonUtil_h
#include "vtkSlicerLayerDMModuleMRMLExport.h"
 
// VTK includes
#include <vtkObject.h>
#include <vtkPython.h>
#include <vtkPythonUtil.h>
#include <vtkSmartPyObject.h>
 
// STD includes
#include <string>
#include <vector>

class VTK_SLICER_LAYERDM_MODULE_MRML_EXPORT vtkMRMLLayerDMPythonUtil : public vtkObject
{
public:
  static vtkMRMLLayerDMPythonUtil* New();
  vtkTypeMacro(vtkMRMLLayerDMPythonUtil, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static PyObject* ToPyObject(vtkObjectBase* obj);

  static PyObject* ToPyObject(unsigned long value);

  static PyObject* ToPyObject(const std::string& value);

  static PyObject* RawPtrToPython(void* ptr);

  static vtkSmartPyObject ToPyArgs(const std::vector<PyObject*>& pyObjs);

  static vtkSmartPyObject ToPyArgs(vtkObjectBase* obj);

  static vtkSmartPyObject ToPyArgs(vtkObject* obj, unsigned long eventId, void* callData);

  static PyObject* CastCallData(PyObject* object, int vtkType);

  static PyObject* CallPythonMethod(PyObject* object, const vtkSmartPyObject& pyArgs, const std::string& fName);

  static PyObject* CallPythonObject(PyObject* object, const vtkSmartPyObject& pyArgs);

  static void SetPythonObject(PyObject** destObject, PyObject* object);

  static void DeletePythonObject(PyObject** destObject);

  static bool IsValidPythonContext();

  static std::string FormatExceptionTraceback();

  static void PrintErrorTraceback(const vtkObject* object, const std::string& errorMsg);

  static std::string GetObjectStr(PyObject* object);
 
protected:
  vtkMRMLLayerDMPythonUtil();
  ~vtkMRMLLayerDMPythonUtil() override;
};
 
#endif