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

  Program:   Image Guided Surgery Software Toolkit
  Module:    $RCSfile: igstkObjectRepresentation.h,v $
  Language:  C++
  Date:      $Date: 2006/06/24 20:30:07 $
  Version:   $Revision: 1.20 $

  Copyright (c) ISIS Georgetown University. All rights reserved.
  See IGSTKCopyright.txt or http://www.igstk.org/HTML/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 __igstkObjectRepresentation_h
#define __igstkObjectRepresentation_h

#ifdef _MSC_VER
#pragma warning ( disable : 4786 )
#endif

#include <vector>
#include "itkCommand.h"
#include "itkLogger.h"
#include "vtkProp.h"
#include "igstkObject.h"
#include "igstkMacros.h"
#include "igstkSpatialObject.h"
#include "igstkStateMachine.h"


namespace igstk
{

class View;

/** \class ObjectRepresentation
 * 
 * \brief Base class for all the igstk representation objects.
 *
 * This class serves as the base class for all the representation objects that
 * will provide a VTK visualization of the Spatial Objects that are composing a
 * given scene.
 *
 *
 * \ingroup Object
 */
class ObjectRepresentation 
  : public Object
{

public:

  /** Macro with standard traits declarations. */
  igstkStandardAbstractClassTraitsMacro( ObjectRepresentation, Object )

public:

  typedef double                             ScalarType;
  typedef SpatialObject                      SpatialObjectType;
  typedef std::vector< vtkProp* >            ActorsListType; 

  igstkFriendClassMacro( View );

  /** Set the color */
  void SetColor(float r, float g, float b);

  /** Get each color component */
  float GetRed() const   {return m_Color[0];}
  float GetGreen() const {return m_Color[1];}
  float GetBlue() const  {return m_Color[2];}

  /** Set/Get the opacity */
  void SetOpacity(float alpha);
  igstkGetMacro( Opacity, float );

protected:

  ObjectRepresentation( void );
  ~ObjectRepresentation( void );

  /** Add an actor to the list */
  void AddActor( vtkProp * );

  /** Create the vtkActors */
  virtual void CreateActors()= 0;

  /** Get the VTK actors */
  igstkGetMacro( Actors, ActorsListType );

  /** Empty the list of actors */
  virtual void DeleteActors();

  /** Print the object informations in a stream. */
  virtual void PrintSelf( std::ostream& os, itk::Indent indent ) const;

  /** Request the state machine to set a Spatial Object */
  void RequestSetSpatialObject( const SpatialObjectType * spatialObject );
  
  /** Verify if the time of the rendering matches the time of the transform.
   * If the two TimeStamps do not overlap, then the actors are made invisible.
   * This method must be called from all the UpdateRepresentation() of the
   * derived classes. */
  void RequestVerifyTimeStamp();
  
private:

  ActorsListType              m_Actors;
  float                       m_Color[3];
  float                       m_Opacity;

  /** The associated SpatialObject is non-const because we invoke requests
   * methods that indirectly will modify the state of its internal StateMachine
   * */
  SpatialObjectType::Pointer  m_SpatialObject;

  /** update the visual representation with changes in the geometry */
  virtual void RequestUpdateRepresentation( const TimeStamp & time );

  /** update the visual representation with changes in the geometry. Only to be
   * called by the State Machine. This is an abstract method that MUST be
   * overloaded in every derived class. */
  virtual void UpdateRepresentationProcessing() = 0;
 
  /** update the visual representation position */
  virtual void RequestUpdatePosition( const TimeStamp & time );

  /** Null operation for a State Machine transition */
  void NoProcessing();

  /** Update the position of the object. 
   *  This should not be overloaded by other classes */
  void UpdateActorsPositionProcessing();

  /** Set the spatial object for this class */
  void SetSpatialObjectProcessing(); 

  /** Report when an invalid request is made to the StateMachine */
  void ReportInvalidRequestProcessing();

  /** Make Objects Invisible. 
   *  This method is called when the Transform time stamp
   *  has expired with respect to the requested rendering time. */
  void MakeObjectsInvisibleProcessing();

  /** Make Objects Visible. This method is called when the Transform time stamp
   * is valid with respect to the requested rendering time. */
  void MakeObjectsVisibleProcessing();

  /** This method will delegate to the attached Spatial Object the request for
   * updating the Transform that defines the position and orientation of the
   * object in space. */
  void RequestUpdatePositionProcessing();

  /** Receive the Transform from the SpatialObject via a transduction macro.
   *  Once the transform is received, the validity time is verified. */
  void ReceiveSpatialObjectTransformProcessing();

private:

  /** Inputs to the State Machine */
  igstkDeclareInputMacro( ValidSpatialObject );
  igstkDeclareInputMacro( NullSpatialObject );
  igstkDeclareInputMacro( UpdateActorsPosition );
  igstkDeclareInputMacro( UpdateRepresentation );
  igstkDeclareInputMacro( ValidTimeStamp );
  igstkDeclareInputMacro( InvalidTimeStamp );
  igstkDeclareInputMacro( SpatialObjectTransform );
  igstkDeclareInputMacro( RequestUpdatePosition );
  
  /** States for the State Machine */
  igstkDeclareStateMacro( NullSpatialObject );
  igstkDeclareStateMacro( ValidSpatialObjectAndVisible );
  igstkDeclareStateMacro( ValidSpatialObjectAndInvisible );
  igstkDeclareStateMacro( ValidSpatialObject );
  igstkDeclareStateMacro( ValidTimeStamp );
  igstkDeclareStateMacro( InvalidTimeStamp );
  igstkDeclareStateMacro( AttemptingUpdatePositionAndVisible );
  igstkDeclareStateMacro( AttemptingUpdatePositionAndInvisible );

  /** Transduction macros that will convert received events 
   *  into StateMachine inputs */
  igstkLoadedEventTransductionMacro( TransformModifiedEvent, 
                                     SpatialObjectTransformInput, 
                                     SpatialObjectTransform );

  /** Internal temporary variable to use when connecting to a SpatialObject */
  SpatialObjectType::Pointer    m_SpatialObjectToAdd;

  /** Time stamp for the time at which the next rendering will take place */
  TimeStamp            m_TimeToRender;

  /** Transform returned from the Spatial Object */
  Transform            m_SpatialObjectTransform;
    
};

} // end namespace igstk

#endif // __igstkObjectRepresentation_h