VTK-m  2.0
Public Member Functions | Private Attributes | List of all members
vtkm::rendering::MapperCylinder Class Reference

MapperCylinder renderers edges from a cell set and renders them as cylinders via ray tracing. More...

#include <MapperCylinder.h>

Inheritance diagram for vtkm::rendering::MapperCylinder:
vtkm::rendering::Mapper

Public Member Functions

 MapperCylinder ()
 
 ~MapperCylinder ()
 
void SetCanvas (vtkm::rendering::Canvas *canvas) override
 
virtual vtkm::rendering::CanvasGetCanvas () const override
 
void UseVariableRadius (bool useVariableRadius)
 render points using a variable radius based on the scalar field. More...
 
void SetRadius (const vtkm::Float32 &radius)
 Set a base radius for all points. More...
 
void SetRadiusDelta (const vtkm::Float32 &delta)
 When using a variable radius for all cylinder, the radius delta controls how much larger and smaller radii become based on the scalar field. More...
 
void RenderCells (const vtkm::cont::UnknownCellSet &cellset, const vtkm::cont::CoordinateSystem &coords, const vtkm::cont::Field &scalarField, const vtkm::cont::ColorTable &colorTable, const vtkm::rendering::Camera &camera, const vtkm::Range &scalarRange) override
 
void SetCompositeBackground (bool on)
 
vtkm::rendering::MapperNewCopy () const override
 
- Public Member Functions inherited from vtkm::rendering::Mapper
VTKM_CONT Mapper ()
 
virtual ~Mapper ()
 
virtual void SetActiveColorTable (const vtkm::cont::ColorTable &ct)
 
virtual void SetLogarithmX (bool l)
 
virtual void SetLogarithmY (bool l)
 

Private Attributes

std::shared_ptr< InternalsType > Internals
 

Additional Inherited Members

- Protected Attributes inherited from vtkm::rendering::Mapper
vtkm::cont::ArrayHandle< vtkm::Vec4f_32ColorMap
 
bool LogarithmX = false
 
bool LogarithmY = false
 

Detailed Description

MapperCylinder renderers edges from a cell set and renders them as cylinders via ray tracing.

Constructor & Destructor Documentation

◆ MapperCylinder()

vtkm::rendering::MapperCylinder::MapperCylinder ( )

◆ ~MapperCylinder()

vtkm::rendering::MapperCylinder::~MapperCylinder ( )

Member Function Documentation

◆ GetCanvas()

virtual vtkm::rendering::Canvas* vtkm::rendering::MapperCylinder::GetCanvas ( ) const
overridevirtual

◆ NewCopy()

vtkm::rendering::Mapper* vtkm::rendering::MapperCylinder::NewCopy ( ) const
overridevirtual

◆ RenderCells()

void vtkm::rendering::MapperCylinder::RenderCells ( const vtkm::cont::UnknownCellSet cellset,
const vtkm::cont::CoordinateSystem coords,
const vtkm::cont::Field scalarField,
const vtkm::cont::ColorTable colorTable,
const vtkm::rendering::Camera camera,
const vtkm::Range scalarRange 
)
overridevirtual

◆ SetCanvas()

void vtkm::rendering::MapperCylinder::SetCanvas ( vtkm::rendering::Canvas canvas)
overridevirtual

◆ SetCompositeBackground()

void vtkm::rendering::MapperCylinder::SetCompositeBackground ( bool  on)

◆ SetRadius()

void vtkm::rendering::MapperCylinder::SetRadius ( const vtkm::Float32 radius)

Set a base radius for all points.

If a radius is never specified the default heuristic is used.

◆ SetRadiusDelta()

void vtkm::rendering::MapperCylinder::SetRadiusDelta ( const vtkm::Float32 delta)

When using a variable radius for all cylinder, the radius delta controls how much larger and smaller radii become based on the scalar field.

If the delta is 0 all points will have the same radius. If the delta is 0.5 then the max/min scalar values would have a radii of base +/- base * 0.5.

◆ UseVariableRadius()

void vtkm::rendering::MapperCylinder::UseVariableRadius ( bool  useVariableRadius)

render points using a variable radius based on the scalar field.

The default is false.

Member Data Documentation

◆ Internals

std::shared_ptr<InternalsType> vtkm::rendering::MapperCylinder::Internals
private

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