igstkCoordinateSystemDelegator.h

Go to the documentation of this file.

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

  Program:   Image Guided Surgery Software Toolkit
  Module:    $RCSfile: igstkCoordinateSystemDelegator.h,v $
  Language:  C++
  Date:      $Date: 2009-02-02 21:00:06 $
  Version:   $Revision: 1.5 $

  Copyright (c) ISC  Insight Software Consortium.  All rights reserved.
  See IGSTKCopyright.txt or http://www.igstk.org/copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

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

#ifndef __igstkCoordinateSystemDelegator_h
#define __igstkCoordinateSystemDelegator_h

#include "igstkCoordinateSystem.h"
#include "igstkCoordinateSystemTransformToResult.h"
#include "igstkCoordinateSystemTransformToErrorResult.h"
#include "igstkCoordinateSystemSetTransformResult.h"

namespace igstk
{

class CoordinateSystemDelegator : public Object
{
public: 

  igstkStandardClassTraitsMacro( CoordinateSystemDelegator, Object )
  
  
  template < class TParentPointer >
  void RequestSetTransformAndParent( const Transform & transformToParent, 
                                     TParentPointer parent )
    {
    if( !(parent) ) // This expression must be suitable for both 
                    // Smart and Raw pointers.
      {
      igstkPushInputMacro( NullParent );
      m_StateMachine.ProcessInputs();
      return;
      }
    else
      {
      const CoordinateSystem* parentReferenceSystem = 
      igstk::Friends::CoordinateSystemHelper
                                    ::GetCoordinateSystem( parent );

      this->m_CoordinateSystem->RequestSetTransformAndParent(
                                                      transformToParent,
                                                      parentReferenceSystem);

      return;
      }
    }

  // This method updates the transform between this object and its parent 
  void RequestUpdateTransformToParent( const Transform & transformToParent )
    {
    this->m_CoordinateSystem->RequestUpdateTransformToParent(
                                                         transformToParent);
    }

  void RequestGetTransformToParent();

  void RequestDetachFromParent()
    {
    this->m_CoordinateSystem->RequestDetachFromParent();
    }

  template <class TTarget>
  void RequestComputeTransformTo(const TTarget & target)
    {
    if( !(target) )
      {
      igstkPushInputMacro( NullTarget );
      m_StateMachine.ProcessInputs();
      return;
      }

    const CoordinateSystem* targetCoordSys = 
      igstk::Friends::CoordinateSystemHelper::
                                      GetCoordinateSystem( target );

    this->m_CoordinateSystem->RequestComputeTransformTo(
                                                             targetCoordSys);
    }

  typedef igstk::CoordinateSystem              CoordinateSystemType;

  bool IsCoordinateSystem( const CoordinateSystemType* ) const;

  void PrintSelf( std::ostream& os, itk::Indent indent ) const;

  void SetName( const char* name );
  void SetName( const std::string& name );
  const char* GetName() const;

  void SetType( const char* type );
  void SetType( const std::string& type );
  const char* GetType() const;
  
protected:
  CoordinateSystemDelegator();
  ~CoordinateSystemDelegator();

private:
  CoordinateSystemDelegator(const CoordinateSystemDelegator& );

  CoordinateSystemDelegator& operator=(const CoordinateSystemDelegator&);

  igstkDeclareStateMacro( Idle );

  igstkDeclareInputMacro( NullParent );
  igstkDeclareInputMacro( NullTarget );

  igstkFriendClassMacro( igstk::Friends::CoordinateSystemHelper );

  const CoordinateSystem * GetCoordinateSystem() const;

  CoordinateSystem::Pointer      m_CoordinateSystem;

  void NullParentProcessing();

  void NullTargetProcessing();

  typedef ::itk::ReceptorMemberCommand< Self > CoordinateSystemObserverType;

  CoordinateSystemObserverType::Pointer m_CoordinateSystemObserver;

  void ObserverCallback(const ::itk::EventObject & eventvar);

}; // class CoordinateSystemDelegator

}

#endif