vtkm::rendering::View2D Class Reference

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

#include <View2D.h>

Inheritance diagram for vtkm::rendering::View2D:

Public Member Functions
	View2D (const vtkm::rendering::Scene &scene, const vtkm::rendering::Mapper &mapper, const vtkm::rendering::Canvas &canvas, const vtkm::rendering::Color &backgroundColor=vtkm::rendering::Color(0, 0, 0, 1), const vtkm::rendering::Color &foregroundColor=vtkm::rendering::Color(1, 1, 1, 1))
	View2D (const vtkm::rendering::Scene &scene, const vtkm::rendering::Mapper &mapper, const vtkm::rendering::Canvas &canvas, const vtkm::rendering::Camera &camera, const vtkm::rendering::Color &backgroundColor=vtkm::rendering::Color(0, 0, 0, 1), const vtkm::rendering::Color &foregroundColor=vtkm::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
Public Member Functions inherited from vtkm::rendering::View
	View (const vtkm::rendering::Scene &scene, const vtkm::rendering::Mapper &mapper, const vtkm::rendering::Canvas &canvas, const vtkm::rendering::Color &backgroundColor=vtkm::rendering::Color(0, 0, 0, 1), const vtkm::rendering::Color &foregroundColor=vtkm::rendering::Color(1, 1, 1, 1))
	View (const vtkm::rendering::Scene &scene, const vtkm::rendering::Mapper &mapper, const vtkm::rendering::Canvas &canvas, const vtkm::rendering::Camera &camera, const vtkm::rendering::Color &backgroundColor=vtkm::rendering::Color(0, 0, 0, 1), const vtkm::rendering::Color &foregroundColor=vtkm::rendering::Color(1, 1, 1, 1))
virtual	~View ()
const vtkm::rendering::Scene &	GetScene () const
	Specify the scene object holding the objects to render. More...
vtkm::rendering::Scene &	GetScene ()
	Specify the scene object holding the objects to render. More...
void	SetScene (const vtkm::rendering::Scene &scene)
	Specify the scene object holding the objects to render. More...
const vtkm::rendering::Mapper &	GetMapper () const
	Specify the mapper object determining how objects are rendered. More...
vtkm::rendering::Mapper &	GetMapper ()
	Specify the mapper object determining how objects are rendered. More...
const vtkm::rendering::Canvas &	GetCanvas () const
	Specify the canvas object that holds the buffer to render into. More...
vtkm::rendering::Canvas &	GetCanvas ()
	Specify the canvas object that holds the buffer to render into. More...
const vtkm::rendering::WorldAnnotator &	GetWorldAnnotator () const
const vtkm::rendering::Camera &	GetCamera () const
	Specify the perspective from which to render a scene. More...
vtkm::rendering::Camera &	GetCamera ()
	Specify the perspective from which to render a scene. More...
void	SetCamera (const vtkm::rendering::Camera &camera)
	Specify the perspective from which to render a scene. More...
const vtkm::rendering::Color &	GetBackgroundColor () const
	Specify the color used where nothing is rendered. More...
void	SetBackgroundColor (const vtkm::rendering::Color &color)
	Specify the color used where nothing is rendered. More...
void	SetForegroundColor (const vtkm::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 (vtkm::rendering::Color c)
void	ClearTextAnnotations ()
void	AddTextAnnotation (std::unique_ptr< vtkm::rendering::TextAnnotation > ann)
void	ClearAdditionalAnnotations ()
void	AddAdditionalAnnotation (std::function< void(void)> ann)

Private Member Functions
void	UpdateCameraProperties ()

Private Attributes
vtkm::rendering::AxisAnnotation2D	HorizontalAxisAnnotation
vtkm::rendering::AxisAnnotation2D	VerticalAxisAnnotation
vtkm::rendering::ColorBarAnnotation	ColorBarAnnotation

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

Detailed Description

A view for a 3D data set.

2D data are rendered directly on the X-Y plane.

Constructor & Destructor Documentation

View2D() [1/2]

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

View2D() [2/2]

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

Member Function Documentation

Paint()

void vtkm::rendering::View2D::Paint ( )

overridevirtual

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

Implements vtkm::rendering::View.

RenderScreenAnnotations()

void vtkm::rendering::View2D::RenderScreenAnnotations ( )

overridevirtual

Implements vtkm::rendering::View.

RenderWorldAnnotations()

void vtkm::rendering::View2D::RenderWorldAnnotations ( )

overridevirtual

Implements vtkm::rendering::View.

UpdateCameraProperties()

void vtkm::rendering::View2D::UpdateCameraProperties ( )

private

Member Data Documentation

ColorBarAnnotation

vtkm::rendering::ColorBarAnnotation vtkm::rendering::View2D::ColorBarAnnotation

private

HorizontalAxisAnnotation

vtkm::rendering::AxisAnnotation2D vtkm::rendering::View2D::HorizontalAxisAnnotation

private

VerticalAxisAnnotation

vtkm::rendering::AxisAnnotation2D vtkm::rendering::View2D::VerticalAxisAnnotation

private

---

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

• View2D.h