QGIS/python/core/auto_generated/qgsvector3d.sip.in

152 lines
4.0 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsvector3d.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsVector3D
{
%Docstring(signature="appended")
Class for storage of 3D vectors similar to QVector3D, with the difference that it uses double precision
instead of single precision floating point numbers.
%End
%TypeHeaderCode
#include "qgsvector3d.h"
%End
public:
QgsVector3D();
%Docstring
Constructs a null vector
%End
QgsVector3D( double x, double y, double z );
%Docstring
Constructs a vector from given coordinates
%End
QgsVector3D( const QVector3D &v );
%Docstring
Constructs a vector from single-precision QVector3D
%End
bool isNull() const /HoldGIL/;
%Docstring
Returns ``True`` if all three coordinates are zero
%End
double x() const /HoldGIL/;
%Docstring
Returns X coordinate
%End
double y() const /HoldGIL/;
%Docstring
Returns Y coordinate
%End
double z() const /HoldGIL/;
%Docstring
Returns Z coordinate
%End
void setX( double x ) /HoldGIL/;
%Docstring
Sets X coordinate
.. versionadded:: 3.34
%End
void setY( double y ) /HoldGIL/;
%Docstring
Sets Y coordinate
.. versionadded:: 3.34
%End
void setZ( double z ) /HoldGIL/;
%Docstring
Sets Z coordinate
.. versionadded:: 3.34
%End
void set( double x, double y, double z ) /HoldGIL/;
%Docstring
Sets vector coordinates
%End
bool operator==( const QgsVector3D &other ) const /HoldGIL/;
bool operator!=( const QgsVector3D &other ) const /HoldGIL/;
QgsVector3D operator+( const QgsVector3D &other ) const /HoldGIL/;
QgsVector3D operator-( const QgsVector3D &other ) const /HoldGIL/;
QgsVector3D operator *( const double factor ) const /HoldGIL/;
QgsVector3D operator /( const double factor ) const /HoldGIL/;
static double dotProduct( const QgsVector3D &v1, const QgsVector3D &v2 ) /HoldGIL/;
%Docstring
Returns the dot product of two vectors
%End
static QgsVector3D crossProduct( const QgsVector3D &v1, const QgsVector3D &v2 ) /HoldGIL/;
%Docstring
Returns the cross product of two vectors
%End
double length() const /HoldGIL/;
%Docstring
Returns the length of the vector
%End
void normalize() /HoldGIL/;
%Docstring
Normalizes the current vector in place.
%End
double distance( const QgsVector3D &other ) const /HoldGIL/;
%Docstring
Returns the distance with the ``other`` QgsVector3D
%End
static QgsVector3D perpendicularPoint( const QgsVector3D &v1, const QgsVector3D &v2, const QgsVector3D &vp ) /HoldGIL/;
%Docstring
Returns the perpendicular point of vector ``vp`` from [``v1`` - ``v2``]
%End
QString toString( int precision = 17 ) const /HoldGIL/;
%Docstring
Returns a string representation of the 3D vector.
Members will be truncated to the specified ``precision``.
%End
QVector3D toVector3D() const /HoldGIL/;
%Docstring
Converts the current object to QVector3D
.. warning::
the conversion may decrease the accuracy (double to float values conversion)
.. versionadded:: 3.24
%End
SIP_PYOBJECT __repr__();
%MethodCode
QString str = QStringLiteral( "<QgsVector3D: %1>" ).arg( sipCpp->toString() );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsvector3d.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/