trax::Arc Struct Reference

A plane arc. More...

#include <C:/Trend/Development/Trax3/Code/trax/Curve.h>

Inheritance diagram for trax::Arc:

Classes
struct	Data
	Data definig the curve. More...

Public Member Functions
virtual spat::Matrix< One, 2, 3 >	Jacobian (Length s) const =0
	Returns the partial derivatives of the position P to the curves radius r and parameter s in a matrix, customly called a 'Jacobian matrix'.
virtual common::Interval< Length >	Create (const Data &data)=0
	Create the curve from data set for which it is guaranteed, that no calculational drift will happen e.g. in write/read cycles.
virtual const Data &	GetData () const noexcept=0
	Retrieves the data to construct this curve type. A roundtrip is guaranteed to be invariant.
Public Member Functions inherited from trax::Curve
virtual const char *	TypeName () const noexcept=0
virtual CurveType	GetCurveType () const noexcept=0
virtual bool	IsValid () const noexcept=0
virtual AnglePerLength	Curvature (Length s) const =0
virtual AnglePerLength	Torsion (Length s) const =0
virtual bool	IsFlat () const noexcept=0
virtual void	Transition (Length s, spat::Position< Length > &pos) const =0
	Copies the 3D Position at the specified location to pos.
virtual void	Transition (Length s, spat::Vector< One > &tan) const =0
	Copies the 3D tangential vector at the specified location to tan.
virtual void	Transition (Length s, spat::VectorBundle< Length, One > &bundle) const =0
	Copies the 3D Position and tangential vector at the specified location to bundle.
virtual void	Transition (Length s, spat::VectorBundle2< Length, One > &bundle) const =0
	Copies the 3D Position and tangential and normal vectors at the specified location to bundle.
virtual void	Transition (Length s, spat::Frame< Length, One > &frame) const =0
	Copies the 3D TBN-Frame at the specified location to frame.
virtual std::vector< Length >	ZeroSet () const =0
	Returns a list of parameters at which the normal vector flips from one side to the other.
virtual common::Interval< Length >	Range () const =0
virtual spat::Vector< One >	LocalUp () const =0
	Gives the Curve's idiosyncratic up direction. Some curves maintain some idea about where they have their upside, either because of their form (e.g Helix) or because it is extra defined (e.g. for Line). Some curves maintain no such notion (e.g. many Cubics).
virtual spat::Frame< Length, One >	GetCurveLocalTransformation () const =0
virtual std::unique_ptr< Curve >	Clone () const =0
	make an exact copy of this curve.
virtual bool	Mirror (const spat::VectorBundle< Length, One > &mirrorPlane)=0
	Make a Curve with mirrored geometry (but of course one thet returns right handed frames).
virtual bool	Equals (const Curve &toCurve, common::Interval< Length > range, Length epsilon_length=epsilon__length, Angle epsilon_angle=epsilon__angle) const =0
	Comparison.
	Curve (Curve &&)=delete
Curve &	operator= (const Curve &)=delete
Curve &	operator= (Curve &&)=delete

Static Public Member Functions
static dclspc std::unique_ptr< Arc >	Make () noexcept
	Makes a Arc object.

Additional Inherited Members
Public Types inherited from trax::Curve
enum class	CurveType {   none = 0 , Line , Arc , Helix ,   LineP , ArcP , HelixP , Clothoid ,   Cubic , Spline , Rotator , RotatorWithOffset ,   RotatorChain , PolygonalChain , SampledCurve , Parallel ,   EEPCurve , EEPResidual , EEPAlternative , Unknown ,   UserDefined }
	Curve type identification values. More...
Protected Member Functions inherited from trax::Curve
	Curve (const Curve &)=default

Detailed Description

A plane arc.

An Arc around the origin that starts at Origin<Length> + Radius() * Ex<One> and runs in Ey<One> axis direction, bending towards -Ex<One>. Normal points to origin, binormal along Ez<One>.

/// 
///              ( cos(ks) )
/// P(s) = 1/k * ( sin(ks) )
///              (    0    )
/// 
/// 

Member Function Documentation

Create()

virtual common::Interval< Length > trax::Arc::Create ( const Data & data )

pure virtual

Create the curve from data set for which it is guaranteed, that no calculational drift will happen e.g. in write/read cycles.

Exceptions

std::invalid_argument

if the curve can not created from the input values.

Jacobian()

virtual spat::Matrix< One, 2, 3 > trax::Arc::Jacobian ( Length s ) const

pure virtual

Returns the partial derivatives of the position P to the curves radius r and parameter s in a matrix, customly called a 'Jacobian matrix'.

For calculation

See also

Helix::Jacobian.

Parameters

s	parameter to evaluate the derivatives at.

Returns

dP/dr and dP/ds will make up the 0th and 1st column of the matrix.

Exceptions

std::bad_alloc

on memory exhaustion.

---

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

• C:/Trend/Development/Trax3/Code/trax/Curve.h