Public Member Functions | Public Attributes | Static Public Attributes | List of all members
shapes::Plane Class Reference

Definition of a plane with equation ax + by + cz + d = 0. More...

#include <shapes.h>

Inheritance diagram for shapes::Plane:
Inheritance graph
[legend]

Public Member Functions

Planeclone () const override
 Create a copy of this shape. More...
 
bool isFixed () const override
 Return a flag indicating whether this shape can be scaled and/or padded. More...
 
 Plane ()
 
 Plane (double pa, double pb, double pc, double pd)
 
void print (std::ostream &out=std::cout) const override
 Print information about this shape. More...
 
void scaleAndPadd (double scale, double padd) override
 Scale and padd this shape. More...
 
- Public Member Functions inherited from shapes::Shape
void padd (double padding)
 Add padding to this shape. More...
 
void scale (double scale)
 Scale this shape by a factor. More...
 
 Shape ()
 
virtual ~Shape ()
 

Public Attributes

double a
 The plane equation is ax + by + cz + d = 0. More...
 
double b
 
double c
 
double d
 
- Public Attributes inherited from shapes::Shape
ShapeType type
 The type of the shape. More...
 

Static Public Attributes

static const std::string STRING_NAME = "plane"
 The type of the shape, as a string. More...
 

Detailed Description

Definition of a plane with equation ax + by + cz + d = 0.

Definition at line 245 of file shapes.h.

Constructor & Destructor Documentation

◆ Plane() [1/2]

shapes::Plane::Plane ( )

Definition at line 182 of file shapes.cpp.

◆ Plane() [2/2]

shapes::Plane::Plane ( double  pa,
double  pb,
double  pc,
double  pd 
)

Definition at line 188 of file shapes.cpp.

Member Function Documentation

◆ clone()

Plane * shapes::Plane::clone ( ) const
overridevirtual

Create a copy of this shape.

Implements shapes::Shape.

Definition at line 255 of file shapes.cpp.

◆ isFixed()

bool shapes::Plane::isFixed ( ) const
overridevirtual

Return a flag indicating whether this shape can be scaled and/or padded.

Reimplemented from shapes::Shape.

Definition at line 416 of file shapes.cpp.

◆ print()

void shapes::Plane::print ( std::ostream &  out = std::cout) const
overridevirtual

Print information about this shape.

Reimplemented from shapes::Shape.

Definition at line 386 of file shapes.cpp.

◆ scaleAndPadd()

void shapes::Plane::scaleAndPadd ( double  scale,
double  padd 
)
overridevirtual

Scale and padd this shape.

Implements shapes::Shape.

Definition at line 270 of file shapes.cpp.

Member Data Documentation

◆ a

double shapes::Plane::a

The plane equation is ax + by + cz + d = 0.

Definition at line 260 of file shapes.h.

◆ b

double shapes::Plane::b

Definition at line 260 of file shapes.h.

◆ c

double shapes::Plane::c

Definition at line 260 of file shapes.h.

◆ d

double shapes::Plane::d

Definition at line 260 of file shapes.h.

◆ STRING_NAME

const std::string shapes::Plane::STRING_NAME = "plane"
static

The type of the shape, as a string.

Definition at line 252 of file shapes.h.


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


geometric_shapes
Author(s): Ioan Sucan , Gil Jones
autogenerated on Wed Nov 20 2019 03:16:43