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

#include <axlAbstractField.h>

Inheritance diagram for axlAbstractField:

Public Types
enum	Type { Int = 0x001, Float = 0x002, Double = 0x004 }

enum	Kind { Scalar = 0x001, Vector = 0x002, Tensor = 0x004 }

enum	Support { Point = 0x001, Cell = 0x002, Custom = 0x004 }

Public Slots
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 axlAbstractData
void	modifiedGeometry (void)

void	modifiedStructure (void)

void	modifiedField (void)

void	modifiedProperty (void)

Public Member Functions
	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)

axlMesh *	mesh (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
Properties inherited from axlAbstractData
QColor	color

double	opacity

double	size

QString	shader

Detailed Description

Class axlAbstractField 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 29 of file axlAbstractField.h.

Member Enumeration Documentation

enum axlAbstractField::Kind

Enumerator
Scalar
Vector
Tensor

Definition at line 40 of file axlAbstractField.h.

enum axlAbstractField::Support

Enumerator
Point
Cell
Custom

Definition at line 46 of file axlAbstractField.h.

enum axlAbstractField::Type

Enumerator
Int
Float
Double

Definition at line 34 of file axlAbstractField.h.

Constructor & Destructor Documentation

axlAbstractField::axlAbstractField ( )

Definition at line 43 of file axlAbstractField.cpp.

axlAbstractField::axlAbstractField	(	QString	name,
		Type	type,
		Kind	kind,
		Support	support
	)

Definition at line 56 of file axlAbstractField.cpp.

axlAbstractField::~axlAbstractField ( void )

virtual

Destroys the field.

Definition at line 71 of file axlAbstractField.cpp.

Member Function Documentation

QString axlAbstractField::identifier ( void ) const

virtual

Return the identifier of an axlAbstractField which is empty.

Reimplemented in axlAbstractFieldParametricSurface, axlFieldParametricVolume, axlAbstractFieldParametric, axlFieldDiscrete, axlFieldParametricSurface, axlFieldParametricCurve, axlAbstractFieldParametricVolume, axlFieldParametricVolumeTangentVector, axlFieldParametricSurfaceTangentVector, axlAbstractFieldParametricCurve, axlFieldParametricNormalVector, axlFieldParametricCurveTangentVector, axlAbstractFieldSpatial, axlFieldSpatialPointDistance, and axlFieldSpatialCoordinates.

Definition at line 272 of file axlAbstractField.cpp.

axlAbstractField::Kind axlAbstractField::kind ( void )

virtual

Definition at line 148 of file axlAbstractField.cpp.

double axlAbstractField::maxValue ( void )

virtual

Returns the maximum value of the field.

Definition at line 194 of file axlAbstractField.cpp.

double axlAbstractField::minValue ( void )

virtual

Returns the minimum value of the field.

Definition at line 175 of file axlAbstractField.cpp.

void axlAbstractField::setKind ( axlAbstractField::Kind kind )

virtual

Sets the kind of the field which can be either scalar, vector or tensor.

Definition at line 88 of file axlAbstractField.cpp.

void axlAbstractField::setMax ( double maxi )

virtual

Sets the maximum value of the field..

Definition at line 203 of file axlAbstractField.cpp.

void axlAbstractField::setMin ( double mini )

virtual

Sets the minimum value of the field.

Definition at line 184 of file axlAbstractField.cpp.

void axlAbstractField::setSupport ( axlAbstractField::Support support )

virtual

Definition at line 97 of file axlAbstractField.cpp.

void axlAbstractField::setType ( axlAbstractField::Type type )

virtual

Sets the type of the field which can be either int, float or double.

Definition at line 79 of file axlAbstractField.cpp.

axlAbstractField::Support axlAbstractField::support ( void )

virtual

Definition at line 153 of file axlAbstractField.cpp.

axlAbstractField::Type axlAbstractField::type ( void )

virtual

! *! ! *! ! *!

Definition at line 143 of file axlAbstractField.cpp.

void axlAbstractField::update ( void )

virtualslot

! Returns the value at index location of the scalar array. *! ! Returns the value at index location of the vector array. *! ! Returns the value at index location of the tensor array. *! ! Returns the name the field. *! Mark the internal data structure as changed to notify underlying pipeline execution.

Definition at line 262 of file axlAbstractField.cpp.

void axlAbstractField::updated ( void )

signal

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

src/axlCore/axlAbstractField.h
src/axlCore/axlAbstractField.cpp

Public Types

Public Slots

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation