IGSTK
|
Display graphical representations of surgical scenes. More...
#include <igstkView.h>
Public Member Functions | |
igstkStandardClassTraitsMacro (View, Object) | |
Macro with standard traits declarations. | |
void | SetRefreshRate (double frequency) |
Set the desired frequency for refreshing the view. | |
void | RequestAddObject (ObjectRepresentation *object) |
Add an object representation to the list of children and associate it with a specific view. | |
void | RequestAddAnnotation2D (Annotation2D::Pointer annotation) |
Add annotation to the view. | |
void | RequestRemoveObject (ObjectRepresentation *object) |
Remove the object passed as arguments from the list of children, only if it is associated to a particular view. | |
void | RequestSaveScreenShot (const std::string &filename) |
Request to save a screen shot into a file. | |
void | Print (std::ostream &os,::itk::Indent indent=0) const |
Print the object information in a stream. | |
void | SetLogger (LoggerType *logger) |
Connect the Logger for this class. | |
void | RequestResetCamera () |
Request to return the camera to a known position. | |
void | RequestStart () |
Request Start the periodic refreshing of the view. | |
void | RequestStop () |
Request Stopping the periodic refreshing of the view. | |
void | SetCameraPosition (double x, double y, double z) |
Set Camera position. | |
void | SetCameraFocalPoint (double x, double y, double z) |
Set camera focal point. | |
void | SetCameraViewUp (double vx, double vy, double vz) |
Set Camera View Up vector. | |
void | SetCameraClippingRange (double dNear, double dFar) |
Set Clipping range. | |
void | SetCameraParallelProjection (bool flag) |
Turn on/off parallel projection. | |
void | SetRendererBackgroundColor (double red, double green, double blue) |
Set renderer background color. | |
void | SetCameraZoomFactor (double rate) |
Set camera zoom factor. | |
Protected Member Functions | |
LoggerType * | GetLogger () const |
Set up variables, types and methods related to the Logger. | |
View () | |
virtual | ~View (void) |
virtual void | PrintSelf (std::ostream &os, itk::Indent indent) const |
Print the object information in a stream. | |
void | SetInteractorStyle (vtkInteractorStyle *style) |
Set the interactor style in the derived classes. | |
void | RequestSetRenderWindowSize (int width, int height) |
Set the size of the render window. | |
void | RequestInitializeRenderWindowInteractor () |
Request initialize the RenderWindow interactor. | |
void | SetPickedPointCoordinates (double xPosition, double yPosition) |
Sets the coordinates of the point picked. | |
Friends | |
class | ViewProxyBase |
Display graphical representations of surgical scenes.
The functionality of the View class is to aggregate all the graphical representations of spatial objects into one scene. igstk::View2D and igstk::View3D classes are derived from this class for 2D and 3D viewing capabilities. The view class encapsulate VTK classes into a restrictive API subjected to control of a state machine.
State Machine Diagram
Definition at line 73 of file igstkView.h.
igstk::View::View | ( | ) | [protected] |
virtual igstk::View::~View | ( | void | ) | [protected, virtual] |
Macro with standard traits declarations.
void igstk::View::SetRefreshRate | ( | double | frequency | ) |
Set the desired frequency for refreshing the view.
It is not worth to attempt to go faster than your monitor, nor more than double than your trackers
void igstk::View::RequestAddObject | ( | ObjectRepresentation * | object | ) |
Add an object representation to the list of children and associate it with a specific view.
void igstk::View::RequestAddAnnotation2D | ( | Annotation2D::Pointer | annotation | ) |
Add annotation to the view.
void igstk::View::RequestRemoveObject | ( | ObjectRepresentation * | object | ) |
Remove the object passed as arguments from the list of children, only if it is associated to a particular view.
void igstk::View::RequestSaveScreenShot | ( | const std::string & | filename | ) |
Request to save a screen shot into a file.
The file format MUST be PNG in order to have lossless compression. This method will trigger an extra rendering of the scene in order to ensure that the image is fresh.
void igstk::View::Print | ( | std::ostream & | os, |
::itk::Indent | indent = 0 |
||
) | const |
Print the object information in a stream.
LoggerType* igstk::View::GetLogger | ( | ) | const [protected] |
Set up variables, types and methods related to the Logger.
Reimplemented from igstk::Object.
void igstk::View::SetLogger | ( | LoggerType * | logger | ) |
Connect the Logger for this class.
Reimplemented from igstk::Object.
void igstk::View::RequestResetCamera | ( | ) |
Request to return the camera to a known position.
void igstk::View::RequestStart | ( | ) |
Request Start the periodic refreshing of the view.
void igstk::View::RequestStop | ( | ) |
Request Stopping the periodic refreshing of the view.
void igstk::View::SetCameraPosition | ( | double | x, |
double | y, | ||
double | z | ||
) |
Set Camera position.
void igstk::View::SetCameraFocalPoint | ( | double | x, |
double | y, | ||
double | z | ||
) |
Set camera focal point.
void igstk::View::SetCameraViewUp | ( | double | vx, |
double | vy, | ||
double | vz | ||
) |
Set Camera View Up vector.
void igstk::View::SetCameraClippingRange | ( | double | dNear, |
double | dFar | ||
) |
Set Clipping range.
void igstk::View::SetCameraParallelProjection | ( | bool | flag | ) |
Turn on/off parallel projection.
void igstk::View::SetRendererBackgroundColor | ( | double | red, |
double | green, | ||
double | blue | ||
) |
Set renderer background color.
void igstk::View::SetCameraZoomFactor | ( | double | rate | ) |
Set camera zoom factor.
virtual void igstk::View::PrintSelf | ( | std::ostream & | os, |
itk::Indent | indent | ||
) | const [protected, virtual] |
Print the object information in a stream.
Reimplemented from igstk::Object.
void igstk::View::SetInteractorStyle | ( | vtkInteractorStyle * | style | ) | [protected] |
Set the interactor style in the derived classes.
void igstk::View::RequestSetRenderWindowSize | ( | int | width, |
int | height | ||
) | [protected] |
Set the size of the render window.
void igstk::View::RequestInitializeRenderWindowInteractor | ( | ) | [protected] |
Request initialize the RenderWindow interactor.
void igstk::View::SetPickedPointCoordinates | ( | double | xPosition, |
double | yPosition | ||
) | [protected] |
Sets the coordinates of the point picked.
friend class ViewProxyBase [friend] |
Definition at line 140 of file igstkView.h.