generator::helix_path_t Class Reference

#include <helix_path.hpp>

Public Types
using	edges_t = typename impl_t::edges_t
using	vertices_t = typename impl_t::vertices_t

Public Member Functions
	helix_path_t (double radius=1.0, double size=1.0, int segments=32, double start=0.0, double sweep=gml::radians(720.0))
edges_t	edges () const noexcept
vertices_t	vertices () const noexcept

Detailed Description

A helix cented at origin aligned along the z-axis.

Definition at line 11 of file helix_path.hpp.

Member Typedef Documentation

edges_t

using generator::helix_path_t::edges_t = typename impl_t::edges_t

Definition at line 29 of file helix_path.hpp.

vertices_t

using generator::helix_path_t::vertices_t = typename impl_t::vertices_t

Definition at line 36 of file helix_path.hpp.

Constructor & Destructor Documentation

helix_path_t()

helix_path_t::helix_path_t	(	double	radius = 1.0,
		double	size = 1.0,
		int	segments = 32,
		double	start = 0.0,
		double	sweep = gml::radians(720.0) )

Parameters

radius	Radius from the z-axis
size	Half of the length along the z-axis.
segments	Number of subdivisions along the path.
start	Counterclockwise angle around the z-axis relative to the x-axis.
sweep	Counterclockwise angle around the z-axis.

Definition at line 5 of file helix_path.cpp.

Member Function Documentation

edges()

edges_t generator::helix_path_t::edges ( ) const

inlinenoexcept

Definition at line 31 of file helix_path.hpp.

vertices()

vertices_t generator::helix_path_t::vertices ( ) const

inlinenoexcept

Definition at line 38 of file helix_path.hpp.

---

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

• C:/Workspace/github/UnravelEngine/UnravelEngine/engine/engine/rendering/generator/helix_path.hpp
• C:/Workspace/github/UnravelEngine/UnravelEngine/engine/engine/rendering/generator/helix_path.cpp