castor3d::Ray Class Reference

#include <Ray.hpp>

Public Member Functions
C3D_API	Ray (castor::Position const &point, Camera const &camera)
	Constructor from mouse coordinates and a camera.
C3D_API	Ray (int x, int y, Camera const &camera)
	Constructor from mouse coordinates and a camera.
C3D_API	Ray (castor::Point3f const &origin, castor::Point3f const &direction)
	Constructor from origin and direction.
C3D_API castor::Intersection	intersects (castor::Point3f const &pt1, castor::Point3f const &pt2, castor::Point3f const &pt3, float &distance) const
	Tells if the ray intersects the given triangle of vertices.
C3D_API castor::Intersection	intersects (Face const &face, castor::Matrix4x4f const &transform, Submesh const &submesh, float &distance) const
	Tells if the ray intersects the given face.
C3D_API castor::Intersection	intersects (castor::Point3f const &point, float &distance) const
	Tells if the vertex is on the ray.
C3D_API castor::Intersection	intersects (castor::BoundingBox const &box, float &distance) const
	Tells if the ray intersects the given Combo box.
C3D_API castor::Intersection	intersects (castor::BoundingSphere const &sphere, float &distance) const
	Tells if the ray intersects the given Sphere.
C3D_API castor::Intersection	intersects (GeometryRPtr geometry, Face &nearestFace, SubmeshRPtr &nearestSubmesh, float &distance) const
	Tells if the ray intersects the given Geometry.
C3D_API bool	projectVertex (castor::Point3f const &point, castor::Point3f &result) const
	Projects the given vertex on the ray.

Public Attributes
castor::Point3f	m_origin
castor::Point3f	m_direction

Constructor & Destructor Documentation

Ray() [1/3]

C3D_API castor3d::Ray::Ray	(	castor::Position const &	point,
		Camera const &	camera )

Constructor from mouse coordinates and a camera.

Parameters

[in]	point	The mouse coordinates.
[in]	camera	The camera from which to retrieve the ray.

Ray() [2/3]

C3D_API castor3d::Ray::Ray	(	int	x,
		int	y,
		Camera const &	camera )

Constructor from mouse coordinates and a camera.

Parameters

[in]	x,y	The mouse coordinates.
[in]	camera	The camera from which to retrieve the ray.

Ray() [3/3]

C3D_API castor3d::Ray::Ray	(	castor::Point3f const &	origin,
		castor::Point3f const &	direction )

Constructor from origin and direction.

Parameters

[in]	origin	The origin of the ray.
[in]	direction	The direction of the ray.

Member Function Documentation

intersects() [1/6]

C3D_API castor::Intersection castor3d::Ray::intersects	(	castor::BoundingBox const &	box,
		float &	distance ) const

Tells if the ray intersects the given Combo box.

Parameters

[in]	box	The box to test.
[out]	distance	Receives the distance.

Returns

castor::Intersection::eIn or castor::Intersection::eOut.

intersects() [2/6]

C3D_API castor::Intersection castor3d::Ray::intersects	(	castor::BoundingSphere const &	sphere,
		float &	distance ) const

Tells if the ray intersects the given Sphere.

Parameters

[in]	sphere	The sphere to test.
[out]	distance	Receives the distance.

Returns

castor::Intersection::eIn or castor::Intersection::eOut.

intersects() [3/6]

C3D_API castor::Intersection castor3d::Ray::intersects	(	castor::Point3f const &	point,
		float &	distance ) const

Tells if the vertex is on the ray.

Parameters

[in]	point	The vertex to test.
[out]	distance	Receives the distance.

Returns

castor::Intersection::eIn or castor::Intersection::eOut.

intersects() [4/6]

C3D_API castor::Intersection castor3d::Ray::intersects	(	castor::Point3f const &	pt1,
		castor::Point3f const &	pt2,
		castor::Point3f const &	pt3,
		float &	distance ) const

Tells if the ray intersects the given triangle of vertices.

Parameters

[in]	pt1	The first triangle vertex.
[in]	pt2	The second triangle vertex.
[in]	pt3	The third triangle vertex.
[out]	distance	Receives the distance.

Returns

castor::Intersection::eIn or castor::Intersection::eOut.

intersects() [5/6]

C3D_API castor::Intersection castor3d::Ray::intersects	(	Face const &	face,
		castor::Matrix4x4f const &	transform,
		Submesh const &	submesh,
		float &	distance ) const

Tells if the ray intersects the given face.

Parameters

[in]	face	The face to test.
[in]	transform	The face's vertex transformation matrix.
[in]	submesh	The submesh holding the face.
[out]	distance	Receives the distance.

Returns

castor::Intersection::eIn or castor::Intersection::eOut.

intersects() [6/6]

C3D_API castor::Intersection castor3d::Ray::intersects	(	GeometryRPtr	geometry,
		Face &	nearestFace,
		SubmeshRPtr &	nearestSubmesh,
		float &	distance ) const

Tells if the ray intersects the given Geometry.

Parameters

[in]	geometry	The geometry to test.
[out]	nearestFace	Receives the intersected face.
[out]	nearestSubmesh	Receives the intersected submesh.
[out]	distance	Receives the distance.

Returns

castor::Intersection::eIn or castor::Intersection::eOut.

projectVertex()

C3D_API bool castor3d::Ray::projectVertex	(	castor::Point3f const &	point,
		castor::Point3f &	result ) const

Projects the given vertex on the ray.

Parameters

[in]	point	The vertex we want to project.
[out]	result	The projecion result.

Returns

true if the vertex can be projected on the ray, false if not.

Member Data Documentation

m_direction

castor::Point3f castor3d::Ray::m_direction

The ray direction.

m_origin

castor::Point3f castor3d::Ray::m_origin

The ray origin.

---

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

• Castor3D/Render/Ray.hpp