viskores::rendering::View1D Class Reference

A view for a 1D data set. More...

#include <View1D.h>

Inheritance diagram for viskores::rendering::View1D:

Public Member Functions
	View1D (const viskores::rendering::Scene &scene, const viskores::rendering::Mapper &mapper, const viskores::rendering::Canvas &canvas, const viskores::rendering::Color &backgroundColor=viskores::rendering::Color(0, 0, 0, 1), const viskores::rendering::Color &foregroundColor=viskores::rendering::Color(1, 1, 1, 1))
	View1D (const viskores::rendering::Scene &scene, const viskores::rendering::Mapper &mapper, const viskores::rendering::Canvas &canvas, const viskores::rendering::Camera &camera, const viskores::rendering::Color &backgroundColor=viskores::rendering::Color(0, 0, 0, 1), const viskores::rendering::Color &foregroundColor=viskores::rendering::Color(1, 1, 1, 1))
void	Paint () override
	Render a scene and store the result in the canvas' buffers. More...
void	RenderScreenAnnotations () override
void	RenderWorldAnnotations () override
void	RenderColorLegendAnnotations ()
void	EnableLegend ()
void	DisableLegend ()
void	SetLegendLabelColor (viskores::rendering::Color c)
void	SetLogX (bool l)
	Specify whether log scaling should be used on the X axis. More...
void	SetLogY (bool l)
	Specify whether log scaling should be used on the Y axis. More...
Public Member Functions inherited from viskores::rendering::View
	View (const viskores::rendering::Scene &scene, const viskores::rendering::Mapper &mapper, const viskores::rendering::Canvas &canvas, const viskores::rendering::Color &backgroundColor=viskores::rendering::Color(0, 0, 0, 1), const viskores::rendering::Color &foregroundColor=viskores::rendering::Color(1, 1, 1, 1))
	View (const viskores::rendering::Scene &scene, const viskores::rendering::Mapper &mapper, const viskores::rendering::Canvas &canvas, const viskores::rendering::Camera &camera, const viskores::rendering::Color &backgroundColor=viskores::rendering::Color(0, 0, 0, 1), const viskores::rendering::Color &foregroundColor=viskores::rendering::Color(1, 1, 1, 1))
virtual	~View ()
const viskores::rendering::Scene &	GetScene () const
	Specify the scene object holding the objects to render. More...
viskores::rendering::Scene &	GetScene ()
	Specify the scene object holding the objects to render. More...
void	SetScene (const viskores::rendering::Scene &scene)
	Specify the scene object holding the objects to render. More...
const viskores::rendering::Mapper &	GetMapper () const
	Specify the mapper object determining how objects are rendered. More...
viskores::rendering::Mapper &	GetMapper ()
	Specify the mapper object determining how objects are rendered. More...
const viskores::rendering::Canvas &	GetCanvas () const
	Specify the canvas object that holds the buffer to render into. More...
viskores::rendering::Canvas &	GetCanvas ()
	Specify the canvas object that holds the buffer to render into. More...
const viskores::rendering::WorldAnnotator &	GetWorldAnnotator () const
const viskores::rendering::Camera &	GetCamera () const
	Specify the perspective from which to render a scene. More...
viskores::rendering::Camera &	GetCamera ()
	Specify the perspective from which to render a scene. More...
void	SetCamera (const viskores::rendering::Camera &camera)
	Specify the perspective from which to render a scene. More...
const viskores::rendering::Color &	GetBackgroundColor () const
	Specify the color used where nothing is rendered. More...
void	SetBackgroundColor (const viskores::rendering::Color &color)
	Specify the color used where nothing is rendered. More...
void	SetForegroundColor (const viskores::rendering::Color &color)
	Specify the color of foreground elements. More...
bool	GetWorldAnnotationsEnabled () const
void	SetWorldAnnotationsEnabled (bool val)
void	SetRenderAnnotationsEnabled (bool val)
bool	GetRenderAnnotationsEnabled () const
void	RenderAnnotations ()
void	SaveAs (const std::string &fileName) const
	Save the rendered image. More...
void	SetAxisColor (viskores::rendering::Color c)
void	ClearTextAnnotations ()
void	AddTextAnnotation (std::unique_ptr< viskores::rendering::TextAnnotation > ann)
void	ClearAdditionalAnnotations ()
void	AddAdditionalAnnotation (std::function< void(void)> ann)

Private Member Functions
void	UpdateCameraProperties ()

Private Attributes
viskores::rendering::AxisAnnotation2D	HorizontalAxisAnnotation
viskores::rendering::AxisAnnotation2D	VerticalAxisAnnotation
viskores::rendering::ColorLegendAnnotation	Legend
bool	LegendEnabled = true
bool	LogX = false
bool	LogY = false

Additional Inherited Members
Protected Member Functions inherited from viskores::rendering::View
void	SetupForWorldSpace (bool viewportClip=true)
void	SetupForScreenSpace (bool viewportClip=false)
Protected Attributes inherited from viskores::rendering::View
viskores::rendering::Color	AxisColor = viskores::rendering::Color::white
bool	WorldAnnotationsEnabled = true
bool	RenderAnnotationsEnabled = true

Detailed Description

A view for a 1D data set.

1D data are rendered as an X-Y plot with the values shone on the Y axis.

Constructor & Destructor Documentation

View1D() [1/2]

viskores::rendering::View1D::View1D	(	const viskores::rendering::Scene &	scene,
		const viskores::rendering::Mapper &	mapper,
		const viskores::rendering::Canvas &	canvas,
		const viskores::rendering::Color &	backgroundColor = viskores::rendering::Color(0, 0, 0, 1),
		const viskores::rendering::Color &	foregroundColor = viskores::rendering::Color(1, 1, 1, 1)
	)

View1D() [2/2]

viskores::rendering::View1D::View1D	(	const viskores::rendering::Scene &	scene,
		const viskores::rendering::Mapper &	mapper,
		const viskores::rendering::Canvas &	canvas,
		const viskores::rendering::Camera &	camera,
		const viskores::rendering::Color &	backgroundColor = viskores::rendering::Color(0, 0, 0, 1),
		const viskores::rendering::Color &	foregroundColor = viskores::rendering::Color(1, 1, 1, 1)
	)

Member Function Documentation

DisableLegend()

void viskores::rendering::View1D::DisableLegend

(

)

EnableLegend()

void viskores::rendering::View1D::EnableLegend

(

)

Paint()

void viskores::rendering::View1D::Paint ( )

overridevirtual

Render a scene and store the result in the canvas' buffers.

Implements viskores::rendering::View.

RenderColorLegendAnnotations()

void viskores::rendering::View1D::RenderColorLegendAnnotations

(

)

RenderScreenAnnotations()

void viskores::rendering::View1D::RenderScreenAnnotations ( )

overridevirtual

Implements viskores::rendering::View.

RenderWorldAnnotations()

void viskores::rendering::View1D::RenderWorldAnnotations ( )

overridevirtual

Implements viskores::rendering::View.

SetLegendLabelColor()

void viskores::rendering::View1D::SetLegendLabelColor ( viskores::rendering::Color  c )

inline

SetLogX()

void viskores::rendering::View1D::SetLogX ( bool  l )

inline

Specify whether log scaling should be used on the X axis.

SetLogY()

void viskores::rendering::View1D::SetLogY ( bool  l )

inline

Specify whether log scaling should be used on the Y axis.

UpdateCameraProperties()

void viskores::rendering::View1D::UpdateCameraProperties ( )

private

Member Data Documentation

HorizontalAxisAnnotation

viskores::rendering::AxisAnnotation2D viskores::rendering::View1D::HorizontalAxisAnnotation

private

Legend

viskores::rendering::ColorLegendAnnotation viskores::rendering::View1D::Legend

private

LegendEnabled

bool viskores::rendering::View1D::LegendEnabled = true

private

LogX

bool viskores::rendering::View1D::LogX = false

private

LogY

bool viskores::rendering::View1D::LogY = false

private

VerticalAxisAnnotation

viskores::rendering::AxisAnnotation2D viskores::rendering::View1D::VerticalAxisAnnotation

private

---

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

• View1D.h