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

A mapper that produces oriented glyphs. More...

#include <MapperGlyphVector.h>

Inheritance diagram for vtkm::rendering::MapperGlyphVector:
vtkm::rendering::MapperGlyphBase vtkm::rendering::Mapper

Public Member Functions

 MapperGlyphVector ()
 
 ~MapperGlyphVector ()
 
vtkm::rendering::GlyphType GetGlyphType () const
 Specify the shape of the glyphs. More...
 
void SetGlyphType (vtkm::rendering::GlyphType glyphType)
 Specify the shape of the glyphs. More...
 
vtkm::rendering::MapperNewCopy () const override
 
- Public Member Functions inherited from vtkm::rendering::MapperGlyphBase
 MapperGlyphBase ()
 
virtual ~MapperGlyphBase ()
 
void SetCanvas (vtkm::rendering::Canvas *canvas) override
 
virtual vtkm::rendering::CanvasGetCanvas () const override
 
virtual vtkm::cont::Field::Association GetAssociation () const
 Specify the elements the glyphs will be associated with. More...
 
virtual void SetAssociation (vtkm::cont::Field::Association association)
 Specify the elements the glyphs will be associated with. More...
 
virtual bool GetUseCells () const
 Specify the elements the glyphs will be associated with. More...
 
virtual void SetUseCells ()
 Specify the elements the glyphs will be associated with. More...
 
virtual bool GetUsePoints () const
 Specify the elements the glyphs will be associated with. More...
 
virtual void SetUsePoints ()
 Specify the elements the glyphs will be associated with. More...
 
virtual bool GetUseNodes () const
 
virtual void SetUseNodes ()
 
virtual bool GetUseStride () const
 
virtual void SetUseStride (bool on)
 
virtual vtkm::Id GetStride () const
 
virtual void SetStride (vtkm::Id stride)
 
virtual vtkm::Float32 GetBaseSize () const
 Specify the size of each glyph (before scaling). More...
 
virtual void SetBaseSize (vtkm::Float32 size)
 Specify the size of each glyph (before scaling). More...
 
virtual bool GetScaleByValue () const
 Specify whether to scale the glyphs by a field. More...
 
virtual void SetScaleByValue (bool on)
 Specify whether to scale the glyphs by a field. More...
 
virtual vtkm::Float32 GetScaleDelta () const
 Specify the range of values to scale the glyphs. More...
 
virtual void SetScaleDelta (vtkm::Float32 delta)
 Specify the range of values to scale the glyphs. More...
 
virtual void SetCompositeBackground (bool on)
 
- 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)
 

Protected 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
 
- Protected Member Functions inherited from vtkm::rendering::MapperGlyphBase
virtual vtkm::cont::DataSet FilterPoints (const vtkm::cont::UnknownCellSet &cellSet, const vtkm::cont::CoordinateSystem &coords, const vtkm::cont::Field &scalarField) const
 

Protected Attributes

vtkm::rendering::GlyphType GlyphType
 
- Protected Attributes inherited from vtkm::rendering::MapperGlyphBase
vtkm::rendering::CanvasRayTracerCanvas = nullptr
 
bool CompositeBackground = true
 
vtkm::cont::Field::Association Association = vtkm::cont::Field::Association::Points
 
bool UseStride = false
 
vtkm::Id Stride = 1
 
bool ScaleByValue = false
 
vtkm::Float32 BaseSize = -1.f
 
vtkm::Float32 ScaleDelta = 0.5f
 
- Protected Attributes inherited from vtkm::rendering::Mapper
vtkm::cont::ArrayHandle< vtkm::Vec4f_32ColorMap
 
bool LogarithmX = false
 
bool LogarithmY = false
 
bool SortBackToFront = true
 

Detailed Description

A mapper that produces oriented glyphs.

This mapper is meant to be used with 3D vector fields. The glyphs are oriented in the direction of the vector field. The glyphs can be optionally sized based on the magnitude of the field.

Constructor & Destructor Documentation

◆ MapperGlyphVector()

vtkm::rendering::MapperGlyphVector::MapperGlyphVector ( )

◆ ~MapperGlyphVector()

vtkm::rendering::MapperGlyphVector::~MapperGlyphVector ( )

Member Function Documentation

◆ GetGlyphType()

vtkm::rendering::GlyphType vtkm::rendering::MapperGlyphVector::GetGlyphType ( ) const

Specify the shape of the glyphs.

◆ NewCopy()

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

◆ RenderCellsImpl()

void vtkm::rendering::MapperGlyphVector::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 
)
overrideprotectedvirtual

◆ SetGlyphType()

void vtkm::rendering::MapperGlyphVector::SetGlyphType ( vtkm::rendering::GlyphType  glyphType)

Specify the shape of the glyphs.

Member Data Documentation

◆ GlyphType

vtkm::rendering::GlyphType vtkm::rendering::MapperGlyphVector::GlyphType
protected

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