Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit

Vtk-based mapper for Splines. More...

#include <mitkSplineVtkMapper3D.h>

Inheritance diagram for mitk::SplineVtkMapper3D:
Collaboration diagram for mitk::SplineVtkMapper3D:

Public Member Functions

 mitkClassMacro (SplineVtkMapper3D, PointSetVtkMapper3D)
 
Pointer Clone () const
 
vtkProp * GetVtkProp (mitk::BaseRenderer *renderer) override
 
void UpdateVtkTransform (mitk::BaseRenderer *renderer) override
 Set the vtkTransform of the m_Prop3D for the current time step of renderer. More...
 
bool SplinesAreAvailable ()
 
vtkPolyData * GetSplinesPolyData ()
 
vtkActor * GetSplinesActor ()
 
virtual void UpdateSpline ()
 
virtual void SetSplineResolution (unsigned int _arg)
 
virtual unsigned int GetSplineResolution ()
 
- Public Member Functions inherited from mitk::PointSetVtkMapper3D
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
virtual const mitk::PointSetGetInput ()
 
void ReleaseGraphicsResources (vtkWindow *renWin)
 
void ReleaseGraphicsResources (mitk::BaseRenderer *renderer) override
 Release vtk-based graphics resources that are being consumed by this mapper. More...
 
- 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 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...
 
- 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...
 
virtual void Update (BaseRenderer *renderer)
 Calls the time step of the input data for the specified renderer and checks whether the time step is valid and calls method GenerateDataForRenderer() 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 Pointer New ()
 
- Static Public Member Functions inherited from mitk::PointSetVtkMapper3D
static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
static void SetDefaultProperties (mitk::DataNode *node, mitk::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

 SplineVtkMapper3D ()
 
 ~SplineVtkMapper3D () override
 
void GenerateDataForRenderer (mitk::BaseRenderer *renderer) override
 Generate the data needed for rendering into renderer. More...
 
void ApplyAllProperties (BaseRenderer *renderer, vtkActor *actor) override
 
- Protected Member Functions inherited from mitk::PointSetVtkMapper3D
 PointSetVtkMapper3D ()
 
 ~PointSetVtkMapper3D () override
 
void ResetMapper (BaseRenderer *renderer) override
 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...
 
virtual void CreateContour (vtkPoints *points, vtkCellArray *connections)
 
virtual void CreateVTKRenderObjects ()
 
- 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...
 

Protected Attributes

vtkActor * m_SplinesActor
 
vtkPropAssembly * m_SplineAssembly
 
bool m_SplinesAvailable
 
bool m_SplinesAddedToAssembly
 
unsigned int m_SplineResolution
 
itk::TimeStamp m_SplineUpdateTime
 
- Protected Attributes inherited from mitk::PointSetVtkMapper3D
vtkSmartPointer< vtkPoints > m_WorldPositions
 All point positions, already in world coordinates. More...
 
vtkSmartPointer< vtkCellArray > m_PointConnections
 All connections between two points (used for contour drawing) More...
 
vtkSmartPointer< vtkAppendPolyData > m_vtkSelectedPointList
 
vtkSmartPointer< vtkAppendPolyData > m_vtkUnselectedPointList
 
vtkSmartPointer< vtkPoints > m_VtkPoints
 
vtkSmartPointer< vtkCellArray > m_VtkPointConnections
 
vtkSmartPointer< vtkTransformPolyDataFilter > m_VtkPointsTransformer
 
vtkSmartPointer< vtkPolyDataMapper > m_VtkSelectedPolyDataMapper
 
vtkSmartPointer< vtkPolyDataMapper > m_VtkUnselectedPolyDataMapper
 
vtkSmartPointer< vtkActor > m_SelectedActor
 
vtkSmartPointer< vtkActor > m_UnselectedActor
 
vtkSmartPointer< vtkActor > m_ContourActor
 
vtkSmartPointer< vtkPropAssembly > m_PointsAssembly
 
vtkSmartPointer< vtkAppendPolyData > m_vtkTextList
 
unsigned int m_NumberOfSelectedAdded
 
unsigned int m_NumberOfUnselectedAdded
 
ScalarType m_PointSize
 
ScalarType m_ContourRadius
 
- Protected Attributes inherited from mitk::Mapper
mitk::DataNodem_DataNode
 

Additional Inherited Members

- Public Types inherited from mitk::PointSetVtkMapper3D
typedef PointSetVtkMapper3D 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 Attributes inherited from mitk::PointSetVtkMapper3D
LocalStorageHandler< BaseLocalStoragem_LSH
 

Detailed Description

Vtk-based mapper for Splines.

The mapper inherits from mitk::PointSetVTKMapper3D and renders a spline in 3D, using a mitk pointset as input.

Properties that can be set for splines which affect the mitk::SplineVtkMapper3D are:

There might be still some other, deprecated properties. These will not be documented anymore. Please check the source if you really need them.

Definition at line 39 of file mitkSplineVtkMapper3D.h.

Constructor & Destructor Documentation

◆ SplineVtkMapper3D()

mitk::SplineVtkMapper3D::SplineVtkMapper3D ( )
protected

◆ ~SplineVtkMapper3D()

mitk::SplineVtkMapper3D::~SplineVtkMapper3D ( )
overrideprotected

Member Function Documentation

◆ ApplyAllProperties()

void mitk::SplineVtkMapper3D::ApplyAllProperties ( BaseRenderer renderer,
vtkActor *  actor 
)
overrideprotectedvirtual

Reimplemented from mitk::PointSetVtkMapper3D.

◆ Clone()

Pointer mitk::SplineVtkMapper3D::Clone ( ) const

◆ GenerateDataForRenderer()

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

Generate the data needed for rendering into renderer.

Reimplemented from mitk::PointSetVtkMapper3D.

◆ GetSplineResolution()

virtual unsigned int mitk::SplineVtkMapper3D::GetSplineResolution ( )
virtual

◆ GetSplinesActor()

vtkActor* mitk::SplineVtkMapper3D::GetSplinesActor ( )

◆ GetSplinesPolyData()

vtkPolyData* mitk::SplineVtkMapper3D::GetSplinesPolyData ( )

◆ GetVtkProp()

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

Reimplemented from mitk::PointSetVtkMapper3D.

◆ mitkClassMacro()

mitk::SplineVtkMapper3D::mitkClassMacro ( SplineVtkMapper3D  ,
PointSetVtkMapper3D   
)

◆ New()

static Pointer mitk::SplineVtkMapper3D::New ( )
static

◆ SetSplineResolution()

virtual void mitk::SplineVtkMapper3D::SetSplineResolution ( unsigned int  _arg)
virtual

◆ SplinesAreAvailable()

bool mitk::SplineVtkMapper3D::SplinesAreAvailable ( )

◆ UpdateSpline()

virtual void mitk::SplineVtkMapper3D::UpdateSpline ( )
virtual

◆ UpdateVtkTransform()

void mitk::SplineVtkMapper3D::UpdateVtkTransform ( mitk::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::PointSetVtkMapper3D.

Member Data Documentation

◆ m_SplineAssembly

vtkPropAssembly* mitk::SplineVtkMapper3D::m_SplineAssembly
protected

Definition at line 74 of file mitkSplineVtkMapper3D.h.

◆ m_SplineResolution

unsigned int mitk::SplineVtkMapper3D::m_SplineResolution
protected

Definition at line 80 of file mitkSplineVtkMapper3D.h.

◆ m_SplinesActor

vtkActor* mitk::SplineVtkMapper3D::m_SplinesActor
protected

Definition at line 72 of file mitkSplineVtkMapper3D.h.

◆ m_SplinesAddedToAssembly

bool mitk::SplineVtkMapper3D::m_SplinesAddedToAssembly
protected

Definition at line 78 of file mitkSplineVtkMapper3D.h.

◆ m_SplinesAvailable

bool mitk::SplineVtkMapper3D::m_SplinesAvailable
protected

Definition at line 76 of file mitkSplineVtkMapper3D.h.

◆ m_SplineUpdateTime

itk::TimeStamp mitk::SplineVtkMapper3D::m_SplineUpdateTime
protected

Definition at line 82 of file mitkSplineVtkMapper3D.h.


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