File: qgsray3d.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (89 lines) | stat: -rw-r--r-- 2,466 bytes parent folder | download | duplicates (14)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/geometry/qgsray3d.h                                         *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/



class QgsRay3D
{
%Docstring(signature="appended")
A representation of a ray in 3D.

A ray is composed of an origin point (the start of the ray) and a
direction vector.

.. versionadded:: 3.18
%End

%TypeHeaderCode
#include "qgsray3d.h"
%End
  public:

    QgsRay3D( const QVector3D &origin, const QVector3D &direction );
%Docstring
Constructor

.. note::

   : the direction is automatically normalized
%End

    QVector3D origin() const;
%Docstring
Returns the origin of the ray

.. seealso:: :py:func:`setOrigin`
%End

    QVector3D direction() const;
%Docstring
Returns the direction of the ray see :py:func:`~QgsRay3D.setDirection`
%End

    void setOrigin( const QVector3D &origin );
%Docstring
Sets the origin of the ray

.. seealso:: :py:func:`origin`
%End

    void setDirection( const QVector3D direction );
%Docstring
Sets the direction of the ray

.. note::

   : the direction is automatically normalized

.. seealso:: :py:func:`direction`
%End

    QVector3D projectedPoint( const QVector3D &point ) const;
%Docstring
Returns the projection of the point on the ray (which is the closest
point of the ray to ``point``)
%End
    bool isInFront( const QVector3D &point ) const;
%Docstring
Checks whether the point is in front of the ray
%End
    double angleToPoint( const QVector3D &point ) const;
%Docstring
Returns the angle between the ray and the vector from the ray's origin
and the point ``point``
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/geometry/qgsray3d.h                                         *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/