vtkMRMLTransformNode.h

Go to the documentation of this file.

/*=auto=========================================================================
 
  Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH) All Rights Reserved.
 
  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.
 
  Program:   3D Slicer
  Module:    $RCSfile: vtkMRMLTransformNode.h,v $
  Date:      $Date: 2006/03/19 17:12:29 $
  Version:   $Revision: 1.13 $
 
=========================================================================auto=*/
 
#ifndef __vtkMRMLTransformNode_h
#define __vtkMRMLTransformNode_h
 
#include "vtkMRMLDisplayableNode.h"
 
class vtkCollection;
class vtkAbstractTransform;
class vtkGeneralTransform;
class vtkMatrix4x4;
class vtkTransform;
 
class VTK_MRML_EXPORT vtkMRMLTransformNode : public vtkMRMLDisplayableNode
{
public:
  static vtkMRMLTransformNode *New();
  vtkTypeMacro(vtkMRMLTransformNode,vtkMRMLDisplayableNode);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  vtkMRMLNode* CreateNodeInstance() override;
 
  void ReadXMLAttributes( const char** atts) override;
 
  void WriteXML(ostream& of, int indent) override;
 
  vtkMRMLCopyContentMacro(vtkMRMLTransformNode);
 
  const char* GetNodeTagName() override {return "Transform";};
 
  void UpdateScene(vtkMRMLScene *scene) override
    {
     Superclass::UpdateScene(scene);
    };
 
  virtual int IsLinear();
 
  virtual int IsComposite();
 
  virtual vtkAbstractTransform* GetTransformToParent();
 
  virtual int GetMatrixTransformToParent(vtkMatrix4x4* matrix);
 
  virtual int GetMatrixTransformFromParent(vtkMatrix4x4* matrix);
 
  virtual vtkMatrix4x4* GetMatrixTransformToParent();
 
  virtual vtkMatrix4x4* GetMatrixTransformFromParent();
 
  virtual const char* GetTransformToParentInfo();
 
  virtual vtkAbstractTransform* GetTransformFromParent();
 
  virtual const char* GetTransformFromParentInfo();
 
  int  IsTransformToWorldLinear();
 
  int  IsTransformToNodeLinear(vtkMRMLTransformNode* node);
 
  void GetTransformToWorld(vtkGeneralTransform* transformToWorld);
 
  void GetTransformFromWorld(vtkGeneralTransform* transformFromWorld);
 
  void GetTransformToNode(vtkMRMLTransformNode* node,
                          vtkGeneralTransform* transformToNode);
 
  void GetTransformFromNode(vtkMRMLTransformNode* node,
                          vtkGeneralTransform* transformFromNode);
 
  static void GetTransformBetweenNodes(vtkMRMLTransformNode* sourceNode,
    vtkMRMLTransformNode* targetNode, vtkGeneralTransform* transformSourceToTarget);
 
  virtual int GetMatrixTransformToWorld(vtkMatrix4x4* transformToWorld);
 
  virtual int GetMatrixTransformFromWorld(vtkMatrix4x4* transformFromWorld);
 
  virtual int GetMatrixTransformToNode(vtkMRMLTransformNode* node,
                                       vtkMatrix4x4* transformToNode);
 
  virtual int GetMatrixTransformFromNode(vtkMRMLTransformNode* node,
                                       vtkMatrix4x4* transformFromNode);
 
  static int GetMatrixTransformBetweenNodes(vtkMRMLTransformNode* sourceNode,
    vtkMRMLTransformNode* targetNode, vtkMatrix4x4* transformSourceToTarget);
 
  int IsTransformNodeMyParent(vtkMRMLTransformNode* node);
 
  int IsTransformNodeMyChild(vtkMRMLTransformNode* node);
 
  vtkMRMLTransformNode* GetFirstCommonParent(vtkMRMLTransformNode* targetNode);
 
  virtual int SetMatrixTransformToParent(vtkMatrix4x4 *matrix);
 
  virtual int SetMatrixTransformFromParent(vtkMatrix4x4 *matrix);
 
  void ApplyTransformMatrix(vtkMatrix4x4* transformMatrix) override;
 
  virtual int SetAndObserveMatrixTransformToParent(vtkMatrix4x4 *matrix);
 
  virtual int SetAndObserveMatrixTransformFromParent(vtkMatrix4x4 *matrix);
 
  bool CanApplyNonLinearTransforms()const override;
  void ApplyTransform(vtkAbstractTransform* transform) override;
 
  virtual int Split();
 
  vtkMRMLStorageNode* CreateDefaultStorageNode() override;
 
  void CreateDefaultDisplayNodes() override;
 
  void CreateDefaultSequenceDisplayNodes() override;
 
  vtkGetMacro(ReadAsTransformToParent, int);
  vtkSetMacro(ReadAsTransformToParent, int);
  vtkBooleanMacro(ReadAsTransformToParent, int);
 
  virtual void TransformModified()
    {
    this->InvokeCustomModifiedEvent(vtkMRMLTransformableNode::TransformModifiedEvent);
    }
 
  bool GetModifiedSinceRead() override;
 
  vtkAbstractTransform* GetTransformToParentAs(const char* transformType, bool logErrorIfFails = true, bool modifiableOnly = false);
 
  vtkAbstractTransform* GetTransformFromParentAs(const char* transformType, bool logErrorIfFails = true, bool modifiableOnly = false);
 
  void SetAndObserveTransformToParent(vtkAbstractTransform *transform);
 
  void SetAndObserveTransformFromParent(vtkAbstractTransform *transform);
 
  void ProcessMRMLEvents ( vtkObject * /*caller*/,
                                   unsigned long /*event*/,
                                   void * /*callData*/ ) override;
 
  static void FlattenGeneralTransform(vtkCollection* outputTransformList, vtkAbstractTransform* inputTransform);
 
  static bool AreTransformsEqual(vtkAbstractTransform* transform1, vtkAbstractTransform* transform2);
 
  static bool IsGeneralTransformLinear(vtkAbstractTransform* inputTransform, vtkTransform* concatenatedLinearTransform=nullptr);
 
  static bool IsAbstractTransformComputedFromInverse(vtkAbstractTransform* abstractTransform);
 
  static int DeepCopyTransform(vtkAbstractTransform* dst, vtkAbstractTransform* src);
 
  void Inverse();
 
  virtual void InverseName();
 
  vtkMTimeType GetTransformToWorldMTime();
 
  const char* GetTransformInfo(vtkAbstractTransform* inputTransform);
 
  static const char* GetMovingNodeReferenceRole() { return "spatialRegistrationMoving"; };
  static const char* GetFixedNodeReferenceRole() { return "spatialRegistrationFixed"; };
 
protected:
  vtkMRMLTransformNode();
  ~vtkMRMLTransformNode() override;
  vtkMRMLTransformNode(const vtkMRMLTransformNode&);
  void operator=(const vtkMRMLTransformNode&);
 
  virtual vtkAbstractTransform* GetAbstractTransformAs(vtkAbstractTransform* inputTransform, const char* transformClassName, bool logErrorIfFails);
 
  virtual void SetAndObserveTransform(vtkAbstractTransform** originalTransformPtr, vtkAbstractTransform** inverseTransformPtr, vtkAbstractTransform *transform);
 
  vtkAbstractTransform* TransformToParent;
  vtkAbstractTransform* TransformFromParent;
 
  int ReadAsTransformToParent;
 
  // Temporary buffers used for returning transform info as char*
  std::string TransformInfo;
 
  vtkMatrix4x4* CachedMatrixTransformToParent;
  vtkMatrix4x4* CachedMatrixTransformFromParent;
};
 
#endif