Developer documentation | Axl-2.5.1

axlDataDynamic Class Reference

Class axlDataDynamic defines a dynamic object. More...

#include <axlDataDynamic.h>

Inheritance diagram for axlDataDynamic:
axlAbstractDataComposite axlAbstractData

Public Types

enum  Type { Dynamic = 0x001, Static = 0x002 }
 

Public Slots

void setInput (dtkAbstractData *data, int channel=0)
 Add input;. More...
 
void setParameter (int parameter)
 Set parameter. More...
 
void setParameter (int parameter, int channel)
 Set parameter. More...
 
void setParameter (double parameter)
 Set parameter. More...
 
void setParameter (double parameter, int channel)
 Set parameter. More...
 
int setProcess (QString processName)
 Create the dynamic object process only with the name of its latter. More...
 
void setProcess (axlAbstractProcess *process)
 Create the dynamic object process by copying the current state of a process. More...
 
int numberOfUpdate (void)
 Return how many times the geometry of the dynamic object has been updated. More...
 
virtual void update (void)
 Update the dynamic object. More...
 
void onRemoved (void)
 This slot is called whenever one of the dynamic object input is deleted. More...
 
- Public Slots inherited from axlAbstractData
void touchGeometry (void)
 
void touchProperty (void)
 
void touchStructure (void)
 
virtual void touchField (void)
 
void setColor (const QColor &color)
 
void setOpacity (const double &opacity)
 
void setSize (const double &size)
 
void setShader (const QString &shader)
 
void setEditable (bool edit)
 

Signals

void dataInserted (axlAbstractData *data)
 
- Signals inherited from axlAbstractDataComposite
void updated (void)
 
void samplingChanged ()
 
- Signals inherited from axlAbstractData
void modifiedGeometry (void)
 
void modifiedStructure (void)
 
void modifiedField (void)
 
void modifiedProperty (void)
 

Public Member Functions

 axlDataDynamic (void)
 
virtual ~axlDataDynamic (void)
 
axlDataDynamic::Type getType (void)
 Return the type : dynamic if it is a dynamic object or static if it is just a computation node. More...
 
void setType (axlDataDynamic::Type type)
 Sets the type of the object. Type could be dynamic or static. More...
 
QList< axlAbstractData * > inputs (void)
 Return input list;. More...
 
QList< axlAbstractData * > parameters (void)
 
axlAbstractProcessprocess (void)
 Return the process. More...
 
axlAbstractDataoutputs (void)
 Return the first output of the list. More...
 
axlAbstractDataoutputs (int channel)
 Return the channel-th output of the list. More...
 
void clearInputs (void)
 Clear input list. More...
 
bool isNotInputProcess (dtkAbstractData *data)
 Check whether the output of the process is a different object that one of its inputs. More...
 
bool isNotOutputProcess (dtkAbstractData *data)
 Check whether the data is an output of the process. More...
 
QVariantList convertDataToQVariant (void) const
 
int convertQVariantToData (const QVariantList &data)
 
virtual QString description (void) const
 Return a description of the dynamic object. More...
 
virtual QString identifier (void) const
 Return the identifier "axlDataDynamic". More...
 
virtual int numberOfChannels (void)
 Return the number of output(s);. More...
 
- Public Member Functions inherited from axlAbstractDataComposite
 axlAbstractDataComposite (void)
 
virtual ~axlAbstractDataComposite (void)
 
void add (dtkAbstractData *data)
 
bool get (dtkAbstractData *data)
 
void set (QList< dtkAbstractData * > data)
 
void remove (dtkAbstractData *data)
 
int count (void)
 
dtkAbstractData * get (int i)
 
- Public Member Functions inherited from axlAbstractData
 axlAbstractData (axlAbstractData *parent=NULL)
 
 axlAbstractData (const axlAbstractData &data)
 
virtual ~axlAbstractData (void)
 
const QColor & color (void) const
 
const double & opacity (void) const
 
const double & size (void) const
 
const QString & shader (void) const
 
const bool & editable (void)
 
const bool & updateView (void)
 
void setColor (double r, double g, double b)
 
void addField (axlAbstractField *field)
 Add a field to the field list of the object. More...
 
bool updateFieldList (QString nameField)
 Check if a field with the same name is already applied on the object. More...
 
QString changeFieldName (QString fieldName)
 
axlMeshmesh (void)
 Return the mesh of that object is computed. More...
 
void setMesh (axlMesh *mesh)
 Set a corresponding mesh for that object. More...
 
void setUpdateView (bool updateView)
 
QList< axlAbstractField * > fields (void)
 

Additional Inherited Members

- Properties inherited from axlAbstractData
QColor color
 
double opacity
 
double size
 
QString shader
 

Detailed Description

Class axlDataDynamic defines a dynamic object.

This class enables to represent and manipulate dynamic object.

Example:

axlDataDynamic *object = new axlDataDynamicObject();
object->setProcess("axlLineCreator");
object->setInput(new axlPoint());
object->setInput(new axlPoint(1.,0.));
object->update();
dynamic_cast<axlLine *>(object->outputs());

Definition at line 33 of file axlDataDynamic.h.

Member Enumeration Documentation

Enumerator
Dynamic 
Static 

Definition at line 38 of file axlDataDynamic.h.

Constructor & Destructor Documentation

axlDataDynamic::axlDataDynamic ( void  )

Definition at line 57 of file axlDataDynamic.cpp.

axlDataDynamic::~axlDataDynamic ( void  )
virtual

Definition at line 66 of file axlDataDynamic.cpp.

Member Function Documentation

void axlDataDynamic::clearInputs ( void  )

Clear input list.

Definition at line 169 of file axlDataDynamic.cpp.

QVariantList axlDataDynamic::convertDataToQVariant ( void  ) const
virtual

Convert an axlShape into a QVariantList. Useful for RPC protocol.

Reimplemented from axlAbstractData.

Definition at line 469 of file axlDataDynamic.cpp.

int axlDataDynamic::convertQVariantToData ( const QVariantList &  data)
virtual

Convert a QVariantList into an axlShape. Useful for RPC protocol.

Reimplemented from axlAbstractData.

Definition at line 522 of file axlDataDynamic.cpp.

void axlDataDynamic::dataInserted ( axlAbstractData data)
signal
QString axlDataDynamic::description ( void  ) const
virtual

Return a description of the dynamic object.

Reimplemented from axlAbstractDataComposite.

Definition at line 311 of file axlDataDynamic.cpp.

axlDataDynamic::Type axlDataDynamic::getType ( void  )

Return the type : dynamic if it is a dynamic object or static if it is just a computation node.

By default type is dynamic.

Definition at line 114 of file axlDataDynamic.cpp.

QString axlDataDynamic::identifier ( void  ) const
virtual

Return the identifier "axlDataDynamic".

Reimplemented from axlAbstractDataComposite.

Definition at line 331 of file axlDataDynamic.cpp.

QList< axlAbstractData * > axlDataDynamic::inputs ( void  )

Return input list;.

Definition at line 202 of file axlDataDynamic.cpp.

bool axlDataDynamic::isNotInputProcess ( dtkAbstractData *  data)

Check whether the output of the process is a different object that one of its inputs.

Definition at line 177 of file axlDataDynamic.cpp.

bool axlDataDynamic::isNotOutputProcess ( dtkAbstractData *  data)

Check whether the data is an output of the process.

Definition at line 189 of file axlDataDynamic.cpp.

int axlDataDynamic::numberOfChannels ( void  )
virtual

Return the number of output(s);.

Definition at line 341 of file axlDataDynamic.cpp.

int axlDataDynamic::numberOfUpdate ( void  )
slot

Return how many times the geometry of the dynamic object has been updated.

Definition at line 132 of file axlDataDynamic.cpp.

void axlDataDynamic::onRemoved ( void  )
slot

This slot is called whenever one of the dynamic object input is deleted.

Definition at line 104 of file axlDataDynamic.cpp.

axlAbstractData * axlDataDynamic::outputs ( void  )

Return the first output of the list.

Definition at line 154 of file axlDataDynamic.cpp.

axlAbstractData * axlDataDynamic::outputs ( int  channel)

Return the channel-th output of the list.

Definition at line 141 of file axlDataDynamic.cpp.

QList<axlAbstractData *> axlDataDynamic::parameters ( void  )
axlAbstractProcess * axlDataDynamic::process ( void  )

Return the process.

Definition at line 210 of file axlDataDynamic.cpp.

void axlDataDynamic::setInput ( dtkAbstractData *  data,
int  channel = 0 
)
slot

Add input;.

Definition at line 218 of file axlDataDynamic.cpp.

void axlDataDynamic::setParameter ( int  parameter)
slot

Set parameter.

Definition at line 241 of file axlDataDynamic.cpp.

void axlDataDynamic::setParameter ( int  parameter,
int  channel 
)
slot

Set parameter.

Definition at line 252 of file axlDataDynamic.cpp.

void axlDataDynamic::setParameter ( double  parameter)
slot

Set parameter.

Definition at line 263 of file axlDataDynamic.cpp.

void axlDataDynamic::setParameter ( double  parameter,
int  channel 
)
slot

Set parameter.

Definition at line 274 of file axlDataDynamic.cpp.

int axlDataDynamic::setProcess ( QString  processName)
slot

Create the dynamic object process only with the name of its latter.

Definition at line 285 of file axlDataDynamic.cpp.

void axlDataDynamic::setProcess ( axlAbstractProcess process)
slot

Create the dynamic object process by copying the current state of a process.

Definition at line 300 of file axlDataDynamic.cpp.

void axlDataDynamic::setType ( axlDataDynamic::Type  type)

Sets the type of the object. Type could be dynamic or static.

Definition at line 123 of file axlDataDynamic.cpp.

void axlDataDynamic::update ( void  )
virtualslot

Update the dynamic object.

Definition at line 350 of file axlDataDynamic.cpp.


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