VTK-m  2.0
Public Member Functions | Private Attributes | List of all members
vtkm::rendering::View3D Class Reference

#include <View3D.h>

Inheritance diagram for vtkm::rendering::View3D:
vtkm::rendering::View

Public Member Functions

 View3D (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))
 
 View3D (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))
 
 ~View3D ()
 
void Paint () override
 
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_CONT vtkm::rendering::SceneGetScene () const
 
VTKM_CONT vtkm::rendering::SceneGetScene ()
 
VTKM_CONT void SetScene (const vtkm::rendering::Scene &scene)
 
const VTKM_CONT vtkm::rendering::MapperGetMapper () const
 
VTKM_CONT vtkm::rendering::MapperGetMapper ()
 
const VTKM_CONT vtkm::rendering::CanvasGetCanvas () const
 
VTKM_CONT vtkm::rendering::CanvasGetCanvas ()
 
const VTKM_CONT vtkm::rendering::WorldAnnotatorGetWorldAnnotator () const
 
const VTKM_CONT vtkm::rendering::CameraGetCamera () const
 
VTKM_CONT vtkm::rendering::CameraGetCamera ()
 
VTKM_CONT void SetCamera (const vtkm::rendering::Camera &camera)
 
const VTKM_CONT vtkm::rendering::ColorGetBackgroundColor () 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 ()
 
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)
 

Private Attributes

vtkm::rendering::LineRendererBatcher LineBatcher
 
vtkm::rendering::BoundingBoxAnnotation BoxAnnotation
 
vtkm::rendering::AxisAnnotation3D XAxisAnnotation
 
vtkm::rendering::AxisAnnotation3D YAxisAnnotation
 
vtkm::rendering::AxisAnnotation3D ZAxisAnnotation
 
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
 

Constructor & Destructor Documentation

◆ View3D() [1/2]

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

◆ View3D() [2/2]

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

◆ ~View3D()

vtkm::rendering::View3D::~View3D ( )

Member Function Documentation

◆ Paint()

void vtkm::rendering::View3D::Paint ( )
overridevirtual

Implements vtkm::rendering::View.

◆ RenderScreenAnnotations()

void vtkm::rendering::View3D::RenderScreenAnnotations ( )
overridevirtual

Implements vtkm::rendering::View.

◆ RenderWorldAnnotations()

void vtkm::rendering::View3D::RenderWorldAnnotations ( )
overridevirtual

Implements vtkm::rendering::View.

Member Data Documentation

◆ BoxAnnotation

vtkm::rendering::BoundingBoxAnnotation vtkm::rendering::View3D::BoxAnnotation
private

◆ ColorBarAnnotation

vtkm::rendering::ColorBarAnnotation vtkm::rendering::View3D::ColorBarAnnotation
private

◆ LineBatcher

vtkm::rendering::LineRendererBatcher vtkm::rendering::View3D::LineBatcher
private

◆ XAxisAnnotation

vtkm::rendering::AxisAnnotation3D vtkm::rendering::View3D::XAxisAnnotation
private

◆ YAxisAnnotation

vtkm::rendering::AxisAnnotation3D vtkm::rendering::View3D::YAxisAnnotation
private

◆ ZAxisAnnotation

vtkm::rendering::AxisAnnotation3D vtkm::rendering::View3D::ZAxisAnnotation
private

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