GranOO  3.0
A robust and versatile workbench to build 3D dynamic simulations based on the Discrete Element Method
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Private Member Functions | Friends | List of all members
GranOO3::Geom::Point Class Reference

#include <Point.hpp>

Public Member Functions

 Point ()
 
 Point (const Point &)
 
 Point (const Point &, const Frame &from, const Frame &to)
 
 Point (double, double, double)
 
 Point (const double *)
 
 ~Point ()
 
Pointoperator= (const Point &)
 
Vectorto_vector ()
 
const Vectorto_vector () const
 
double distance_with (const Point &) const
 
void translate (const Vector &v)
 
void rotate (const Quaternion &q)
 
double & x ()
 
const double & x () const
 
double & y ()
 
const double & y () const
 
double & z ()
 
const double & z () const
 
void set_x (const double &)
 
void set_y (const double &)
 
void set_z (const double &)
 
double get_x () const
 
double get_y () const
 
double get_z () const
 
template<typename Axis >
double & val ()
 
template<typename Axis >
const double & val () const
 
const double & operator() (unsigned int i) const
 
double & operator() (unsigned int i)
 
bool is_nan () const
 
std::string info () const
 
void add_glob (const std::string &id)
 

Static Public Member Functions

static Pointglob (const std::string &id)
 
static std::string class_ID ()
 
static Pointnew_object (const TiXmlElement *el)
 
static Point mid_point (const Point &p1, const Point &p2)
 

Public Attributes

Eigen::Matrix< double, 3, 1 > coord
 

Static Public Attributes

static const int N = 3
 
static const Pointglobal = global::center
 
static const Pointnull = null::center
 

Private Member Functions

template<class Archive >
void serialize (Archive &, const unsigned int)
 

Friends

class Vector
 
class boost::serialization::access
 
bool operator== (const Point &, const Point &)
 
bool operator!= (const Point &, const Point &)
 
std::ostream & operator<< (std::ostream &, const Point &)
 

Constructor & Destructor Documentation

◆ Point() [1/5]

GranOO3::Geom::Point::Point ( )
explicit

◆ Point() [2/5]

GranOO3::Geom::Point::Point ( const Point )

◆ Point() [3/5]

GranOO3::Geom::Point::Point ( const Point p,
const Frame from,
const Frame to 
)

◆ Point() [4/5]

GranOO3::Geom::Point::Point ( double  ,
double  ,
double   
)
explicit

◆ Point() [5/5]

GranOO3::Geom::Point::Point ( const double *  )
explicit

◆ ~Point()

GranOO3::Geom::Point::~Point ( )

Member Function Documentation

◆ add_glob()

void GranOO3::Geom::Point::add_glob ( const std::string &  id)

◆ class_ID()

static std::string GranOO3::Geom::Point::class_ID ( )
inlinestatic

◆ distance_with()

double GranOO3::Geom::Point::distance_with ( const Point ) const

◆ get_x()

double GranOO3::Geom::Point::get_x ( ) const

◆ get_y()

double GranOO3::Geom::Point::get_y ( ) const

◆ get_z()

double GranOO3::Geom::Point::get_z ( ) const

◆ glob()

Point & GranOO3::Geom::Point::glob ( const std::string &  id)
static

◆ info()

std::string GranOO3::Geom::Point::info ( ) const

◆ is_nan()

bool GranOO3::Geom::Point::is_nan ( ) const

◆ mid_point()

static Point GranOO3::Geom::Point::mid_point ( const Point p1,
const Point p2 
)
static

◆ new_object()

Point * GranOO3::Geom::Point::new_object ( const TiXmlElement *  el)
static

◆ operator()() [1/2]

double& GranOO3::Geom::Point::operator() ( unsigned int  i)

◆ operator()() [2/2]

const double& GranOO3::Geom::Point::operator() ( unsigned int  i) const

◆ operator=()

Point& GranOO3::Geom::Point::operator= ( const Point )

◆ rotate()

void GranOO3::Geom::Point::rotate ( const Quaternion q)

◆ serialize()

template<class Archive >
void GranOO3::Geom::Point::serialize ( Archive &  ,
const unsigned int   
)
private

◆ set_x()

void GranOO3::Geom::Point::set_x ( const double &  )

◆ set_y()

void GranOO3::Geom::Point::set_y ( const double &  )

◆ set_z()

void GranOO3::Geom::Point::set_z ( const double &  )

◆ to_vector() [1/2]

Vector& GranOO3::Geom::Point::to_vector ( )

◆ to_vector() [2/2]

const Vector& GranOO3::Geom::Point::to_vector ( ) const

◆ translate()

void GranOO3::Geom::Point::translate ( const Vector v)

◆ val() [1/2]

template<typename Axis >
double& GranOO3::Geom::Point::val ( )

◆ val() [2/2]

template<typename Axis >
const double& GranOO3::Geom::Point::val ( ) const

◆ x() [1/2]

double& GranOO3::Geom::Point::x ( )

◆ x() [2/2]

const double& GranOO3::Geom::Point::x ( ) const

◆ y() [1/2]

double& GranOO3::Geom::Point::y ( )

◆ y() [2/2]

const double& GranOO3::Geom::Point::y ( ) const

◆ z() [1/2]

double& GranOO3::Geom::Point::z ( )

◆ z() [2/2]

const double& GranOO3::Geom::Point::z ( ) const

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

◆ operator!=

bool operator!= ( const Point ,
const Point  
)
friend

◆ operator<<

std::ostream& operator<< ( std::ostream &  ,
const Point  
)
friend

◆ operator==

bool operator== ( const Point ,
const Point  
)
friend

◆ Vector

friend class Vector
friend

Member Data Documentation

◆ coord

Eigen::Matrix<double, 3, 1> GranOO3::Geom::Point::coord

◆ global

const Point & GranOO3::Geom::Point::global = global::center
static

◆ N

const int GranOO3::Geom::Point::N = 3
static

◆ null

const Point & GranOO3::Geom::Point::null = null::center
static

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