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

#include <CeresEngine/Mesh/Generator/HelixPath.hpp>

Public Types
using	Edges = typename Impl::Edges

using	Vertices = typename Impl::Vertices

Public Member Functions
	HelixPath (double radius=1.0, double size=1.0, int segments=32, double start=0.0, double sweep=radians(720.0))

Edges	edges () const noexcept

Vertices	vertices () const noexcept

Private Types
using	Impl = ParametricPath

Private Attributes
Impl	mParametricPath

Detailed Description

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

Member Typedef Documentation

◆ Edges

using CeresEngine::MeshGenerator::HelixPath::Edges = typename Impl::Edges

◆ Impl

using CeresEngine::MeshGenerator::HelixPath::Impl = ParametricPath

private

◆ Vertices

using CeresEngine::MeshGenerator::HelixPath::Vertices = typename Impl::Vertices

Constructor & Destructor Documentation

◆ HelixPath()

CeresEngine::MeshGenerator::HelixPath::HelixPath	(	double	radius = `1.0`,
		double	size = `1.0`,
		int	segments = `32`,
		double	start = `0.0`,
		double	sweep = `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.

Member Function Documentation

◆ edges()

Edges CeresEngine::MeshGenerator::HelixPath::edges ( ) const

inlinenoexcept

◆ vertices()

Vertices CeresEngine::MeshGenerator::HelixPath::vertices ( ) const

inlinenoexcept

Member Data Documentation

◆ mParametricPath

Impl CeresEngine::MeshGenerator::HelixPath::mParametricPath