Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
mitk::CrosshairVtkMapper2D Class Reference

Vtk-based 2D mapper for rendering a crosshair using vtk mapper. More...

#include <mitkCrosshairVtkMapper2D.h>

Inheritance diagram for mitk::CrosshairVtkMapper2D:
Collaboration diagram for mitk::CrosshairVtkMapper2D:

Classes

class  LocalStorage
 Internal class holding the mapper, actor, etc. for each of the 2D render windows. More...
 

Public Types

typedef CrosshairVtkMapper2D Self
 
typedef VtkMapper Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::VtkMapper
typedef VtkMapper Self
 
typedef Mapper Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::Mapper
typedef Mapper Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
const CrosshairDataGetInput () const
 
void Update (mitk::BaseRenderer *renderer) override
 Checks whether this mapper needs to update itself and generate data. More...
 
vtkProp * GetVtkProp (BaseRenderer *renderer) override
 
- Public Member Functions inherited from mitk::VtkMapper
virtual bool IsVtkBased () const override
 Returns whether this is an vtk-based mapper. More...
 
void MitkRender (mitk::BaseRenderer *renderer, mitk::VtkPropRenderer::RenderType type) override
 Determines which geometry should be rendered (opaque, translucent, volumetric, overlay) and calls the appropriate function. More...
 
virtual void MitkRenderOverlay (BaseRenderer *renderer)
 Checks visibility and renders the overlay. More...
 
virtual void MitkRenderOpaqueGeometry (BaseRenderer *renderer)
 Checks visibility and renders untransparent geometry. More...
 
virtual void MitkRenderTranslucentGeometry (BaseRenderer *renderer)
 Checks visibility and renders transparent geometry. More...
 
virtual void MitkRenderVolumetricGeometry (BaseRenderer *renderer)
 Checks visibility and renders volumes. More...
 
virtual bool HasVtkProp (const vtkProp *prop, BaseRenderer *renderer)
 Returns true if this mapper owns the specified vtkProp for the given BaseRenderer. More...
 
virtual void UpdateVtkTransform (mitk::BaseRenderer *renderer)
 Set the vtkTransform of the m_Prop3D for the current time step of renderer. More...
 
virtual void ApplyProperties (vtkActor *actor, mitk::BaseRenderer *renderer)
 Apply color and opacity properties read from the PropertyList. More...
 
void ApplyShaderProperties (mitk::BaseRenderer *)
 
void ApplyColorAndOpacityProperties (mitk::BaseRenderer *renderer, vtkActor *actor) override
 Apply color and opacity properties read from the PropertyList. Called by mapper subclasses. More...
 
virtual void ReleaseGraphicsResources (mitk::BaseRenderer *)
 Release vtk-based graphics resources that are being consumed by this mapper. More...
 
- Public Member Functions inherited from mitk::Mapper
virtual void SetDataNode (DataNode *_arg)
 Set the DataNode containing the data to map. More...
 
virtual DataNodeGetDataNode () const
 Get the DataNode containing the data to map. Method only returns valid DataNode Pointer if the mapper belongs to a data node. Otherwise, the returned DataNode Pointer might be invalid. More...
 
BaseDataGetData () const
 Get the data to map. More...
 
virtual bool GetColor (float rgb[3], BaseRenderer *renderer, const char *name="color") const
 Convenience access method for color properties (instances of ColorProperty) More...
 
virtual bool GetVisibility (bool &visible, BaseRenderer *renderer, const char *name="visible") const
 Convenience access method for visibility properties (instances of BoolProperty) More...
 
virtual bool GetOpacity (float &opacity, BaseRenderer *renderer, const char *name="opacity") const
 Convenience access method for opacity properties (instances of FloatProperty) More...
 
virtual bool GetLevelWindow (LevelWindow &levelWindow, BaseRenderer *renderer, const char *name="levelwindow") const
 Convenience access method for color properties (instances of LevelWindoProperty) More...
 
virtual bool IsVisible (BaseRenderer *renderer, const char *name="visible") const
 Convenience access method for visibility properties (instances of BoolProperty). Return value is the visibility. Default is visible==true, i.e., true is returned even if the property (propertyKey) is not found. More...
 
TimeStepType GetTimestep () const
 Returns the current time step as calculated from the renderer. More...
 
virtual bool IsLODEnabled (BaseRenderer *) const
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
static void SetDefaultProperties (DataNode *node, BaseRenderer *renderer=nullptr, bool overwrite=false)
 
- Static Public Member Functions inherited from mitk::VtkMapper
static const char * GetStaticNameOfClass ()
 
- Static Public Member Functions inherited from mitk::Mapper
static const char * GetStaticNameOfClass ()
 
static void SetDefaultProperties (DataNode *node, BaseRenderer *renderer=nullptr, bool overwrite=false)
 Set default values of properties used by this mapper to node. More...
 

Protected Member Functions

 CrosshairVtkMapper2D ()
 
 ~CrosshairVtkMapper2D () override
 
void GenerateDataForRenderer (BaseRenderer *renderer) override
 Generate the data needed for rendering into renderer. More...
 
void CreateVtkCrosshair (BaseRenderer *renderer)
 
void DrawLine (Point3D p0, Point3D p1, vtkCellArray *lines, vtkPoints *points)
 
void ApplyAllProperties (BaseRenderer *renderer)
 
void ApplyColorAndOpacityProperties2D (BaseRenderer *renderer, vtkActor2D *actor)
 
- Protected Member Functions inherited from mitk::VtkMapper
 VtkMapper ()
 
 ~VtkMapper () override
 
- Protected Member Functions inherited from mitk::Mapper
 Mapper ()
 explicit constructor which disallows implicit conversions More...
 
 ~Mapper () override
 virtual destructor in order to derive from this class More...
 
virtual void GenerateData ()
 Generate the data needed for rendering (independent of a specific renderer) More...
 
virtual void CalculateTimeStep (BaseRenderer *renderer)
 Updates the time step, which is sometimes needed in subclasses. More...
 
virtual void ResetMapper (BaseRenderer *)
 Reset the mapper (i.e., make sure that nothing is displayed) if no valid data is present. In most cases the reimplemented function disables the according actors (toggling visibility off) More...
 

Protected Attributes

LocalStorageHandler< LocalStoragem_LSH
 The LocalStorageHandler holds all LocalStorages for the 2D render windows. More...
 
const int defaultGapSize
 
- Protected Attributes inherited from mitk::Mapper
mitk::DataNodem_DataNode
 

Detailed Description

Vtk-based 2D mapper for rendering a crosshair using vtk mapper.

   CrosshairData is used to retrieve the selected position, which is stored
   in the processed data node.
   The crosshair is created by drawing lines through the selected position,
   adding an additional gap in the center of the crosshair and creating vtk poly
   data from the created points and lines.

Definition at line 40 of file mitkCrosshairVtkMapper2D.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ CrosshairVtkMapper2D()

mitk::CrosshairVtkMapper2D::CrosshairVtkMapper2D ( )
protected

◆ ~CrosshairVtkMapper2D()

mitk::CrosshairVtkMapper2D::~CrosshairVtkMapper2D ( )
overrideprotected

Member Function Documentation

◆ ApplyAllProperties()

void mitk::CrosshairVtkMapper2D::ApplyAllProperties ( BaseRenderer renderer)
protected

◆ ApplyColorAndOpacityProperties2D()

void mitk::CrosshairVtkMapper2D::ApplyColorAndOpacityProperties2D ( BaseRenderer renderer,
vtkActor2D *  actor 
)
protected

◆ CreateVtkCrosshair()

void mitk::CrosshairVtkMapper2D::CreateVtkCrosshair ( BaseRenderer renderer)
protected

◆ DrawLine()

void mitk::CrosshairVtkMapper2D::DrawLine ( Point3D  p0,
Point3D  p1,
vtkCellArray *  lines,
vtkPoints *  points 
)
protected

◆ GenerateDataForRenderer()

void mitk::CrosshairVtkMapper2D::GenerateDataForRenderer ( BaseRenderer )
overrideprotectedvirtual

Generate the data needed for rendering into renderer.

Reimplemented from mitk::Mapper.

◆ GetClassHierarchy()

virtual std::vector<std::string> mitk::CrosshairVtkMapper2D::GetClassHierarchy ( ) const
inlineoverridevirtual

Reimplemented from mitk::VtkMapper.

Definition at line 44 of file mitkCrosshairVtkMapper2D.h.

◆ GetClassName()

virtual const char* mitk::CrosshairVtkMapper2D::GetClassName ( ) const
virtual

Reimplemented from mitk::VtkMapper.

◆ GetInput()

const CrosshairData* mitk::CrosshairVtkMapper2D::GetInput ( ) const

◆ GetStaticNameOfClass()

static const char* mitk::CrosshairVtkMapper2D::GetStaticNameOfClass ( )
inlinestatic

Definition at line 44 of file mitkCrosshairVtkMapper2D.h.

◆ GetVtkProp()

vtkProp* mitk::CrosshairVtkMapper2D::GetVtkProp ( BaseRenderer renderer)
overridevirtual

Implements mitk::VtkMapper.

◆ New()

static Pointer mitk::CrosshairVtkMapper2D::New ( )
static

◆ SetDefaultProperties()

static void mitk::CrosshairVtkMapper2D::SetDefaultProperties ( DataNode node,
BaseRenderer renderer = nullptr,
bool  overwrite = false 
)
static

◆ Update()

void mitk::CrosshairVtkMapper2D::Update ( mitk::BaseRenderer renderer)
overridevirtual

Checks whether this mapper needs to update itself and generate data.

Reimplemented from mitk::Mapper.

Member Data Documentation

◆ defaultGapSize

const int mitk::CrosshairVtkMapper2D::defaultGapSize
protected

Definition at line 88 of file mitkCrosshairVtkMapper2D.h.

◆ m_LSH

LocalStorageHandler<LocalStorage> mitk::CrosshairVtkMapper2D::m_LSH
protected

The LocalStorageHandler holds all LocalStorages for the 2D render windows.

Definition at line 76 of file mitkCrosshairVtkMapper2D.h.


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