Cubic spline interpolation for yarn paths. More...

#include <InterpolationCubic.h>

Inheritance diagram for TexGen::CInterpolationCubic:

Classes
struct	CUBICEQUATION
	Struct to represent a cubic equation. More...

Public Member Functions
	CInterpolationCubic (bool bPeriodic=true, bool bForceInPlaneTangent=false, bool bForceMasterNodeTangent=false)

	CInterpolationCubic (TiXmlElement &Element)

	~CInterpolationCubic (void)

CInterpolation *	Copy () const
	This is a function to allow copying of derived classes correctly. More...

string	GetType () const
	Derived class should return the class name. More...

void	Initialise (const vector< CNode > &MasterNodes) const
	Create the spline cubic equations and store them in m_?Cubics. More...

CSlaveNode	GetNode (const vector< CNode > &MasterNodes, int iIndex, double t) const
	Get a node from parametric function where t is specified. More...

virtual void	PopulateTiXmlElement (TiXmlElement &Element, OUTPUT_TYPE OutputType) const
	Used for saving data to XML. More...

vector< CSlaveNode >	GetSlaveNodes (const vector< CNode > &MasterNodes, int iNumPoints, bool bEquiSpaced=true) const
	Get a list of nodes along the centre line of the yarn. More...

CSlaveNode	GetNode (const vector< CNode > &MasterNodes, double t) const
	Get a node from parametric function. Initialise should be called first. More...

void	SetPeriodic (bool bPeriodic)

void	SetForceInPlaneTangent (bool bForceInPlaneTangent)

bool	GetPeriodic () const

bool	GetForceInPlaneTangent () const

Static Public Member Functions
static CObjectContainer< CInterpolation >	CreateInterpolation (TiXmlElement &Element)
	Create an interpolation from TiXmlElement. More...

Protected Member Functions
void	CreateSlaveNodes (vector< CSlaveNode > &SlaveNodes, const vector< CNode > &MasterNodes, int iNumPoints) const
	Create slave nodes with specified number of points between master nodes. More...

bool	CreateEquiSpacedSlaveNodes (vector< CSlaveNode > &SlaveNodes, const vector< CNode > &MasterNodes, int iNumPoints) const
	Create slave nodes equispaced with total specified number of points. More...

void	CalculateNodeCoordinateSystem (const vector< CNode > &MasterNodes, vector< XYZ > &Tangents) const

vector< CSlaveNode >	CalcSlaveNodePositions (const vector< CNode > &MasterNodes, vector< double > &LValues, vector< double > &TValues, double dL, int iNumNodes, int iNumPoints) const

Static Protected Member Functions
static void	GetPeriodicCubicSplines (const vector< double > &Knots, vector< CUBICEQUATION > &Cubics)

static void	GetNaturalCubicSplines (const vector< double > &Knots, vector< CUBICEQUATION > &Cubics)

static void	InterpolateUp (const CNode &Node1, const CNode &Node2, CSlaveNode &SlaveNode, double t)

static void	InterpolateAngle (const CNode &Node1, const CNode &Node2, CSlaveNode &SlaveNode, double t)

Protected Attributes
vector< CUBICEQUATION >	m_XCubics

vector< CUBICEQUATION >	m_YCubics

vector< CUBICEQUATION >	m_ZCubics

bool	m_bPeriodic

bool	m_bForceInPlaneTangent

bool	m_bForceMasterNodeTangent

Detailed Description

Cubic spline interpolation for yarn paths.

Definition at line 28 of file InterpolationCubic.h.

Constructor & Destructor Documentation

◆ CInterpolationCubic() [1/2]

CInterpolationCubic::CInterpolationCubic	(	bool	bPeriodic = `true`,
		bool	bForceInPlaneTangent = `false`,
		bool	bForceMasterNodeTangent = `false`
	)

Definition at line 25 of file InterpolationCubic.cpp.

◆ CInterpolationCubic() [2/2]

CInterpolationCubic::CInterpolationCubic ( TiXmlElement & Element )

Definition at line 34 of file InterpolationCubic.cpp.

◆ ~CInterpolationCubic()

CInterpolationCubic::~CInterpolationCubic ( void )

Definition at line 30 of file InterpolationCubic.cpp.

Member Function Documentation

◆ CalcSlaveNodePositions()

vector< CSlaveNode > CInterpolation::CalcSlaveNodePositions	(	const vector< CNode > &	MasterNodes,
		vector< double > &	LValues,
		vector< double > &	TValues,
		double	dL,
		int	iNumNodes,
		int	iNumPoints
	)		const

protectedinherited

Definition at line 315 of file Interpolation.cpp.

References TexGen::CInterpolation::GetNode().

Referenced by TexGen::CInterpolation::CreateEquiSpacedSlaveNodes().

◆ CalculateNodeCoordinateSystem()

void CInterpolation::CalculateNodeCoordinateSystem	(	const vector< CNode > &	MasterNodes,
		vector< XYZ > &	Tangents
	)		const

protectedinherited

This function will calculate the Tangent and Up vectors automatically to sensible values without user input for the parent nodes within the current yarn. It may be desirable to give more control to the user.

Definition at line 261 of file Interpolation.cpp.

References TexGen::GetLength(), TexGen::CInterpolation::m_bForceMasterNodeTangent, TexGen::CInterpolation::m_bPeriodic, TexGen::Normalise(), TGERROR, and TexGen::XYZ::z.

Referenced by TexGen::CInterpolationBezier::Initialise(), and TexGen::CInterpolationLinear::Initialise().

◆ Copy()

CInterpolation * TexGen::CInterpolationCubic::Copy ( ) const

inlinevirtual

This is a function to allow copying of derived classes correctly.

Derived classes should implement this as CInterpolation* Copy() const { return new CInterpolationDerived(*this); } where CInterpolationDerived should be replaced by the name of the derived class

Implements TexGen::CInterpolation.

Definition at line 35 of file InterpolationCubic.h.