Developer documentation | Axl-2.5.1

axlAbstractFieldParametric Class Reference

Class axlAbstractFieldParametric defines an API for parametric field. More...

#include <axlAbstractFieldParametric.h>

Inheritance diagram for axlAbstractFieldParametric:
axlAbstractField axlAbstractData axlAbstractFieldParametricCurve axlAbstractFieldParametricSurface axlAbstractFieldParametricVolume axlFieldParametricCurve axlFieldParametricCurveTangentVector axlFieldParametricNormalVector axlFieldParametricSurface axlFieldParametricSurfaceTangentVector axlFieldParametricVolume axlFieldParametricVolumeTangentVector

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

 axlAbstractFieldParametric ()
 
virtual ~axlAbstractFieldParametric (void)
 Destroys a parametric field. More...
 
virtual int size (void)
 Returns number of parameters on which the field is evaluated. More...
 
virtual double scalar (double u, double v=0, double w=0)
 Returns the value of the parametric field at the parameters values in input. More...
 
virtual double * vector (double u, double v=0, double w=0)
 Returns the value of the parametric field evaluated at the parameters in input. More...
 
virtual double * tensor (double u, double v=0, double w=0)
 Returns the value of the spatial field at the coordinates point entered. More...
 
virtual void setFunction (axlAbstractData *data)
 Returns the description of the field. More...
 
virtual axlAbstractDatagetFunction (void)
 Returns the description of the field. 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 axlAbstractFieldParametric defines an API for parametric field.

Definition at line 22 of file axlAbstractFieldParametric.h.

Constructor & Destructor Documentation

axlAbstractFieldParametric::axlAbstractFieldParametric ( )

Definition at line 38 of file axlAbstractFieldParametric.cpp.

axlAbstractFieldParametric::~axlAbstractFieldParametric ( void  )
virtual

Destroys a parametric field.

Definition at line 49 of file axlAbstractFieldParametric.cpp.

Member Function Documentation

axlAbstractData * axlAbstractFieldParametric::getFunction ( void  )
virtual
double axlAbstractFieldParametric::scalar ( double  u,
double  v = 0,
double  w = 0 
)
virtual

Returns the value of the parametric field at the parameters values in input.

Reimplemented in axlFieldParametricVolume, axlFieldParametricSurface, axlFieldParametricCurve, axlAbstractFieldParametricSurface, axlAbstractFieldParametricCurve, and axlAbstractFieldParametricVolume.

Definition at line 70 of file axlAbstractFieldParametric.cpp.

void axlAbstractFieldParametric::setFunction ( axlAbstractData data)
virtual
double * axlAbstractFieldParametric::tensor ( double  u,
double  v = 0,
double  w = 0 
)
virtual

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

Reimplemented in axlFieldParametricVolume, axlFieldParametricSurface, axlFieldParametricCurve, axlAbstractFieldParametricSurface, axlAbstractFieldParametricCurve, and axlAbstractFieldParametricVolume.

Definition at line 96 of file axlAbstractFieldParametric.cpp.

void axlAbstractFieldParametric::update ( void  )
virtualslot

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

Definition at line 225 of file axlAbstractFieldParametric.cpp.

void axlAbstractFieldParametric::updated ( void  )
signal
double * axlAbstractFieldParametric::vector ( double  u,
double  v = 0,
double  w = 0 
)
virtual

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