usOrientedPlane3D Class Reference

#include <visp3/ustk_core/usOrientedPlane3D.h>

Inheritance diagram for usOrientedPlane3D:

Public Member Functions
	usOrientedPlane3D ()
	usOrientedPlane3D (const usOrientedPlane3D &plane)
	usOrientedPlane3D (const vpPoseVector &pose)
	usOrientedPlane3D (const vpColVector &p, const vpColVector &d)
virtual	~usOrientedPlane3D ()
const usOrientedPlane3D &	operator= (const usOrientedPlane3D &plane)
void	setPose (const vpPoseVector &pose)
vpPoseVector	getPose () const
void	setPosition (const vpColVector &P)
vpColVector	getPosition () const
void	setDirection (const vpColVector &D)
vpColVector	getDirection () const
void	moveInLocalFrame (const vpHomogeneousMatrix &H)
void	moveInLocalFrame (double x, double y, double z, double tx, double ty, double tz)
void	moveInWorldFrame (const vpHomogeneousMatrix &H)
void	moveInWorldFrame (double x, double y, double z, double tx, double ty, double tz)

Protected Attributes
vpColVector	m_direction
vpPoseVector	m_pose

Friends
VISP_EXPORT std::ostream &	operator<< (std::ostream &s, const usOrientedPlane3D &plane)
VISP_EXPORT std::istream &	operator>> (std::istream &s, usOrientedPlane3D &plane)
VISP_EXPORT std::ostream &	operator<<= (std::ostream &s, const usOrientedPlane3D &plane)
VISP_EXPORT std::istream &	operator>>= (std::istream &s, usOrientedPlane3D &plane)

Detailed Description

Examples

testUsGeometryDisplayTools.cpp, testUsNeedleInsertionModelKinematic.cpp, and testUsOrientedPlane3D.cpp.

Definition at line 42 of file usOrientedPlane3D.h.

Constructor & Destructor Documentation

usOrientedPlane3D() [1/4]

usOrientedPlane3D::usOrientedPlane3D

(

)

Constructors, destructor.

Definition at line 39 of file usOrientedPlane3D.cpp.

usOrientedPlane3D() [2/4]

usOrientedPlane3D::usOrientedPlane3D

(

const usOrientedPlane3D &

plane

)

Definition at line 41 of file usOrientedPlane3D.cpp.

usOrientedPlane3D() [3/4]

usOrientedPlane3D::usOrientedPlane3D

(

const vpPoseVector &

pose

)

Definition at line 46 of file usOrientedPlane3D.cpp.

usOrientedPlane3D() [4/4]

usOrientedPlane3D::usOrientedPlane3D	(	const vpColVector &	p,
		const vpColVector &	d
	)

Definition at line 48 of file usOrientedPlane3D.cpp.

References setDirection(), and setPosition().

~usOrientedPlane3D()

usOrientedPlane3D::~usOrientedPlane3D ( )

virtual

Definition at line 54 of file usOrientedPlane3D.cpp.

Member Function Documentation

getDirection()

vpColVector usOrientedPlane3D::getDirection

(

)

const

Examples

testUsOrientedPlane3D.cpp.

Definition at line 116 of file usOrientedPlane3D.cpp.

References m_direction.

Referenced by usNeedleInsertionModelVirtualSprings::addInsertionPoint(), usNeedleInsertionModelVirtualSprings::addMeasureSpring(), usNeedleInsertionModelVirtualSprings::addRemoveSprings(), usTissueTranslationEstimatorUKF::computeProcessNoiseCovarianceMatrix(), usGeometryDisplayTools::display(), usNeedleModelingDisplayTools::displayTissueLayers(), usGeometryTools::getPointPlaneDistance(), usGeometryTools::projectPointOnPlane(), usNeedleInsertionModelRayleighRitzSpline::setBasePose(), usNeedleInsertionModelRayleighRitzSpline::solveSegmentsParametersDense(), usNeedleInsertionModelRayleighRitzSpline::solveSegmentsParametersFullSparseEigen(), usNeedleInsertionModelRayleighRitzSpline::solveSegmentsParametersFullSparseEigenFixedLength(), and usNeedleInsertionModelRayleighRitzSpline::solveSegmentsParametersSparseEigen().

getPose()

vpPoseVector usOrientedPlane3D::getPose

(

)

const

Examples

testUsOrientedPlane3D.cpp.

Definition at line 70 of file usOrientedPlane3D.cpp.

References m_pose.

Referenced by usTissueTranslationEstimatorUKF::applyStateToNeedle(), usTissueModelPolynomial::getPose(), and usTissueModelSpline::getPose().

getPosition()

vpColVector usOrientedPlane3D::getPosition

(

)

const

Examples

testUsOrientedPlane3D.cpp.

Definition at line 80 of file usOrientedPlane3D.cpp.

References m_pose.

Referenced by usGeometryDisplayTools::display(), usNeedleModelingDisplayTools::displayTissueLayers(), usGeometryTools::getPointPlaneDistance(), and usGeometryTools::projectPointOnPlane().

moveInLocalFrame() [1/2]

void usOrientedPlane3D::moveInLocalFrame

(

const vpHomogeneousMatrix &

H

)

Examples

testUsOrientedPlane3D.cpp.

Definition at line 118 of file usOrientedPlane3D.cpp.

References m_pose, and setPose().

Referenced by moveInLocalFrame().

moveInLocalFrame() [2/2]

void usOrientedPlane3D::moveInLocalFrame	(	double	x,
		double	y,
		double	z,
		double	tx,
		double	ty,
		double	tz
	)

Definition at line 123 of file usOrientedPlane3D.cpp.

References moveInLocalFrame().

moveInWorldFrame() [1/2]

void usOrientedPlane3D::moveInWorldFrame

(

const vpHomogeneousMatrix &

H

)

Examples

testUsOrientedPlane3D.cpp.

Definition at line 128 of file usOrientedPlane3D.cpp.

References m_pose, and setPose().

Referenced by usTissueModelPolynomial::move(), usTissueModelSpline::move(), usTissueModelPolynomial::moveInWorldFrame(), usTissueModelSpline::moveInWorldFrame(), moveInWorldFrame(), usTissueModelPolynomial::setPose(), and usTissueModelSpline::setPose().

moveInWorldFrame() [2/2]

void usOrientedPlane3D::moveInWorldFrame	(	double	x,
		double	y,
		double	z,
		double	tx,
		double	ty,
		double	tz
	)

Definition at line 133 of file usOrientedPlane3D.cpp.

References moveInWorldFrame().

operator=()

const usOrientedPlane3D & usOrientedPlane3D::operator=

(

const usOrientedPlane3D &

plane

)

Definition at line 56 of file usOrientedPlane3D.cpp.

References m_direction, and m_pose.

Referenced by usVirtualSpring::operator=().

setDirection()

void usOrientedPlane3D::setDirection

(

const vpColVector &

D

)

Examples

testUsNeedleInsertionModelRayleighRitzSpline.cpp, and testUsOrientedPlane3D.cpp.

Definition at line 90 of file usOrientedPlane3D.cpp.

References m_direction, and m_pose.

Referenced by usNeedleInsertionModelVirtualSprings::addInsertionPoint(), usNeedleInsertionModelVirtualSprings::setSurfaceAtTip(), and usOrientedPlane3D().

setPose()

void usOrientedPlane3D::setPose

(

const vpPoseVector &

pose

)

Parameters setters and getters.

Examples

testUsOrientedPlane3D.cpp.

Definition at line 64 of file usOrientedPlane3D.cpp.

References m_direction, and m_pose.

Referenced by moveInLocalFrame(), moveInWorldFrame(), and usNeedleInsertionModelRayleighRitzSpline::setSurfaceAtTip().

setPosition()

void usOrientedPlane3D::setPosition

(

const vpColVector &

P

)

Examples

testUsNeedleInsertionModelRayleighRitzSpline.cpp, and testUsOrientedPlane3D.cpp.

Definition at line 72 of file usOrientedPlane3D.cpp.

References m_pose.

Referenced by usNeedleInsertionModelVirtualSprings::setSurfaceAtTip(), usNeedleInsertionModelRayleighRitzSpline::updateState(), and usOrientedPlane3D().

Friends And Related Function Documentation

operator<<

VISP_EXPORT std::ostream& operator<< ( std::ostream &  s, const usOrientedPlane3D &  plane  )

friend

Data saving.

Text

Definition at line 138 of file usOrientedPlane3D.cpp.

operator<<=

VISP_EXPORT std::ostream& operator<<= ( std::ostream &  s, const usOrientedPlane3D &  plane  )

friend

Binary.

Definition at line 166 of file usOrientedPlane3D.cpp.

operator>>

VISP_EXPORT std::istream& operator>> ( std::istream &  s, usOrientedPlane3D &  plane  )

friend

Definition at line 149 of file usOrientedPlane3D.cpp.

operator>>=

VISP_EXPORT std::istream& operator>>= ( std::istream &  s, usOrientedPlane3D &  plane  )

friend

Definition at line 175 of file usOrientedPlane3D.cpp.

Member Data Documentation

m_direction

vpColVector usOrientedPlane3D::m_direction

protected

Definition at line 45 of file usOrientedPlane3D.h.

Referenced by getDirection(), operator=(), setDirection(), and setPose().

m_pose

vpPoseVector usOrientedPlane3D::m_pose

protected

Definition at line 46 of file usOrientedPlane3D.h.

Referenced by getPose(), getPosition(), moveInLocalFrame(), moveInWorldFrame(), operator=(), setDirection(), setPose(), and setPosition().