KJB
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
kjb::Polymesh_Plane Class Reference

This class contains a Vector of plane parameters, a vector of the face indices that lie in the plane, and the polymesh that the faces are from. The plane parameters are the coefficients of a plane of the form ax + by + cz + d = 0. More...

#include <gr_polymesh_plane.h>

Public Member Functions

 Polymesh_Plane (const Polymesh &p)
 Constructs a polymesh_plane from a polymesh. More...
 
 Polymesh_Plane (const Polymesh &p, Vector &params, std::vector< int > &indices)
 Constructs a polymesh_plane with a polymesh, plane parameters, and a vector of face indices. More...
 
 Polymesh_Plane (const Polymesh_Plane &pp)
 Copy constructor. More...
 
 ~Polymesh_Plane ()
 Deletes this Polymesh_Plane. More...
 
Polymesh_Planeoperator= (const Polymesh_Plane &)
 Copies a Polymesh_Plane into this one. More...
 
std::vector< int > get_face_indices () const
 Returns the indices of the faces that lie in the defined plane. More...
 
Vector get_plane_params () const
 Returns the coefficients of a plane. More...
 
const Polymeshget_polymesh () const
 Returns the polymesh. More...
 
void set_face_indices (std::vector< int > indices)
 Sets the vector of indices that lies in the plane. More...
 
void set_plane_params (Vector params)
 Sets the Vector of plane coefficients. More...
 

Detailed Description

This class contains a Vector of plane parameters, a vector of the face indices that lie in the plane, and the polymesh that the faces are from. The plane parameters are the coefficients of a plane of the form ax + by + cz + d = 0.

Constructor & Destructor Documentation

Polymesh_Plane::Polymesh_Plane ( const Polymesh p)

Constructs a polymesh_plane from a polymesh.

Parameters
pthe polymesh
Polymesh_Plane::Polymesh_Plane ( const Polymesh p,
Vector params,
std::vector< int > &  indices 
)

Constructs a polymesh_plane with a polymesh, plane parameters, and a vector of face indices.

Parameters
pthe polymesh
paramsthe vector of coefficients of the plane
indicesthe vector of indices of the faces in the polymesh p that lie in the plane defined by params
Polymesh_Plane::Polymesh_Plane ( const Polymesh_Plane pp)

Copy constructor.

Parameters
ppthe Polymesh_Plane to copy into this one.
Polymesh_Plane::~Polymesh_Plane ( )

Deletes this Polymesh_Plane.

Frees all space allocated by this Polymesh_Plane.

Member Function Documentation

std::vector< int > kjb::Polymesh_Plane::get_face_indices ( ) const
inline

Returns the indices of the faces that lie in the defined plane.

Vector kjb::Polymesh_Plane::get_plane_params ( ) const
inline

Returns the coefficients of a plane.

const Polymesh * kjb::Polymesh_Plane::get_polymesh ( ) const
inline

Returns the polymesh.

Polymesh_Plane & Polymesh_Plane::operator= ( const Polymesh_Plane pp)

Copies a Polymesh_Plane into this one.

Performs a deep copy of the plane parameters and face indices.

Parameters
ppPolymesh_Plane to copy into this one.
Returns
A reference to this Polymesh_Plane.
void kjb::Polymesh_Plane::set_face_indices ( std::vector< int >  indices)
inline

Sets the vector of indices that lies in the plane.

void kjb::Polymesh_Plane::set_plane_params ( Vector  params)
inline

Sets the Vector of plane coefficients.


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