Kanzi  3.9.6
Kanzi Engine API
kanzi::RayBoxIntersection Struct Reference

Stores the result of an intersection between a box and a ray. More...

#include <kanzi/core/math/ray.hpp>

Public Member Functions

 RayBoxIntersection ()
 Default constructor. More...
 
 RayBoxIntersection (bool hit, float dist, Vector3 point)
 Constructor. More...
 

Public Attributes

float distance
 The distance between the point of intersection and the origin of a ray. More...
 
Vector3 hitPoint
 The point of intersection between a ray and a box in object space. More...
 
bool isHit
 Intersection flag. Whether a ray intersects with a box. More...
 

Detailed Description

Stores the result of an intersection between a box and a ray.

Constructor & Destructor Documentation

◆ RayBoxIntersection() [1/2]

kanzi::RayBoxIntersection::RayBoxIntersection ( )
inlineexplicit

Default constructor.

◆ RayBoxIntersection() [2/2]

kanzi::RayBoxIntersection::RayBoxIntersection ( bool  hit,
float  dist,
Vector3  point 
)
inlineexplicit

Constructor.

Parameters
hitIntersection flag. If a ray intersects with a box, true, otherwise false.
distThe distance between the point of intersection and the origin of a ray.
pointThe point of intersection between a ray and a box.

Member Data Documentation

◆ isHit

bool kanzi::RayBoxIntersection::isHit

Intersection flag. Whether a ray intersects with a box.

◆ distance

float kanzi::RayBoxIntersection::distance

The distance between the point of intersection and the origin of a ray.

◆ hitPoint

Vector3 kanzi::RayBoxIntersection::hitPoint

The point of intersection between a ray and a box in object space.


The documentation for this struct was generated from the following file: