Struct ILLIXR::data_format::point

ClassList > ILLIXR > data_format > point

Inherits the following classes: Eigen::Vector3f

Inherited by the following classes: ILLIXR::data_format::point_with_validity

Public Functions

Type	Name
point &	operator+= (const Eigen::Vector3f & other)
point &	operator-= (const Eigen::Vector3f & other)
point &	operator= (const Eigen::Vector3f & other)
point &	operator= (const Eigen::Product< T, U, Option > & pr)
	point ()
	point (const float x, const float y, const float z=0.)
void	set (const float x_, const float y_, const float z_=0.)

Public Functions Documentation

function operator+=

inline point & ILLIXR::data_format::point::operator+= (
    const Eigen::Vector3f & other
) 

Addition operator for adding two points

Parameters:

• other the point to add to this one

Returns:

reference to the updated point

---

function operator-=

inline point & ILLIXR::data_format::point::operator-= (
    const Eigen::Vector3f & other
) 

Subtraction operator for adding two points

Parameters:

• other the point to subtract from this one

Returns:

reference to the updated point

---

function operator=

inline point & ILLIXR::data_format::point::operator= (
    const Eigen::Vector3f & other
) 

Assignment operator

Parameters:

• other The point to copy

Returns:

A reference to the updated point

---

function operator=

template<typename T, typename U, int Option>
inline point & ILLIXR::data_format::point::operator= (
    const Eigen::Product< T, U, Option > & pr
) 

Assignment operator when dealing with multiplication products

Template parameters:

• T the type of the left hand side expression
• U the type of the right hand side expression
• Option

Parameters:

• pr the multiplication product

Returns:

a reference to the updated point

---

function point [1/2]

inline ILLIXR::data_format::point::point () 

---

function point [2/2]

inline ILLIXR::data_format::point::point (
    const float x,
    const float y,
    const float z=0.
) 

Initial point based on the given x, y, and z coordinates

Parameters:

• x The x coordinate in arbitrary units
• y The y coordinate in arbitrary units
• z The z coordinate in arbitrary units, default is 0, indicating a point in 2-D space

---

function set

inline void ILLIXR::data_format::point::set (
    const float x_,
    const float y_,
    const float z_=0.
) 

Set the coordinates based on the given x, y, and z coordinates

Parameters:

• x The x coordinate in arbitrary units
• y The y coordinate in arbitrary units
• z The z coordinate in arbitrary units, default is 0, indicating a point in 2-D space

---

---

The documentation for this class was generated from the following file /home/friedel/devel/ILLIXR-clean/include/illixr/data_format/point.hpp