camitk::PlaneC Class Reference

This class allows you to transform a plane(translation,rotation around an axis) and visualize it. More...

#include <PlaneC.h>

Public Types
enum	PlaneCType {   X_MIN, Y_MIN, Z_MIN, X_MAX,   Y_MAX, Z_MAX, UNDEFINED }
	a planeC could represent a plane of a bounding box More...

Public Member Functions
void	clear ()
	Delete the plane from the View. More...
vtkSmartPointer< vtkActor >	getActor ()
	get the actor of the plane More...
void	getNormal (double tab[3])
	get the normal of the plane More...
void	getOrigin (double tab[3])
	get the origin of the plane More...
void	getTransformationInPercent (double *, double *, double *)
	get the transformation (translation, rot1 and rot2) in percentage More...
void	init (PlaneCType type, double bounds[6])
	Initialize the plane at a particular place of a bounding box. More...
	PlaneC ()
	Constructor by default. More...
void	rotationAxe1 ()
	Rotate the plane around Axe1. More...
void	rotationAxe2 ()
	Rotate the plane around Axe2. More...
void	setOrigin (double, double, double)
	Initilize the origin of the plane. More...
void	setTransfoPercentToRealValue (double tab[3], double, double)
	set the transformation (translation, rot1 and rot2)and convert percentage to real value More...
void	setTranslationMaxInPercent (double)
	set the translation value of the plane max to 100% More...
void	setVisuActivePlane ()
	Visualization of the plane in red tone. More...
void	setVisuActivePlaneOff ()
	Visualization of the plane in blue tone. More...
void	setVisuPlane ()
	Visualization of the plane in wireframe. More...
void	setXAxisPoint (double, double, double)
	The local x-axis vector will be set to (PointX - Origin) . More...
void	setYAxisPoint (double, double, double)
	The local y-axis vector will be set to (PointY - Origin) . More...
void	translatePlaneX ()
	Translate the plane on XAxis. More...
void	translatePlaneY ()
	Translate the plane on YAxis. More...
void	translatePlaneZ ()
	Translate the plane on ZAxis. More...
	~PlaneC ()
	Destructor. More...

Private Attributes
double	angle1
	difference between current and initial position More...
double	angle2
vtkSmartPointer< vtkProperty >	aProp
vtkSmartPointer< vtkPlaneSource >	plane
vtkSmartPointer< vtkActor >	planeActor
vtkSmartPointer < vtkPolyDataMapper >	planeMapper
double	transfor [3]
	store the transformation More...
double	translat
	store the translation in percentage More...
double	translation1

Detailed Description

This class allows you to transform a plane(translation,rotation around an axis) and visualize it.

This is a pure vtk wrapper class (no Core stuff).

Member Enumeration Documentation

enum camitk::PlaneC::PlaneCType

a planeC could represent a plane of a bounding box

Enumerator
X_MIN	the plane's normal is in X direction, the plane is at the min x
Y_MIN	the plane's normal is in Y direction, the plane is at the min y
Z_MIN	the plane's normal is in Z direction, the plane is at the min z
X_MAX	the plane's normal is in X direction, the plane is at the max x
Y_MAX	the plane's normal is in Y direction, the plane is at the max y
Z_MAX	the plane's normal is in Z direction, the plane is at the max z
UNDEFINED	the plane's normal is not defined yet

Constructor & Destructor Documentation

camitk::PlaneC::PlaneC

(

)

Constructor by default.

camitk::PlaneC::~PlaneC

(

)

Destructor.

Member Function Documentation

void camitk::PlaneC::clear

(

)

Delete the plane from the View.

vtkSmartPointer<vtkActor> camitk::PlaneC::getActor

(

)

get the actor of the plane

void camitk::PlaneC::getNormal

(

double

tab[3]

)

get the normal of the plane

void camitk::PlaneC::getOrigin

(

double

tab[3]

)

get the origin of the plane

void camitk::PlaneC::getTransformationInPercent	(	double *	,
		double *	,
		double *
	)

get the transformation (translation, rot1 and rot2) in percentage

void camitk::PlaneC::init	(	PlaneCType	type,
		double	bounds[6]
	)

Initialize the plane at a particular place of a bounding box.

Parameters

type	the type of the plane (see enum PlaneCType)
bounds	an array of 6 doubles representing the bounding box (the six values have to be put in the correct order : xmin, ymin, zmin, xmax, ymax, zmax)

void camitk::PlaneC::rotationAxe1

(

)

Rotate the plane around Axe1.

void camitk::PlaneC::rotationAxe2

(

)

Rotate the plane around Axe2.

void camitk::PlaneC::setOrigin	(	double	,
		double	,
		double
	)

Initilize the origin of the plane.

void camitk::PlaneC::setTransfoPercentToRealValue	(	double	tab[3],
		double	,
		double
	)

set the transformation (translation, rot1 and rot2)and convert percentage to real value

void camitk::PlaneC::setTranslationMaxInPercent

(

double

)

set the translation value of the plane max to 100%

void camitk::PlaneC::setVisuActivePlane

(

)

Visualization of the plane in red tone.

void camitk::PlaneC::setVisuActivePlaneOff

(

)

Visualization of the plane in blue tone.

void camitk::PlaneC::setVisuPlane

(

)

Visualization of the plane in wireframe.

void camitk::PlaneC::setXAxisPoint	(	double	,
		double	,
		double
	)

The local x-axis vector will be set to (PointX - Origin) .

The normal of the plane is defined by the cross product (x-axis, y-axis)

void camitk::PlaneC::setYAxisPoint	(	double	,
		double	,
		double
	)

The local y-axis vector will be set to (PointY - Origin) .

The normal of the plane is defined by the cross product (x-axis, y-axis)

void camitk::PlaneC::translatePlaneX

(

)

Translate the plane on XAxis.

void camitk::PlaneC::translatePlaneY

(

)

Translate the plane on YAxis.

void camitk::PlaneC::translatePlaneZ

(

)

Translate the plane on ZAxis.

Member Data Documentation

double camitk::PlaneC::angle1

private

difference between current and initial position

double camitk::PlaneC::angle2

private

vtkSmartPointer<vtkProperty> camitk::PlaneC::aProp

private

vtkSmartPointer<vtkPlaneSource> camitk::PlaneC::plane

private

vtkSmartPointer<vtkActor> camitk::PlaneC::planeActor

private

vtkSmartPointer<vtkPolyDataMapper> camitk::PlaneC::planeMapper

private

double camitk::PlaneC::transfor[3]

private

store the transformation

double camitk::PlaneC::translat

private

store the translation in percentage

double camitk::PlaneC::translation1

private

---

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

• PlaneC.h