IGSTK
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
igstk::VideoFrameRepresentation< TVideoFrameSpatialObject > Class Template Reference

#include <igstkVideoFrameRepresentation.h>

Inheritance diagram for igstk::VideoFrameRepresentation< TVideoFrameSpatialObject >:
Inheritance graph
[legend]
Collaboration diagram for igstk::VideoFrameRepresentation< TVideoFrameSpatialObject >:
Collaboration graph
[legend]

Public Types

typedef
VideoFrameSpatialObjectType::ConstPointer 
VideoFrameSpatialObjectConstPointer
 
- Public Types inherited from igstk::ObjectRepresentation
typedef double OpacityType
 Type for representing the opacity of the object. More...
 
- Public Types inherited from igstk::Object
typedef Object Self
 General Typedefs. More...
 
typedef ::itk::Object Superclass
 
typedef ::itk::SmartPointer< SelfPointer
 
typedef ::itk::SmartPointer
< const Self
ConstPointer
 
typedef igstk::Logger LoggerType
 

Public Member Functions

void RequestSetVideoFrameSpatialObject (const VideoFrameSpatialObjectType *spatialObject)
 Connect this representation class to the spatial object. More...
 
 igstkObserverMacro (VTKImage, VTKImageModifiedEvent, EventHelperType::VTKImagePointerType)
 Observer macro that will received a event with an image as payload and will store it internally. More...
 
void SetWindowLevel (double window, double level)
 Set the Window Level for the representation. More...
 
void SaveScreenShot (const std::string &filename)
 
Pointer Copy () const
 Return a copy of the current object representation. More...
 
- Public Member Functions inherited from igstk::ObjectRepresentation
void SetColor (ColorScalarType r, ColorScalarType g, ColorScalarType b)
 Set the color. More...
 
ColorScalarType GetRed () const
 Get each color component. More...
 
ColorScalarType GetGreen () const
 
ColorScalarType GetBlue () const
 
virtual void SetOpacity (OpacityType alpha)
 Set/Get the opacity. More...
 
virtual OpacityType GetOpacity ()
 
virtual ActorsListType GetActors ()
 Get the VTK actors. More...
 
virtual void RequestUpdateRepresentation (const TimeStamp &time, const CoordinateSystem *cs)
 Update the visual representation with changes in the geometry. More...
 
- Public Member Functions inherited from igstk::Object
virtual const char * GetNameOfClass () const
 
void SetLogger (LoggerType *logger)
 Connect the Logger for this class. More...
 
void RemoveObserver (unsigned long tag) const
 

Public Attributes

igstkStandardTemplatedClassTraitsMacro(VideoFrameRepresentation,
ObjectRepresentation) typedef
itk typedef
TVideoFrameSpatialObject 
VideoFrameSpatialObjectType
 Observer type for loaded event, the callback can be set to a member function. More...
 
- Public Attributes inherited from igstk::ObjectRepresentation
igstkStandardAbstractClassTraitsMacro(ObjectRepresentation,
Object) public typedef double 
ColorScalarType
 Macro with standard traits declarations. More...
 

Protected Member Functions

 VideoFrameRepresentation (void)
 
 ~VideoFrameRepresentation (void)
 
void DeleteActors ()
 Overloaded function to delete actors. More...
 
bool VerifyTimeStamp () const
 Verify the time stamp. More...
 
void CreateActors ()
 Create the VTK actors for displaying geometry. More...
 
- Protected Member Functions inherited from igstk::ObjectRepresentation
 ObjectRepresentation (void)
 
 ~ObjectRepresentation (void)
 
void AddActor (vtkProp *)
 Add an actor to the list. More...
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object informations in a stream. More...
 
void RequestSetSpatialObject (const SpatialObject *spatialObject)
 Request the state machine to set a Spatial Object. More...
 
TimeStamp GetRenderTimeStamp () const
 Get Time stamp for the time at which the next rendering will take place. More...
 
- Protected Member Functions inherited from igstk::Object
LoggerTypeGetLogger () const
 
 Object (void)
 Constructor is protected in order to enforce the use of the New() operator. More...
 
virtual ~Object (void)
 
void RegisterObservedObject (const ::igstk::Object *object, unsigned long tag)
 Register observed objects in an internal array so that they can be disconnected upon destruction. More...
 
void RemoveFromObservedObjects ()
 Remove observers that this object may have connected to other objects. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)
 
- Protected Attributes inherited from igstk::ObjectRepresentation
ActorsListType m_Actors
 
OpacityType m_Opacity
 

Detailed Description

template<class TVideoFrameSpatialObject>
class igstk::VideoFrameRepresentation< TVideoFrameSpatialObject >

Definition at line 32 of file igstkVideoFrameRepresentation.h.

Member Typedef Documentation

template<class TVideoFrameSpatialObject >
typedef VideoFrameSpatialObjectType::ConstPointer igstk::VideoFrameRepresentation< TVideoFrameSpatialObject >::VideoFrameSpatialObjectConstPointer

Definition at line 45 of file igstkVideoFrameRepresentation.h.

Constructor & Destructor Documentation

template<class TVideoFrameSpatialObject >
igstk::VideoFrameRepresentation< TVideoFrameSpatialObject >::VideoFrameRepresentation ( void  )
protected
template<class TVideoFrameSpatialObject >
igstk::VideoFrameRepresentation< TVideoFrameSpatialObject >::~VideoFrameRepresentation ( void  )
protected

Member Function Documentation

template<class TVideoFrameSpatialObject >
void igstk::VideoFrameRepresentation< TVideoFrameSpatialObject >::RequestSetVideoFrameSpatialObject ( const VideoFrameSpatialObjectType spatialObject)

Connect this representation class to the spatial object.

template<class TVideoFrameSpatialObject >
igstk::VideoFrameRepresentation< TVideoFrameSpatialObject >::igstkObserverMacro ( VTKImage  ,
VTKImageModifiedEvent  ,
EventHelperType::VTKImagePointerType   
)

Observer macro that will received a event with an image as payload and will store it internally.

This will be the receptor of the event sent by the VideoFrameSpatialObject when an image is requested.

template<class TVideoFrameSpatialObject >
void igstk::VideoFrameRepresentation< TVideoFrameSpatialObject >::SetWindowLevel ( double  window,
double  level 
)

Set the Window Level for the representation.

template<class TVideoFrameSpatialObject >
void igstk::VideoFrameRepresentation< TVideoFrameSpatialObject >::SaveScreenShot ( const std::string &  filename)
template<class TVideoFrameSpatialObject >
Pointer igstk::VideoFrameRepresentation< TVideoFrameSpatialObject >::Copy ( ) const

Return a copy of the current object representation.

template<class TVideoFrameSpatialObject >
void igstk::VideoFrameRepresentation< TVideoFrameSpatialObject >::DeleteActors ( )
protectedvirtual

Overloaded function to delete actors.

Reimplemented from igstk::ObjectRepresentation.

template<class TVideoFrameSpatialObject >
bool igstk::VideoFrameRepresentation< TVideoFrameSpatialObject >::VerifyTimeStamp ( ) const
protectedvirtual

Verify the time stamp.

A default implementation is provided that checks if the spatial object transform is within the Rendering time period. This method could be overridden in derived classes that can use other criteria to verify the time stamp.

Reimplemented from igstk::ObjectRepresentation.

template<class TVideoFrameSpatialObject >
void igstk::VideoFrameRepresentation< TVideoFrameSpatialObject >::CreateActors ( )
protectedvirtual

Create the VTK actors for displaying geometry.

Implements igstk::ObjectRepresentation.

Member Data Documentation

template<class TVideoFrameSpatialObject >
igstkStandardTemplatedClassTraitsMacro ( VideoFrameRepresentation, ObjectRepresentation ) typedef itk typedef TVideoFrameSpatialObject igstk::VideoFrameRepresentation< TVideoFrameSpatialObject >::VideoFrameSpatialObjectType

Observer type for loaded event, the callback can be set to a member function.

Definition at line 36 of file igstkVideoFrameRepresentation.h.


The documentation for this class was generated from the following file: