Medical Imaging Interaction Toolkit  2018.4.99-65942676
Medical Imaging Interaction Toolkit

Vtk-based mapper for Surfaces. More...

#include <mitkSurfaceVtkMapper3D.h>

Inheritance diagram for mitk::SurfaceVtkMapper3D:
Collaboration diagram for mitk::SurfaceVtkMapper3D:

Classes

class  LocalStorage
 

Public Types

typedef SurfaceVtkMapper3D 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
 
Pointer Clone () const
 
virtual void SetGenerateNormals (bool _arg)
 
virtual bool GetGenerateNormals ()
 
virtual const mitk::SurfaceGetInput ()
 
vtkProp * GetVtkProp (mitk::BaseRenderer *renderer) override
 
virtual void ApplyAllProperties (mitk::BaseRenderer *renderer, vtkActor *actor)
 
- 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 visiblity 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...
 
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...
 
int 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 (mitk::DataNode *node, mitk::BaseRenderer *renderer=nullptr, bool overwrite=false)
 
static void ApplyMitkPropertiesToVtkProperty (mitk::DataNode *node, vtkProperty *property, mitk::BaseRenderer *renderer)
 
static void SetDefaultPropertiesForVtkProperty (mitk::DataNode *node, mitk::BaseRenderer *renderer, bool overwrite)
 
- 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...
 

Public Attributes

mitk::LocalStorageHandler< LocalStoragem_LSH
 

Protected Member Functions

 SurfaceVtkMapper3D ()
 
 ~SurfaceVtkMapper3D () override
 
void GenerateDataForRenderer (mitk::BaseRenderer *renderer) override
 Generate the data needed for rendering into renderer. More...
 
void ResetMapper (mitk::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 CheckForClippingProperty (mitk::BaseRenderer *renderer, mitk::BaseProperty *property)
 
- 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

bool m_GenerateNormals
 
- Protected Attributes inherited from mitk::Mapper
mitk::DataNodem_DataNode
 

Detailed Description

Vtk-based mapper for Surfaces.

The mapper renders a surface in 3D. The actor is adapted according to the geometry in the base class in mitk::VtkMapper::UpdateVtkTransform().

Properties that can be set for surfaces and influence the surfaceVTKMapper3D are:

  • "Backface Culling": True enables backface culling, which means only front-facing polygons will be visualized. False/disabled by default.
  • "color": (ColorProperty) Diffuse color of the surface object (this property will be read when material.diffuseColor is not defined)
  • "Opacity": (FloatProperty) Opacity of the surface object
  • "material.ambientColor": (ColorProperty) Ambient color of the surface object
  • "material.ambientCoefficient": ( FloatProperty) Ambient coefficient of the surface object
  • "material.diffuseColor": ( ColorProperty) Diffuse color of the surface object
  • "material.diffuseCoefficient": (FloatProperty) Diffuse coefficient of the surface object
  • "material.specularColor": (ColorProperty) Specular Color of the surface object
  • "material.specularCoefficient": (FloatProperty) Specular coefficient of the surface object
  • "material.specularPower": (FloatProperty) Specular power of the surface object
  • "material.interpolation": (VtkInterpolationProperty) Interpolation
  • "material.representation": (VtkRepresentationProperty*) Representation
  • "material.wireframeLineWidth": (FloatProperty) Width in pixels of the lines drawn.
  • "material.pointSize": (FloatProperty) Size in pixels of the points drawn.
  • "scalar visibility": (BoolProperty) If the scarlars of the surface are visible
  • "Surface.TransferFunction (TransferFunctionProperty) Set a transferfunction for coloring the surface - \b "LookupTable (LookupTableProperty) LookupTable

Properties to look for are:

  • "scalar visibility": if set to on, scalars assigned to the data are shown Turn this on if using a lookup table.
  • "ScalarsRangeMinimum": Optional. Can be used to store the scalar min, e.g. for the level window settings.
  • "ScalarsRangeMaximum": Optional. See above.

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 74 of file mitkSurfaceVtkMapper3D.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ SurfaceVtkMapper3D()

mitk::SurfaceVtkMapper3D::SurfaceVtkMapper3D ( )
protected

◆ ~SurfaceVtkMapper3D()

mitk::SurfaceVtkMapper3D::~SurfaceVtkMapper3D ( )
overrideprotected

Member Function Documentation

◆ ApplyAllProperties()

virtual void mitk::SurfaceVtkMapper3D::ApplyAllProperties ( mitk::BaseRenderer renderer,
vtkActor *  actor 
)
virtual

◆ ApplyMitkPropertiesToVtkProperty()

static void mitk::SurfaceVtkMapper3D::ApplyMitkPropertiesToVtkProperty ( mitk::DataNode node,
vtkProperty *  property,
mitk::BaseRenderer renderer 
)
static

◆ CheckForClippingProperty()

virtual void mitk::SurfaceVtkMapper3D::CheckForClippingProperty ( mitk::BaseRenderer renderer,
mitk::BaseProperty property 
)
protectedvirtual

Checks whether the specified property is a ClippingProperty and if yes, adds it to m_ClippingPlaneCollection (internal method).

◆ Clone()

Pointer mitk::SurfaceVtkMapper3D::Clone ( ) const

◆ GenerateDataForRenderer()

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

Generate the data needed for rendering into renderer.

Reimplemented from mitk::Mapper.

◆ GetClassHierarchy()

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

Reimplemented from mitk::VtkMapper.

Definition at line 77 of file mitkSurfaceVtkMapper3D.h.

◆ GetClassName()

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

Reimplemented from mitk::VtkMapper.

◆ GetGenerateNormals()

virtual bool mitk::SurfaceVtkMapper3D::GetGenerateNormals ( )
virtual

◆ GetInput()

virtual const mitk::Surface* mitk::SurfaceVtkMapper3D::GetInput ( )
virtual

◆ GetStaticNameOfClass()

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

Definition at line 77 of file mitkSurfaceVtkMapper3D.h.

◆ GetVtkProp()

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

Implements mitk::VtkMapper.

◆ New()

static Pointer mitk::SurfaceVtkMapper3D::New ( )
static

◆ ResetMapper()

void mitk::SurfaceVtkMapper3D::ResetMapper ( mitk::BaseRenderer )
overrideprotectedvirtual

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)

To be implemented in sub-classes.

Reimplemented from mitk::Mapper.

◆ SetDefaultProperties()

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

◆ SetDefaultPropertiesForVtkProperty()

static void mitk::SurfaceVtkMapper3D::SetDefaultPropertiesForVtkProperty ( mitk::DataNode node,
mitk::BaseRenderer renderer,
bool  overwrite 
)
static

◆ SetGenerateNormals()

virtual void mitk::SurfaceVtkMapper3D::SetGenerateNormals ( bool  _arg)
virtual

Member Data Documentation

◆ m_GenerateNormals

bool mitk::SurfaceVtkMapper3D::m_GenerateNormals
protected

Definition at line 108 of file mitkSurfaceVtkMapper3D.h.

◆ m_LSH

mitk::LocalStorageHandler<LocalStorage> mitk::SurfaceVtkMapper3D::m_LSH

Definition at line 136 of file mitkSurfaceVtkMapper3D.h.


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