Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit

Composite pattern for combination of different mappers. More...

#include <mitkCompositeMapper.h>

Inheritance diagram for mitk::CompositeMapper:
Collaboration diagram for mitk::CompositeMapper:

Public Member Functions

 mitkClassMacro (CompositeMapper, VtkMapper)
 
Pointer Clone () const
 
virtual void MitkRenderOverlay (BaseRenderer *renderer) override
 Checks visibility and renders the overlay. More...
 
virtual void MitkRenderOpaqueGeometry (BaseRenderer *renderer) override
 Checks visibility and renders untransparent geometry. More...
 
virtual void MitkRenderTranslucentGeometry (BaseRenderer *renderer) override
 Checks visiblity and renders transparent geometry. More...
 
virtual void MitkRenderVolumetricGeometry (BaseRenderer *renderer) override
 Checks visibility and renders volumes. More...
 
void SetDataNode (DataNode *node) override
 Set the DataNode containing the data to map. More...
 
mitk::ImageVtkMapper2D::Pointer GetImageMapper ()
 
bool HasVtkProp (const vtkProp *prop, BaseRenderer *renderer) override
 Returns true if this mapper owns the specified vtkProp for the given BaseRenderer. More...
 
void ReleaseGraphicsResources (mitk::BaseRenderer *renderer) override
 Release vtk-based graphics resources that are being consumed by this mapper. More...
 
bool IsLODEnabled (BaseRenderer *renderer) const override
 
vtkProp * GetVtkProp (mitk::BaseRenderer *renderer) override
 
- Public Member Functions inherited from mitk::VtkMapper
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
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 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 *renderer)
 SHADERTODO. More...
 
virtual 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 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...
 
int GetTimestep () const
 Returns the current time step as calculated from the renderer. More...
 

Static Public Member Functions

static Pointer New ()
 
static void SetDefaultProperties (DataNode *node, BaseRenderer *renderer=NULL, bool overwrite=false)
 
- Static Public Member Functions inherited from mitk::VtkMapper
static const char * GetStaticNameOfClass ()
 
static void SetVtkMapperImmediateModeRendering (vtkMapper *mapper)
 Re-issues all drawing commands required to describe the entire scene each time a new frame is required, regardless of actual changes. More...
 
- 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

virtual void Update (mitk::BaseRenderer *renderer) override
 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...
 
virtual void GenerateDataForRenderer (mitk::BaseRenderer *renderer) override
 Generate the data needed for rendering into renderer. More...
 
 CompositeMapper ()
 
virtual ~CompositeMapper ()
 
- Protected Member Functions inherited from mitk::VtkMapper
 VtkMapper ()
 
virtual ~VtkMapper ()
 
- Protected Member Functions inherited from mitk::Mapper
 Mapper ()
 explicit constructor which disallows implicit conversions More...
 
virtual ~Mapper ()
 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...
 
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...
 
virtual OverlayManagerGetOverlayManager () const
 

Additional Inherited Members

- 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::VtkMapper
mitk::LocalStorageHandler< VtkMapperLocalStoragem_VtkMapperLSH
 
- Protected Attributes inherited from mitk::Mapper
mitk::DataNodem_DataNode
 

Detailed Description

Composite pattern for combination of different mappers.

Definition at line 43 of file mitkCompositeMapper.h.

Constructor & Destructor Documentation

mitk::CompositeMapper::CompositeMapper ( )
protected

Definition at line 22 of file mitkCompositeMapper.cpp.

References mitk::CopyImageMapper2D::New(), and mitk::New().

mitk::CompositeMapper::~CompositeMapper ( )
protectedvirtual

Definition at line 28 of file mitkCompositeMapper.cpp.

Member Function Documentation

Pointer mitk::CompositeMapper::Clone ( ) const
virtual void mitk::CompositeMapper::GenerateDataForRenderer ( mitk::BaseRenderer )
inlineoverrideprotectedvirtual

Generate the data needed for rendering into renderer.

Reimplemented from mitk::Mapper.

Definition at line 136 of file mitkCompositeMapper.h.

mitk::ImageVtkMapper2D::Pointer mitk::CompositeMapper::GetImageMapper ( )
inline

Definition at line 86 of file mitkCompositeMapper.h.

vtkProp* mitk::CompositeMapper::GetVtkProp ( mitk::BaseRenderer renderer)
inlineoverridevirtual

Implements mitk::VtkMapper.

Definition at line 120 of file mitkCompositeMapper.h.

References mitk::New().

bool mitk::CompositeMapper::HasVtkProp ( const vtkProp *  prop,
BaseRenderer renderer 
)
inlineoverridevirtual

Returns true if this mapper owns the specified vtkProp for the given BaseRenderer.

Note: returns false by default; should be implemented for VTK-based Mapper subclasses.

Reimplemented from mitk::VtkMapper.

Definition at line 92 of file mitkCompositeMapper.h.

bool mitk::CompositeMapper::IsLODEnabled ( BaseRenderer ) const
inlineoverridevirtual

Returns true if this Mapper currently allows for Level-of-Detail rendering. This reflects whether this Mapper currently invokes StartEvent, EndEvent, and ProgressEvent on BaseRenderer.

Reimplemented from mitk::Mapper.

Definition at line 115 of file mitkCompositeMapper.h.

mitk::CompositeMapper::mitkClassMacro ( CompositeMapper  ,
VtkMapper   
)
virtual void mitk::CompositeMapper::MitkRenderOpaqueGeometry ( BaseRenderer renderer)
inlineoverridevirtual

Checks visibility and renders untransparent geometry.

Reimplemented from mitk::VtkMapper.

Definition at line 57 of file mitkCompositeMapper.h.

References mitk::RenderingManager::GetInstance().

virtual void mitk::CompositeMapper::MitkRenderOverlay ( BaseRenderer renderer)
inlineoverridevirtual

Checks visibility and renders the overlay.

Reimplemented from mitk::VtkMapper.

Definition at line 51 of file mitkCompositeMapper.h.

virtual void mitk::CompositeMapper::MitkRenderTranslucentGeometry ( BaseRenderer renderer)
inlineoverridevirtual

Checks visiblity and renders transparent geometry.

Reimplemented from mitk::VtkMapper.

Definition at line 67 of file mitkCompositeMapper.h.

virtual void mitk::CompositeMapper::MitkRenderVolumetricGeometry ( BaseRenderer renderer)
inlineoverridevirtual

Checks visibility and renders volumes.

Reimplemented from mitk::VtkMapper.

Definition at line 73 of file mitkCompositeMapper.h.

static Pointer mitk::CompositeMapper::New ( )
static
void mitk::CompositeMapper::ReleaseGraphicsResources ( mitk::BaseRenderer )
inlineoverridevirtual

Release vtk-based graphics resources that are being consumed by this mapper.

Method called by mitk::VtkPropRenderer. The parameter renderer could be used to determine which graphic resources to release. The local storage is accessible by the parameter renderer. Should be overwritten in subclasses.

Reimplemented from mitk::VtkMapper.

Definition at line 97 of file mitkCompositeMapper.h.

void mitk::CompositeMapper::SetDataNode ( DataNode _arg)
inlineoverridevirtual

Set the DataNode containing the data to map.

Reimplemented from mitk::Mapper.

Definition at line 79 of file mitkCompositeMapper.h.

References mitk::Mapper::m_DataNode.

virtual void mitk::CompositeMapper::Update ( mitk::BaseRenderer renderer)
inlineoverrideprotectedvirtual

Calls the time step of the input data for the specified renderer and checks whether the time step is valid and calls method GenerateDataForRenderer()

Reimplemented from mitk::Mapper.

Definition at line 130 of file mitkCompositeMapper.h.

References mitk::ImageVtkMapper2D::GenerateDataForRenderer().


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