PySide6.Qt3DRender.Qt3DRender.QRayCasterHit

class QRayCasterHit

Details of a hit when casting a ray through a model. More…

Synopsis

Properties

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

QRayCasterHit contains the details of a successful hit when casting a ray through a model using a QRayCaster or QScreenRayCaster component.

See also

QRayCaster QScreenRayCaster QPickingSettings

class HitType

Specifies type of hit that was returned. This is controlled using QPickingSettings .

Constant

Description

Qt3DRender.QRayCasterHit.TriangleHit

The picked primitive was a triangle and the vertex indices refer to the three points making up the triangle

Qt3DRender.QRayCasterHit.LineHit

The picked primitive was a line segment, and the first two vertices refer to the two points making up the line

Qt3DRender.QRayCasterHit.PointHit

The picked primitive was a single point; all 3 vertex indices will be undefined

Qt3DRender.QRayCasterHit.EntityHit

Only the bounding volume was considered; the primitive and vertex indices will be undefined

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property distanceᅟ: float
Access functions:
property entityᅟ: QEntity
Access functions:
property entityIdᅟ: QNodeId
Access functions:
property localIntersectionᅟ: QVector3D
Access functions:
property primitiveIndexᅟ: int
Access functions:
property typeᅟ: Qt3DRender.QRayCasterHit.HitType
Access functions:
property vertex1Indexᅟ: int
Access functions:
property vertex2Indexᅟ: int
Access functions:
property vertex3Indexᅟ: int
Access functions:
property worldIntersectionᅟ: QVector3D
Access functions:
__init__()
__init__(other)
Parameters:

other – QRayCasterHit

__init__(type, id, distance, localIntersect, worldIntersect, primitiveIndex, v1, v2, v3)
Parameters:

  • type – HitType

  • id – QNodeId

  • distance – float

  • localIntersect – QVector3D

  • worldIntersect – QVector3D

  • primitiveIndex – int

  • v1 – int

  • v2 – int

  • v3 – int

distance()
Return type:

float

Returns the distance between the origin of the ray and the intersection point

Getter of property distanceᅟ .

entity()
Return type:

QEntity

Returns a pointer to the entity that was hit

Getter of property entityᅟ .

entityId()
Return type:

QNodeId

Returns the id of the entity that was hit

Getter of property entityIdᅟ .

localIntersection()
Return type:

QVector3D

Returns the coordinates of the intersection point in the entity’s coordinate system

Getter of property localIntersectionᅟ .

primitiveIndex()
Return type:

int

Returns the index of the picked primitive

Getter of property primitiveIndexᅟ .

toString()
Return type:

str

type()
Return type:

HitType

Returns the type of the hit

Getter of property typeᅟ .

vertex1Index()
Return type:

int

Returns the index of the first vertex of the picked primitive

Getter of property vertex1Indexᅟ .

vertex2Index()
Return type:

int

Returns the index of the second vertex of the picked primitive

Getter of property vertex2Indexᅟ .

vertex3Index()
Return type:

int

Returns the index of the third vertex of the picked primitive

Getter of property vertex3Indexᅟ .

worldIntersection()
Return type:

QVector3D

Returns the coordinates of the intersection point in the model’s coordinate system

Getter of property worldIntersectionᅟ .