Viskores  1.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
viskores::rendering::MapperVolume Class Reference

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

#include <MapperVolume.h>

Inheritance diagram for viskores::rendering::MapperVolume:
viskores::rendering::Mapper

Public Member Functions

 MapperVolume ()
 
 ~MapperVolume ()
 
void SetCanvas (viskores::rendering::Canvas *canvas) override
 
virtual viskores::rendering::CanvasGetCanvas () const override
 
viskores::rendering::MapperNewCopy () const override
 
void SetSampleDistance (const viskores::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 viskores::rendering::Mapper
 Mapper ()
 
virtual ~Mapper ()
 
virtual void RenderCells (const viskores::cont::UnknownCellSet &cellset, const viskores::cont::CoordinateSystem &coords, const viskores::cont::Field &scalarField, const viskores::cont::ColorTable &colorTable, const viskores::rendering::Camera &camera, const viskores::Range &scalarRange)
 
void RenderCells (const viskores::cont::UnknownCellSet &cellset, const viskores::cont::CoordinateSystem &coords, const viskores::cont::Field &scalarField, const viskores::cont::ColorTable &colorTable, const viskores::rendering::Camera &camera, const viskores::Range &scalarRange, const viskores::cont::Field &ghostField)
 
virtual void RenderCellsPartitioned (const viskores::cont::PartitionedDataSet partitionedData, const std::string fieldName, const viskores::cont::ColorTable &colorTable, const viskores::rendering::Camera &camera, const viskores::Range &scalarRange)
 
virtual void SetActiveColorTable (const viskores::cont::ColorTable &ct)
 
virtual void SetLogarithmX (bool l)
 
virtual void SetLogarithmY (bool l)
 

Private Member Functions

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

Private Attributes

std::shared_ptr< InternalsType > Internals
 

Additional Inherited Members

- Protected Attributes inherited from viskores::rendering::Mapper
viskores::cont::ArrayHandle< viskores::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()

viskores::rendering::MapperVolume::MapperVolume ( )

◆ ~MapperVolume()

viskores::rendering::MapperVolume::~MapperVolume ( )

Member Function Documentation

◆ GetCanvas()

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

◆ NewCopy()

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

◆ RenderCellsImpl()

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

◆ SetCanvas()

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

◆ SetCompositeBackground()

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

◆ SetSampleDistance()

void viskores::rendering::MapperVolume::SetSampleDistance ( const viskores::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> viskores::rendering::MapperVolume::Internals
private

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