vtkm::rendering::View Class Reference

#include <View.h>

Inheritance diagram for vtkm::rendering::View:

Public Member Functions
	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_CONT vtkm::rendering::Scene &	GetScene () const
VTKM_CONT vtkm::rendering::Scene &	GetScene ()
VTKM_CONT void	SetScene (const vtkm::rendering::Scene &scene)
const VTKM_CONT vtkm::rendering::Mapper &	GetMapper () const
VTKM_CONT vtkm::rendering::Mapper &	GetMapper ()
const VTKM_CONT vtkm::rendering::Canvas &	GetCanvas () const
VTKM_CONT vtkm::rendering::Canvas &	GetCanvas ()
const VTKM_CONT vtkm::rendering::WorldAnnotator &	GetWorldAnnotator () const
const VTKM_CONT vtkm::rendering::Camera &	GetCamera () const
VTKM_CONT vtkm::rendering::Camera &	GetCamera ()
VTKM_CONT void	SetCamera (const vtkm::rendering::Camera &camera)
const VTKM_CONT vtkm::rendering::Color &	GetBackgroundColor () const
VTKM_CONT void	SetBackgroundColor (const vtkm::rendering::Color &color)
VTKM_CONT void	SetForegroundColor (const vtkm::rendering::Color &color)
VTKM_CONT bool	GetWorldAnnotationsEnabled () const
VTKM_CONT void	SetWorldAnnotationsEnabled (bool val)
VTKM_CONT void	SetRenderAnnotationsEnabled (bool val)
VTKM_CONT bool	GetRenderAnnotationsEnabled ()
virtual void	Paint ()=0
virtual void	RenderScreenAnnotations ()=0
virtual void	RenderWorldAnnotations ()=0
void	RenderAnnotations ()
void	SaveAs (const std::string &fileName) const
VTKM_CONT void	SetAxisColor (vtkm::rendering::Color c)
VTKM_CONT void	ClearTextAnnotations ()
VTKM_CONT void	AddTextAnnotation (std::unique_ptr< vtkm::rendering::TextAnnotation > ann)
VTKM_CONT void	ClearAdditionalAnnotations ()
VTKM_CONT void	AddAdditionalAnnotation (std::function< void(void)> ann)

Protected Member Functions
void	SetupForWorldSpace (bool viewportClip=true)
void	SetupForScreenSpace (bool viewportClip=false)

Protected Attributes
vtkm::rendering::Color	AxisColor = vtkm::rendering::Color::white
bool	WorldAnnotationsEnabled = true
bool	RenderAnnotationsEnabled = true

Private Attributes
std::shared_ptr< InternalData >	Internal

Constructor & Destructor Documentation

View() [1/2]

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() [2/2]

vtkm::rendering::View::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)
	)

~View()

virtual vtkm::rendering::View::~View ( )

virtual

Member Function Documentation

AddAdditionalAnnotation()

VTKM_CONT void vtkm::rendering::View::AddAdditionalAnnotation

(

std::function< void(void)>

ann

)

AddTextAnnotation()

VTKM_CONT void vtkm::rendering::View::AddTextAnnotation

(

std::unique_ptr< vtkm::rendering::TextAnnotation >

ann

)

ClearAdditionalAnnotations()

VTKM_CONT void vtkm::rendering::View::ClearAdditionalAnnotations

(

)

ClearTextAnnotations()

VTKM_CONT void vtkm::rendering::View::ClearTextAnnotations

(

)

GetBackgroundColor()

const VTKM_CONT vtkm::rendering::Color& vtkm::rendering::View::GetBackgroundColor

(

)

const

GetCamera() [1/2]

VTKM_CONT vtkm::rendering::Camera& vtkm::rendering::View::GetCamera

(

)

GetCamera() [2/2]

const VTKM_CONT vtkm::rendering::Camera& vtkm::rendering::View::GetCamera

(

)

const

GetCanvas() [1/2]

VTKM_CONT vtkm::rendering::Canvas& vtkm::rendering::View::GetCanvas

(

)

GetCanvas() [2/2]

const VTKM_CONT vtkm::rendering::Canvas& vtkm::rendering::View::GetCanvas

(

)

const

GetMapper() [1/2]

VTKM_CONT vtkm::rendering::Mapper& vtkm::rendering::View::GetMapper

(

)

GetMapper() [2/2]

const VTKM_CONT vtkm::rendering::Mapper& vtkm::rendering::View::GetMapper

(

)

const

GetRenderAnnotationsEnabled()

VTKM_CONT bool vtkm::rendering::View::GetRenderAnnotationsEnabled ( )

inline

GetScene() [1/2]

VTKM_CONT vtkm::rendering::Scene& vtkm::rendering::View::GetScene

(

)

GetScene() [2/2]

const VTKM_CONT vtkm::rendering::Scene& vtkm::rendering::View::GetScene

(

)

const

GetWorldAnnotationsEnabled()

VTKM_CONT bool vtkm::rendering::View::GetWorldAnnotationsEnabled ( ) const

inline

GetWorldAnnotator()

const VTKM_CONT vtkm::rendering::WorldAnnotator& vtkm::rendering::View::GetWorldAnnotator

(

)

const

Paint()

virtual void vtkm::rendering::View::Paint ( )

pure virtual

Implemented in vtkm::rendering::View3D, vtkm::rendering::View2D, and vtkm::rendering::View1D.

RenderAnnotations()

void vtkm::rendering::View::RenderAnnotations

(

)

RenderScreenAnnotations()

virtual void vtkm::rendering::View::RenderScreenAnnotations ( )

pure virtual

Implemented in vtkm::rendering::View3D, vtkm::rendering::View2D, and vtkm::rendering::View1D.

RenderWorldAnnotations()

virtual void vtkm::rendering::View::RenderWorldAnnotations ( )

pure virtual

Implemented in vtkm::rendering::View3D, vtkm::rendering::View2D, and vtkm::rendering::View1D.

SaveAs()

void vtkm::rendering::View::SaveAs

(

const std::string &

fileName

)

const

SetAxisColor()

VTKM_CONT void vtkm::rendering::View::SetAxisColor

(

vtkm::rendering::Color

c

)

SetBackgroundColor()

VTKM_CONT void vtkm::rendering::View::SetBackgroundColor

(

const vtkm::rendering::Color &

color

)

SetCamera()

VTKM_CONT void vtkm::rendering::View::SetCamera

(

const vtkm::rendering::Camera &

camera

)

SetForegroundColor()

VTKM_CONT void vtkm::rendering::View::SetForegroundColor

(

const vtkm::rendering::Color &

color

)

SetRenderAnnotationsEnabled()

VTKM_CONT void vtkm::rendering::View::SetRenderAnnotationsEnabled ( bool  val )

inline

SetScene()

VTKM_CONT void vtkm::rendering::View::SetScene

(

const vtkm::rendering::Scene &

scene

)

SetupForScreenSpace()

void vtkm::rendering::View::SetupForScreenSpace ( bool  viewportClip = false )

protected

SetupForWorldSpace()

void vtkm::rendering::View::SetupForWorldSpace ( bool  viewportClip = true )

protected

SetWorldAnnotationsEnabled()

VTKM_CONT void vtkm::rendering::View::SetWorldAnnotationsEnabled ( bool  val )

inline

Member Data Documentation

AxisColor

vtkm::rendering::Color vtkm::rendering::View::AxisColor = vtkm::rendering::Color::white

protected

Internal

std::shared_ptr<InternalData> vtkm::rendering::View::Internal

private

RenderAnnotationsEnabled

bool vtkm::rendering::View::RenderAnnotationsEnabled = true

protected

WorldAnnotationsEnabled

bool vtkm::rendering::View::WorldAnnotationsEnabled = true

protected

---

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

• View.h