Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::BoundingShapeVtkMapper2D Class Referencefinal

VTK-based 2D mapper for rendering bounding shape cross-sections and handles. More...

#include <mitkBoundingShapeVtkMapper2D.h>

Inheritance diagram for mitk::BoundingShapeVtkMapper2D:
Collaboration diagram for mitk::BoundingShapeVtkMapper2D:

Public Member Functions

 mitkClassMacro (BoundingShapeVtkMapper2D, 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...
 
vtkProp * GetVtkProp (BaseRenderer *renderer) override
 Get the VTK prop assembly for rendering. 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 UpdateVtkTransform (mitk::BaseRenderer *renderer)
 Set the vtkTransform of the m_Prop3D for the current time step of renderer. More...
 
void ApplyColorAndOpacityProperties (mitk::BaseRenderer *renderer, vtkActor *actor) override
 Apply color and opacity properties read from the PropertyList to the given vtkActor. 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...
 
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 *node, BaseRenderer *renderer=nullptr, bool overwrite=false)
 Set default rendering properties for bounding shape 2D visualization. More...
 
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 2D mapper for rendering bounding shape cross-sections and handles.

Renders the intersection of a bounding box (GeometryData) with the current 2D slice plane, along with interactive handles for resizing. Handles are displayed as small cubes at the face centers of the bounding box where they intersect the slice.

See also
BoundingShapeVtkMapper3D, BoundingShapeInteractor, VtkMapper

Definition at line 38 of file mitkBoundingShapeVtkMapper2D.h.

Member Function Documentation

◆ ApplyColorAndOpacityProperties()

void mitk::BoundingShapeVtkMapper2D::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.

Implements mitk::Mapper.

◆ Clone()

Pointer mitk::BoundingShapeVtkMapper2D::Clone ( ) const

◆ GetVtkProp()

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

Get the VTK prop assembly for rendering.

Parameters
[in]rendererThe renderer to get the prop for.
Returns
The VTK prop assembly containing the bounding shape and handle actors.

Implements mitk::VtkMapper.

◆ mitkClassMacro()

mitk::BoundingShapeVtkMapper2D::mitkClassMacro ( BoundingShapeVtkMapper2D  ,
VtkMapper   
)

◆ New()

static Pointer mitk::BoundingShapeVtkMapper2D::New ( )
static

◆ SetDefaultProperties()

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

Set default rendering properties for bounding shape 2D visualization.

Parameters
[in]nodeThe data node to set properties on.
[in]rendererThe renderer context, or nullptr for all renderers.
[in]overwriteIf true, overwrite existing properties.

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