Base class for glyph mappers. More...

#include <MapperGlyphBase.h>

Inheritance diagram for viskores::rendering::MapperGlyphBase:

Public Member Functions
	MapperGlyphBase ()

virtual	~MapperGlyphBase ()

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

virtual viskores::rendering::Canvas *	GetCanvas () const override

virtual viskores::cont::Field::Association	GetAssociation () const
	Specify the elements the glyphs will be associated with. More...

virtual void	SetAssociation (viskores::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 viskores::Id	GetStride () const

virtual void	SetStride (viskores::Id stride)

virtual viskores::Float32	GetBaseSize () const
	Specify the size of each glyph (before scaling). More...

virtual void	SetBaseSize (viskores::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 viskores::Float32	GetScaleDelta () const
	Specify the range of values to scale the glyphs. More...

virtual void	SetScaleDelta (viskores::Float32 delta)
	Specify the range of values to scale the glyphs. More...

virtual void	SetCompositeBackground (bool on)

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 viskores::rendering::Mapper *	NewCopy () const =0

virtual void	SetLogarithmX (bool l)

virtual void	SetLogarithmY (bool l)

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

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

Protected Attributes
viskores::rendering::CanvasRayTracer *	Canvas = nullptr

bool	CompositeBackground = true

viskores::cont::Field::Association	Association = viskores::cont::Field::Association::Points

bool	UseStride = false

viskores::Id	Stride = 1

bool	ScaleByValue = false

viskores::Float32	BaseSize = -1.f

viskores::Float32	ScaleDelta = 0.5f

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

viskores::rendering::MapperGlyphBase::MapperGlyphBase ( )

◆ ~MapperGlyphBase()

virtual viskores::rendering::MapperGlyphBase::~MapperGlyphBase ( )

virtual

Member Function Documentation

◆ FilterPoints()

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

protectedvirtual

◆ GetAssociation()

virtual viskores::cont::Field::Association viskores::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 viskores::Float32 viskores::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 viskores::rendering::Canvas* viskores::rendering::MapperGlyphBase::GetCanvas ( ) const

overridevirtual

Implements viskores::rendering::Mapper.

◆ GetScaleByValue()

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

virtual

Specify whether to scale the glyphs by a field.

◆ GetScaleDelta()

virtual viskores::Float32 viskores::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 viskores::Id viskores::rendering::MapperGlyphBase::GetStride ( ) const

virtual

◆ GetUseCells()

virtual bool viskores::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 viskores::rendering::MapperGlyphBase::GetUseNodes ( ) const

virtual

◆ GetUsePoints()

virtual bool viskores::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 viskores::rendering::MapperGlyphBase::GetUseStride ( ) const

virtual

◆ SetAssociation()

virtual void viskores::rendering::MapperGlyphBase::SetAssociation ( viskores::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 viskores::rendering::MapperGlyphBase::SetBaseSize ( viskores::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 viskores::rendering::MapperGlyphBase::SetCanvas ( viskores::rendering::Canvas * canvas )

overridevirtual

Implements viskores::rendering::Mapper.

◆ SetCompositeBackground()

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

virtual

◆ SetScaleByValue()

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

virtual

Specify whether to scale the glyphs by a field.

◆ SetScaleDelta()

virtual void viskores::rendering::MapperGlyphBase::SetScaleDelta ( viskores::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 viskores::rendering::MapperGlyphBase::SetStride ( viskores::Id stride )

virtual

◆ SetUseCells()

virtual void viskores::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 viskores::rendering::MapperGlyphBase::SetUseNodes ( )

virtual

◆ SetUsePoints()

virtual void viskores::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 viskores::rendering::MapperGlyphBase::SetUseStride ( bool on )

virtual

Member Data Documentation

◆ Association

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

protected

◆ BaseSize

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

protected

◆ Canvas

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

protected

◆ CompositeBackground

bool viskores::rendering::MapperGlyphBase::CompositeBackground = true

protected

◆ ScaleByValue

bool viskores::rendering::MapperGlyphBase::ScaleByValue = false

protected

◆ ScaleDelta

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

protected

◆ Stride

viskores::Id viskores::rendering::MapperGlyphBase::Stride = 1

protected

◆ UseStride

bool viskores::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