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

This mapper renders points from a cell set. More...

#include <MapperPoint.h>

Inheritance diagram for vtkm::rendering::MapperPoint:
vtkm::rendering::Mapper

Public Member Functions

 MapperPoint ()
 
 ~MapperPoint ()
 
void SetCanvas (vtkm::rendering::Canvas *canvas) override
 
virtual vtkm::rendering::CanvasGetCanvas () const override
 
virtual vtkm::cont::Field::Association GetAssociation () const
 Specify the elements the points will be associated with. More...
 
virtual void SetAssociation (vtkm::cont::Field::Association association)
 Specify the elements the points will be associated with. More...
 
virtual bool GetUseCells () const
 Specify the elements the points will be associated with. More...
 
virtual void SetUseCells ()
 Specify the elements the points will be associated with. More...
 
virtual bool GetUsePoints () const
 Specify the elements the points will be associated with. More...
 
virtual void SetUsePoints ()
 Specify the elements the points will be associated with. More...
 
void UseCells ()
 
void UseNodes ()
 
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 raidus for all points. More...
 
void SetRadiusDelta (const vtkm::Float32 &delta)
 When using a variable raidus for all points, the radius delta controls how much larger and smaller radii become based on the scalar field. More...
 
void SetCompositeBackground (bool on)
 
vtkm::rendering::MapperNewCopy () const override
 
- 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

void RenderCellsImpl (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) 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

This mapper renders points from a cell set.

This mapper can natively create points from vertex cell shapes as well as use the points defined by a coordinate system.

Constructor & Destructor Documentation

◆ MapperPoint()

vtkm::rendering::MapperPoint::MapperPoint ( )

◆ ~MapperPoint()

vtkm::rendering::MapperPoint::~MapperPoint ( )

Member Function Documentation

◆ GetAssociation()

virtual vtkm::cont::Field::Association vtkm::rendering::MapperPoint::GetAssociation ( ) const
virtual

Specify the elements the points will be associated with.

The point mapper will place visible points over locations specified by either the points or the cells of a mesh.

◆ GetCanvas()

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

◆ GetUseCells()

virtual bool vtkm::rendering::MapperPoint::GetUseCells ( ) const
virtual

Specify the elements the points will be associated with.

The point mapper will place visible points over locations specified by either the points or the cells of a mesh.

◆ GetUsePoints()

virtual bool vtkm::rendering::MapperPoint::GetUsePoints ( ) const
virtual

Specify the elements the points will be associated with.

The point mapper will place visible points over locations specified by either the points or the cells of a mesh.

◆ NewCopy()

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

◆ RenderCellsImpl()

void vtkm::rendering::MapperPoint::RenderCellsImpl ( 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 
)
overrideprivatevirtual

◆ SetAssociation()

virtual void vtkm::rendering::MapperPoint::SetAssociation ( vtkm::cont::Field::Association  association)
virtual

Specify the elements the points will be associated with.

The point mapper will place visible points over locations specified by either the points or the cells of a mesh.

◆ SetCanvas()

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

◆ SetCompositeBackground()

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

◆ SetRadius()

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

Set a base raidus for all points.

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

◆ SetRadiusDelta()

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

When using a variable raidus for all points, 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.

◆ SetUseCells()

virtual void vtkm::rendering::MapperPoint::SetUseCells ( )
virtual

Specify the elements the points will be associated with.

The point mapper will place visible points over locations specified by either the points or the cells of a mesh.

◆ SetUsePoints()

virtual void vtkm::rendering::MapperPoint::SetUsePoints ( )
virtual

Specify the elements the points will be associated with.

The point mapper will place visible points over locations specified by either the points or the cells of a mesh.

◆ UseCells()

void vtkm::rendering::MapperPoint::UseCells ( )

◆ UseNodes()

void vtkm::rendering::MapperPoint::UseNodes ( )

◆ UseVariableRadius()

void vtkm::rendering::MapperPoint::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::MapperPoint::Internals
private

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