All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATGSMUseItf Interface CATIGSMUseLineAngle

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

interface CATIGSMUseLineAngle

Interface to line feature defined from a reference curve, a plane, a point and an angle.
Role: Allows you to access data of the the line feature created with an angle to a curve.

See also:

Method Index

o GetAngle(CATICkeParm_var&): Gets the angle.
o GetLengthType(CATGSMLineLengthType&): Gets the length type : length or infinite or infinite start point or infinite end point.
o GetLengths(CATICkeParm_var&,CATICkeParm_var&): Gets the start and end lengthes of the line.
o GetPlaneNormal(CATMathVector&): Get the Normal of the plane created when the Support of the curve is not specified.
o GetReferenceCurve(CATIMmiMechanicalFeature_var&): Gets the reference curve.
o GetSolution(int&): Gets a solution number which corresponds to the current solution/result.
o GetStartingPoint(CATIMmiMechanicalFeature_var&): Gets the starting point of the line.
o GetSupport(CATIMmiMechanicalFeature_var&): Gets the support surface.
o GetSymmetricalExtension(CATBoolean&): Gets whether the symmetrical extension of the line is active.
o IsGeodesic(CATBoolean&): Queries geodesic mode.
o SetAngle(CATICkeParm_var): Sets the angle.
o SetGeodesic(): Sets geodesic mode.
o SetLengthType(CATGSMLineLengthType): Sets the length type : length or infinite or infinite start point or infinite end point.
o SetLengths(CATICkeParm_var,CATICkeParm_var): Sets the start and end lengthes of the line.
o SetNormal(): Sets the line normal to the curve on the surface.
o SetPlaneNormal(CATMathVector&): Set the Normal of the plane created when the Support of the curve is not specified.
o SetReferenceCurve(CATIMmiMechanicalFeature_var): Sets the reference curve.
o SetSolution(int): Sets a solution number which corresponds to the desired solution from list of multiple solutions.
o SetStartingPoint(CATIMmiMechanicalFeature_var): Sets the starting point of the line.
o SetSupport(CATIMmiMechanicalFeature_var): Sets the support surface.
o SetSymmetricalExtension(CATBoolean): Sets the symmetrical extension of the line (start = -end).
o UnsetGeodesic(): Inactivates geodesic mode.

Methods

o GetAngle

public virtual GetAngle( oAngle)

Gets the angle.

Parameters:

oAngle: angle value

o GetLengthType

public virtual GetLengthType( oType)

Gets the length type : length or infinite or infinite start point or infinite end point. 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 GetLengths

public virtual GetLengths(		`oStart`,
		`oEnd`)

Gets the start and end lengthes of the line.

Parameters:

oStart: start length
oEnd: end length

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 GetReferenceCurve

public virtual GetReferenceCurve( oCurve)

Gets the reference curve.

Parameters:

oCurve: reference curve

o GetSolution

public virtual GetSolution( oSolNo)

Gets a solution number which corresponds to the current solution/result.

Parameters:

oSolNo,: number which identifies current solution

o GetStartingPoint

public virtual GetStartingPoint( oPoint)

Gets the starting point of the line.

Parameters:

oPoint: starting point

o GetSupport

public virtual GetSupport( oSupport)

Gets the support surface.

Parameters:

oSupport: support surface

o GetSymmetricalExtension

public virtual GetSymmetricalExtension( oSym)

Gets whether the symmetrical extension of the line is active.

Parameters:

oSym: Symetry flag

o IsGeodesic

public virtual IsGeodesic( oGeod)

Queries geodesic mode.

Parameters:

oGeod: geodesic mode on (TRUE) or not (FALSE)

o SetAngle

public virtual SetAngle( const iAngle)

Sets the angle.

Parameters:

iAngle: angle value

o SetGeodesic

public virtual SetGeodesic(

)

Sets geodesic mode.
If geodesic, the line lies on the support surface, otherwise the surface is only used to compute the line direction.

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 SetLengths

public virtual SetLengths(	const	`iStart`,
	const	`iEnd`)

Sets the start and end lengthes of the line.

Parameters:

iStart: start length
iEnd: end length

o SetNormal

public virtual SetNormal(

)

Sets the line normal to the curve on the surface. Same as Angle = 90deg.

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 SetReferenceCurve

public virtual SetReferenceCurve( const iCurve)

Sets the reference curve.

Parameters:

iCurve: reference curve

o SetSolution

public virtual SetSolution( const iSolNo)

Sets a solution number which corresponds to the desired solution from list of multiple solutions.

Parameters:

iSolNo,: number which corresponds to the desired solution.

o SetStartingPoint

public virtual SetStartingPoint( const iPoint)

Sets the starting point of the line.

Parameters:

iPoint: starting point

o SetSupport

public virtual SetSupport( const iSupport)

Sets the support surface.

Parameters:

iSupport: support surface

o SetSymmetricalExtension

public virtual SetSymmetricalExtension( iSym)

Sets the symmetrical extension of the line (start = -end).

Parameters:

iSym: Symetry flag

o UnsetGeodesic

public virtual UnsetGeodesic(

)

Inactivates geodesic mode. If geodesic, the line lies on the support surface, otherwise the surface is only used to compute the line direction.

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