Viskores  1.0
Public Member Functions | List of all members
viskores::rendering::CanvasRayTracer Class Reference

Represents the image space that is the target of rendering using the internal ray tracing code. More...

#include <CanvasRayTracer.h>

Inheritance diagram for viskores::rendering::CanvasRayTracer:
viskores::rendering::Canvas

Public Member Functions

 CanvasRayTracer (viskores::Id width=1024, viskores::Id height=1024)
 Construct a canvas of a given width and height. More...
 
 ~CanvasRayTracer ()
 
viskores::rendering::CanvasNewCopy () const override
 Create a new Canvas object of the same subtype as this one. More...
 
void WriteToCanvas (const viskores::rendering::raytracing::Ray< viskores::Float32 > &rays, const viskores::cont::ArrayHandle< viskores::Float32 > &colors, const viskores::rendering::Camera &camera)
 
void WriteToCanvas (const viskores::rendering::raytracing::Ray< viskores::Float64 > &rays, const viskores::cont::ArrayHandle< viskores::Float64 > &colors, const viskores::rendering::Camera &camera)
 
- Public Member Functions inherited from viskores::rendering::Canvas
 Canvas (viskores::Id width=1024, viskores::Id height=1024)
 Construct a canvas of a given width and height. More...
 
virtual ~Canvas ()
 
virtual void Clear ()
 Clear out the image buffers. More...
 
virtual void BlendBackground ()
 Blend the foreground data with the background color. More...
 
viskores::Id GetWidth () const
 The width of the image. More...
 
viskores::Id GetHeight () const
 The height of the image. More...
 
const ColorBufferTypeGetColorBuffer () const
 Get the color channels of the image. More...
 
ColorBufferTypeGetColorBuffer ()
 Get the color channels of the image. More...
 
const DepthBufferTypeGetDepthBuffer () const
 Get the depth channel of the image. More...
 
DepthBufferTypeGetDepthBuffer ()
 Get the depth channel of the image. More...
 
viskores::cont::DataSet GetDataSet (const std::string &colorFieldName="color", const std::string &depthFieldName="depth") const
 Gets the image in this Canvas as a viskores::cont::DataSet. More...
 
viskores::cont::DataSet GetDataSet (const char *colorFieldName, const char *depthFieldName="depth") const
 Gets the image in this Canvas as a viskores::cont::DataSet. More...
 
void ResizeBuffers (viskores::Id width, viskores::Id height)
 Change the size of the image. More...
 
const viskores::rendering::ColorGetBackgroundColor () const
 Specify the background color. More...
 
void SetBackgroundColor (const viskores::rendering::Color &color)
 Specify the background color. More...
 
const viskores::rendering::ColorGetForegroundColor () const
 Specify the foreground color used for annotations. More...
 
void SetForegroundColor (const viskores::rendering::Color &color)
 Specify the foreground color used for annotations. More...
 
viskores::Id2 GetScreenPoint (viskores::Float32 x, viskores::Float32 y, viskores::Float32 z, const viskores::Matrix< viskores::Float32, 4, 4 > &transfor) const
 
virtual void RefreshColorBuffer () const
 
virtual void RefreshDepthBuffer () const
 
virtual void SetViewToWorldSpace (const viskores::rendering::Camera &camera, bool clip)
 
virtual void SetViewToScreenSpace (const viskores::rendering::Camera &camera, bool clip)
 
virtual void SetViewportClipping (const viskores::rendering::Camera &, bool)
 
virtual void SaveAs (const std::string &fileName) const
 Save the rendered image. More...
 
virtual viskores::rendering::WorldAnnotatorCreateWorldAnnotator () const
 Creates a WorldAnnotator of a type that is paired with this Canvas. More...
 
virtual void AddColorSwatch (const viskores::Vec2f_64 &point0, const viskores::Vec2f_64 &point1, const viskores::Vec2f_64 &point2, const viskores::Vec2f_64 &point3, const viskores::rendering::Color &color) const
 
void AddColorSwatch (const viskores::Float64 x0, const viskores::Float64 y0, const viskores::Float64 x1, const viskores::Float64 y1, const viskores::Float64 x2, const viskores::Float64 y2, const viskores::Float64 x3, const viskores::Float64 y3, const viskores::rendering::Color &color) const
 
virtual void AddLine (const viskores::Vec2f_64 &point0, const viskores::Vec2f_64 &point1, viskores::Float32 linewidth, const viskores::rendering::Color &color) const
 
void AddLine (viskores::Float64 x0, viskores::Float64 y0, viskores::Float64 x1, viskores::Float64 y1, viskores::Float32 linewidth, const viskores::rendering::Color &color) const
 
virtual void AddColorBar (const viskores::Bounds &bounds, const viskores::cont::ColorTable &colorTable, bool horizontal) const
 
void AddColorBar (viskores::Float32 x, viskores::Float32 y, viskores::Float32 width, viskores::Float32 height, const viskores::cont::ColorTable &colorTable, bool horizontal) const
 
virtual void AddText (const viskores::Vec2f_32 &position, viskores::Float32 scale, viskores::Float32 angle, viskores::Float32 windowAspect, const viskores::Vec2f_32 &anchor, const viskores::rendering::Color &color, const std::string &text) const
 
void AddText (viskores::Float32 x, viskores::Float32 y, viskores::Float32 scale, viskores::Float32 angle, viskores::Float32 windowAspect, viskores::Float32 anchorX, viskores::Float32 anchorY, const viskores::rendering::Color &color, const std::string &text) const
 
void AddText (const viskores::Matrix< viskores::Float32, 4, 4 > &transform, viskores::Float32 scale, const viskores::Vec2f_32 &anchor, const viskores::rendering::Color &color, const std::string &text, const viskores::Float32 &depth=0) const
 
void BeginTextRenderingBatch () const
 
void EndTextRenderingBatch () const
 

Additional Inherited Members

- Public Types inherited from viskores::rendering::Canvas
using ColorBufferType = viskores::cont::ArrayHandle< viskores::Vec4f_32 >
 
using DepthBufferType = viskores::cont::ArrayHandle< viskores::Float32 >
 
using FontTextureType = viskores::rendering::Texture2D< 1 >
 

Detailed Description

Represents the image space that is the target of rendering using the internal ray tracing code.

Constructor & Destructor Documentation

◆ CanvasRayTracer()

viskores::rendering::CanvasRayTracer::CanvasRayTracer ( viskores::Id  width = 1024,
viskores::Id  height = 1024 
)

Construct a canvas of a given width and height.

◆ ~CanvasRayTracer()

viskores::rendering::CanvasRayTracer::~CanvasRayTracer ( )

Member Function Documentation

◆ NewCopy()

viskores::rendering::Canvas* viskores::rendering::CanvasRayTracer::NewCopy ( ) const
overridevirtual

Create a new Canvas object of the same subtype as this one.

Reimplemented from viskores::rendering::Canvas.

◆ WriteToCanvas() [1/2]

void viskores::rendering::CanvasRayTracer::WriteToCanvas ( const viskores::rendering::raytracing::Ray< viskores::Float32 > &  rays,
const viskores::cont::ArrayHandle< viskores::Float32 > &  colors,
const viskores::rendering::Camera camera 
)

◆ WriteToCanvas() [2/2]

void viskores::rendering::CanvasRayTracer::WriteToCanvas ( const viskores::rendering::raytracing::Ray< viskores::Float64 > &  rays,
const viskores::cont::ArrayHandle< viskores::Float64 > &  colors,
const viskores::rendering::Camera camera 
)

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