Medical Imaging Interaction Toolkit  2018.4.99-701c8286
Medical Imaging Interaction Toolkit
mitk::CameraVisualization Class Reference

CameraVisualization controls the camera according to the spatial information of the navigation data. More...

#include <mitkCameraVisualization.h>

Inheritance diagram for mitk::CameraVisualization:
Collaboration diagram for mitk::CameraVisualization:

Public Member Functions

 mitkClassMacro (CameraVisualization, NavigationDataToNavigationDataFilter)
 
Pointer Clone () const
 
virtual void SetDirectionOfProjectionInToolCoordinates (mitk::Vector3D _arg)
 sets the direction of projection of the camera of the renderer in tool coordinates More...
 
virtual void SetViewUpInToolCoordinates (mitk::Vector3D _arg)
 sets the view up vector of the camera of the renderer in tool coordinates More...
 
virtual void SetFocalLength (float _arg)
 sets the focal length of the camera More...
 
virtual mitk::Vector3D GetDirectionOfProjectionInToolCoordinates () const
 returns the direction of projection of the camera of the renderer in tool coordinates More...
 
virtual mitk::Vector3D GetViewUpInToolCoordinates () const
 returns the view up vector of the camera of the renderer in tool coordinates More...
 
virtual float GetFocalLength () const
 returns the focal length of the camera More...
 
virtual void SetRenderer (mitk::BaseRenderer *renderer)
 sets renderer that visualizes the navigation data More...
 
virtual const mitk::BaseRendererGetRenderer ()
 returns the renderer that visualizes the navigation data More...
 
void SetParameters (const mitk::PropertyList *p) override
 Set all filter parameters as the PropertyList p. More...
 
mitk::PropertyList::ConstPointer GetParameters () const override
 Get all filter parameters as a PropertyList. More...
 
- Public Member Functions inherited from mitk::NavigationDataToNavigationDataFilter
 mitkClassMacro (NavigationDataToNavigationDataFilter, NavigationDataSource)
 
virtual void SetInput (const NavigationData *nd)
 Set the input of this filter. More...
 
virtual void SetInput (unsigned int idx, const NavigationData *nd)
 Set input with id idx of this filter. More...
 
const NavigationDataGetInput (void) const
 Get the input of this filter. More...
 
const NavigationDataGetInput (unsigned int idx) const
 Get the input with id idx of this filter. More...
 
const NavigationDataGetInput (std::string navDataName) const
 Get the input with name navDataName of this filter. More...
 
DataObjectPointerArraySizeType GetInputIndex (std::string navDataName)
 return the index of the input with name navDataName, throw std::invalid_argument exception if that name was not found More...
 
virtual void ConnectTo (mitk::NavigationDataSource *UpstreamFilter)
 Connects the input of this filter to the outputs of the given NavigationDataSource. More...
 
- Public Member Functions inherited from mitk::NavigationDataSource
 mitkClassMacroItkParent (NavigationDataSource, itk::ProcessObject)
 
virtual std::string GetName ()
 
virtual void SetName (std::string _arg)
 Sets the human readable name of this source. There is also a default name, but you can use this method if you need to define it on your own. More...
 
NavigationDataGetOutput (void)
 return the output (output with id 0) of the filter More...
 
NavigationDataGetOutput (DataObjectPointerArraySizeType idx)
 return the output with id idx of the filter More...
 
NavigationDataGetOutput (const std::string &navDataName)
 return the output with name navDataName of the filter More...
 
NavigationTool::Pointer GetToolMetaData (DataObjectPointerArraySizeType idx)
 
NavigationTool::Pointer GetToolMetaData (const std::string &navDataName)
 
virtual mitk::NavigationToolStorage::Pointer GetToolMetaDataCollection ()
 
virtual void SetToolMetaDataCollection (mitk::NavigationToolStorage::Pointer _arg)
 
DataObjectPointerArraySizeType GetOutputIndex (std::string navDataName)
 return the index of the output with name navDataName, -1 if no output with that name was found More...
 
virtual void RegisterAsMicroservice ()
 Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice(). More...
 
virtual void UnRegisterMicroservice ()
 Registers this object as a Microservice, making it available to every module and/or plugin. More...
 
std::string GetMicroserviceID ()
 Returns the id that this device is registered with. The id will only be valid, if the NavigationDataSource has been registered using RegisterAsMicroservice(). More...
 
virtual void GraftNthOutput (unsigned int idx, itk::DataObject *graft)
 Graft the specified DataObject onto this ProcessObject's output. More...
 
virtual void GraftOutput (itk::DataObject *graft)
 Graft the specified DataObject onto this ProcessObject's output. More...
 
itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
virtual void Freeze ()
 
virtual void UnFreeze ()
 
virtual bool GetIsFrozen ()
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 CameraVisualization ()
 
 ~CameraVisualization () override
 
void GenerateData () override
 filter execute method More...
 
- Protected Member Functions inherited from mitk::NavigationDataToNavigationDataFilter
 NavigationDataToNavigationDataFilter ()
 
 ~NavigationDataToNavigationDataFilter () override
 
void CreateOutputsForAllInputs ()
 Create an output for each input. More...
 
- Protected Member Functions inherited from mitk::NavigationDataSource
 NavigationDataSource ()
 
 ~NavigationDataSource () override
 

Protected Attributes

mitk::BaseRenderer::Pointer m_Renderer
 renderer that visualizes the navigation data- More...
 
Vector3D m_DirectionOfProjectionInToolCoordinates
 vector of the direction of projection in tool coordinates More...
 
Vector3D m_ViewUpInToolCoordinates
 view up vector in tool coordinates More...
 
Vector3D m_DirectionOfProjection
 vector of the current direction of view of the camera in world coordinates More...
 
Point3D m_CameraPosition
 current position of the camera More...
 
ScalarType m_FocalLength
 focal length of the camera: distance between camera position and focal point. More...
 
- Protected Attributes inherited from mitk::NavigationDataSource
std::string m_Name
 
bool m_IsFrozen
 
NavigationToolStorage::Pointer m_ToolMetaDataCollection
 

Additional Inherited Members

- Static Public Attributes inherited from mitk::NavigationDataSource
static const std::string US_INTERFACE_NAME
 These Constants are used in conjunction with Microservices. More...
 
static const std::string US_PROPKEY_DEVICENAME
 
static const std::string US_PROPKEY_ID
 
static const std::string US_PROPKEY_ISACTIVE
 

Detailed Description

CameraVisualization controls the camera according to the spatial information of the navigation data.

Documentation The camera of the renderer will be placed at the position of the navigation data and oriented according to its orientation and the camera specific information "direction of projection", "view up", "focal length", "view angle"

Definition at line 28 of file mitkCameraVisualization.h.

Constructor & Destructor Documentation

◆ CameraVisualization()

mitk::CameraVisualization::CameraVisualization ( )
protected

◆ ~CameraVisualization()

mitk::CameraVisualization::~CameraVisualization ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::CameraVisualization::Clone ( ) const

◆ GenerateData()

void mitk::CameraVisualization::GenerateData ( )
overrideprotected

filter execute method

Documentation positions and orients camera according to the position and orientation hold in the NavigationData

◆ GetDirectionOfProjectionInToolCoordinates()

virtual mitk::Vector3D mitk::CameraVisualization::GetDirectionOfProjectionInToolCoordinates ( ) const
virtual

returns the direction of projection of the camera of the renderer in tool coordinates

◆ GetFocalLength()

virtual float mitk::CameraVisualization::GetFocalLength ( ) const
virtual

returns the focal length of the camera

◆ GetParameters()

mitk::PropertyList::ConstPointer mitk::CameraVisualization::GetParameters ( ) const
overridevirtual

Get all filter parameters as a PropertyList.

Documentation This method returns a PropertyList containing the following properties (name : data type):

Reimplemented from mitk::NavigationDataSource.

◆ GetRenderer()

virtual const mitk::BaseRenderer* mitk::CameraVisualization::GetRenderer ( )
virtual

returns the renderer that visualizes the navigation data

◆ GetViewUpInToolCoordinates()

virtual mitk::Vector3D mitk::CameraVisualization::GetViewUpInToolCoordinates ( ) const
virtual

returns the view up vector of the camera of the renderer in tool coordinates

◆ mitkClassMacro()

mitk::CameraVisualization::mitkClassMacro ( CameraVisualization  ,
NavigationDataToNavigationDataFilter   
)

◆ New()

static Pointer mitk::CameraVisualization::New ( )
static

◆ SetDirectionOfProjectionInToolCoordinates()

virtual void mitk::CameraVisualization::SetDirectionOfProjectionInToolCoordinates ( mitk::Vector3D  _arg)
virtual

sets the direction of projection of the camera of the renderer in tool coordinates

◆ SetFocalLength()

virtual void mitk::CameraVisualization::SetFocalLength ( float  _arg)
virtual

sets the focal length of the camera

◆ SetParameters()

void mitk::CameraVisualization::SetParameters ( const mitk::PropertyList p)
overridevirtual

Set all filter parameters as the PropertyList p.

Documentation This method reads the following properties from the PropertyList (name : data type):

Reimplemented from mitk::NavigationDataSource.

◆ SetRenderer()

virtual void mitk::CameraVisualization::SetRenderer ( mitk::BaseRenderer renderer)
virtual

sets renderer that visualizes the navigation data

◆ SetViewUpInToolCoordinates()

virtual void mitk::CameraVisualization::SetViewUpInToolCoordinates ( mitk::Vector3D  _arg)
virtual

sets the view up vector of the camera of the renderer in tool coordinates

Member Data Documentation

◆ m_CameraPosition

Point3D mitk::CameraVisualization::m_CameraPosition
protected

current position of the camera

Definition at line 116 of file mitkCameraVisualization.h.

◆ m_DirectionOfProjection

Vector3D mitk::CameraVisualization::m_DirectionOfProjection
protected

vector of the current direction of view of the camera in world coordinates

Definition at line 115 of file mitkCameraVisualization.h.

◆ m_DirectionOfProjectionInToolCoordinates

Vector3D mitk::CameraVisualization::m_DirectionOfProjectionInToolCoordinates
protected

vector of the direction of projection in tool coordinates

Definition at line 113 of file mitkCameraVisualization.h.

◆ m_FocalLength

ScalarType mitk::CameraVisualization::m_FocalLength
protected

focal length of the camera: distance between camera position and focal point.

Definition at line 117 of file mitkCameraVisualization.h.

◆ m_Renderer

mitk::BaseRenderer::Pointer mitk::CameraVisualization::m_Renderer
protected

renderer that visualizes the navigation data-

Definition at line 111 of file mitkCameraVisualization.h.

◆ m_ViewUpInToolCoordinates

Vector3D mitk::CameraVisualization::m_ViewUpInToolCoordinates
protected

view up vector in tool coordinates

Definition at line 114 of file mitkCameraVisualization.h.


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