Developer documentation | Axl-2.5.1

axlPlane Class Reference

Class axlPlane defines 3D planes. More...

#include <axlPlane.h>

Inheritance diagram for axlPlane:
axlAbstractData

Public Member Functions

 axlPlane (QObject *parent=0)
 Constructs a axel plane of with point and normal vector are NULL with parent parent of QObject type. More...
 
 axlPlane (axlPoint *point, axlPoint *normal, QObject *parent=0)
 Constructs a axel plane of two axlPoint, one for a point of on the plane point and one for the normal of the plane normal with parent parent of QObject type. More...
 
 axlPlane (const axlPoint &point, const axlPoint &normal, QObject *parent=0)
 Constructs an axel plane from two axlPoint, one for a point of on the plane point and one for the normal of the plane normal with parent parent. More...
 
 axlPlane (const axlPlane &other)
 Constructs a copy of other with same point and normal. More...
 
 ~axlPlane (void)
 Destroys the axel plane. More...
 
virtual QString description (void) const
 
virtual QString identifier (void) const
 
axlPointpoint (void) const
 Returns the point of the plane. More...
 
axlPointnormal (void) const
 Returns the normal of the plane. More...
 
void setValues (axlPoint *point, axlPoint *normal)
 Change first point and second point of this plane. More...
 
void setPoint (axlPoint *point)
 Change first point of this plane. More...
 
void setPoint (double *p)
 
void setNormal (axlPoint *normal)
 Change second point of this plane. More...
 
void setNormal (double *normal)
 
void touchPoint (axlPoint point)
 
void touchNormal (axlPoint normal)
 
axlPlaneoperator= (const axlPlane &other)
 Assigns other to this plane and returns a reference to this plane. 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 point
 
axlPoint normal
 
- Properties inherited from axlAbstractData
QColor color
 
double opacity
 
double size
 
QString shader
 

Friends

QDebug operator<< (QDebug dbg, axlPlane plane)
 
QDebug operator<< (QDebug dbg, axlPlane &plane)
 
QDebug operator<< (QDebug dbg, axlPlane *plane)
 

Additional Inherited Members

- 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 axlPlane defines 3D planes.

This class enables to represent and manipulate 3D planes.

Example:

axlPoint *point = new axlPoint(0.0, 0.0, 0.0)
axlPoint *normal = new axlPoint(1.0, 0.0, 0.0)
axlPlane *A = new axlPlane(point, normal);

Definition at line 34 of file axlPlane.h.

Constructor & Destructor Documentation

axlPlane::axlPlane ( QObject *  parent = 0)

Constructs a axel plane of with point and normal vector 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 plane with no parent.

Definition at line 47 of file axlPlane.cpp.

axlPlane::axlPlane ( axlPoint point,
axlPoint normal,
QObject *  parent = 0 
)

Constructs a axel plane of two axlPoint, one for a point of on the plane point and one for the normal of the plane normal 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 63 of file axlPlane.cpp.

axlPlane::axlPlane ( const axlPoint point,
const axlPoint normal,
QObject *  parent = 0 
)

Constructs an axel plane from two axlPoint, one for a point of on the plane point and one for the normal of the plane normal 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 77 of file axlPlane.cpp.

axlPlane::axlPlane ( const axlPlane other)

Constructs a copy of other with same point and normal.

Definition at line 89 of file axlPlane.cpp.

axlPlane::~axlPlane ( void  )

Destroys the axel plane.

Definition at line 101 of file axlPlane.cpp.

Member Function Documentation

QVariantList axlPlane::convertDataToQVariant ( void  ) const
virtual

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

Reimplemented from axlAbstractData.

Definition at line 258 of file axlPlane.cpp.

int axlPlane::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 272 of file axlPlane.cpp.

QString axlPlane::description ( void  ) const
virtual

Definition at line 232 of file axlPlane.cpp.

QString axlPlane::identifier ( void  ) const
virtual

Definition at line 239 of file axlPlane.cpp.

axlPoint * axlPlane::normal ( void  ) const

Returns the normal of the plane.

Definition at line 142 of file axlPlane.cpp.

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

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

Definition at line 121 of file axlPlane.cpp.

axlPoint * axlPlane::point ( void  ) const

Returns the point of the plane.

Definition at line 133 of file axlPlane.cpp.

void axlPlane::setNormal ( axlPoint normal)

Change second point of this plane.

Definition at line 181 of file axlPlane.cpp.

void axlPlane::setNormal ( double *  normal)

Definition at line 187 of file axlPlane.cpp.

void axlPlane::setPoint ( axlPoint point)

Change first point of this plane.

Definition at line 163 of file axlPlane.cpp.

void axlPlane::setPoint ( double *  p)

Definition at line 169 of file axlPlane.cpp.

void axlPlane::setValues ( axlPoint point,
axlPoint normal 
)

Change first point and second point of this plane.

Definition at line 152 of file axlPlane.cpp.

void axlPlane::touchNormal ( axlPoint  normal)

Definition at line 201 of file axlPlane.cpp.

void axlPlane::touchPoint ( axlPoint  point)

Definition at line 195 of file axlPlane.cpp.

Friends And Related Function Documentation

QDebug operator<< ( QDebug  dbg,
axlPlane  plane 
)
friend

Definition at line 211 of file axlPlane.cpp.

QDebug operator<< ( QDebug  dbg,
axlPlane plane 
)
friend

Definition at line 218 of file axlPlane.cpp.

QDebug operator<< ( QDebug  dbg,
axlPlane plane 
)
friend

Definition at line 225 of file axlPlane.cpp.

Property Documentation

axlPoint axlPlane::normal
readwrite

Definition at line 37 of file axlPlane.h.

axlPoint axlPlane::point
readwrite

Definition at line 37 of file axlPlane.h.


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