Developer documentation | Axl-2.5.1

axlAbstractFieldSpatial Class Reference

Class axlAbstractFieldSpatial defines an API for spatial field. More...

#include <axlAbstractFieldSpatial.h>

Inheritance diagram for axlAbstractFieldSpatial:
axlAbstractField axlAbstractData axlFieldSpatialCoordinates axlFieldSpatialPointDistance

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

 axlAbstractFieldSpatial ()
 
virtual ~axlAbstractFieldSpatial (void)
 Destroys a spatial field. More...
 
virtual double scalar (double x, double y=0, double z=0)
 Returns the value of the spatial field at the coordinates point entered. More...
 
virtual double * vector (double x, double y=0, double z=0)
 Returns the value of the spatial field at the coordinates point entered. More...
 
virtual double * tensor (double x, double y=0, double z=0)
 Returns the value of the spatial field at the coordinates point entered. More...
 
virtual QString description (void) const
 Returns the description of the field. More...
 
virtual QString identifier (void) const
 Returns the description of the field. 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...
 
- 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 axlAbstractFieldSpatial defines an API for spatial field.

Definition at line 22 of file axlAbstractFieldSpatial.h.

Constructor & Destructor Documentation

axlAbstractFieldSpatial::axlAbstractFieldSpatial ( )

Definition at line 37 of file axlAbstractFieldSpatial.cpp.

axlAbstractFieldSpatial::~axlAbstractFieldSpatial ( void  )
virtual

Destroys a spatial field.

Definition at line 47 of file axlAbstractFieldSpatial.cpp.

Member Function Documentation

QString axlAbstractFieldSpatial::description ( void  ) const
virtual

Returns the description of the field.

! Returns the name the field. *! ! Sets the name of the field. *!

Reimplemented in axlFieldSpatialPointDistance, and axlFieldSpatialCoordinates.

Definition at line 166 of file axlAbstractFieldSpatial.cpp.

QString axlAbstractFieldSpatial::identifier ( void  ) const
virtual

Returns the description of the field.

Reimplemented from axlAbstractField.

Reimplemented in axlFieldSpatialPointDistance, and axlFieldSpatialCoordinates.

Definition at line 178 of file axlAbstractFieldSpatial.cpp.

double axlAbstractFieldSpatial::scalar ( double  x,
double  y = 0,
double  z = 0 
)
virtual

Returns the value of the spatial field at the coordinates point entered.

! 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. *! ! *!

Reimplemented in axlFieldSpatialPointDistance, and axlFieldSpatialCoordinates.

Definition at line 107 of file axlAbstractFieldSpatial.cpp.

double * axlAbstractFieldSpatial::tensor ( double  x,
double  y = 0,
double  z = 0 
)
virtual

Returns the value of the spatial field at the coordinates point entered.

Definition at line 133 of file axlAbstractFieldSpatial.cpp.

void axlAbstractFieldSpatial::update ( void  )
virtualslot

Mark the internal data structure as changed to notify underlying pipeline execution.

Definition at line 191 of file axlAbstractFieldSpatial.cpp.

void axlAbstractFieldSpatial::updated ( void  )
signal
double * axlAbstractFieldSpatial::vector ( double  x,
double  y = 0,
double  z = 0 
)
virtual

Returns the value of the spatial field at the coordinates point entered.

Definition at line 120 of file axlAbstractFieldSpatial.cpp.


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