Base class of all OpenGL-based mappers. More...
#include <mitkGLMapper.h>
Public Member Functions | |
| mitkClassMacro (GLMapper, Mapper) | |
| virtual void | Paint (mitk::BaseRenderer *renderer)=0 |
| Do the painting into the renderer. More... | |
| virtual void | ApplyProperties (mitk::BaseRenderer *renderer) |
| Apply color and opacity properties read from the PropertyList. More... | |
| void | ApplyColorAndOpacityProperties (mitk::BaseRenderer *renderer, vtkActor *actor=nullptr) override |
| Apply color and opacity properties read from the PropertyList. The actor is not used in the GLMappers. Called by mapper subclasses. More... | |
| void | MitkRender (mitk::BaseRenderer *renderer, mitk::VtkPropRenderer::RenderType type) override |
| Checks visibility and calls the paint method. More... | |
| virtual bool | IsVtkBased () const override |
| Returns whether this is a vtk-based mapper. More... | |
 Public Member Functions inherited from mitk::Mapper | |
| virtual std::vector< std::string > | GetClassHierarchy () const |
| virtual const char * | GetClassName () const |
| 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. Method only returns valid DataNode Pointer if the mapper belongs to a data node. Otherwise, the returned DataNode Pointer might be invalid. More... | |
| BaseData * | GetData () 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 |
Protected Member Functions | |
| GLMapper () | |
| Returns whether this mapper allows picking in the renderwindow virtual bool IsPickable() const { return false; }. More... | |
| ~GLMapper () 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 | GenerateDataForRenderer (BaseRenderer *) |
| Generate the data needed for rendering into 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... | |
Additional Inherited Members | |
| Public Types inherited from mitk::Mapper | |
| typedef Mapper | Self |
| typedef itk::Object | Superclass |
| typedef itk::SmartPointer< Self > | Pointer |
| typedef itk::SmartPointer< const Self > | ConstPointer |
| 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 Attributes inherited from mitk::Mapper | |
| mitk::DataNode * | m_DataNode |
Detailed Description
Base class of all OpenGL-based mappers.
Those must implement the abstract method Paint(BaseRenderer), which is called by method MitkRender(). The Paint() method should be used to paint into a renderer via OpenGL-drawing commands. The OpenGL context matrices (GL_MODELVIEWMATRIX/GL_PROJECTIONMATRIX) are preinitialized by the mitkVtkPropRenderer so that the origin of the 2D-coordinate system of the 2D render window is located in the lower left corner and has the width and height in display pixels of the respective renderwindow. The x-axis is horizontally oriented, while the y-axis is vertically oriented. The drawing commands are directly interpreted as display coordinates. ApplyColorAndOpacity() can be used in the subclasses to apply color and opacity properties read from the PropertyList.
- Deprecated:
- (as of 2015_05) GLMappers are no longer supported in the rendering pipeline. Please use mitkVtkMapper instead or consider writing your own vtk classes, such as vtkActor or vtkMapper
Definition at line 41 of file mitkGLMapper.h.
Constructor & Destructor Documentation
◆ GLMapper()
|
protected |
Returns whether this mapper allows picking in the renderwindow virtual bool IsPickable() const { return false; }.
constructor
◆ ~GLMapper()
|
overrideprotected |
virtual destructor in order to derive from this class
Member Function Documentation
◆ ApplyColorAndOpacityProperties()
|
overridevirtual |
Apply color and opacity properties read from the PropertyList. The actor is not used in the GLMappers. Called by mapper subclasses.
Implements mitk::Mapper.
◆ ApplyProperties()
|
inlinevirtual |
Apply color and opacity properties read from the PropertyList.
- Deprecated:
- (as of 2013_03) Use ApplyColorAndOpacityProperties(...) instead
Definition at line 52 of file mitkGLMapper.h.
◆ IsVtkBased()
|
overridevirtual |
Returns whether this is a vtk-based mapper.
- Returns
- false, since all mappers deriving from this class are OpenGL mappers
- Deprecated:
- (as of 2013_03) All mappers of superclass VTKMapper are vtk based, use a dynamic_cast instead
Reimplemented from mitk::Mapper.
◆ mitkClassMacro()
◆ MitkRender()
|
overridevirtual |
Checks visibility and calls the paint method.
Note: The enumeration is disregarded, since OpenGL rendering only needs a single render pass.
Implements mitk::Mapper.
◆ Paint()
|
pure virtual |
Do the painting into the renderer.
Implemented in mitk::UnstructuredGridMapper2D, and mitk::VectorImageMapper2D.
The documentation for this class was generated from the following file:
