xc
Public Member Functions | List of all members
Ray3d Class Reference

Ray in a three-dimensional space. More...

#include <Ray3d.h>

Inheritance diagram for Ray3d:
Inheritance graph
[legend]
Collaboration diagram for Ray3d:
Collaboration graph
[legend]

Public Member Functions

 Ray3d (void)
 Default constructor.
 
 Ray3d (const CGRay_3 &)
 Constructor from CGAL object.
 
 Ray3d (const Pos3d &, const Pos3d &)
 Constructor. More...
 
 Ray3d (const Pos3d &, const Vector3d &)
 Constructor. More...
 
virtual GeomObjgetCopy (void) const
 
void swap (void)
 @ brief Swaps the ray orientation.
 
virtual bool operator== (const Ray3d &) const
 Comparison operator.
 
const CGRay_3 & ToCGAL (void) const
 
void TwoPoints (const Pos3d &p1, const Pos3d &p2)
 
virtual GEOM_FT GetMax (unsigned short int) const
 Return the maximum value of the i-th coordinate.
 
virtual GEOM_FT GetMin (unsigned short int) const
 Return the minimum value of the i-th coordinate.
 
virtual Line3d getSupportLine (void) const
 
Pos3d getFromPoint (void) const
 
GEOM_FT getSlope (void) const
 
bool upwards (void) const
 Return true if the ray goes up.
 
bool downwards (void) const
 Return true if the ray goes down.
 
const Pos3d Point (const int &i=0) const
 
Pos3d PtoParametricas (const GEOM_FT &lambda) const
 Return a point of the line at a distance lambda from its origin.
 
bool isDegenerated (void) const
 
virtual bool In (const Pos3d &p, const double &tol=0.0) const
 Return true if point lies inside the object.
 
virtual GEOM_FT dist2 (const Pos3d &p) const
 Returns the squared distand from the point.
 
GEOM_FT dist (const Pos3d &p) const
 Return the distance from the point to the ray. More...
 
void Put (const Pos3d &p1, const Pos3d &p2)
 Set the points that define the line.
 
bool isParallel (const Ray3d &r) const
 Return true if parallel.
 
bool isParallel (const Line3d &r) const
 Return true if parallel.
 
GeomObj3d::list_Pos3d getIntersection (unsigned short int, const double &) const
 Return the intersection of the ray with the plane defined by the equation coord_i= d. More...
 
GeomObj3d::list_Pos3d getIntersection (const Line3d &r) const
 Return the intersection point with the argument line if it doesn't exist return an empty list. More...
 
GeomObj3d::list_Pos3d getIntersection (const Ray3d &sr) const
 Return the intersection point of both rays, if it doesn't exists return an empty list. More...
 
Pos3d Projection (const Pos3d &) const
 Return the orthogonal projection onto the line. More...
 
Vector3d Projection (const Vector3d &) const
 Return the projection onto the line. More...
 
virtual GEOM_FT getLength (void) const
 Return the object length.
 
virtual Pos3d getCenterOfMass (void) const
 
Dir3d GetDir (void) const
 
Vector3d VDir (void) const
 
virtual Vector3d getIVector (void) const
 Returns a vector in the direction of the local X axis. More...
 
virtual Vector3d getJVector (void) const
 Returns a vector in the direction of the local Y axis. More...
 
virtual Vector3d getKVector (void) const
 Returns a vector in the direction of the local Z axis.
 
double getAngle (const Vector3d &v) const
 
virtual GEOM_FT Ix (void) const
 
virtual GEOM_FT Iy (void) const
 
virtual GEOM_FT Iz (void) const
 
boost::python::dict getPyDict (void) const
 Return a Python dictionary with the object members values.
 
void setPyDict (const boost::python::dict &)
 Set the values of the object members from a Python dictionary.
 
void Print (std::ostream &os) const
 
- Public Member Functions inherited from Linear3d
virtual unsigned short int Dimension (void) const
 Return the dimension of the object 0, 1, 2 or 3.
 
virtual GEOM_FT getArea (void) const
 Return the object area.
 
virtual GEOM_FT getVolume (void) const
 Return the volume of the object.
 
virtual GEOM_FT getLambda (const Pos3d &) const
 Return the lambda parameter for the given point: p= getFromPoint()+lambda*VDir()
 
std::vector< std::pair< Pos3d, GEOM_FT > > sortPointsAlong (const GeomObj3d::list_Pos3d &) const
 Return the given points sorted by its parameter along the line (assuming they are on the line) in the form of a list of (position, lambda) pairs. More...
 
boost::python::list sortPointsAlongPy (const boost::python::list &) const
 Return the given points sorted by its parameter along the line (assuming they are on the line) in the form of a list of (position, lambda) pairs. More...
 
- Public Member Functions inherited from GeomObj3d
GEOM_FT GetXMax (void) const
 
GEOM_FT GetYMax (void) const
 
GEOM_FT GetZMax (void) const
 
GEOM_FT GetXMin (void) const
 
GEOM_FT GetYMin (void) const
 
GEOM_FT GetZMin (void) const
 
virtual void XProjection (void)
 
virtual void YProjection (void)
 
virtual void ZProjection (void)
 
Pos3d getPMax (void) const
 
Pos3d getPMin (void) const
 
BND3d Bnd (void) const
 Return the boundary of the object.
 
virtual bool Out (const Pos3d &p, const double &tol=0.0) const
 Return true if the point lies outside the object.
 
virtual GEOM_FT getCenterOfMassFactor (void) const
 Return the factor used for the computation of the center of mass (1.0 by default). More...
 
virtual GEOM_FT Pxy (void) const
 
virtual GEOM_FT Pxz (void) const
 
virtual GEOM_FT Pyz (void) const
 
GEOM_FT I (const unsigned short int &i, const unsigned short int &j) const
 
virtual GEOM_FT IArea (void) const
 
GEOM_FT I (const Pos3d &O, const Vector3d &e) const
 Return el moment of inertia with respect to the axis that passes through O with the direction of e. More...
 
GEOM_FT I (const Line3d &r) const
 Return el moment of inertia with respect to the argument line.
 
GEOM_FT I (const unsigned short int i, const unsigned short int j, const Pos3d &o) const
 Return el moment of inertia (i,j) respect to the axis parallel to i through o. More...
 
GEOM_FT IO (const Pos3d &o) const
 Return the polar moment of inertia with respect to the point o.
 
FT_matrix I (void) const
 Return the inertia tensor with respect to the center of mass of the object. More...
 
FT_matrix I (const Pos3d &o) const
 Return the inertia tensor with respect to the point o.
 
- Public Member Functions inherited from GeomObj
 GeomObj (void)
 Constructor.
 
virtual bool hasCenterOfMass (void) const
 Return true if the object has a center of mass.
 
GEOM_FT getCenterOfMassArea (void) const
 Return the dimension used to compute the center of mass, as follows: More...
 
virtual void Plot (Plotter &) const
 
- Public Member Functions inherited from ProtoGeom
 ProtoGeom (void)
 False when solution is not possible: intersection of parallel planes. More...
 
void setExists (bool e)
 
bool exists (void) const
 
boost::python::dict getPyDict (void) const
 Return a Python dictionary with the object members values.
 
void setPyDict (const boost::python::dict &)
 Set the values of the object members from a Python dictionary.
 
- Public Member Functions inherited from CommandEntity
 CommandEntity (CommandEntity *owr=nullptr)
 Default constructor.
 
CommandEntityOwner (void)
 Return a pointer to the object owner.
 
const CommandEntityOwner (void) const
 Return un puntero al objeto propietario de ESTE.
 
const StandardOutputWrappergetStandardOutputWrapper (void) const
 Return the regular output stream wrapper.
 
StandardOutputWrappergetStandardOutputWrapper (void)
 Return the regular output stream wrapper.
 
const std::string & getLogFileName (void) const
 Returns log file name.
 
void setLogFileName (const std::string &)
 Sets log file name.
 
const std::string & getErrFileName (void) const
 Returns err file name.
 
void setErrFileName (const std::string &)
 Sets error file name.
 
const std::string & getOutputFileName (void) const
 Returns regular output file name.
 
void setOutputFileName (const std::string &)
 Sets regular output file name.
 
boost::python::object evalPy (boost::python::object dict, const std::string &)
 Return the Python object that results from evaluating the argument.
 
boost::python::object execPy (boost::python::object dict, const std::string &)
 Return the Python objects that results from executing the code in the string argument.
 
boost::python::object execFilePy (boost::python::object dict, const std::string &)
 Return the Python object that results from executing the code in the file.
 
- Public Member Functions inherited from EntityWithProperties
 EntityWithProperties (EntityWithProperties *owr=nullptr)
 Default constructor.
 
void clearPyProps (void)
 Clear python properties map.
 
bool hasPyProp (const std::string &)
 Returns true if property exists.
 
boost::python::object getPyProp (const std::string &str)
 Return the Python object with the name being passed as parameter.
 
void setPyProp (std::string str, boost::python::object val)
 Sets/appends a value tho the Python object's dictionary.
 
void copyPropsFrom (const EntityWithProperties &)
 Copy the properties from the argument.
 
boost::python::list getPropNames (void) const
 Return the names of the object properties weightings.
 
const PythonDict & getPropertiesDict (void) const
 Return a std::map container with the properties of the object.
 
boost::python::dict getPyDict (void) const
 Return a Python dictionary containing the object members values.
 
void setPyDict (const boost::python::dict &)
 Set the values of the object members from a Python dictionary.
 
- Public Member Functions inherited from EntityWithOwner
 EntityWithOwner (EntityWithOwner *owr=nullptr)
 Default constructor.
 
 EntityWithOwner (const EntityWithOwner &)
 Copy constructor.
 
EntityWithOwneroperator= (const EntityWithOwner &)
 Assignment operator.
 
virtual bool operator== (const EntityWithOwner &) const
 Comparison operator.
 
virtual ~EntityWithOwner (void)
 Virtual destructor.
 
virtual std::string getClassName (void) const
 Returns demangled class name.
 
void set_owner (EntityWithOwner *owr)
 Assigns the owner of the object.
 
EntityWithOwnerOwner (void)
 
const EntityWithOwnerOwner (void) const
 

Additional Inherited Members

- Public Types inherited from GeomObj3d
typedef PolyPos< Pos3dlist_Pos3d
 
- Public Types inherited from GeomObj
typedef PolyPos< Pos3dlist_Pos3d
 
typedef PolyPos< Pos2dlist_Pos2d
 
- Public Types inherited from EntityWithProperties
typedef std::map< std::string, boost::python::object > PythonDict
 
- Static Public Member Functions inherited from CommandEntity
static void resetStandardOutput (void)
 Reset the standard output streams to its defaults buffers.
 
- Static Public Member Functions inherited from EntityWithOwner
static int getVerbosityLevel (void)
 Get the value of the verbosity level.
 
static void setVerbosityLevel (const int &)
 Set the value of the verbosity level.
 
- Protected Member Functions inherited from CommandEntity
template<class T >
void string_to (T &, const std::string &) const
 
- Protected Member Functions inherited from EntityWithProperties
bool isEqual (const EntityWithProperties &) const
 Return true if both objects are equal.
 
- Protected Member Functions inherited from EntityWithOwner
virtual bool isEqual (const EntityWithOwner &) const
 Return true if both objects are equal.
 
- Static Protected Member Functions inherited from CommandEntity
static CommandEntityentcmd_cast (boost::any &data)
 
- Static Protected Attributes inherited from EntityWithOwner
static int verbosity = 1
 Object that owns THIS ONE. More...
 

Detailed Description

Ray in a three-dimensional space.

Constructor & Destructor Documentation

◆ Ray3d() [1/2]

Ray3d::Ray3d ( const Pos3d p1,
const Pos3d p2 
)

Constructor.

Parameters
p1ray origing.
p2point in the ray direction.

◆ Ray3d() [2/2]

Ray3d::Ray3d ( const Pos3d p,
const Vector3d v 
)

Constructor.

Parameters
pray origing.
vray direction.

Member Function Documentation

◆ dist()

GEOM_FT Ray3d::dist ( const Pos3d p) const

Return the distance from the point to the ray.

◆ getIntersection() [1/3]

GeomObj3d::list_Pos3d Ray3d::getIntersection ( unsigned short int  i,
const double &  d 
) const

Return the intersection of the ray with the plane defined by the equation coord_i= d.

◆ getIntersection() [2/3]

GeomObj3d::list_Pos3d Ray3d::getIntersection ( const Line3d r) const

Return the intersection point with the argument line if it doesn't exist return an empty list.

◆ getIntersection() [3/3]

GeomObj3d::list_Pos3d Ray3d::getIntersection ( const Ray3d sr) const

Return the intersection point of both rays, if it doesn't exists return an empty list.

◆ getIVector()

Vector3d Ray3d::getIVector ( void  ) const
virtual

Returns a vector in the direction of the local X axis.

◆ getJVector()

Vector3d Ray3d::getJVector ( void  ) const
virtual

Returns a vector in the direction of the local Y axis.

◆ Projection() [1/2]

Pos3d Ray3d::Projection ( const Pos3d p) const
virtual

Return the orthogonal projection onto the line.

Parameters
ppoint to project.

Reimplemented from GeomObj3d.

◆ Projection() [2/2]

Vector3d Ray3d::Projection ( const Vector3d v) const
virtual

Return the projection onto the line.

Parameters
vvector to project.

Reimplemented from GeomObj3d.


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