Shuenhoy/vtk-m2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

adding doxygen comments to new rendering

Browse Source
This commit is contained in:
mclarsen 2018-09-11 20:07:27 -07:00
parent f519cd2e48
commit 0b99ff5796
7 changed files with 24 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
vtkm/rendering/Canvas.cxx
View File

@ -313,8 +313,6 @@ void Canvas::Activate()
void Canvas::Clear()
{
// TODO: Should the rendering library support policies or some other way to
// configure with custom devices?
internal::ClearBuffers worklet;
vtkm::worklet::DispatcherMapField<internal::ClearBuffers> dispatcher(worklet);
dispatcher.Invoke(this->GetColorBuffer(), this->GetDepthBuffer());

6
vtkm/rendering/MapperCylinder.h
View File

@ -31,6 +31,11 @@ namespace vtkm
namespace rendering
{
/**
* \brief MapperCylinder renderers edges from a cell set
* and renders them as cylinders via ray tracing.
*
*/
class VTKM_RENDERING_EXPORT MapperCylinder : public Mapper
{
public:
@ -39,6 +44,7 @@ public:
~MapperCylinder();
void SetCanvas(vtkm::rendering::Canvas* canvas) override;
virtual vtkm::rendering::Canvas* GetCanvas() const override;
/**

7
vtkm/rendering/MapperPoint.h
View File

@ -31,6 +31,13 @@ namespace vtkm
namespace rendering
{
/**
* \brief MapperPonts renders points from a cell set.
* This mapper can natively create points from
* vertex cell shapes as well as use the points
* defined by a coordinate system.
*
*/
class VTKM_RENDERING_EXPORT MapperPoint : public Mapper
{
public:

6
vtkm/rendering/MapperQuad.h
View File

@ -31,6 +31,12 @@ namespace vtkm
namespace rendering
{
/**
* \brief MapperQuad renderers quad facess from a cell set via ray tracing.
* As opposed to breaking quads into two trianges, scalars are
* interpolated using all 4 points of the quad resulting in more
* accurate interpolation.
*/
class VTKM_RENDERING_EXPORT MapperQuad : public Mapper
{
public:

1
vtkm/rendering/raytracing/BoundingVolumeHierarchy.cxx
View File

@ -179,7 +179,6 @@ public:
class LinearBVHBuilder::BVHData
{
public:
//TODO: make private
vtkm::cont::ArrayHandle<vtkm::UInt32> mortonCodes;
vtkm::cont::ArrayHandle<vtkm::Id> parent;
vtkm::cont::ArrayHandle<vtkm::Id> leftChild;

21
vtkm/rendering/raytracing/CylinderExtractor.cxx
View File

@ -114,9 +114,6 @@ public:
segment[1] = cellIndices[0];
segment[2] = cellIndices[1];
outputIndices.Set(pointOffset, segment);
//outputIndices.Set(pointOffset, cellId);
//outputId2.Set(pointOffset, vtkm::Id2(cellId, cellId));
}
else if (shapeType.Id == vtkm::CELL_SHAPE_TRIANGLE)
{
@ -210,22 +207,6 @@ public:
} //namespace detail
//void CylinderExtractor::ExtractCoordinates(const vtkm::cont::CoordinateSystem& coords,
// const vtkm::Float32 radius)
//{
// this->SetPointIdsFromCoords(coords);
// this->SetUniformRadius(radius);
//}
//TODO: I don't think I need varying radius
//void CylinderExtractor::ExtractCoordinates(const vtkm::cont::CoordinateSystem& coords,
// const vtkm::cont::Field& field,
// const vtkm::Float32 minRadius,
// const vtkm::Float32 maxRadius)
//{
// this->SetPointIdsFromCoords(coords);
// this->SetVaryingRadius(minRadius, maxRadius, field);
//}
void CylinderExtractor::ExtractCells(const vtkm::cont::DynamicCellSet& cells,
const vtkm::Float32 radius)
@ -234,7 +215,6 @@ void CylinderExtractor::ExtractCells(const vtkm::cont::DynamicCellSet& cells,
vtkm::rendering::Cylinderizer geometrizer;
geometrizer.Run(cells, this->CylIds, numOfSegments);
//this->SetCylinderIdsFromCells(cells);
this->SetUniformRadius(radius);
}
@ -247,7 +227,6 @@ void CylinderExtractor::ExtractCells(const vtkm::cont::DynamicCellSet& cells,
vtkm::rendering::Cylinderizer geometrizer;
geometrizer.Run(cells, this->CylIds, numOfSegments);
//this->SetCylinderIdsFromCells(cells);
this->SetVaryingRadius(minRadius, maxRadius, field);
}

18
vtkm/rendering/raytracing/CylinderExtractor.h
View File

@ -29,6 +29,11 @@ namespace rendering
namespace raytracing
{
/**
* \brief CylinderExtractor creates a line segments from
* the edges of a cell set.
*
*/
class CylinderExtractor
{
protected:
@ -36,19 +41,6 @@ protected:
vtkm::cont::ArrayHandle<vtkm::Float32> Radii;
public:
//
// Extract all nodes using a constant radius
//
// void ExtractCoordinates(const vtkm::cont::CoordinateSystem& coords, const vtkm::Float32 radius);
// //
// // Set radius based on scalar field values. Each is interpolated from min to max
// //
// void ExtractCoordinates(const vtkm::cont::CoordinateSystem& coords,
// const vtkm::cont::Field& field,
// const vtkm::Float32 minRadius,
// const vtkm::Float32 maxRadius);
//
// Extract all vertex shapes with constant radius
//