neurolots  0.3.4
NeuroLOTs
nlgeometry::OrbitalVertex Class Reference
+ Inheritance diagram for nlgeometry::OrbitalVertex:
+ Collaboration diagram for nlgeometry::OrbitalVertex:

Public Member Functions

NLGEOMETRY_API OrbitalVertex (const Eigen::Vector3f &position_, const Eigen::Vector3f &center_=Eigen::Vector3f(0.0f, 0.0f, 0.0f), const Eigen::Vector3f &tangent_=Eigen::Vector3f(0.0f, 0.0f, 0.0f), const Eigen::Vector3f &color_=Eigen::Vector3f(0.0f, 0.0f, 0.0f))
 Constructor. More...
 
NLGEOMETRY_API OrbitalVertex (const OrbitalVertex &other_)
 Copy constructor. More...
 
virtual NLGEOMETRY_API ~OrbitalVertex ()
 Default constructor.
 
NLGEOMETRY_API Eigen::Vector3f & center (void)
 Method that returns the orbital vertex center.
 
NLGEOMETRY_API const Eigen::Vector3f & center (void) const
 
NLGEOMETRY_API Eigen::Vector3f & tangent (void)
 Method that returns the orbital vertex tangent.
 
NLGEOMETRY_API const Eigen::Vector3f & tangent (void) const
 
virtual NLGEOMETRY_API void displace (const Eigen::Vector3f &displacement_)
 Method to displace the orbital vertex position. More...
 
virtual NLGEOMETRY_API void place (const Eigen::Vector3f &placement_)
 Method to place the orbital vertex position. More...
 
virtual NLGEOMETRY_API void rotate (const Eigen::Matrix3f &rotation_)
 Method to rotate the orbital vertex position and normal. More...
 
virtual NLGEOMETRY_API void rotate (const Eigen::Quaternion< float > &rotation_)
 Method to rotate the orbital vertex position and normal. More...
 
virtual NLGEOMETRY_API void norm (const float norm_)
 Method to change the modulus of the position vector. More...
 
virtual NLGEOMETRY_API void normalize (const Eigen::Vector3f &axis_)
 
virtual NLGEOMETRY_API void store (std::vector< float > &buffer_, const TAttribType attribType_)
 
NLGEOMETRY_API VertexPtr clone (void)
 Method that return a cloned orbtial vertex. More...
 
- Public Member Functions inherited from nlgeometry::Vertex
NLGEOMETRY_API Vertex (const Eigen::Vector3f &position_, const Eigen::Vector3f &normal_=Eigen::Vector3f(0.0f, 0.0f, 0.0f), const Eigen::Vector3f &color_=Eigen::Vector3f(0.0f, 0.0f, 0.0f), const Eigen::Vector2f &uv_=Eigen::Vector2f(0.0f, 0.0f))
 Constructor. More...
 
NLGEOMETRY_API Vertex (const Vertex &other_)
 Copy constructor. More...
 
virtual NLGEOMETRY_API ~Vertex (void)
 Default destructor.
 
NLGEOMETRY_API const unsigned int & id (void) const
 Method to get the vertex id. More...
 
NLGEOMETRY_API Eigen::Vector3f & position (void)
 Method to get the vertex position. More...
 
NLGEOMETRY_API const Eigen::Vector3f & position (void) const
 
NLGEOMETRY_API Eigen::Vector3f & normal (void)
 Method to get the vertex normal. More...
 
NLGEOMETRY_API const Eigen::Vector3f & normal (void) const
 
NLGEOMETRY_API Eigen::Vector3f & color (void)
 Method to get the vertex color. More...
 
NLGEOMETRY_API const Eigen::Vector3f & color (void) const
 
NLGEOMETRY_API Eigen::Vector2f & uv (void)
 Method to get the vertex uv coordinates. More...
 
NLGEOMETRY_API const Eigen::Vector2f & uv (void) const
 
NLGEOMETRY_API void store (Attribs &attribs_, const AttribsFormat format_)
 Method that store the vertex attribs (position, normal, color, uv coordinates) and assigns the vertex id. More...
 

Protected Attributes

Eigen::Vector3f _center
 Orbital Vertex center.
 
Eigen::Vector3f _tangent
 Orbital Vertex tangent.
 
- Protected Attributes inherited from nlgeometry::Vertex
unsigned int _id
 Vertex id.
 
Eigen::Vector3f _position
 Vertex position.
 
Eigen::Vector3f _normal
 Vertex normal.
 
Eigen::Vector3f _color
 Vertex color.
 
Eigen::Vector2f _uv
 Vertex uv coordinates.
 

Detailed Description

Definition at line 35 of file OrbitalVertex.h.

Constructor & Destructor Documentation

NLGEOMETRY_API nlgeometry::OrbitalVertex::OrbitalVertex ( const Eigen::Vector3f &  position_,
const Eigen::Vector3f &  center_ = Eigen::Vector3f(0.0f, 0.0f, 0.0f),
const Eigen::Vector3f &  tangent_ = Eigen::Vector3f(0.0f, 0.0f, 0.0f),
const Eigen::Vector3f &  color_ = Eigen::Vector3f(0.0f, 0.0f, 0.0f) 
)

Constructor.

Parameters
position_vertex position
pivot_vertex pivot
tangent_vertex tanget
color_vertex color
NLGEOMETRY_API nlgeometry::OrbitalVertex::OrbitalVertex ( const OrbitalVertex other_)

Copy constructor.

Parameters
other_vertex to be copied

Member Function Documentation

NLGEOMETRY_API VertexPtr nlgeometry::OrbitalVertex::clone ( void  )
virtual

Method that return a cloned orbtial vertex.

Returns
a cloned orbital vertex from the actual orbital vertex

Reimplemented from nlgeometry::Vertex.

virtual NLGEOMETRY_API void nlgeometry::OrbitalVertex::displace ( const Eigen::Vector3f &  displacement_)
virtual

Method to displace the orbital vertex position.

Parameters
displacement_displacement applied to the orbital vertex position

Reimplemented from nlgeometry::Vertex.

virtual NLGEOMETRY_API void nlgeometry::OrbitalVertex::norm ( const float  norm_)
virtual

Method to change the modulus of the position vector.

Parameters
norm_new position vector modulus

Reimplemented from nlgeometry::Vertex.

virtual NLGEOMETRY_API void nlgeometry::OrbitalVertex::place ( const Eigen::Vector3f &  placement_)
virtual

Method to place the orbital vertex position.

Parameters
placement_placement to place the orbital vertex position

Reimplemented from nlgeometry::Vertex.

virtual NLGEOMETRY_API void nlgeometry::OrbitalVertex::rotate ( const Eigen::Matrix3f &  rotation_)
virtual

Method to rotate the orbital vertex position and normal.

Parameters
rotation_matrix with the rotation to be applied

Reimplemented from nlgeometry::Vertex.

virtual NLGEOMETRY_API void nlgeometry::OrbitalVertex::rotate ( const Eigen::Quaternion< float > &  rotation_)
virtual

Method to rotate the orbital vertex position and normal.

Parameters
rotation_quaternion with the rotation to be applied

Reimplemented from nlgeometry::Vertex.


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