Developer documentation | Axl-2.5.1

axlFieldParametricVolume Class Reference

Class axlFieldParametricVolume defines an API for field which owns a BSpline Volume. More...

#include <axlFieldParametricVolume.h>

Inheritance diagram for axlFieldParametricVolume:
axlAbstractFieldParametricVolume axlAbstractFieldParametric axlAbstractField axlAbstractData

Public Slots

virtual void update (void)
 
- Public Slots inherited from axlAbstractFieldParametricVolume
virtual void update (void)
 
- Public Slots inherited from axlAbstractFieldParametric
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 axlAbstractFieldParametricVolume
void updated (void)
 
- Signals inherited from axlAbstractFieldParametric
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

 axlFieldParametricVolume ()
 
virtual ~axlFieldParametricVolume (void)
 Destroys a Bspline field. More...
 
void setFunction (axlAbstractData *data)
 Sets the Bspline function which determines the values of the parametric field. More...
 
axlAbstractDatagetFunction (void)
 Returns the Bspline function which determines the values of the parametric field. More...
 
void setVolume (axlAbstractData *data)
 Sets the BSpline on which the BSpline field is applied. More...
 
double start_u (void)
 Returns the first parameter value of the field. More...
 
double start_v (void)
 Returns the first parameter value of the field. More...
 
double start_w (void)
 Returns the first parameter value of the field. More...
 
double end_u (void)
 Returns the last parameter value of the field. More...
 
double end_v (void)
 Returns the last parameter value of the field. More...
 
double end_w (void)
 Returns the last parameter value of the field. More...
 
double numbersample_u (void)
 Returns the number of parameters. More...
 
double numbersample_v (void)
 Returns the number of parameters. More...
 
double numbersample_w (void)
 Returns the number of parameters. More...
 
int size (void)
 Returns the number of values evaluated for this BSpline field on each samples of the input BSpline. More...
 
virtual double scalar (double u, double v, double w)
 Returns the value of the spatial field at the coordinates point entered. More...
 
virtual double * vector (double u, double v, double w)
 Returns the value of the spatial field at the coordinates point entered. More...
 
virtual double * tensor (double u, double v, double w)
 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 identifier of the field "axlFieldParametricVolume". More...
 
- Public Member Functions inherited from axlAbstractFieldParametricVolume
 axlAbstractFieldParametricVolume ()
 
virtual ~axlAbstractFieldParametricVolume (void)
 Destroys a parametric field. More...
 
- Public Member Functions inherited from axlAbstractFieldParametric
 axlAbstractFieldParametric ()
 
virtual ~axlAbstractFieldParametric (void)
 Destroys a parametric 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 axlFieldParametricVolume defines an API for field which owns a BSpline Volume.

Definition at line 23 of file axlFieldParametricVolume.h.

Constructor & Destructor Documentation

axlFieldParametricVolume::axlFieldParametricVolume ( )

Definition at line 46 of file axlFieldParametricVolume.cpp.

axlFieldParametricVolume::~axlFieldParametricVolume ( void  )
virtual

Destroys a Bspline field.

Definition at line 59 of file axlFieldParametricVolume.cpp.

Member Function Documentation

QString axlFieldParametricVolume::description ( void  ) const
virtual

Returns the description of the field.

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

Reimplemented from axlAbstractFieldParametricVolume.

Definition at line 181 of file axlFieldParametricVolume.cpp.

double axlFieldParametricVolume::end_u ( void  )
virtual

Returns the last parameter value of the field.

Reimplemented from axlAbstractFieldParametricVolume.

Definition at line 306 of file axlFieldParametricVolume.cpp.

double axlFieldParametricVolume::end_v ( void  )
virtual

Returns the last parameter value of the field.

Reimplemented from axlAbstractFieldParametricVolume.

Definition at line 316 of file axlFieldParametricVolume.cpp.

double axlFieldParametricVolume::end_w ( void  )
virtual

Returns the last parameter value of the field.

Reimplemented from axlAbstractFieldParametricVolume.

Definition at line 326 of file axlFieldParametricVolume.cpp.

axlAbstractData * axlFieldParametricVolume::getFunction ( void  )
virtual

Returns the Bspline function which determines the values of the parametric field.

Reimplemented from axlAbstractFieldParametricVolume.

Definition at line 259 of file axlFieldParametricVolume.cpp.

QString axlFieldParametricVolume::identifier ( void  ) const
virtual

Returns the identifier of the field "axlFieldParametricVolume".

Reimplemented from axlAbstractFieldParametricVolume.

Definition at line 240 of file axlFieldParametricVolume.cpp.

double axlFieldParametricVolume::numbersample_u ( void  )
virtual

Returns the number of parameters.

Reimplemented from axlAbstractFieldParametricVolume.

Definition at line 336 of file axlFieldParametricVolume.cpp.

double axlFieldParametricVolume::numbersample_v ( void  )
virtual

Returns the number of parameters.

Reimplemented from axlAbstractFieldParametricVolume.

Definition at line 345 of file axlFieldParametricVolume.cpp.

double axlFieldParametricVolume::numbersample_w ( void  )
virtual

Returns the number of parameters.

Reimplemented from axlAbstractFieldParametricVolume.

Definition at line 354 of file axlFieldParametricVolume.cpp.

double axlFieldParametricVolume::scalar ( double  u,
double  v,
double  w 
)
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 from axlAbstractFieldParametricVolume.

Definition at line 117 of file axlFieldParametricVolume.cpp.

void axlFieldParametricVolume::setFunction ( axlAbstractData data)
virtual

Sets the Bspline function which determines the values of the parametric field.

Reimplemented from axlAbstractFieldParametricVolume.

Definition at line 250 of file axlFieldParametricVolume.cpp.

void axlFieldParametricVolume::setVolume ( axlAbstractData data)
virtual

Sets the BSpline on which the BSpline field is applied.

Reimplemented from axlAbstractFieldParametricVolume.

Definition at line 267 of file axlFieldParametricVolume.cpp.

int axlFieldParametricVolume::size ( void  )
virtual

Returns the number of values evaluated for this BSpline field on each samples of the input BSpline.

Reimplemented from axlAbstractFieldParametricVolume.

Definition at line 363 of file axlFieldParametricVolume.cpp.

double axlFieldParametricVolume::start_u ( void  )
virtual

Returns the first parameter value of the field.

Reimplemented from axlAbstractFieldParametricVolume.

Definition at line 277 of file axlFieldParametricVolume.cpp.

double axlFieldParametricVolume::start_v ( void  )
virtual

Returns the first parameter value of the field.

Reimplemented from axlAbstractFieldParametricVolume.

Definition at line 288 of file axlFieldParametricVolume.cpp.

double axlFieldParametricVolume::start_w ( void  )
virtual

Returns the first parameter value of the field.

Reimplemented from axlAbstractFieldParametricVolume.

Definition at line 297 of file axlFieldParametricVolume.cpp.

double * axlFieldParametricVolume::tensor ( double  u,
double  v,
double  w 
)
virtual

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

Reimplemented from axlAbstractFieldParametricVolume.

Definition at line 147 of file axlFieldParametricVolume.cpp.

void axlFieldParametricVolume::update ( void  )
virtualslot

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

Definition at line 374 of file axlFieldParametricVolume.cpp.

void axlFieldParametricVolume::updated ( void  )
signal
double * axlFieldParametricVolume::vector ( double  u,
double  v,
double  w 
)
virtual

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

Reimplemented from axlAbstractFieldParametricVolume.

Definition at line 133 of file axlFieldParametricVolume.cpp.


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