Base class for glyph mappers. More...

#include <MapperGlyphBase.h>

Inheritance diagram for vtkm::rendering::MapperGlyphBase:

Public Member Functions
	MapperGlyphBase ()

virtual	~MapperGlyphBase ()

void	SetCanvas (vtkm::rendering::Canvas *canvas) override

virtual vtkm::rendering::Canvas *	GetCanvas () 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 vtkm::rendering::Mapper *	NewCopy () const =0

virtual void	SetLogarithmX (bool l)

virtual void	SetLogarithmY (bool l)

Protected Member Functions
virtual vtkm::cont::DataSet	FilterPoints (const vtkm::cont::UnknownCellSet &cellSet, const vtkm::cont::CoordinateSystem &coords, const vtkm::cont::Field &scalarField) const

Protected Member Functions inherited from vtkm::rendering::Mapper
virtual 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)=0

Protected Attributes
vtkm::rendering::CanvasRayTracer *	Canvas = 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_32 >	ColorMap

bool	LogarithmX = false

bool	LogarithmY = false

bool	SortBackToFront = true

Detailed Description

Base class for glyph mappers.

Glyph mappers place 3D icons at various places in the mesh. The icons are placed based on the location of points or cells in the mesh.

Constructor & Destructor Documentation

◆ MapperGlyphBase()

vtkm::rendering::MapperGlyphBase::MapperGlyphBase ( )

◆ ~MapperGlyphBase()

virtual vtkm::rendering::MapperGlyphBase::~MapperGlyphBase ( )

virtual

Member Function Documentation

◆ FilterPoints()

virtual vtkm::cont::DataSet vtkm::rendering::MapperGlyphBase::FilterPoints	(	const vtkm::cont::UnknownCellSet &	cellSet,
		const vtkm::cont::CoordinateSystem &	coords,
		const vtkm::cont::Field &	scalarField
	)		const

protectedvirtual

◆ GetAssociation()

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

virtual

Specify the elements the glyphs will be associated with.

The glyph mapper will place glyphs over locations specified by either the points or the cells of a mesh. The glyph may also be oriented by a scalar field with the same association.

◆ GetBaseSize()

virtual vtkm::Float32 vtkm::rendering::MapperGlyphBase::GetBaseSize ( ) const

virtual

Specify the size of each glyph (before scaling).

If the base size is not set to a positive value, it is automatically sized with a heuristic based off the bounds of the geometry.

◆ GetCanvas()

virtual vtkm::rendering::Canvas* vtkm::rendering::MapperGlyphBase::GetCanvas ( ) const

overridevirtual

Implements vtkm::rendering::Mapper.

◆ GetScaleByValue()

virtual bool vtkm::rendering::MapperGlyphBase::GetScaleByValue ( ) const

virtual

Specify whether to scale the glyphs by a field.

◆ GetScaleDelta()

virtual vtkm::Float32 vtkm::rendering::MapperGlyphBase::GetScaleDelta ( ) const

virtual

Specify the range of values to scale the glyphs.

When ScaleByValue is on, the glyphs will be scaled proportionally to the field magnitude. The ScaleDelta determines how big and small they get. For a ScaleDelta of one, the smallest field values will have glyphs of zero size and the maximum field values will be twice the base size. A ScaleDelta of 0.5 will result in glyphs sized in the range of 0.5 times the base size to 1.5 times the base size. ScaleDelta outside the range [0, 1] is undefined.

◆ GetStride()

virtual vtkm::Id vtkm::rendering::MapperGlyphBase::GetStride ( ) const

virtual

◆ GetUseCells()

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

virtual

Specify the elements the glyphs will be associated with.

The glyph mapper will place glyphs over locations specified by either the points or the cells of a mesh. The glyph may also be oriented by a scalar field with the same association.

◆ GetUseNodes()

virtual bool vtkm::rendering::MapperGlyphBase::GetUseNodes ( ) const

virtual

◆ GetUsePoints()

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

virtual

Specify the elements the glyphs will be associated with.

The glyph mapper will place glyphs over locations specified by either the points or the cells of a mesh. The glyph may also be oriented by a scalar field with the same association.

◆ GetUseStride()

virtual bool vtkm::rendering::MapperGlyphBase::GetUseStride ( ) const

virtual

◆ SetAssociation()

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

virtual

Specify the elements the glyphs will be associated with.

The glyph mapper will place glyphs over locations specified by either the points or the cells of a mesh. The glyph may also be oriented by a scalar field with the same association.

◆ SetBaseSize()

virtual void vtkm::rendering::MapperGlyphBase::SetBaseSize ( vtkm::Float32 size )

virtual

Specify the size of each glyph (before scaling).

If the base size is not set to a positive value, it is automatically sized with a heuristic based off the bounds of the geometry.

◆ SetCanvas()

void vtkm::rendering::MapperGlyphBase::SetCanvas ( vtkm::rendering::Canvas * canvas )

overridevirtual

Implements vtkm::rendering::Mapper.

◆ SetCompositeBackground()

virtual void vtkm::rendering::MapperGlyphBase::SetCompositeBackground ( bool on )

virtual

◆ SetScaleByValue()

virtual void vtkm::rendering::MapperGlyphBase::SetScaleByValue ( bool on )

virtual

Specify whether to scale the glyphs by a field.

◆ SetScaleDelta()

virtual void vtkm::rendering::MapperGlyphBase::SetScaleDelta ( vtkm::Float32 delta )

virtual

Specify the range of values to scale the glyphs.

When ScaleByValue is on, the glyphs will be scaled proportionally to the field magnitude. The ScaleDelta determines how big and small they get. For a ScaleDelta of one, the smallest field values will have glyphs of zero size and the maximum field values will be twice the base size. A ScaleDelta of 0.5 will result in glyphs sized in the range of 0.5 times the base size to 1.5 times the base size. ScaleDelta outside the range [0, 1] is undefined.

◆ SetStride()

virtual void vtkm::rendering::MapperGlyphBase::SetStride ( vtkm::Id stride )

virtual

◆ SetUseCells()

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

virtual

Specify the elements the glyphs will be associated with.

The glyph mapper will place glyphs over locations specified by either the points or the cells of a mesh. The glyph may also be oriented by a scalar field with the same association.

◆ SetUseNodes()

virtual void vtkm::rendering::MapperGlyphBase::SetUseNodes ( )

virtual

◆ SetUsePoints()

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

virtual

Specify the elements the glyphs will be associated with.

The glyph mapper will place glyphs over locations specified by either the points or the cells of a mesh. The glyph may also be oriented by a scalar field with the same association.

◆ SetUseStride()

virtual void vtkm::rendering::MapperGlyphBase::SetUseStride ( bool on )

virtual

Member Data Documentation

◆ Association

vtkm::cont::Field::Association vtkm::rendering::MapperGlyphBase::Association = vtkm::cont::Field::Association::Points

protected

◆ BaseSize

vtkm::Float32 vtkm::rendering::MapperGlyphBase::BaseSize = -1.f

protected

◆ Canvas

vtkm::rendering::CanvasRayTracer* vtkm::rendering::MapperGlyphBase::Canvas = nullptr

protected

◆ CompositeBackground

bool vtkm::rendering::MapperGlyphBase::CompositeBackground = true

protected

◆ ScaleByValue

bool vtkm::rendering::MapperGlyphBase::ScaleByValue = false

protected

◆ ScaleDelta

vtkm::Float32 vtkm::rendering::MapperGlyphBase::ScaleDelta = 0.5f

protected

◆ Stride

vtkm::Id vtkm::rendering::MapperGlyphBase::Stride = 1

protected

◆ UseStride

bool vtkm::rendering::MapperGlyphBase::UseStride = false

protected

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

MapperGlyphBase.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MapperGlyphBase()

◆ ~MapperGlyphBase()

Member Function Documentation

◆ FilterPoints()

◆ GetAssociation()

◆ GetBaseSize()

◆ GetCanvas()

◆ GetScaleByValue()

◆ GetScaleDelta()

◆ GetStride()

◆ GetUseCells()

◆ GetUseNodes()

◆ GetUsePoints()

◆ GetUseStride()

◆ SetAssociation()

◆ SetBaseSize()

◆ SetCanvas()

◆ SetCompositeBackground()

◆ SetScaleByValue()

◆ SetScaleDelta()

◆ SetStride()

◆ SetUseCells()

◆ SetUseNodes()

◆ SetUsePoints()

◆ SetUseStride()

Member Data Documentation

◆ Association

◆ BaseSize

◆ Canvas

◆ CompositeBackground

◆ ScaleByValue

◆ ScaleDelta

◆ Stride

◆ UseStride