spat::VectorBundle2< Valtype, ValtypeT > Struct Template Reference

Implements a tangential space bundle. More...

#include <C:/Trend/Development/Trax3/Code/spat/VectorBundle2.h>

Inheritance diagram for spat::VectorBundle2< Valtype, ValtypeT >:

Public Member Functions
	operator VectorBundle< Valtype, ValtypeT > () const noexcept
	Implicit conversion.
Valtype *	ptr () noexcept
	Pointer accessor for direct copying.
const Valtype *	ptr () const noexcept
	Pointer accessor for direct copying.
VectorBundle2 &	Init () noexcept
	Initializes the VectorBundle2 structure to position zero and the vectors to standard right-handed unit vector system.
VectorBundle2 &	Init (const VectorBundle< Valtype, ValtypeT > &bundle, const Vector< ValtypeT > &up) noexcept
	Initializes the VectorBundle2 structure to vb and calculates nor as to be orthogonal to up.
VectorBundle2 &	Normalize () noexcept
	Makes the vectors unit vectors.
VectorBundle2 &	OrthoNormalize () noexcept
	Normalizes the vectors preserving the direction of T as is. It then adjusts Nor and Bin in a way to form a orthogonal frame.
bool	IsOrthoNormal (ValtypeT epsilon_length=2 *std::numeric_limits< ValtypeT >::epsilon(), ValtypeT epsilon_angle=2 *std::numeric_limits< ValtypeT >::epsilon()) const noexcept
VectorBundle2 &	TransportTo (Valtype d) noexcept
	Moves the Frame by d in direction T.
VectorBundle2 &	TransportTo (const Position2D< Valtype > &p) noexcept
	Transport this Frame to p.
VectorBundle2 &	TransportTan (Valtype d) noexcept
	Moves the Frame by d in direction T.
VectorBundle2 &	TransportNor (Valtype d) noexcept
	Moves the Frame by d in direction N.
VectorBundle2 &	Rotate (const Vector< ValtypeT > &nr, ValtypeT angle) noexcept
	Rotate the vectors around nr with angle in radiants.
VectorBundle2 &	Rotate (const Vector< ValtypeT > &r) noexcept
	Rotate the vectors around r with angle r.Length() in radiants.
VectorBundle2 &	RotateTan (ValtypeT angle) noexcept
	Rotates the vectors around the tan vector.
VectorBundle2 &	RotateNor (ValtypeT angle) noexcept
	Rotates the vectors around the nor vector.
constexpr bool	Equals (const VectorBundle2 &bundle, Valtype epsilon_length=std::numeric_limits< Valtype >::epsilon(), ValtypeT epsilon_lengthT=std::numeric_limits< ValtypeT >::epsilon()) const noexcept
	Comparison within some ranges.
template<typename Valtype2>
VectorBundle2< Valtype, ValtypeT > &	operator= (const Valtype2 *pVal) noexcept
Construction
Parameters x y z dx dy dz pos tan nor bundle rot frame
constexpr	VectorBundle2 () noexcept=default
	Does not initialize the members.
constexpr	VectorBundle2 (Valtype x, Valtype y, Valtype z, ValtypeT tx, ValtypeT ty, ValtypeT tz, ValtypeT nx, ValtypeT ny, ValtypeT nz) noexcept
	Does not initialize the members.
constexpr	VectorBundle2 (const Position< Valtype > &pos, const Vector< ValtypeT > &tan, const Vector< ValtypeT > &nor) noexcept
	Does not initialize the members.
constexpr	VectorBundle2 (const VectorBundle< Valtype, ValtypeT > &bundle, const Vector< ValtypeT > &nor) noexcept
	Does not initialize the members.
	VectorBundle2 (const Position< Valtype > &pos, const Rotation< ValtypeT > &rot) noexcept
	Does not initialize the members.
constexpr	VectorBundle2 (const Frame< Valtype, ValtypeT > &frame) noexcept
	Does not initialize the members.
	VectorBundle2 (const Rotation< ValtypeT > &rot) noexcept
	Does not initialize the members.
template<typename Valtype2>
	VectorBundle2 (const Valtype2 *pVal) noexcept
	Does not initialize the members.
Assignment
Parameters frame rot
VectorBundle2 &	operator= (const Frame< Valtype, ValtypeT > &frame) noexcept
VectorBundle2 &	operator= (const Rotation< ValtypeT > &rot) noexcept
template<typename Valtype2>
VectorBundle2 &	operator= (const Valtype2 *pVal) noexcept

Public Attributes
Position< Valtype >	P
	Base space postion.
Vector< ValtypeT >	T
	Tangent vector or x-axis.
Vector< ValtypeT >	N
	Normal axis or y-axis.

Detailed Description

template<typename Valtype, typename ValtypeT = Valtype>
struct spat::VectorBundle2< Valtype, ValtypeT >

Implements a tangential space bundle.

Specifies the coordinates of a point in 3D space and two additional Vector.

Member Function Documentation

Equals()

template<typename Valtype, typename ValtypeT>

bool spat::VectorBundle2< Valtype, ValtypeT >::Equals ( const VectorBundle2< Valtype, ValtypeT > & bundle, Valtype epsilon_length = std::numeric_limits<Valtype>::epsilon(), ValtypeT epsilon_lengthT = std::numeric_limits<ValtypeT>::epsilon() ) const

inlineconstexprnoexcept

Comparison within some ranges.

The area within two positions regarded as equal is a sphere with radius epsilon_length; the absolute difference of two vectors will at most be epsilon_lengthT. If the two vectors are both unit vectors, the actual difference between them will be sin(a) with a being the rotational angle. This makes a small enough epsilon_lengthT a limit in rotational angle.

Parameters

bundle	VectorBundle2 to compare with.
epsilon_length	epsilon distance <= which two positions are regarded as equal.
epsilon_lengthT	epsilon for the Vectors of the VectorBundle2s.

Init()

template<typename Valtype, typename ValtypeT>

VectorBundle2< Valtype, ValtypeT > & spat::VectorBundle2< Valtype, ValtypeT >::Init ( const VectorBundle< Valtype, ValtypeT > & bundle, const Vector< ValtypeT > & up )

inlinenoexcept

Initializes the VectorBundle2 structure to vb and calculates nor as to be orthogonal to up.

Parameters

bundle	Values for pos and tan
up	Vector pointing in up direction

IsOrthoNormal()

template<typename Valtype, typename ValtypeT>

bool spat::VectorBundle2< Valtype, ValtypeT >::IsOrthoNormal ( ValtypeT epsilon_length = 2*std::numeric_limits<ValtypeT>::epsilon(), ValtypeT epsilon_angle = 2*std::numeric_limits<ValtypeT>::epsilon() ) const

inlinenoexcept

Parameters

epsilon_length	Margin for deviation.
epsilon_angle	Margin for deviation.

Returns

true if the Frame forms an orthonormal frameset.

operator VectorBundle< Valtype, ValtypeT >()

template<typename Valtype, typename ValtypeT>

spat::VectorBundle2< Valtype, ValtypeT >::operator VectorBundle< Valtype, ValtypeT > ( ) const

inlinenoexcept

Implicit conversion.

Returns

A Vector bundle with the P and T values.

TransportNor()

template<typename Valtype, typename ValtypeT>

VectorBundle2< Valtype, ValtypeT > & spat::VectorBundle2< Valtype, ValtypeT >::TransportNor ( Valtype d )

inlinenoexcept

Moves the Frame by d in direction N.

Parameters

d	Distance to move along N.

TransportTan()

template<typename Valtype, typename ValtypeT>

VectorBundle2< Valtype, ValtypeT > & spat::VectorBundle2< Valtype, ValtypeT >::TransportTan ( Valtype d )

inlinenoexcept

Moves the Frame by d in direction T.

Parameters

d	Distance to move along T.

TransportTo() [1/2]

template<typename Valtype, typename ValtypeT>

VectorBundle2< Valtype, ValtypeT > & spat::VectorBundle2< Valtype, ValtypeT >::TransportTo ( const Position2D< Valtype > & p )

inlinenoexcept

Transport this Frame to p.

Parameters

p	a point in space formulated with respect to this Frame.

TransportTo() [2/2]

template<typename Valtype, typename ValtypeT>

VectorBundle2< Valtype, ValtypeT > & spat::VectorBundle2< Valtype, ValtypeT >::TransportTo ( Valtype d )

inlinenoexcept

Moves the Frame by d in direction T.

Parameters

d	Distance to move along T.

---

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

• C:/Trend/Development/Trax3/Code/spat/Frame.h
• C:/Trend/Development/Trax3/Code/spat/VectorBundle2.h