Developer documentation | Axl-2.5.1

axlCylinder Class Reference

Class axlCylinder defines 3D cylinders. More...

#include <axlCylinder.h>

Inheritance diagram for axlCylinder:
axlAbstractData

Public Slots

void onFirstPointChanged (axlPoint *p1)
 
void onSecondPointChanged (axlPoint *p2)
 
void onRadiusChanged (double radius)
 
- 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)
 

Public Member Functions

 axlCylinder (QObject *parent=0)
 Constructs a axel cylinder of with firstPoint and second point are NULL and 1.0 radius with parent parent of QObject type. More...
 
 axlCylinder (axlPoint *p1, axlPoint *p2, double radius, QObject *parent=0)
 Constructs a axel cylinder of two axlPoint p1 p2 and radius radius with parent parent of QObject type. More...
 
 axlCylinder (const axlPoint &p1, const axlPoint &p2, double radius, QObject *parent=0)
 Constructs an axel cylinder from two axlPoint p1 p2 and radius radius with parent parent. More...
 
 axlCylinder (const axlCylinder &other)
 Constructs a copy of other with same axlPoints. More...
 
 ~axlCylinder (void)
 Destroys the axel cylinder. More...
 
virtual QString description (void) const
 
virtual QString identifier (void) const
 
axlPointfirstPoint (void) const
 Returns first point of the cylinder. More...
 
axlPointsecondPoint (void) const
 Returns second point of the cylinder. More...
 
double radius (void) const
 Returns radius of the cylinder. More...
 
double length (void) const
 Returns length of the cylinder. More...
 
void setValues (axlPoint *p1, axlPoint *p2, double radius)
 Change first point and second point of this cylinder. More...
 
void setFirstPoint (axlPoint *p1)
 Change first point of this cylinder. More...
 
void setSecondPoint (axlPoint *p2)
 Change second point of this cylinder. More...
 
void setRadius (double radius)
 Change radius of this cylinder. More...
 
void setLength (double length)
 Change length of this cylinder we considered then first point is the origin of the cylinder and we change secondPoint in consequence. More...
 
void setFirstPoint (double *p1)
 modify first point of this line. More...
 
void setSecondPoint (double *p2)
 modify second point of this line. More...
 
void touchFirstPoint (axlPoint p1)
 
void touchSecondPoint (axlPoint p2)
 
void touchRadius (double radius)
 
axlCylinderoperator= (const axlCylinder &other)
 Assigns other to this cylinder and returns a reference to this cylinder. 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...
 
- 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
 
double radius
 
- Properties inherited from axlAbstractData
QColor color
 
double opacity
 
double size
 
QString shader
 

Friends

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

Additional Inherited Members

- Signals inherited from axlAbstractData
void modifiedGeometry (void)
 
void modifiedStructure (void)
 
void modifiedField (void)
 
void modifiedProperty (void)
 

Detailed Description

Class axlCylinder defines 3D cylinders.

This class enables to represent and manipulate 3D cylinders.

Example:

axlPoint *firstPoint = new axlPoint(0.0, 0.0, 0.0);
axlPoint *secondPoint = new axlPoint(1.0, 0.0, 0.0);
double radius = 1.0;
axlCylinder *A = new axlCylinder(firstPoint, secondPoint, radius);

Definition at line 33 of file axlCylinder.h.

Constructor & Destructor Documentation

axlCylinder::axlCylinder ( QObject *  parent = 0)

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

Definition at line 49 of file axlCylinder.cpp.

axlCylinder::axlCylinder ( axlPoint p1,
axlPoint p2,
double  radius,
QObject *  parent = 0 
)

Constructs a axel cylinder of two axlPoint p1 p2 and radius radius 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 64 of file axlCylinder.cpp.

axlCylinder::axlCylinder ( const axlPoint p1,
const axlPoint p2,
double  radius,
QObject *  parent = 0 
)

Constructs an axel cylinder from two axlPoint p1 p2 and radius radius with parent 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 79 of file axlCylinder.cpp.

axlCylinder::axlCylinder ( const axlCylinder other)

Constructs a copy of other with same axlPoints.

Definition at line 91 of file axlCylinder.cpp.

axlCylinder::~axlCylinder ( void  )

Destroys the axel cylinder.

Definition at line 104 of file axlCylinder.cpp.

Member Function Documentation

QVariantList axlCylinder::convertDataToQVariant ( void  ) const
virtual

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

Reimplemented from axlAbstractData.

Definition at line 328 of file axlCylinder.cpp.

int axlCylinder::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 343 of file axlCylinder.cpp.

QString axlCylinder::description ( void  ) const
virtual

Definition at line 299 of file axlCylinder.cpp.

axlPoint * axlCylinder::firstPoint ( void  ) const

Returns first point of the cylinder.

Definition at line 137 of file axlCylinder.cpp.

QString axlCylinder::identifier ( void  ) const
virtual

Definition at line 306 of file axlCylinder.cpp.

double axlCylinder::length ( void  ) const

Returns length of the cylinder.

Definition at line 164 of file axlCylinder.cpp.

void axlCylinder::onFirstPointChanged ( axlPoint p1)
slot

Definition at line 312 of file axlCylinder.cpp.

void axlCylinder::onRadiusChanged ( double  radius)
slot

Definition at line 322 of file axlCylinder.cpp.

void axlCylinder::onSecondPointChanged ( axlPoint p2)
slot

Definition at line 317 of file axlCylinder.cpp.

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

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

Definition at line 124 of file axlCylinder.cpp.

double axlCylinder::radius ( void  ) const

Returns radius of the cylinder.

Definition at line 155 of file axlCylinder.cpp.

axlPoint * axlCylinder::secondPoint ( void  ) const

Returns second point of the cylinder.

Definition at line 146 of file axlCylinder.cpp.

void axlCylinder::setFirstPoint ( axlPoint p1)

Change first point of this cylinder.

Definition at line 188 of file axlCylinder.cpp.

void axlCylinder::setFirstPoint ( double *  p1)

modify first point of this line.

Definition at line 199 of file axlCylinder.cpp.

void axlCylinder::setLength ( double  length)

Change length of this cylinder we considered then first point is the origin of the cylinder and we change secondPoint in consequence.

Definition at line 244 of file axlCylinder.cpp.

void axlCylinder::setRadius ( double  radius)

Change radius of this cylinder.

Definition at line 233 of file axlCylinder.cpp.

void axlCylinder::setSecondPoint ( axlPoint p2)

Change second point of this cylinder.

Definition at line 222 of file axlCylinder.cpp.

void axlCylinder::setSecondPoint ( double *  p2)

modify second point of this line.

Definition at line 210 of file axlCylinder.cpp.

void axlCylinder::setValues ( axlPoint p1,
axlPoint p2,
double  radius 
)

Change first point and second point of this cylinder.

Definition at line 174 of file axlCylinder.cpp.

void axlCylinder::touchFirstPoint ( axlPoint  p1)

Definition at line 256 of file axlCylinder.cpp.

void axlCylinder::touchRadius ( double  radius)

Definition at line 268 of file axlCylinder.cpp.

void axlCylinder::touchSecondPoint ( axlPoint  p2)

Definition at line 262 of file axlCylinder.cpp.

Friends And Related Function Documentation

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

Definition at line 278 of file axlCylinder.cpp.

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

Definition at line 285 of file axlCylinder.cpp.

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

Definition at line 292 of file axlCylinder.cpp.

Property Documentation

axlPoint axlCylinder::point1
readwrite

Definition at line 36 of file axlCylinder.h.

axlPoint axlCylinder::point2
readwrite

Definition at line 36 of file axlCylinder.h.

double axlCylinder::radius
readwrite

Definition at line 37 of file axlCylinder.h.


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