Volume Cartographer 2.27.0
Public Member Functions | List of all members
volcart::shapes::Plane Class Reference

Planar surface shape. More...

#include <vc/core/shapes/Plane.hpp>

Inheritance diagram for volcart::shapes::Plane:
[legend]
Collaboration diagram for volcart::shapes::Plane:
[legend]

Public Member Functions

 Plane (int width=5, int height=5)
 
- Public Member Functions inherited from volcart::shapes::ShapePrimitive
ITKMesh::Pointer itkMesh ()
 Return the shape as an ITKMesh.
 
vtkSmartPointer< vtkPolyData > vtkMesh ()
 Return the shape as a vtkPolyData.
 
PointSet< cv::Vec3d > unorderedPoints ()
 Return the vertices as a PointSet. More...
 
PointSet< cv::Vec6d > unorderedPointNormal ()
 Return the vertices and vertex normals as a PointSet. More...
 
std::vector< SimpleMesh::VertexgetPoints () const
 Return the vertices as a list of SimpleMesh::Vertex. More...
 
std::vector< SimpleMesh::CellgetCells () const
 Return the faces as a list of volcart::Cell. More...
 
OrderedPointSet< cv::Vec3d > orderedPoints ()
 Return the vertices as an OrderedPointSet. More...
 
OrderedPointSet< cv::Vec6d > orderedPointNormal ()
 Return the vertices and vertex normals as an OrderedPointSet. More...
 
bool isOrdered () const
 Return if the shape generator created ordered vertices. More...
 
std::size_t orderedWidth () const
 Return the width of the ordered vertex set. More...
 
std::size_t orderedHeight () const
 Return the height of the ordered vertex set. More...
 

Additional Inherited Members

- Protected Member Functions inherited from volcart::shapes::ShapePrimitive
 ShapePrimitive ()
 
void addVertex_ (double x, double y, double z)
 Add a new vertex to the shape.
 
void addCell_ (int v1, int v2, int v3)
 Add a new triangular face to the mesh from vertex IDs. More...
 
void updateNormal_ (int vertID, double nx, double ny, double nz)
 Update the normal of a vertex with a new normal component. More...
 
- Protected Attributes inherited from volcart::shapes::ShapePrimitive
std::vector< SimpleMesh::Vertexpoints_
 
std::vector< SimpleMesh::Cellcells_
 
bool ordered_ {false}
 
std::size_t orderedWidth_ {0}
 
std::size_t orderedHeight_ {0}
 

Detailed Description

Planar surface shape.

Author
Seth Parker
Date
11/19/15

This class generates a planar surface parallel to the XZ plane at y = 0. Points are 1 unit apart.

The shape will have a number of points equal to width x height. The points generated by this class are ordered.

Definition at line 23 of file Plane.hpp.

Constructor & Destructor Documentation

◆ Plane()

volcart::shapes::Plane::Plane ( int  width = 5,
int  height = 5 
)
inline

Definition at line 26 of file Plane.hpp.


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