Computer Assited Medical Intervention Tool Kit  version 3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Member Functions | Private Attributes | List of all members
AtomDecoration Class Reference

This class allows you to display a geometric object (arrow, sphere, ...) positionned on an atom. More...

#include <AtomDecoration.h>

+ Inheritance diagram for AtomDecoration:

Public Member Functions

 AtomDecoration (AtomDC *, camitk::GeometricObject::Geometry)
 this constructor set the current atom to follow More...
 
camitk::GeometricObject::Geometry getType () const
 
void setColor (const double, const double, const double)
 change the color of the geometric object More...
 
void setDirection (const double, const double, const double)
 set the direction of the of the object without updating the position More...
 
void setDirection (const double[3])
 set the direction of the object, without updating the position More...
 
void setPosition (const double, const double, const double)
 change the position of the geometric object (even if different from the atom's position) More...
 
void setSize (const double)
 change the size of the geometric object More...
 
void show (const bool)
 show the geometric object in 3D or not depending on the paramater More...
 
void update (const double, const double, const double)
 update the 3D representation More...
 
void update (const double[3])
 update the 3D representation More...
 
void update ()
 update the position of the geometric object (using the atom's position) More...
 
 ~AtomDecoration ()
 
- Public Member Functions inherited from Decoration
 Decoration (camitk::Component *theDC)
 
virtual ~Decoration ()
 virtual destructor More...
 

Private Attributes

AtommyAtom
 
camitk::GeometricObjectmyObject
 

Additional Inherited Members

- Protected Attributes inherited from Decoration
camitk::Componentdc
 the data component where the decoration is attached to More...
 

Detailed Description

This class allows you to display a geometric object (arrow, sphere, ...) positionned on an atom.

For example an arrow can represent a vector associated to the atom (e.g. a force, its velocity...)

Constructor & Destructor Documentation

AtomDecoration::AtomDecoration ( AtomDC ,
camitk::GeometricObject::Geometry   
)

this constructor set the current atom to follow

AtomDecoration::~AtomDecoration ( )

Member Function Documentation

camitk::GeometricObject::Geometry AtomDecoration::getType ( ) const
inline
void AtomDecoration::setColor ( const double  ,
const double  ,
const double   
)
virtual

change the color of the geometric object

Implements Decoration.

void AtomDecoration::setDirection ( const double  ,
const double  ,
const double   
)

set the direction of the of the object without updating the position

void AtomDecoration::setDirection ( const double  [3])

set the direction of the object, without updating the position

void AtomDecoration::setPosition ( const double  ,
const double  ,
const double   
)

change the position of the geometric object (even if different from the atom's position)

void AtomDecoration::setSize ( const double  )

change the size of the geometric object

void AtomDecoration::show ( const bool  )
virtual

show the geometric object in 3D or not depending on the paramater

Implements Decoration.

void AtomDecoration::update ( const double  ,
const double  ,
const double   
)

update the 3D representation

  • if the geometry is an arrow : update position of the geometric object using the atom's position and the three parameters as the new direction
  • if the geometry is a sphere: use the parameters as the new position (do not take into account the position of the atom.
void AtomDecoration::update ( const double  [3])

update the 3D representation

  • if the geometry is an arrow : update position of the geometric object using the atom's position and and the new vector given in parameter as the new direction
  • if the geometry is a sphere: use the parameters as the new position (do not take into account the position of the atom.
void AtomDecoration::update ( )
virtual

update the position of the geometric object (using the atom's position)

Implements Decoration.

Member Data Documentation

Atom* AtomDecoration::myAtom
private
camitk::GeometricObject* AtomDecoration::myObject
private

Referenced by getType().


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