igstkSpatialObject.h

Go to the documentation of this file.

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

  Program:   Image Guided Surgery Software Toolkit
  Module:    $RCSfile: igstkSpatialObject.h,v $
  Language:  C++
  Date:      $Date: 2009-01-30 18:24:31 $
  Version:   $Revision: 1.23 $

  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 __igstkSpatialObject_h
#define __igstkSpatialObject_h

#include "igstkLogger.h"
#include "itkSpatialObject.h"

#include "igstkMacros.h"
#include "igstkObject.h"
#include "igstkStateMachine.h"
#include "igstkEvents.h"

#include "igstkCoordinateSystemInterfaceMacros.h"

namespace igstk
{


class SpatialObject : public Object
{

public:

  igstkStandardClassTraitsMacro( SpatialObject, Object )

public: // this "public: is necessary because the 
        // Macro above introduces a private section.


  typedef itk::SpatialObject<3>          SpatialObjectType;

  typedef SpatialObjectType::BoundingBoxType BoundingBoxType;

  igstkLoadedObjectEventMacro( BoundingBoxEvent, IGSTKEvent,
                                        BoundingBoxType );

  void RequestGetBounds();
  void RequestGetBounds() const;

protected:

  SpatialObject( void );

  ~SpatialObject( void );

  void RequestSetInternalSpatialObject( SpatialObjectType * object );

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

  SpatialObjectType * GetInternalSpatialObject() const;

private:
  
  SpatialObjectType::Pointer   m_SpatialObject;
  SpatialObjectType::Pointer   m_SpatialObjectToBeSet;

  void ReportBoundsProcessing();
  void ReportBoundsNotAvailableProcessing();

  igstkDeclareInputMacro( InternalSpatialObjectNull );
  igstkDeclareInputMacro( InternalSpatialObjectValid );
  igstkDeclareInputMacro( RequestBounds );

  igstkDeclareStateMacro( Initial );
  igstkDeclareStateMacro( Ready );

  void SetInternalSpatialObjectProcessing();

  void ReportSpatialObjectNullProcessing();

  igstkCoordinateSystemClassInterfaceMacro();

};

igstkLoadedObjectEventMacro( 
  SpatialObjectModifiedEvent, IGSTKEvent, SpatialObject );

igstkEventMacro( SpatialObjectNotAvailableEvent, IGSTKErrorEvent );

} // end namespace igstk

#endif // __igstkSpatialObject_h