All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATGSMUseItf Interface CATIGSMUseLinePtPt

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

interface CATIGSMUseLinePtPt

Interface to line point-point feature.
Role: Allows you to access data of the line feature created between two points.

See also:

Method Index

o GetFirstPoint(CATIMmiMechanicalFeature_var&): Gets the first point.
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 GetSecondPoint(CATIMmiMechanicalFeature_var&): Gets the second point.
o GetSupport(CATIMmiMechanicalFeature_var&): Gets the support surface.
o GetSymmetricalExtension(CATBoolean&): Gets whether the symmetrical extension of the line is active.
o RemoveSupport(): Removes the support surface.
o SetFirstPoint(CATIMmiMechanicalFeature_var): Sets the first point.
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 SetSecondPoint(CATIMmiMechanicalFeature_var): Sets the second point.
o SetSupport(CATIMmiMechanicalFeature_var): Sets the support surface.
o SetSymmetricalExtension(CATBoolean): Sets the symmetrical extension of the line (start = -end).

Methods

o GetFirstPoint

public virtual GetFirstPoint( oFirstPoint)

Gets the first point.

Parameters:

oFirstPoint: first point

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. These paramaters are optionnal.

Parameters:

oStart: extension of the line, beginning at the starting point
oEnd: extension of the line, beginning at the ending point

o GetSecondPoint

public virtual GetSecondPoint( oSecondPoint)

Gets the second point.

Parameters:

oSecondPoint: second point

o GetSupport

public virtual GetSupport( oSupport)

Gets the support surface. if a support surface is given, the line will lie on it.

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 RemoveSupport

public virtual RemoveSupport(

)

Removes the support surface.

o SetFirstPoint

public virtual SetFirstPoint( const iFirstPoint)

Sets the first point.

Parameters:

iFirstPoint: first point

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. These paramaters are optionnal.

Parameters:

iStart: extension of the line, beginning at the starting point
iEnd: extension of the line, beginning at the ending point

o SetSecondPoint

public virtual SetSecondPoint( const iSecondPoint)

Sets the second point.

Parameters:

iSecondPoint: second point

o SetSupport

public virtual SetSupport( const iSupport)

Sets the support surface. if a support surface is given, the line will lie on it.

Parameters:

iSupport: support surface

o SetSymmetricalExtension

public virtual SetSymmetricalExtension( iSym)

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

Parameters:

iSym: Symetry flag

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