Constructs curves with a constant or linearly increasing section to be used in the design of wooden or plastic battens. These curves are two-dimensional, and simulate physical splines or battens. More...

#include <FairCurve_Batten.hxx>

Inheritance diagram for FairCurve_Batten:

[legend]

Public Member Functions
	FairCurve_Batten (const gp_Pnt2d &P1, const gp_Pnt2d &P2, const Standard_Real Height, const Standard_Real Slope=0)
	Constructor with the two points and the geometrical characteristics of the batten (elastic beam) Height is the height of the deformation, and Slope is the slope value, initialized at 0. The user can then supply the desired slope value by the method, SetSlope. Other parameters are initialized as follow : More...

virtual	~FairCurve_Batten ()

void	SetFreeSliding (const Standard_Boolean FreeSliding)
	Freesliding is initialized with the default setting false. When Freesliding is set to true and, as a result, sliding is free, the sliding factor is automatically computed to satisfy the equilibrium of the batten. More...

void	SetConstraintOrder1 (const Standard_Integer ConstraintOrder)
	Allows you to change the order of the constraint on the first point. ConstraintOrder has the default setting of 1. The following settings are available: More...

void	SetConstraintOrder2 (const Standard_Integer ConstraintOrder)
	Allows you to change the order of the constraint on the second point. ConstraintOrder is initialized with the default setting of 1. The following settings are available: More...

void	SetP1 (const gp_Pnt2d &P1)
	Allows you to change the location of the point, P1, and in doing so, modify the curve. Warning This method changes the angle as well as the point. Exceptions NullValue if the distance between P1 and P2 is less than or equal to the tolerance value for distance in Precision::Confusion: P1.IsEqual(P2, Precision::Confusion()). The function gp_Pnt2d::IsEqual tests to see if this is the case. More...

void	SetP2 (const gp_Pnt2d &P2)
	Allows you to change the location of the point, P1, and in doing so, modify the curve. Warning This method changes the angle as well as the point. Exceptions NullValue if the distance between P1 and P2 is less than or equal to the tolerance value for distance in Precision::Confusion: P1.IsEqual(P2, Precision::Confusion()). The function gp_Pnt2d::IsEqual tests to see if this is the case. More...

void	SetAngle1 (const Standard_Real Angle1)
	Allows you to change the angle Angle1 at the first point, P1. The default setting is 0. More...

void	SetAngle2 (const Standard_Real Angle2)
	Allows you to change the angle Angle2 at the second point, P2. The default setting is 0. More...

void	SetHeight (const Standard_Real Height)
	Allows you to change the height of the deformation. Raises NegativeValue; – if Height <= 0 if Height <= 0. More...

void	SetSlope (const Standard_Real Slope)
	Allows you to set the slope value, Slope. More...

void	SetSlidingFactor (const Standard_Real SlidingFactor)
	Allows you to change the ratio SlidingFactor. This compares the length of the batten and the reference length, which is, in turn, a function of the constraints. This modification has one of the following two effects: More...

virtual Standard_Boolean	Compute (FairCurve_AnalysisCode &Code, const Standard_Integer NbIterations=50, const Standard_Real Tolerance=1.0e-3)
	Performs the algorithm, using the arguments Code, NbIterations and Tolerance and computes the curve with respect to the constraints. Code will have one of the following values: More...

Standard_Real	SlidingOfReference () const
	Computes the real number value for length Sliding of Reference for new constraints. If you want to give a specific length to a batten curve, use the following syntax: b.SetSlidingFactor(L / b.SlidingOfReference()) where b is the name of the batten curve object. More...

Standard_Boolean	GetFreeSliding () const
	Returns the initial free sliding value, false by default. Free sliding is generally more aesthetically pleasing than constrained sliding. However, the computation can fail with values such as angles greater than PI/2. This is because the resulting batten length is theoretically infinite. More...

Standard_Integer	GetConstraintOrder1 () const
	Returns the established first constraint order. More...

Standard_Integer	GetConstraintOrder2 () const
	Returns the established second constraint order. More...

const gp_Pnt2d &	GetP1 () const
	Returns the established location of the point P1. More...

const gp_Pnt2d &	GetP2 () const
	Returns the established location of the point P2. More...

Standard_Real	GetAngle1 () const
	Returns the established first angle. More...

Standard_Real	GetAngle2 () const
	Returns the established second angle. More...

Standard_Real	GetHeight () const
	Returns the thickness of the lathe. More...

Standard_Real	GetSlope () const
	Returns the established slope value. More...

Standard_Real	GetSlidingFactor () const
	Returns the initial sliding factor. More...

Handle< Geom2d_BSplineCurve >	Curve () const
	Returns the computed curve a 2d BSpline. More...

virtual void	Dump (Standard_OStream &o) const
	Prints on the stream o information on the current state of the object. More...

Protected Member Functions
Standard_Real	SlidingOfReference (const Standard_Real D, const Standard_Real A1, const Standard_Real A2) const

Standard_Real	Compute (const Standard_Real D, const Standard_Real A1, const Standard_Real A2) const

Standard_Real	Compute (const Standard_Real D, const Standard_Real A) const
	Returns the effective geometrical constraints at the last batten computation. This effectives values may be not equal with the wanted values if. More...

Protected Attributes
FairCurve_AnalysisCode	myCode

gp_Pnt2d	OldP1

gp_Pnt2d	OldP2

Standard_Real	OldAngle1

Standard_Real	OldAngle2

Standard_Real	OldHeight

Standard_Real	OldSlope

Standard_Real	OldSlidingFactor

Standard_Boolean	OldFreeSliding

Standard_Integer	OldConstraintOrder1

Standard_Integer	OldConstraintOrder2

gp_Pnt2d	NewP1

gp_Pnt2d	NewP2

Standard_Real	NewAngle1

Standard_Real	NewAngle2

Standard_Real	NewHeight

Standard_Real	NewSlope

Standard_Real	NewSlidingFactor

Standard_Boolean	NewFreeSliding

Standard_Integer	NewConstraintOrder1

Standard_Integer	NewConstraintOrder2

Standard_Integer	Degree

Handle< TColgp_HArray1OfPnt2d >	Poles

Handle< TColStd_HArray1OfReal >	Flatknots

Handle< TColStd_HArray1OfReal >	Knots

Handle< TColStd_HArray1OfInteger >	Mults

Detailed Description

Constructs curves with a constant or linearly increasing section to be used in the design of wooden or plastic battens. These curves are two-dimensional, and simulate physical splines or battens.

Constructor & Destructor Documentation

◆ FairCurve_Batten()

FairCurve_Batten::FairCurve_Batten	(	const gp_Pnt2d &	P1,
		const gp_Pnt2d &	P2,
		const Standard_Real	Height,
		const Standard_Real	Slope = `0`
	)

Constructor with the two points and the geometrical characteristics of the batten (elastic beam) Height is the height of the deformation, and Slope is the slope value, initialized at 0. The user can then supply the desired slope value by the method, SetSlope. Other parameters are initialized as follow :

FreeSliding = False
ConstraintOrder1 = 1
ConstraintOrder2 = 1
Angle1 = 0
Angle2 = 0
SlidingFactor = 1 Exceptions NegativeValue if Height is less than or equal to 0. NullValue if the distance between P1 and P2 is less than or equal to the tolerance value for distance in Precision::Confusion: P1.IsEqual(P2, Precision::Confusion()). The function gp_Pnt2d::IsEqual tests to see if this is the case.

◆ ~FairCurve_Batten()

virtual FairCurve_Batten::~FairCurve_Batten ( )

virtual

Member Function Documentation

◆ Compute() [1/3]

virtual Standard_Boolean FairCurve_Batten::Compute	(	FairCurve_AnalysisCode &	Code,
		const Standard_Integer	NbIterations = `50`,
		const Standard_Real	Tolerance = `1.0e-3`
	)

virtual

Performs the algorithm, using the arguments Code, NbIterations and Tolerance and computes the curve with respect to the constraints. Code will have one of the following values:

OK
NotConverged
InfiniteSliding
NullHeight The parameters Tolerance and NbIterations control how precise the computation is, and how long it will take.

Reimplemented in FairCurve_MinimalVariation.

◆ Compute() [2/3]

Standard_Real FairCurve_Batten::Compute	(	const Standard_Real	D,
		const Standard_Real	A1,
		const Standard_Real	A2
	)		const

protected

◆ Compute() [3/3]

Standard_Real FairCurve_Batten::Compute	(	const Standard_Real	D,
		const Standard_Real	A
	)		const

protected

Returns the effective geometrical constraints at the last batten computation. This effectives values may be not equal with the wanted values if.

if the value is "free"
in the case of incomplete computation : collapse, infinite sliding, height of batten will be negative at end points

◆ Curve()

Handle< Geom2d_BSplineCurve > FairCurve_Batten::Curve ( ) const

Returns the computed curve a 2d BSpline.

◆ Dump()

virtual void FairCurve_Batten::Dump ( Standard_OStream & o ) const

virtual

Prints on the stream o information on the current state of the object.

Private methodes -----------------------------------—

Reimplemented in FairCurve_MinimalVariation.

◆ GetAngle1()

Standard_Real FairCurve_Batten::GetAngle1 ( ) const

Returns the established first angle.

◆ GetAngle2()

Standard_Real FairCurve_Batten::GetAngle2 ( ) const

Returns the established second angle.

◆ GetConstraintOrder1()

Standard_Integer FairCurve_Batten::GetConstraintOrder1 ( ) const

Returns the established first constraint order.

◆ GetConstraintOrder2()

Standard_Integer FairCurve_Batten::GetConstraintOrder2 ( ) const

Returns the established second constraint order.

◆ GetFreeSliding()

Standard_Boolean FairCurve_Batten::GetFreeSliding ( ) const

Returns the initial free sliding value, false by default. Free sliding is generally more aesthetically pleasing than constrained sliding. However, the computation can fail with values such as angles greater than PI/2. This is because the resulting batten length is theoretically infinite.

◆ GetHeight()

Standard_Real FairCurve_Batten::GetHeight ( ) const

Returns the thickness of the lathe.

◆ GetP1()

const gp_Pnt2d& FairCurve_Batten::GetP1 ( ) const

Returns the established location of the point P1.

◆ GetP2()

const gp_Pnt2d& FairCurve_Batten::GetP2 ( ) const

Returns the established location of the point P2.

◆ GetSlidingFactor()

Standard_Real FairCurve_Batten::GetSlidingFactor ( ) const

Returns the initial sliding factor.

◆ GetSlope()

Standard_Real FairCurve_Batten::GetSlope ( ) const

Returns the established slope value.

◆ SetAngle1()

void FairCurve_Batten::SetAngle1 ( const Standard_Real Angle1 )

Allows you to change the angle Angle1 at the first point, P1. The default setting is 0.

◆ SetAngle2()

void FairCurve_Batten::SetAngle2 ( const Standard_Real Angle2 )

Allows you to change the angle Angle2 at the second point, P2. The default setting is 0.

◆ SetConstraintOrder1()

void FairCurve_Batten::SetConstraintOrder1 ( const Standard_Integer ConstraintOrder )

Allows you to change the order of the constraint on the first point. ConstraintOrder has the default setting of 1. The following settings are available:

0-the curve must pass through a point
1-the curve must pass through a point and have a given tangent
2-the curve must pass through a point, have a given tangent and a given curvature. The third setting is only valid for FairCurve_MinimalVariation curves. These constraints, though geometric, represent the mechanical constraints due, for example, to the resistance of the material the actual physical batten is made of.

◆ SetConstraintOrder2()

void FairCurve_Batten::SetConstraintOrder2 ( const Standard_Integer ConstraintOrder )

Allows you to change the order of the constraint on the second point. ConstraintOrder is initialized with the default setting of 1. The following settings are available:

0-the curve must pass through a point
1-the curve must pass through a point and have a given tangent
2-the curve must pass through a point, have a given tangent and a given curvature. The third setting is only valid for FairCurve_MinimalVariation curves. These constraints, though geometric, represent the mechanical constraints due, for example, to the resistance of the material the actual physical batten is made of.

◆ SetFreeSliding()

void FairCurve_Batten::SetFreeSliding ( const Standard_Boolean FreeSliding )

Freesliding is initialized with the default setting false. When Freesliding is set to true and, as a result, sliding is free, the sliding factor is automatically computed to satisfy the equilibrium of the batten.

◆ SetHeight()

void FairCurve_Batten::SetHeight ( const Standard_Real Height )

Allows you to change the height of the deformation. Raises NegativeValue; – if Height <= 0 if Height <= 0.

◆ SetP1()

void FairCurve_Batten::SetP1 ( const gp_Pnt2d & P1 )

Allows you to change the location of the point, P1, and in doing so, modify the curve. Warning This method changes the angle as well as the point. Exceptions NullValue if the distance between P1 and P2 is less than or equal to the tolerance value for distance in Precision::Confusion: P1.IsEqual(P2, Precision::Confusion()). The function gp_Pnt2d::IsEqual tests to see if this is the case.

◆ SetP2()

void FairCurve_Batten::SetP2 ( const gp_Pnt2d & P2 )

Allows you to change the location of the point, P1, and in doing so, modify the curve. Warning This method changes the angle as well as the point. Exceptions NullValue if the distance between P1 and P2 is less than or equal to the tolerance value for distance in Precision::Confusion: P1.IsEqual(P2, Precision::Confusion()). The function gp_Pnt2d::IsEqual tests to see if this is the case.

◆ SetSlidingFactor()

void FairCurve_Batten::SetSlidingFactor ( const Standard_Real SlidingFactor )

Allows you to change the ratio SlidingFactor. This compares the length of the batten and the reference length, which is, in turn, a function of the constraints. This modification has one of the following two effects:

if you increase the value, it inflates the batten
if you decrease the value, it flattens the batten. When sliding is free, the sliding factor is automatically computed to satisfy the equilibrium of the batten. When sliding is imposed, a value is required for the sliding factor. SlidingFactor is initialized with the default setting of 1.

◆ SetSlope()

void FairCurve_Batten::SetSlope ( const Standard_Real Slope )

Allows you to set the slope value, Slope.

◆ SlidingOfReference() [1/2]

Standard_Real FairCurve_Batten::SlidingOfReference ( ) const

Computes the real number value for length Sliding of Reference for new constraints. If you want to give a specific length to a batten curve, use the following syntax: b.SetSlidingFactor(L / b.SlidingOfReference()) where b is the name of the batten curve object.

◆ SlidingOfReference() [2/2]

Standard_Real FairCurve_Batten::SlidingOfReference	(	const Standard_Real	D,
		const Standard_Real	A1,
		const Standard_Real	A2
	)		const

protected

Field Documentation

◆ Degree

Standard_Integer FairCurve_Batten::Degree

protected

◆ Flatknots

Handle< TColStd_HArray1OfReal > FairCurve_Batten::Flatknots

protected

◆ Knots

Handle< TColStd_HArray1OfReal > FairCurve_Batten::Knots

protected

◆ Mults

Handle< TColStd_HArray1OfInteger > FairCurve_Batten::Mults

protected

◆ myCode

FairCurve_AnalysisCode FairCurve_Batten::myCode

protected

◆ NewAngle1

Standard_Real FairCurve_Batten::NewAngle1

protected

◆ NewAngle2

Standard_Real FairCurve_Batten::NewAngle2

protected

◆ NewConstraintOrder1

Standard_Integer FairCurve_Batten::NewConstraintOrder1

protected

◆ NewConstraintOrder2

Standard_Integer FairCurve_Batten::NewConstraintOrder2

protected

◆ NewFreeSliding

Standard_Boolean FairCurve_Batten::NewFreeSliding

protected

◆ NewHeight

Standard_Real FairCurve_Batten::NewHeight

protected

◆ NewP1

gp_Pnt2d FairCurve_Batten::NewP1

protected

◆ NewP2

gp_Pnt2d FairCurve_Batten::NewP2

protected

◆ NewSlidingFactor

Standard_Real FairCurve_Batten::NewSlidingFactor

protected

◆ NewSlope

Standard_Real FairCurve_Batten::NewSlope

protected

◆ OldAngle1

Standard_Real FairCurve_Batten::OldAngle1

protected

◆ OldAngle2

Standard_Real FairCurve_Batten::OldAngle2

protected

◆ OldConstraintOrder1

Standard_Integer FairCurve_Batten::OldConstraintOrder1

protected

◆ OldConstraintOrder2

Standard_Integer FairCurve_Batten::OldConstraintOrder2

protected

◆ OldFreeSliding

Standard_Boolean FairCurve_Batten::OldFreeSliding

protected

◆ OldHeight

Standard_Real FairCurve_Batten::OldHeight

protected

◆ OldP1

gp_Pnt2d FairCurve_Batten::OldP1

protected

◆ OldP2

gp_Pnt2d FairCurve_Batten::OldP2

protected

◆ OldSlidingFactor

Standard_Real FairCurve_Batten::OldSlidingFactor

protected

◆ OldSlope

Standard_Real FairCurve_Batten::OldSlope

protected

◆ Poles

Handle< TColgp_HArray1OfPnt2d > FairCurve_Batten::Poles

protected

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

FairCurve_Batten.hxx

FairCurve_Batten Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FairCurve_Batten()

◆ ~FairCurve_Batten()

Member Function Documentation

◆ Compute() [1/3]

◆ Compute() [2/3]

◆ Compute() [3/3]

◆ Curve()

◆ Dump()

◆ GetAngle1()

◆ GetAngle2()

◆ GetConstraintOrder1()

◆ GetConstraintOrder2()

◆ GetFreeSliding()

◆ GetHeight()

◆ GetP1()

◆ GetP2()

◆ GetSlidingFactor()

◆ GetSlope()

◆ SetAngle1()

◆ SetAngle2()

◆ SetConstraintOrder1()

◆ SetConstraintOrder2()

◆ SetFreeSliding()

◆ SetHeight()

◆ SetP1()

◆ SetP2()

◆ SetSlidingFactor()

◆ SetSlope()

◆ SlidingOfReference() [1/2]

◆ SlidingOfReference() [2/2]

Field Documentation

◆ Degree

◆ Flatknots

◆ Knots

◆ Mults

◆ myCode

◆ NewAngle1

◆ NewAngle2

◆ NewConstraintOrder1

◆ NewConstraintOrder2

◆ NewFreeSliding

◆ NewHeight

◆ NewP1

◆ NewP2

◆ NewSlidingFactor

◆ NewSlope

◆ OldAngle1

◆ OldAngle2

◆ OldConstraintOrder1

◆ OldConstraintOrder2

◆ OldFreeSliding

◆ OldHeight

◆ OldP1

◆ OldP2

◆ OldSlidingFactor

◆ OldSlope

◆ Poles