Collaboration diagram for nlgeometry::SectionQuad:

Public Member Functions
NLGEOMETRY_API	SectionQuad (OrbitalVertexPtr vertex0_, OrbitalVertexPtr vertex1_, OrbitalVertexPtr vertex2_, OrbitalVertexPtr vertex3_)
	Constructor. More...

virtual NLGEOMETRY_API	~SectionQuad (void)
	Default destructor.

NLGEOMETRY_API OrbitalVertexPtr &	vertex0 (void)
	Method that return the first section quad vertex. More...

NLGEOMETRY_API const OrbitalVertexPtr &	vertex0 (void) const

NLGEOMETRY_API OrbitalVertexPtr &	vertex1 (void)
	Method that return the second section quad vertex. More...

NLGEOMETRY_API const OrbitalVertexPtr &	vertex1 (void) const

NLGEOMETRY_API OrbitalVertexPtr &	vertex2 (void)
	Method that return the third section quad vertex. More...

NLGEOMETRY_API const OrbitalVertexPtr &	vertex2 (void) const

NLGEOMETRY_API OrbitalVertexPtr &	vertex3 (void)
	Method that return the fourth section quad vertex. More...

NLGEOMETRY_API const OrbitalVertexPtr &	vertex3 (void) const

NLGEOMETRY_API void	inverse (void)
	Method that inverse the section quad.

NLGEOMETRY_API SectionQuadPtr	inversed (void) const
	Method return a pointer to a inversed section quad. More...

virtual NLGEOMETRY_API void	displace (const Eigen::Vector3f &displacement_)
	Method that displace the section quad. More...

virtual NLGEOMETRY_API void	place (const Eigen::Vector3f &placement_)
	Method that place the section quad. More...

virtual NLGEOMETRY_API void	rotate (const Eigen::Matrix3f &rotation_)
	Method to rotate the section quad. More...

virtual NLGEOMETRY_API void	rotate (const Eigen::Quaternion< float > &rotation_)
	Method to rotate the section quad. More...

virtual NLGEOMETRY_API void	orient (const Eigen::Vector3f &orientation_)
	Method to orient the section quad. More...

NLGEOMETRY_API Eigen::Vector3f	axis0 (void) const
	Method that return the 0 section quad axis. More...

NLGEOMETRY_API Eigen::Vector3f	axis1 (void) const
	Method that return the 1 section quad axis. More...

virtual NLGEOMETRY_API void	norm (float norm_)
	Method to change the modulus of the section quad vertices. More...

virtual NLGEOMETRY_API void	normalize (void)
	Method to normalize the section quad vertices.

NLGEOMETRY_API Eigen::Vector3f	normal (void) const
	Method that return the section quad normal. More...

NLGEOMETRY_API SectionQuadPtr	clone (void) const
	Method that return a cloned section quad. More...

NLGEOMETRY_API void	deleteVertices (void)
	Method that delete the section quad vertices.

NLGEOMETRY_API Eigen::Quaternion< float >	getZRotation (SectionQuadPtr otherQuad_)
	Method that returns a quaternion with the minimum z rotation between this and the given section quads. More...

NLGEOMETRY_API float	getZAngle (SectionQuadPtr otherQuad_)
	Method that returns the minimum z rotation between this and the given section quads. More...

Static Public Member Functions
static NLGEOMETRY_API SectionQuadPtr	identity (void)
	Static method that return a identity section quad. More...

static NLGEOMETRY_API void	createPipe (SectionQuadPtr startQuad_, SectionQuadPtr endQuad_, Facets &facets_, bool checkDirection_=false)
	Static method that added facets to the referenced facets vector forming a pipe. More...

static NLGEOMETRY_API Eigen::Quaternion< float >	getZRotation (SectionQuadPtr quad0_, SectionQuadPtr quad1_)
	Static method that returns a quaternion with the minimum z rotation between two section quads. More...

static NLGEOMETRY_API float	getZAngle (SectionQuadPtr quad0_, SectionQuadPtr quad1_)
	Static method that returns the minimum z rotation between two section quads. More...

Protected Attributes
OrbitalVertexPtr	_vertex0
	First section quad vertex.

OrbitalVertexPtr	_vertex1
	Second section quad vertex.

OrbitalVertexPtr	_vertex2
	Third section quad vertex.

OrbitalVertexPtr	_vertex3
	Fourth section quad vertex.

Detailed Description

Definition at line 37 of file SectionQuad.h.

Constructor & Destructor Documentation

NLGEOMETRY_API nlgeometry::SectionQuad::SectionQuad	(	OrbitalVertexPtr	vertex0_,
		OrbitalVertexPtr	vertex1_,
		OrbitalVertexPtr	vertex2_,
		OrbitalVertexPtr	vertex3_
	)

Constructor.

Parameters

vertex0_	first vertex of the section quad
vertex1_	second vertex of the section quad
vertex2_	third vertex of the section quad
vertex3_	fourth vertex of the section quad

Member Function Documentation

NLGEOMETRY_API Eigen::Vector3f nlgeometry::SectionQuad::axis0 ( void ) const

Method that return the 0 section quad axis.

Returns: the 0 section quad axis

NLGEOMETRY_API Eigen::Vector3f nlgeometry::SectionQuad::axis1 ( void ) const

Method that return the 1 section quad axis.

Returns: the 1 section quad axis

NLGEOMETRY_API SectionQuadPtr nlgeometry::SectionQuad::clone ( void ) const

Method that return a cloned section quad.

Returns: a cloned section quad

static NLGEOMETRY_API void nlgeometry::SectionQuad::createPipe	(	SectionQuadPtr	startQuad_,
		SectionQuadPtr	endQuad_,
		Facets &	facets_,
		bool	checkDirection_ = `false`
	)

static

Static method that added facets to the referenced facets vector forming a pipe.

Parameters

startQuad_	start pipe section quad
endQuad_	end pipe section quad

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

virtual

Method that displace the section quad.

Parameters

displacement_ vector to displace the section quad

NLGEOMETRY_API float nlgeometry::SectionQuad::getZAngle ( SectionQuadPtr otherQuad_ )

Method that returns the minimum z rotation between this and the given section quads.

Parameters

otherQuad_ first section quad

Returns: the minimum z rotation between this and the given section quads

static NLGEOMETRY_API float nlgeometry::SectionQuad::getZAngle	(	SectionQuadPtr	quad0_,
		SectionQuadPtr	quad1_
	)

static

Static method that returns the minimum z rotation between two section quads.

Parameters

quad0_	first section quad
quad1_	second section quad

Returns: the minimum z rotation between the to given section quads

NLGEOMETRY_API Eigen::Quaternion< float > nlgeometry::SectionQuad::getZRotation ( SectionQuadPtr otherQuad_ )

Method that returns a quaternion with the minimum z rotation between this and the given section quads.

Parameters

otherQuad_ first section quad

Returns: a quaterion with the minimum z rotation between this and the given section quads

static NLGEOMETRY_API Eigen::Quaternion< float > nlgeometry::SectionQuad::getZRotation	(	SectionQuadPtr	quad0_,
		SectionQuadPtr	quad1_
	)

static

Static method that returns a quaternion with the minimum z rotation between two section quads.

Parameters

quad0_	first section quad
quad1_	second section quad

Returns: a quaterion with the minimum z rotation between the to given section quads

static NLGEOMETRY_API SectionQuadPtr nlgeometry::SectionQuad::identity ( void )

static

Static method that return a identity section quad.

Returns: a identity section quad

NLGEOMETRY_API SectionQuadPtr nlgeometry::SectionQuad::inversed ( void ) const

Method return a pointer to a inversed section quad.

Returns: a pointer to a inversed section quad

virtual NLGEOMETRY_API void nlgeometry::SectionQuad::norm ( float norm_ )

virtual

Method to change the modulus of the section quad vertices.

Parameters

norm_ new section quad vertices position vector modulus

NLGEOMETRY_API Eigen::Vector3f nlgeometry::SectionQuad::normal ( void ) const

Method that return the section quad normal.

Returns: the section quad normal

virtual NLGEOMETRY_API void nlgeometry::SectionQuad::orient ( const Eigen::Vector3f & orientation_ )

virtual

Method to orient the section quad.

Parameters

orientation_ to be applied to the section quad

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

virtual

Method that place the section quad.

Parameters

placement_ vector to place the section quad

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

virtual

Method to rotate the section quad.

Parameters

rotation_ matrix with the rotation to be applied

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

virtual

Method to rotate the section quad.

Parameters

rotation_ quad with the rotation to be applied

NLGEOMETRY_API OrbitalVertexPtr& nlgeometry::SectionQuad::vertex0 ( void )

Method that return the first section quad vertex.

Returns: the first section quad vertex

NLGEOMETRY_API OrbitalVertexPtr& nlgeometry::SectionQuad::vertex1 ( void )

Method that return the second section quad vertex.

Returns: the second section quad vertex

NLGEOMETRY_API OrbitalVertexPtr& nlgeometry::SectionQuad::vertex2 ( void )

Method that return the third section quad vertex.

Returns: the third section quad vertex

NLGEOMETRY_API OrbitalVertexPtr& nlgeometry::SectionQuad::vertex3 ( void )

Method that return the fourth section quad vertex.

Returns: the fourth section quad vertex

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

SectionQuad.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation