GridTopology Class Reference

Create a 3D grid mesh. More...

#include <GridTopology.h>

Inheritance diagram for GridTopology:

Public Member Functions
	GridTopology (ActionExtension *)
	the constructor
virtual	~GridTopology ()
	the destructor
Public Member Functions inherited from camitk::Action
	Action (ActionExtension *)
	Default Constructor: the ActionExtension is needed.
bool	getAutoUpdateProperties () const
	auto update properties
void	setAutoUpdateProperties (bool)
	are the properties to be udpated every time the user makes a change in the widget (default is false)?
virtual	~Action ()
	Destructor.
QAction *	getQAction ()
	Get the corresponding QAction.
QString	getName () const
	the name of the component class that can be used by this action
QString	getDescription () const
	the description of the action
QString	getComponent () const
	the name of the component class that can be used by this action
QString	getFamily () const
	the name of the family in which this action is associated
QString	getExtensionName () const
	the name of the extension in the family in which this action is associated
QStringList	getTag () const
	the name of the tag called this action
bool	getEmbedded () const
	argument use to know if the widget is embedded or not
virtual QWidget *	getWidget ()
	This method has to be redefined in your Action only if:
virtual QPixmap	getIcon ()
	the icon to personalize the action (no icon by default)
const ComponentList	getTargets () const
	the currently selected and valid (regarding the component property) components, for which this action is called
virtual ApplyStatus	applyInPipeline ()
	This method encapsulates the apply() method.
virtual void	setInputComponents (ComponentList inputs)
	Specify the input Component(s) Only applyInPipeline() should be called with this method (maybe apply), but not trigger() as its first intruction is to clear the target components list !!!
virtual void	setInputComponent (Component *input)
	Specify the input Components in case of only one Component.
virtual ComponentList	getOutputComponents ()
	Returns the output Component(s)
virtual Component *	getOutputComponent ()
	Returns the output Components in case of only one Component.

Private Member Functions
virtual ApplyStatus	apply ()
	method called when the action is applied
void	buildGrid (vtkSmartPointer< vtkUnstructuredGrid > grid)
void	buildNetwork (vtkSmartPointer< vtkUnstructuredGrid > grid)

Additional Inherited Members
Public Types inherited from camitk::Action
enum	ApplyStatus {   SUCCESS, ERROR, WARNING, ABORTED,   TRIGGERED }
	describes what happened during the application of an algorithm (i.e. results of the apply method) More...
Public Slots inherited from camitk::Action
virtual ApplyStatus	apply ()=0
	This method is called when the action has to be applied on the target list (get the target lists using getTargets())
ApplyStatus	trigger (QWidget *parent=NULL)
	This method triggers the action.
Protected Member Functions inherited from camitk::Action
void	setName (QString name)
void	setDescription (QString description)
	the description of the action
void	setComponent (QString component)
	the name of the component class that can be used by this action
void	setFamily (QString family)
	the name of the family in which this action is associated
void	addTag (QString tag)
	add a tag to the tags list of this action
void	setEmbedded (bool isEmbedded)
	set the embedded property (an action is embedded by default, unless specified otherwise by explicitly calling this method with false)
void	setIcon (QPixmap)
	set the Pixmap
virtual void	preProcess ()
virtual void	postProcess ()
	Set the right output component list so that the method getOutputComponents() can be called TODO: save the Action History.
Protected Attributes inherited from camitk::Action
QWidget *	actionWidget
	the action widget

Detailed Description

Create a 3D grid mesh.

Constructor & Destructor Documentation

GridTopology::GridTopology

(

ActionExtension *

extension

)

the constructor

References camitk::Action::addTag(), camitk::Action::setComponent(), camitk::Action::setDescription(), camitk::Action::setFamily(), and camitk::Action::setName().

GridTopology::~GridTopology ( )

virtual

the destructor

Member Function Documentation

Action::ApplyStatus GridTopology::apply ( )

privatevirtual

method called when the action is applied

References buildGrid(), buildNetwork(), and camitk::Action::SUCCESS.

void GridTopology::buildGrid ( vtkSmartPointer< vtkUnstructuredGrid >  grid )

private

Referenced by apply().

void GridTopology::buildNetwork ( vtkSmartPointer< vtkUnstructuredGrid >  grid )

private

Referenced by apply().

---

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

• GridTopology.h
• GridTopology.cpp