Developer documentation | Axl-2.5.1

axlLine Class Reference

Class axlLine defines 3D lines. More...

#include <axlLine.h>

Inheritance diagram for axlLine:
axlAbstractCurveParametric axlAbstractCurve axlAbstractData

Public Member Functions

 axlLine (QObject *parent=0)
 Constructs a axel line of with firstPoint and second point are NULL with parent parent of QObject type. More...
 
 axlLine (axlPoint *p1, axlPoint *p2, QObject *parent=0)
 Constructs a axel line of two axlPoint p1 p2 with parent parent of QObject type. More...
 
 axlLine (const axlPoint &p1, const axlPoint &p2, QObject *parent=0)
 Constructs an axel line from two axl points p1 p2 and a parent. More...
 
 axlLine (const axlLine &other)
 Constructs a copy of other with same axlPoints. More...
 
 ~axlLine (void)
 Destroys the axel line. More...
 
virtual QString description (void) const
 
virtual QString identifier (void) const
 
axlPointfirstPoint (void) const
 Returns first point of the line. More...
 
axlPointsecondPoint (void) const
 Returns second point of the line. More...
 
axlPointgetBarycenterPoint (double coeff)
 Returns a barycenter point of the line. More...
 
axlPointgetMiddlePoint (void)
 Returns the center point of the line. More...
 
void setFirstPoint (axlPoint *p1)
 Change first point of this line. More...
 
void setFirstPoint (double *p1)
 modify first point of this line. More...
 
void touchFirstPoint (const axlPoint &point)
 Change first point of this line and emit using touchGeometry. More...
 
void touchSecondPoint (const axlPoint &point)
 Change second point of this line and emit using touchGeometry. More...
 
void setSecondPoint (axlPoint *p2)
 Change second point of this line. More...
 
void setSecondPoint (double *p2)
 modify second point of this line. More...
 
void setValues (axlPoint *p1, axlPoint *p2)
 Change first point and second point of this line. More...
 
void applyMatrix (double *matrix)
 
double planeDirection (void)
 compute the direction value of the line ie a in y = ax + b. More...
 
double planeOrigineOrdinate (void)
 compute the b value of the line y = ax + b. More...
 
axlLineoperator= (const axlLine &other)
 Assigns other to this line and returns a reference to this line. More...
 
QVariantList convertDataToQVariant (void) const
 Convert an axlAbstractData into a QVariantList that specifies all properties of the axlAbstractData. More...
 
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 onFirstPointChanged (axlPoint *p1)
 
void onSecondPointChanged (axlPoint *p2)
 
- Public Member Functions inherited from axlAbstractCurveParametric
 axlAbstractCurveParametric (void)
 
virtual ~axlAbstractCurveParametric (void)
 
virtual double startParam (void)
 
virtual double endParam (void)
 
virtual axlPoint eval (double u)
 
virtual void eval (axlPoint *point, double u)
 
virtual axlMesh eval (double u, int derivs, bool from_right=true)
 
double parameterOf (const axlPoint &p)
 
virtual double length (double tolerance)
 
virtual int numSamples (void)
 
virtual void setNumSamples (int numSamples)
 
const int & samples (void) const
 
- Public Member Functions inherited from axlAbstractCurve
 axlAbstractCurve (void)
 
virtual ~axlAbstractCurve (void)
 
virtual int dimension (void) const
 
virtual bool isPlanar (void) const
 
virtual void * curve (void)
 
- 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...
 
void setUpdateView (bool updateView)
 
QList< axlAbstractField * > fields (void)
 

Properties

axlPoint point1
 
axlPoint point2
 
- Properties inherited from axlAbstractCurveParametric
int samples
 
- Properties inherited from axlAbstractData
QColor color
 
double opacity
 
double size
 
QString shader
 

Friends

QDebug operator<< (QDebug dbg, axlLine line)
 
QDebug operator<< (QDebug dbg, axlLine &line)
 
QDebug operator<< (QDebug dbg, axlLine *line)
 

Additional Inherited Members

- Public Slots inherited from axlAbstractCurveParametric
virtual void onDirectChanged (bool direct)
 
void setSamples (const int &color)
 
- 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 inherited from axlAbstractData
void modifiedGeometry (void)
 
void modifiedStructure (void)
 
void modifiedField (void)
 
void modifiedProperty (void)
 

Detailed Description

Class axlLine defines 3D lines.

This class enables to represent and manipulate 3D lines.

Example:

axlPoint *firstPoint = new axlPoint(0.0, 0.0, 0.0);
axlPoint *secondPoint = new axlPoint(1.0, 0.0, 0.0);
axlLine *A = new axlLine(firstPoint, secondPoint);

Definition at line 35 of file axlLine.h.

Constructor & Destructor Documentation

axlLine::axlLine ( QObject *  parent = 0)

Constructs a axel line of with firstPoint and second point are NULL with parent parent of QObject 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 axel line with no parent.

Definition at line 47 of file axlLine.cpp.

axlLine::axlLine ( axlPoint p1,
axlPoint p2,
QObject *  parent = 0 
)

Constructs a axel line of two axlPoint p1 p2 with parent parent of QObject 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 axel point with no parent.

Definition at line 60 of file axlLine.cpp.

axlLine::axlLine ( const axlPoint p1,
const axlPoint p2,
QObject *  parent = 0 
)

Constructs an axel line from two axl points p1 p2 and a parent.

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 axel point with no parent.

Definition at line 74 of file axlLine.cpp.

axlLine::axlLine ( const axlLine other)

Constructs a copy of other with same axlPoints.

Definition at line 86 of file axlLine.cpp.

axlLine::~axlLine ( void  )

Destroys the axel line.

Definition at line 98 of file axlLine.cpp.

Member Function Documentation

void axlLine::applyMatrix ( double *  matrix)

Definition at line 242 of file axlLine.cpp.

QVariantList axlLine::convertDataToQVariant ( void  ) const
virtual

Convert an axlAbstractData into a QVariantList that specifies all properties of the axlAbstractData.

Reimplemented from axlAbstractData.

Definition at line 319 of file axlLine.cpp.

int axlLine::convertQVariantToData ( const QVariantList &  data)
virtual

Modify properties and geometry variables of the axlAbstractData. Return 1 if the modification was sucessfully made. Otherwise return 0.

Reimplemented from axlAbstractData.

Definition at line 333 of file axlLine.cpp.

QString axlLine::description ( void  ) const
virtual

Definition at line 293 of file axlLine.cpp.

axlPoint * axlLine::firstPoint ( void  ) const

Returns first point of the line.

Definition at line 128 of file axlLine.cpp.

axlPoint * axlLine::getBarycenterPoint ( double  coeff)

Returns a barycenter point of the line.

Definition at line 146 of file axlLine.cpp.

axlPoint * axlLine::getMiddlePoint ( void  )

Returns the center point of the line.

Definition at line 158 of file axlLine.cpp.

QString axlLine::identifier ( void  ) const
virtual

Definition at line 300 of file axlLine.cpp.

void axlLine::onFirstPointChanged ( axlPoint p1)

Definition at line 306 of file axlLine.cpp.

void axlLine::onSecondPointChanged ( axlPoint p2)

Definition at line 312 of file axlLine.cpp.

axlLine & axlLine::operator= ( const axlLine other)

Assigns other to this line and returns a reference to this line.

Definition at line 116 of file axlLine.cpp.

double axlLine::planeDirection ( void  )

compute the direction value of the line ie a in y = ax + b.

Definition at line 252 of file axlLine.cpp.

double axlLine::planeOrigineOrdinate ( void  )

compute the b value of the line y = ax + b.

Definition at line 262 of file axlLine.cpp.

axlPoint * axlLine::secondPoint ( void  ) const

Returns second point of the line.

Definition at line 137 of file axlLine.cpp.

void axlLine::setFirstPoint ( axlPoint p1)

Change first point of this line.

Definition at line 182 of file axlLine.cpp.

void axlLine::setFirstPoint ( double *  p1)

modify first point of this line.

Definition at line 202 of file axlLine.cpp.

void axlLine::setSecondPoint ( axlPoint p2)

Change second point of this line.

Definition at line 192 of file axlLine.cpp.

void axlLine::setSecondPoint ( double *  p2)

modify second point of this line.

Definition at line 214 of file axlLine.cpp.

void axlLine::setValues ( axlPoint p1,
axlPoint p2 
)

Change first point and second point of this line.

Definition at line 170 of file axlLine.cpp.

void axlLine::touchFirstPoint ( const axlPoint point)

Change first point of this line and emit using touchGeometry.

Definition at line 226 of file axlLine.cpp.

void axlLine::touchSecondPoint ( const axlPoint point)

Change second point of this line and emit using touchGeometry.

Definition at line 236 of file axlLine.cpp.

Friends And Related Function Documentation

QDebug operator<< ( QDebug  dbg,
axlLine  line 
)
friend

Definition at line 272 of file axlLine.cpp.

QDebug operator<< ( QDebug  dbg,
axlLine line 
)
friend

Definition at line 279 of file axlLine.cpp.

QDebug operator<< ( QDebug  dbg,
axlLine line 
)
friend

Definition at line 286 of file axlLine.cpp.

Property Documentation

axlPoint axlLine::point1
readwrite

Definition at line 39 of file axlLine.h.

axlPoint axlLine::point2
readwrite

Definition at line 39 of file axlLine.h.


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