All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATGSMUseItf Interface CATIGSMUseLineBiTangent

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIGSMUseLineBiTangent

Interface to line bitangent feature.
Role: Allows to access data of the line feature created to be tangent to two elements.

See also:
See also:

Method Index

o GetChoiceNo(int&,CATGSMOrientation&,CATGSMOrientation&,CATGSMOrientation&,CATGSMOrientation&): Gets a sequence which identifies a solution among all possibilities of curve/point or curve/curve tangent lines.
o GetFirstTangentElement(CATIMmiMechanicalFeature_var&): Get the first curve to which the line is tangent.
o GetLengthType(CATGSMLineLengthType&): Gets the length type : length or infinite or infinite start point or infinite end point.
o GetPlaneNormal(CATMathVector&): Get the Normal of the plane created when the Support of the curve is not specified.
o GetSecondTangentElement(CATIMmiMechanicalFeature_var&): Get the second element to which the line is tangent (curve or point).
o GetSupport(CATIMmiMechanicalFeature_var&): Get the support surface.
o SetChoiceNo(int,CATGSMOrientation,CATGSMOrientation,CATGSMOrientation,CATGSMOrientation): Sets a sequence which identifies a solution (see above).
o SetFirstTangentElement(CATIMmiMechanicalFeature_var): Set the first curve to which the line will be tangent.
o SetLengthType(CATGSMLineLengthType): Sets the length type : length or infinite or infinite start point or infinite end point.
o SetPlaneNormal(CATMathVector&): Set the Normal of the plane created when the Support of the curve is not specified.
o SetSecondTangentElement(CATIMmiMechanicalFeature_var): Set the second element to which the line will be tangent (curve or point).
o SetSupport(CATIMmiMechanicalFeature_var): Set the support surface.

Methods

o GetChoiceNo

public virtual GetChoiceNo(		`oNo`,
		`oOriTgt1`,
		`oOriCvt1`,
		`oOriTgt2`,
		`oOriCvt2`)

Gets a sequence which identifies a solution among all possibilities of curve/point or curve/curve tangent lines.

Parameters:

oNo: Given the orientations, solution number in a distance ordered list.
oOriTgt1: This orientation allows to compute just the results that are tangent to a specific region of the first curve. It can take 3 values:
CATGSMSameOrientation : the result has the same orientation as the curve,
CATGSMInvertOrientation : the result has the opposite orientation of the curve,
CATGSMKoOrientation : no orientation is specified.
oOriCvt1: This orientation allows to compute just the results that are tangent to a specific side of the first curve. It can take 3 values:
CATGSMSameOrientation : curvature direction of curve and cross product of support normal and result direction are in the same direction,
CATGSMInvertOrientation : curvature direction of curve and cross product of support normal and result direction are in opposite directions,
CATGSMKoOrientation : no orientation is specified.
oOriTgt2: In case of curve/curve bitangent line, this orientation allows to compute just the results that are tangent to a specific region of the second curve . It can take 3 values:
CATGSMSameOrientation : the result has the same orientation as the curve,
CATGSMInvertOrientation : the result has the opposite orientation of the curve,
CATGSMKoOrientation : no orientation is specified.
oOriCvt2: In case of curve/curve bitangent line this orientation allows to compute just the results that are tangent to a specific side of the second curve. It can take 3 values:
CATGSMSameOrientation : curvature direction of curve and cross product of support normal and result direction are in the same direction,
CATGSMInvertOrientation : curvature direction of curve and cross product of support normal and result direction are in opposite directions,
CATGSMKoOrientation : no orientation is specified.

o GetFirstTangentElement

public virtual GetFirstTangentElement( Element1)

Get the first curve to which the line is tangent.

o GetLengthType

public virtual GetLengthType( oType)

Gets the length type : length or infinite or infinite start point or infinite end point.
Note: Default is Length.
Length means that the line is limited by its extremities Infinite means that the line is infinite InfStartPoint means that the line is infinite on the side of the start point InfEndPoint means that the line is infinite on the side of the end point

Parameters:

oType: distance type enum {Length, Infinite, InfStartPoint, InfEndPoint}

o GetPlaneNormal

public virtual GetPlaneNormal( oNormal)

Get the Normal of the plane created when the Support of the curve is not specified.

Parameters:

oNormal: CATMathVector

o GetSecondTangentElement

public virtual GetSecondTangentElement( Element2)

Get the second element to which the line is tangent (curve or point).

o GetSupport

public virtual GetSupport( Support)

Get the support surface. The line lies on it.

o SetChoiceNo

public virtual SetChoiceNo(	const	`iNo`,
	const	`iOriTgt1`,
	const	`iOriCvt1`,
	const	`iOriTgt2`	`=CATGSMKoOrientation`,
	const	`iOriCvt2`	`=CATGSMKoOrientation`)

Sets a sequence which identifies a solution (see above).

Parameters:

iNo: Given the orientations, solution number in a distance ordered list.
iOriTgt1: This orientation allows to compute just the results that are tangent to a specific region of the first curve. It can take 3 values:
CATGSMSameOrientation : the result has the same orientation as the curve,
CATGSMInvertOrientation : the result has the opposite orientation of the curve,
CATGSMKoOrientation : no orientation is specified.
iOriCvt1: This orientation allows to compute just the results that are tangent to a specific side of the first curve. It can take 3 values:
CATGSMSameOrientation : curvature direction of curve and cross product of support normal and result direction are in the same direction,
CATGSMInvertOrientation : curvature direction of curve and cross product of support normal and result direction are in opposite directions,
CATGSMKoOrientation : no orientation is specified.
iOriTgt2: In case of curve/curve bitangent line, this orientation allows to compute just the results that are tangent to a specific region of the second curve . It can take 3 values:
CATGSMSameOrientation : the result has the same orientation as the curve,
CATGSMInvertOrientation : the result has the opposite orientation of the curve,
CATGSMKoOrientation : no orientation is specified.
iOriCvt2: In case of curve/curve bitangent line this orientation allows to compute just the results that are tangent to a specific side of the second curve. It can take 3 values:
CATGSMSameOrientation : curvature direction of curve and cross product of support normal and result direction are in the same direction,
CATGSMInvertOrientation : curvature direction of curve and cross product of support normal and result direction are in opposite directions,
CATGSMKoOrientation : no orientation is specified.

o SetFirstTangentElement

public virtual SetFirstTangentElement( const Element1)

Set the first curve to which the line will be tangent.

o SetLengthType

public virtual SetLengthType( iType)

Sets the length type : length or infinite or infinite start point or infinite end point.

Parameters:

iType: length type: enum {Length, Infinite, InfStartPoint, InfEndPoint}

o SetPlaneNormal

public virtual SetPlaneNormal( const iNormal)

Set the Normal of the plane created when the Support of the curve is not specified.

Parameters:

iNormal: CATMathVector

o SetSecondTangentElement

public virtual SetSecondTangentElement( const Element2)

Set the second element to which the line will be tangent (curve or point).

o SetSupport

public virtual SetSupport( const Support)

Set the support surface. The line will lie on it.

This object is included in the file: CATIGSMUseLineBiTangent.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf