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

VTK-based 3D mapper for rendering bounding shapes as wireframe cubes with handles. More...

#include <mitkBoundingShapeVtkMapper3D.h>

Inheritance diagram for mitk::BoundingShapeVtkMapper3D:
Collaboration diagram for mitk::BoundingShapeVtkMapper3D:

Public Member Functions

 mitkClassMacro (BoundingShapeVtkMapper3D, 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 ApplyBoundingShapeProperties (BaseRenderer *renderer, vtkActor *actor)
 Apply bounding-shape-specific visual properties to the actor. More...
 
vtkProp * GetVtkProp (BaseRenderer *renderer) override
 Get the VTK prop assembly for 3D 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...
 
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 *node, BaseRenderer *renderer=nullptr, bool overwrite=false)
 Set default rendering properties for bounding shape 3D 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...
 

Protected Member Functions

void GenerateDataForRenderer (BaseRenderer *renderer) override
 Generate the data needed for rendering into renderer. More...
 
- 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...
 

Additional Inherited Members

- Protected Attributes inherited from mitk::Mapper
mitk::DataNode * m_DataNode
 

Detailed Description

VTK-based 3D mapper for rendering bounding shapes as wireframe cubes with handles.

Renders a bounding box (GeometryData) as a 3D wireframe cube with interactive handles at the face centers for resizing. Selected handles are highlighted with a different color.

See also
BoundingShapeVtkMapper2D, BoundingShapeInteractor, VtkMapper

Definition at line 28 of file mitkBoundingShapeVtkMapper3D.h.

Member Function Documentation

◆ ApplyBoundingShapeProperties()

void mitk::BoundingShapeVtkMapper3D::ApplyBoundingShapeProperties ( BaseRenderer *  renderer,
vtkActor *  actor 
)

Apply bounding-shape-specific visual properties to the actor.

Parameters
[in]rendererThe renderer context.
[in]actorThe VTK actor to apply properties to (currently unused).

◆ ApplyColorAndOpacityProperties()

void mitk::BoundingShapeVtkMapper3D::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::BoundingShapeVtkMapper3D::Clone ( ) const

◆ GenerateDataForRenderer()

void mitk::BoundingShapeVtkMapper3D::GenerateDataForRenderer ( BaseRenderer *  )
overrideprotectedvirtual

Generate the data needed for rendering into renderer.

Reimplemented from mitk::Mapper.

◆ GetVtkProp()

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

Get the VTK prop assembly for 3D rendering.

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

Implements mitk::VtkMapper.

◆ mitkClassMacro()

mitk::BoundingShapeVtkMapper3D::mitkClassMacro ( BoundingShapeVtkMapper3D  ,
VtkMapper   
)

◆ New()

static Pointer mitk::BoundingShapeVtkMapper3D::New ( )
static

◆ SetDefaultProperties()

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

Set default rendering properties for bounding shape 3D 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: