Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::PlanarFigureVtkMapper3D Class Reference

VTK-based mapper for rendering planar figures in 3D render windows. More...

#include <mitkPlanarFigureVtkMapper3D.h>

Inheritance diagram for mitk::PlanarFigureVtkMapper3D:
Collaboration diagram for mitk::PlanarFigureVtkMapper3D:

Public Member Functions

 mitkClassMacro (PlanarFigureVtkMapper3D, VtkMapper)
 
Pointer Clone () const
 
void ApplyColorAndOpacityProperties (BaseRenderer *renderer, vtkActor *actor) override
 Apply color and opacity properties read from the PropertyList to the given vtkActor. More...
 
void ApplyPlanarFigureProperties (BaseRenderer *renderer, vtkActor *actor)
 
vtkProp * GetVtkProp (BaseRenderer *renderer) override
 Return the VTK prop (actor, assembly, etc.) for the given renderer. More...
 
void UpdateVtkTransform (BaseRenderer *) override
 Set the vtkTransform of the m_Prop3D for the current time step of renderer. More...
 
- Public Member Functions inherited from mitk::VtkMapper
 mitkClassMacro (VtkMapper, Mapper)
 
void MitkRender (mitk::BaseRenderer *renderer, mitk::VtkPropRenderer::RenderType type) override
 Determine the render pass type and call the appropriate render method. More...
 
virtual void MitkRenderOverlay (BaseRenderer *renderer)
 Check visibility and render the overlay pass. More...
 
virtual void MitkRenderOpaqueGeometry (BaseRenderer *renderer)
 Check visibility and render opaque (untransparent) geometry. More...
 
virtual void MitkRenderTranslucentGeometry (BaseRenderer *renderer)
 Check visibility and render translucent (transparent) geometry. More...
 
virtual void MitkRenderVolumetricGeometry (BaseRenderer *renderer)
 Check visibility and render volumetric geometry. More...
 
virtual bool HasVtkProp (const vtkProp *prop, BaseRenderer *renderer)
 Check whether this mapper owns the specified vtkProp for the given renderer. More...
 
virtual void ReleaseGraphicsResources (mitk::BaseRenderer *)
 Release VTK-based graphics resources consumed by this mapper. More...
 
- Public Member Functions inherited from mitk::Mapper
 mitkClassMacroItkParent (Mapper, itk::Object)
 
virtual void SetDataNode (DataNode *_arg)
 Set the DataNode containing the data to map. More...
 
virtual DataNode * GetDataNode () const
 Get the DataNode containing the data to map. More...
 
virtual void Update (BaseRenderer *renderer)
 Calculate the time step for the current renderer and generate rendering data. More...
 
TimeStepType GetTimestep () const
 Return the current time step as calculated from the renderer. More...
 
virtual bool IsLODEnabled (BaseRenderer *) const
 Return whether this Mapper currently allows for Level-of-Detail rendering. More...
 

Static Public Member Functions

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

Additional Inherited Members

- 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 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 inherited from mitk::Mapper
mitk::DataNode * m_DataNode
 

Detailed Description

VTK-based mapper for rendering planar figures in 3D render windows.

Renders the polyline representation of a PlanarFigure as a 3D VTK actor.

See also
PlanarFigure
PlanarFigureMapper2D

Definition at line 31 of file mitkPlanarFigureVtkMapper3D.h.

Member Function Documentation

◆ ApplyColorAndOpacityProperties()

void mitk::PlanarFigureVtkMapper3D::ApplyColorAndOpacityProperties ( BaseRenderer *  renderer,
vtkActor *  actor 
)
overridevirtual

Apply color and opacity properties read from the PropertyList to the given vtkActor.

Reads the "color" and "opacity" properties from the DataNode and applies them to the actor's vtkProperty.

Parameters
[in]rendererThe renderer whose property list is queried.
[in]actorThe vtkActor to apply color and opacity to.

Reimplemented from mitk::VtkMapper.

◆ ApplyPlanarFigureProperties()

void mitk::PlanarFigureVtkMapper3D::ApplyPlanarFigureProperties ( BaseRenderer *  renderer,
vtkActor *  actor 
)

◆ Clone()

Pointer mitk::PlanarFigureVtkMapper3D::Clone ( ) const

◆ GetVtkProp()

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

Return the VTK prop (actor, assembly, etc.) for the given renderer.

Each subclass must implement this to provide its rendering representation.

Parameters
[in]rendererThe renderer for which the prop is requested.
Returns
Pointer to the vtkProp used for rendering.

Implements mitk::VtkMapper.

◆ mitkClassMacro()

mitk::PlanarFigureVtkMapper3D::mitkClassMacro ( PlanarFigureVtkMapper3D  ,
VtkMapper   
)

◆ New()

static Pointer mitk::PlanarFigureVtkMapper3D::New ( )
static

◆ SetDefaultProperties()

static void mitk::PlanarFigureVtkMapper3D::SetDefaultProperties ( DataNode *  ,
BaseRenderer *  = nullptr,
bool  = false 
)
static

◆ UpdateVtkTransform()

void mitk::PlanarFigureVtkMapper3D::UpdateVtkTransform ( BaseRenderer *  renderer)
overridevirtual

Set the vtkTransform of the m_Prop3D for the current time step of renderer.

Called by mitk::VtkPropRenderer::Update before rendering. This method will transform all actors (e.g. of an vtkAssembly) according the geometry.

Warning
This method transforms only props which derive from vtkProp3D. Make sure to use vtkAssembly, if you have multiple props. vtkPropAssembly does not work, since it derives from vtkProp.

Reimplemented from mitk::VtkMapper.


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