Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
shammath::RingRay< T > Struct Template Reference

Ring ray representation for intersection testing. More...

#include <shammath/include/shammath/AABB.hpp>

+ Collaboration diagram for shammath::RingRay< T >:

Public Types

using T_prop = shambase::VectorProperties< T >
 
using Tscal = typename T_prop::component_type
 

Public Member Functions

get_ez ()
 
 RingRay (T center, Tscal radius, T e_x, T e_y)
 Construct a ring ray from center, e_x, and e_y.
 

Public Attributes

center
 
Tscal radius
 
e_x
 
e_y
 

Detailed Description

template<class T>
struct shammath::RingRay< T >

Ring ray representation for intersection testing.

A = {center + radius * (e_x * cos(theta) + e_y * sin(theta)) | theta in [0, 2*pi]}

Template Parameters
TVector type for coordinates

Definition at line 67 of file AABB.hpp.

Member Typedef Documentation

◆ T_prop

template<class T >
using shammath::RingRay< T >::T_prop = shambase::VectorProperties<T>

Definition at line 68 of file AABB.hpp.

◆ Tscal

template<class T >
using shammath::RingRay< T >::Tscal = typename T_prop::component_type

Definition at line 69 of file AABB.hpp.

Constructor & Destructor Documentation

◆ RingRay()

template<class T >
shammath::RingRay< T >::RingRay ( center,
Tscal  radius,
e_x,
e_y 
)
inline

Construct a ring ray from center, e_x, and e_y.

Parameters
centerCenter of the ring
e_xUnit vector along the x-axis of the ring
e_yUnit vector along the y-axis of the ring

Definition at line 84 of file AABB.hpp.

Member Function Documentation

◆ get_ez()

template<class T >
T shammath::RingRay< T >::get_ez ( )
inline

Definition at line 76 of file AABB.hpp.

Member Data Documentation

◆ center

template<class T >
T shammath::RingRay< T >::center

Definition at line 71 of file AABB.hpp.

◆ e_x

template<class T >
T shammath::RingRay< T >::e_x

Definition at line 73 of file AABB.hpp.

◆ e_y

template<class T >
T shammath::RingRay< T >::e_y

Definition at line 74 of file AABB.hpp.

◆ radius

template<class T >
Tscal shammath::RingRay< T >::radius

Definition at line 72 of file AABB.hpp.


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