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

Mapper that renders a volume as a translucent cloud. More...

#include <MapperVolume.h>

Inheritance diagram for vtkm::rendering::MapperVolume:
vtkm::rendering::Mapper

Public Member Functions

 MapperVolume ()
 
 ~MapperVolume ()
 
void SetCanvas (vtkm::rendering::Canvas *canvas) override
 
virtual vtkm::rendering::CanvasGetCanvas () const override
 
vtkm::rendering::MapperNewCopy () const override
 
void SetSampleDistance (const vtkm::Float32 distance)
 Specify how much space is between samples of rays that traverse the volume. More...
 
void SetCompositeBackground (const bool compositeBackground)
 
- Public Member Functions inherited from vtkm::rendering::Mapper
 Mapper ()
 
virtual ~Mapper ()
 
virtual 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)
 
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, const vtkm::cont::Field &ghostField)
 
virtual void RenderCellsPartitioned (const vtkm::cont::PartitionedDataSet partitionedData, const std::string fieldName, const vtkm::cont::ColorTable &colorTable, const vtkm::rendering::Camera &camera, const vtkm::Range &scalarRange)
 
virtual void SetActiveColorTable (const vtkm::cont::ColorTable &ct)
 
virtual void SetLogarithmX (bool l)
 
virtual void SetLogarithmY (bool l)
 

Private Member Functions

virtual void RenderCellsImpl (const vtkm::cont::UnknownCellSet &cellset, const vtkm::cont::CoordinateSystem &coords, const vtkm::cont::Field &scalarField, const vtkm::cont::ColorTable &, const vtkm::rendering::Camera &camera, const vtkm::Range &scalarRange, const vtkm::cont::Field &ghostField) override
 

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
 
bool SortBackToFront = true
 

Detailed Description

Mapper that renders a volume as a translucent cloud.

Constructor & Destructor Documentation

◆ MapperVolume()

vtkm::rendering::MapperVolume::MapperVolume ( )

◆ ~MapperVolume()

vtkm::rendering::MapperVolume::~MapperVolume ( )

Member Function Documentation

◆ GetCanvas()

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

◆ NewCopy()

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

◆ RenderCellsImpl()

virtual void vtkm::rendering::MapperVolume::RenderCellsImpl ( const vtkm::cont::UnknownCellSet cellset,
const vtkm::cont::CoordinateSystem coords,
const vtkm::cont::Field scalarField,
const vtkm::cont::ColorTable ,
const vtkm::rendering::Camera camera,
const vtkm::Range scalarRange,
const vtkm::cont::Field ghostField 
)
overrideprivatevirtual

◆ SetCanvas()

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

◆ SetCompositeBackground()

void vtkm::rendering::MapperVolume::SetCompositeBackground ( const bool  compositeBackground)

◆ SetSampleDistance()

void vtkm::rendering::MapperVolume::SetSampleDistance ( const vtkm::Float32  distance)

Specify how much space is between samples of rays that traverse the volume.

The volume rendering ray caster finds the entry point of the ray through the volume and then samples the volume along the direction of the ray at regular intervals. This parameter specifies how far these samples occur.

Member Data Documentation

◆ Internals

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

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