Interpolate sections between arbritrary positions along the length of the yarn. More...

#include <YarnSectionInterpPosition.h>

Inheritance diagram for TexGen::CYarnSectionInterpPosition:

Public Member Functions
	CYarnSectionInterpPosition (bool bRamped=true, bool bPolar=false, bool bConstMesh=true)

	CYarnSectionInterpPosition (TiXmlElement &Element)

	~CYarnSectionInterpPosition (void)

vector< XY >	GetSection (const YARN_POSITION_INFORMATION PositionInfo, int iNumPoints, bool bEquiSpaced=false) const
	This function must be implemented by derived classes. More...

CMesh	GetSectionMesh (const YARN_POSITION_INFORMATION PositionInfo, int iNumPoints, bool bEquiSpaced) const
	This function must be implemented by derived classes. More...

CYarnSection *	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	PopulateTiXmlElement (TiXmlElement &Element, OUTPUT_TYPE OutputType) const
	Used for saving data to XML. More...

void	AddSection (double dPosition, const CSection &Section)
	Add a section at a specific point along the path of the yarn. More...

void	SetSectionMeshLayersEqual (int iNumPoints) const
	Function to set the number of layers equal for all sections in a given yarn. More...

int	GetNumNodeSections () const

const CSection &	GetSection (int iIndex) const

double	GetSectionPosition (int iIndex) const

bool	GetRamped ()

bool	GetPolar ()

bool	GetForceMeshLayers () const

CYarnSectionConstant *	GetSectionConstant ()
	Get a pointer of that the inherited class. More...

CYarnSectionInterpNode *	GetSectionInterpNode ()

CYarnSectionInterpPosition *	GetSectionInterpPosition ()

Static Public Member Functions
static CObjectContainer< CYarnSection >	CreateYarnSection (TiXmlElement &Element)
	Create a yarn section from TiXmlElement. More...

Public Attributes
bool	m_bForceEqualMeshLayers

Protected Member Functions
bool	GetInterpedSection (const CSection &Section1, const CSection &Section2, double u, int iNumPoints, bool bEquiSpaced, vector< XY > &Points) const

bool	GetInterpedSectionMesh (const CSection &Section1, const CSection &Section2, double u, int iNumPoints, bool bEquiSpaced, CMesh &Mesh) const

XY	InterpolatePoints (XY P1, XY P2, double u) const

int	CalculateNumberofLayers (const vector< XY > &Section) const

Protected Attributes
vector< pair< double, CObjectContainer< CSection > > >	m_Sections

bool	m_bRamped

bool	m_bPolar

Detailed Description

Interpolate sections between arbritrary positions along the length of the yarn.

Sections should be added to the class by use of the AddSection function.

Definition at line 31 of file YarnSectionInterpPosition.h.

Constructor & Destructor Documentation

◆ CYarnSectionInterpPosition() [1/2]

CYarnSectionInterpPosition::CYarnSectionInterpPosition	(	bool	bRamped = `true`,
		bool	bPolar = `false`,
		bool	bConstMesh = `true`
	)

Parameters

bRamped,bPolar Specify how points are interpolated between master nodes using CYarnSectionInterp::InterpolatePoints() If bRamped is set to true, the interpolation fraction given to functions in GetInterpedSection and GetInterpedSectionMesh will be ramped using a cubic equation. Where du = 0 at u = 0, and du = 0 at u = 1. This provides a smoother transition between sections when the interpolation begins and ends.

bConstMesh Defines whether all section meshes are forced to have same configuration ie number of rows and columns in mesh

Definition at line 25 of file YarnSectionInterpPosition.cpp.

◆ CYarnSectionInterpPosition() [2/2]

CYarnSectionInterpPosition::CYarnSectionInterpPosition ( TiXmlElement & Element )

Definition at line 34 of file YarnSectionInterpPosition.cpp.

References TexGen::CSection::CreateSection(), FOR_EACH_TIXMLELEMENT, and m_Sections.

◆ ~CYarnSectionInterpPosition()

CYarnSectionInterpPosition::~CYarnSectionInterpPosition ( void )

Definition at line 30 of file YarnSectionInterpPosition.cpp.

Member Function Documentation

◆ AddSection()

void CYarnSectionInterpPosition::AddSection	(	double	dPosition,
		const CSection &	Section
	)

Add a section at a specific point along the path of the yarn.

Positions in between specified sections will be interpolated. If no section is specified at the start and end then the sections are applied periodically.

Parameters

dPosition	Represents the position along the length of the yarn where the section is to be applied, this value should vary between 0 and 1
Section	The section to be applied at that position

Definition at line 174 of file YarnSectionInterpPosition.cpp.

References m_Sections.

Referenced by TexGen::CAdjustMeshInterference::AdjustSectionMeshes().

◆ CalculateNumberofLayers()

int CYarnSectionInterp::CalculateNumberofLayers ( const vector< XY > & Section ) const

protectedinherited

Definition at line 147 of file YarnSectionInterp.cpp.

References TexGen::XY::x, and TexGen::XY::y.

Referenced by TexGen::CYarnSectionInterpNode::SetSectionMeshLayersEqual(), and SetSectionMeshLayersEqual().

◆ Copy()

CYarnSection * TexGen::CYarnSectionInterpPosition::Copy ( ) const

inlinevirtual

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

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

Implements TexGen::CYarnSection.

Definition at line 49 of file YarnSectionInterpPosition.h.

◆ CreateYarnSection()

CObjectContainer< CYarnSection > CYarnSection::CreateYarnSection ( TiXmlElement & Element )

staticinherited

Create a yarn section from TiXmlElement.

Definition at line 49 of file YarnSection.cpp.

Referenced by TexGen::CYarn::CYarn(), and TexGen::CYarnSectionAdjusted::CYarnSectionAdjusted().

◆ GetForceMeshLayers()

bool TexGen::CYarnSection::GetForceMeshLayers ( ) const

inlineinherited

Definition at line 99 of file YarnSection.h.

◆ GetInterpedSection()

bool CYarnSectionInterp::GetInterpedSection	(	const CSection &	Section1,
		const CSection &	Section2,
		double	u,
		int	iNumPoints,
		bool	bEquiSpaced,
		vector< XY > &	Points
	)		const

protectedinherited

Definition at line 49 of file YarnSectionInterp.cpp.

References TexGen::CSection::GetPoints(), and TexGen::CYarnSectionInterp::InterpolatePoints().

Referenced by TexGen::CYarnSectionInterpNode::GetSection(), and GetSection().

◆ GetInterpedSectionMesh()

bool CYarnSectionInterp::GetInterpedSectionMesh	(	const CSection &	Section1,
		const CSection &	Section2,
		double	u,
		int	iNumPoints,
		bool	bEquiSpaced,
		CMesh &	Mesh
	)		const

protectedinherited

Definition at line 72 of file YarnSectionInterp.cpp.

References TexGen::CMesh::AddNode(), TexGen::CMesh::Clear(), TexGen::CSection::GetDefaultName(), TexGen::CMesh::GetIndices(), TexGen::CSection::GetMesh(), TexGen::CMesh::GetNode(), TexGen::CMesh::GetNumNodes(), TexGen::CYarnSectionInterp::InterpolatePoints(), TexGen::CMesh::NUM_ELEMENT_TYPES, TGERROR, TexGen::XYZ::x, TexGen::XY::x, TexGen::XYZ::y, and TexGen::XY::y.

Referenced by TexGen::CYarnSectionInterpNode::GetSectionMesh(), and GetSectionMesh().

◆ GetNumNodeSections()

int TexGen::CYarnSectionInterpPosition::GetNumNodeSections ( ) const

inline

Definition at line 67 of file YarnSectionInterpPosition.h.

◆ GetPolar()

bool TexGen::CYarnSectionInterp::GetPolar ( )

inlineinherited

Definition at line 48 of file YarnSectionInterp.h.

◆ GetRamped()

bool TexGen::CYarnSectionInterp::GetRamped ( )

inlineinherited

Definition at line 47 of file YarnSectionInterp.h.

◆ GetSection() [1/2]

vector< XY > CYarnSectionInterpPosition::GetSection	(	const YARN_POSITION_INFORMATION	PositionInfo,
		int	iNumPoints,
		bool	bEquiSpaced = `false`
	)		const

virtual

This function must be implemented by derived classes.

Parameters

PositionInfo	Structure which contains information about the position along the yarn
iNumPoints	Number of points on the perimeter of the section to return
bEquiSpaced	Create the points such that they are all equispaced or not

Implements TexGen::CYarnSection.

Definition at line 66 of file YarnSectionInterpPosition.cpp.

References TexGen::CYarnSectionInterp::GetInterpedSection(), TexGen::YARN_POSITION_INFORMATION::GetYarnPosition(), m_Sections, and TGERROR.

◆ GetSection() [2/2]

const CSection & CYarnSectionInterpPosition::GetSection ( int iIndex ) const

Definition at line 180 of file YarnSectionInterpPosition.cpp.

References m_Sections.

◆ GetSectionConstant()

CYarnSectionConstant * CYarnSection::GetSectionConstant ( )

inherited

Get a pointer of that the inherited class.

Internally the function just returns dynamic_cast<CYarnSectionConstant*>(this) etc This is mainly useful in the python interface because type casting is not supported in this language.

Definition at line 91 of file YarnSection.cpp.

◆ GetSectionInterpNode()

CYarnSectionInterpNode * CYarnSection::GetSectionInterpNode ( )

inherited

Definition at line 96 of file YarnSection.cpp.

◆ GetSectionInterpPosition()

CYarnSectionInterpPosition * CYarnSection::GetSectionInterpPosition ( )

inherited

Definition at line 100 of file YarnSection.cpp.

◆ GetSectionMesh()

CMesh CYarnSectionInterpPosition::GetSectionMesh	(	const YARN_POSITION_INFORMATION	PositionInfo,
		int	iNumPoints,
		bool	bEquiSpaced
	)		const

virtual

This function must be implemented by derived classes.

Parameters

PositionInfo	Structure which contains information about the position along the yarn
iNumPoints	Number of points on the perimeter of the section to return
bEquiSpaced	Create the points such that they are all equispaced or not

Implements TexGen::CYarnSection.

Definition at line 118 of file YarnSectionInterpPosition.cpp.

References TexGen::CYarnSectionInterp::GetInterpedSectionMesh(), TexGen::YARN_POSITION_INFORMATION::GetYarnPosition(), m_Sections, and TGERROR.