#include <PBasicSphere.h>

Inheritance diagram for ph::PBasicSphere:

Public Member Functions
	PBasicSphere (real radius)

void	calcHitDetail (const Ray &ray, HitProbe &probe, HitDetail *out_detail) const override=0
	Calculates properties of a hit, such as coordinates and normal.

bool	isIntersecting (const Ray &ray, HitProbe &probe) const override
	Determine whether a given ray hits the object.

bool	reintersect (const Ray &ray, HitProbe &probe, const Ray &srcRay, HitProbe &srcProbe) const override
	Intersect the intersected object again with a different ray.

bool	mayOverlapVolume (const math::AABB3D &volume) const override
	Conservatively checks whether this object overlaps a volume.

math::AABB3D	calcAABB () const override
	Calculates Axis-Aligned Bounding Box (AABB) of itself.

real	calcExtendedArea () const override
	Calculates the area extended by this primitive. The term "extended" implies single-sided, e.g., a triangle's extended area is half the absolute value of the cross product of its two edge vectors. To treat it as double-sided, you need to multiply the result by 2 manually.

real	getRadius () const

real	getRcpRadius () const

Public Member Functions inherited from ph::Primitive
virtual void	genPosSample (PrimitivePosSampleQuery &query, SampleFlow &sampleFlow, HitProbe &probe) const
	Generates a sample point on the surface of this primitive.

virtual void	calcPosPdf (PrimitivePosPdfQuery &query) const
	Given a point on the surface of this primitive, calculates the PDF of sampling this point.

virtual const PrimitiveMetadata *	getMetadata () const

Public Member Functions inherited from ph::Intersectable
virtual	~Intersectable ()=default

virtual bool	isOccluding (const Ray &ray) const
	Determines whether this object blocks the ray.

Protected Member Functions
auto	getRefinedSurfaceAndNormal (const math::Vector3R &srcSurface) const -> std::pair< math::Vector3R, math::Vector3R >

Constructor & Destructor Documentation

◆ PBasicSphere()

ph::PBasicSphere::PBasicSphere ( real radius )

explicit

Member Function Documentation

◆ calcAABB()

math::AABB3D ph::PBasicSphere::calcAABB ( ) const

overridevirtual

Calculates Axis-Aligned Bounding Box (AABB) of itself.

Implements ph::Primitive.

Reimplemented in ph::PLatLongEnvSphere.

◆ calcExtendedArea()

real ph::PBasicSphere::calcExtendedArea ( ) const

overridevirtual

Calculates the area extended by this primitive. The term "extended" implies single-sided, e.g., a triangle's extended area is half the absolute value of the cross product of its two edge vectors. To treat it as double-sided, you need to multiply the result by 2 manually.

Returns: The extended area of this primitive. A zero return value means the concept of extended area does not apply to this primitive.

Reimplemented from ph::Primitive.

Reimplemented in ph::PLatLongEnvSphere.

◆ calcHitDetail()

void ph::PBasicSphere::calcHitDetail	(	const Ray &	ray,
		HitProbe &	probe,
		HitDetail *	out_detail ) const

overridepure virtual

Calculates properties of a hit, such as coordinates and normal.

This method calculates a detailed description of a hit from the ray and probe involved in a hit event. For example, the ray and probe used for calling isIntersecting() can be the inputs of this method (if an intersection is found). The process of calculating intersection detail will destroy the input probe.

Parameters

ray	The ray from a hit event.
probe	The probe from a hit event. The process of detail calculation will destroy the probe.
out_detail	Stores the calculated details. This method calculates the essential details only. Some information such as coordinate bases will only be available if specifically requested afterwards (for an example, see `HitDetail::computeBases()`).

Note: See Primitive for more methods that can generate a hit event.

Warning: This method will destroy the probe.

Implements ph::Primitive.

Implemented in ph::PLatLong01Sphere, and ph::PLatLongEnvSphere.

◆ getRadius()

real ph::PBasicSphere::getRadius ( ) const

inline

◆ getRcpRadius()

real ph::PBasicSphere::getRcpRadius ( ) const

inline

◆ getRefinedSurfaceAndNormal()

auto ph::PBasicSphere::getRefinedSurfaceAndNormal ( const math::Vector3R & srcSurface ) const -> std::pair<math::Vector3R, math::Vector3R>

inlineprotected

Get refined surface position since the original coordinates may contain large numerical error due to far ray, extreme-sized sphere, etc.

Returns: Refined surface position and the normal of that position. Normal is pointing away from the sphere.

◆ isIntersecting()

bool ph::PBasicSphere::isIntersecting	(	const Ray &	ray,
		HitProbe &	probe ) const

overridevirtual

Determine whether a given ray hits the object.

Checks whether the specified ray intersects this intersectable. If there is an intersection, true is returned and a brief hit report is stored inside the probe. If there is no intersection, false is returned and the state of the probe is undefined. ray and probe can be used for obtaining hit detail if an intersection is found.

Note: Generates hit event (with ray and probe).

Implements ph::Primitive.

Reimplemented in ph::PLatLongEnvSphere.

◆ mayOverlapVolume()

bool ph::PBasicSphere::mayOverlapVolume ( const math::AABB3D & volume ) const

overridevirtual

Conservatively checks whether this object overlaps a volume.

By conservative, it means true can be returned even though the object does not overlap the volume; but if it actually does, true must be returned. The default implementation performs conservative intersecting test using the AABB calculated by calcAABB(). Although false-positives are allowed for this method, providing an implementation with higher accuracy is benefitial for many algorithms used by the renderer. The test generally considers the underlying shape as hollow (for closed shape), while the volume is solid.

Reimplemented from ph::Intersectable.

Reimplemented in ph::PLatLongEnvSphere.

◆ reintersect()

bool ph::PBasicSphere::reintersect	(	const Ray &	ray,
		HitProbe &	probe,
		const Ray &	srcRay,
		HitProbe &	srcProbe ) const

overridevirtual

Intersect the intersected object again with a different ray.

This method is different to isIntersecting(const Ray, HitProbe&) const. Given srcRay and srcProbe, this method performs an intersection test against the chain of intersectables recorded in srcProbe (so it is impossible to "discover" new intersectables with this method). Taking BVH as an example, the implementation may only record the intersected object in the probe so this method can bypass the entire BVH traversal.

Parameters

ray	The ray to test for intersection.
probe	The probe to record the intersection.
srcRay	The ray from a previous hit event.
srcProbe	The probe from a hit event. The process of re-intersect will destroy the probe.

Returns: Whether ray intersects the object.

Note: Generates hit event (with ray and probe).

Warning: This method will destroy srcProbe.

Implements ph::Primitive.

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

Source/Core/Intersection/PBasicSphere.h
Source/Core/Intersection/PBasicSphere.cpp

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

◆ PBasicSphere()

Member Function Documentation

◆ calcAABB()

◆ calcExtendedArea()

◆ calcHitDetail()

◆ getRadius()

◆ getRcpRadius()

◆ getRefinedSurfaceAndNormal()

◆ isIntersecting()

◆ mayOverlapVolume()

◆ reintersect()