Developer documentation | Axl-2.5.1

axlAbstractFieldDiscrete Class Reference

Class axlAbstractFieldDiscrete defines an API for arrays of numeric data. More...

#include <axlAbstractFieldDiscrete.h>

Inheritance diagram for axlAbstractFieldDiscrete:
axlAbstractField axlAbstractData axlFieldDiscrete

Public Slots

virtual void update (void)
 
- Public Slots inherited from axlAbstractField
virtual void update (void)
 
- 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 updated (void)
 
- Signals inherited from axlAbstractField
void updated (void)
 
- Signals inherited from axlAbstractData
void modifiedGeometry (void)
 
void modifiedStructure (void)
 
void modifiedField (void)
 
void modifiedProperty (void)
 

Public Member Functions

 axlAbstractFieldDiscrete ()
 
 axlAbstractFieldDiscrete (QString name, Type type, Kind kind, Support support, int size)
 
 axlAbstractFieldDiscrete (void *array)
 Constructs a discrete field from an array of underlying vtkDataArray type. More...
 
virtual ~axlAbstractFieldDiscrete (void)
 Destroys the discrete field. More...
 
virtual void setScalar (int index, double v1)
 
virtual void setVector (int index, double v1, double v2, double v3)
 
virtual void setTensor (int index, double v1, double v2, double v3, double v4, double v5, double v6, double v7, double v8, double v9)
 
virtual int size (void)
 
virtual void setSize (int size)
 
virtual double scalar (int index)
 Returns the value at index location of the scalar array. More...
 
virtual double * vector (int index)
 Returns the value at index location of the vector array. More...
 
virtual double * tensor (int index)
 Returns the value at index location of the tensor array. More...
 
- Public Member Functions inherited from axlAbstractField
 axlAbstractField ()
 
 axlAbstractField (QString name, Type type, Kind kind, Support support)
 
virtual ~axlAbstractField (void)
 Destroys the field. More...
 
virtual void setType (Type type)
 Sets the type of the field which can be either int, float or double. More...
 
virtual void setKind (Kind kind)
 Sets the kind of the field which can be either scalar, vector or tensor. More...
 
virtual void setSupport (Support support)
 
virtual Type type (void)
 
virtual Kind kind (void)
 
virtual Support support (void)
 
virtual void setMin (double mini)
 Sets the minimum value of the field. More...
 
virtual double minValue (void)
 Returns the minimum value of the field. More...
 
virtual void setMax (double maxi)
 Sets the maximum value of the field.. More...
 
virtual double maxValue (void)
 Returns the maximum value of the field. More...
 
virtual QString identifier (void) const
 
- 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...
 
virtual QVariantList convertDataToQVariant (void) const
 Convert an axlAbstractData into a QVariantList that specifies all properties of the axlAbstractData. More...
 
virtual int convertQVariantToData (const QVariantList &data)
 Modify properties and geometry variables of the axlAbstractData. Return 1 if the modification was sucessfully made. Otherwise return 0. More...
 
void setUpdateView (bool updateView)
 
QList< axlAbstractField * > fields (void)
 

Additional Inherited Members

- Public Types inherited from axlAbstractField
enum  Type { Int = 0x001, Float = 0x002, Double = 0x004 }
 
enum  Kind { Scalar = 0x001, Vector = 0x002, Tensor = 0x004 }
 
enum  Support { Point = 0x001, Cell = 0x002, Custom = 0x004 }
 
- Properties inherited from axlAbstractData
QColor color
 
double opacity
 
double size
 
QString shader
 

Detailed Description

Class axlAbstractFieldDiscrete defines an API for arrays of numeric data.

! Returns a void pointer to the underlying vtkDataArray object. *!

This class, based on a wrapping of vtkDataArray class, enables to deal with different type (int, float or double) and different kind (scalar, vector, tensor) of data.

Definition at line 24 of file axlAbstractFieldDiscrete.h.

Constructor & Destructor Documentation

axlAbstractFieldDiscrete::axlAbstractFieldDiscrete ( )

Definition at line 29 of file axlAbstractFieldDiscrete.cpp.

axlAbstractFieldDiscrete::axlAbstractFieldDiscrete ( QString  name,
Type  type,
Kind  kind,
Support  support,
int  size 
)

Definition at line 37 of file axlAbstractFieldDiscrete.cpp.

axlAbstractFieldDiscrete::axlAbstractFieldDiscrete ( void *  array)

Constructs a discrete field from an array of underlying vtkDataArray type.

The parent of an object may be viewed as the object's owner. The destructor of a parent object destroys all child objects. Setting parent to 0 constructs a discrete field with no parent.

Definition at line 48 of file axlAbstractFieldDiscrete.cpp.

axlAbstractFieldDiscrete::~axlAbstractFieldDiscrete ( void  )
virtual

Destroys the discrete field.

Definition at line 57 of file axlAbstractFieldDiscrete.cpp.

Member Function Documentation

double axlAbstractFieldDiscrete::scalar ( int  index)
virtual

Returns the value at index location of the scalar array.

Reimplemented in axlFieldDiscrete.

Definition at line 167 of file axlAbstractFieldDiscrete.cpp.

void axlAbstractFieldDiscrete::setScalar ( int  index,
double  v1 
)
virtual

! Sets the type of the field which can be either int, float or double. *! ! Sets the kind of the field which can be either scalar, vector or tensor. *! ! *!

Set a scalar element v1 at index location in the scalar data array.

Reimplemented in axlFieldDiscrete.

Definition at line 92 of file axlAbstractFieldDiscrete.cpp.

void axlAbstractFieldDiscrete::setSize ( int  size)
virtual

Reimplemented in axlFieldDiscrete.

Definition at line 157 of file axlAbstractFieldDiscrete.cpp.

void axlAbstractFieldDiscrete::setTensor ( int  index,
double  v1,
double  v2,
double  v3,
double  v4,
double  v5,
double  v6,
double  v7,
double  v8,
double  v9 
)
virtual

Set a tensor element (v1, v2, v3, v4, v5, v6, v7, v8, v9) at index location in the tensor data array.

Reimplemented in axlFieldDiscrete.

Definition at line 115 of file axlAbstractFieldDiscrete.cpp.

void axlAbstractFieldDiscrete::setVector ( int  index,
double  v1,
double  v2,
double  v3 
)
virtual

Set a vector element (v1, v2, v3) at index location in the vector data array.

Reimplemented in axlFieldDiscrete.

Definition at line 102 of file axlAbstractFieldDiscrete.cpp.

int axlAbstractFieldDiscrete::size ( void  )
virtual

Reimplemented in axlFieldDiscrete.

Definition at line 150 of file axlAbstractFieldDiscrete.cpp.

double * axlAbstractFieldDiscrete::tensor ( int  index)
virtual

Returns the value at index location of the tensor array.

Reimplemented in axlFieldDiscrete.

Definition at line 189 of file axlAbstractFieldDiscrete.cpp.

void axlAbstractFieldDiscrete::update ( void  )
virtualslot

! Returns the name the field. *! Mark the internal data structure as changed to notify underlying pipeline execution.

Definition at line 218 of file axlAbstractFieldDiscrete.cpp.

void axlAbstractFieldDiscrete::updated ( void  )
signal
double * axlAbstractFieldDiscrete::vector ( int  index)
virtual

Returns the value at index location of the vector array.

Reimplemented in axlFieldDiscrete.

Definition at line 178 of file axlAbstractFieldDiscrete.cpp.


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