All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMLineTangency

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIGSMLineTangency
 

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


interface CATIGSMLineTangency

Interface to line feature defined tangent to a curve.
Role: Allows you to access data of the line feature created to be tangent to a curve at a given point.

See also:
CATIGSMFactory.CreateLineTangency


Method Index


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 GetReferenceCurve(CATISpecObject_var&)
Gets the curve to which the line will be tangent.
o GetStartingPoint(CATISpecObject_var&)
Gets the starting point of the line.
o GetSupport(CATISpecObject_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 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 SetReferenceCurve(CATISpecObject_var)
Sets the curve to which the line will be tangent.
o SetStartingPoint(CATISpecObject_var)
Sets the starting point of the line.
o SetSupport(CATISpecObject_var)
Sets the support surface.
o SetSymmetricalExtension(CATBoolean)
Sets the symmetrical extension of the line (start = -end).

Methods


o GetLengthType
public virtual HRESULT GetLengthType(CATGSMLineLengthType& oType) = 0
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 HRESULT GetLengths(CATICkeParm_var& oStart,
CATICkeParm_var& oEnd) = 0
Gets the start and end lengthes of the line.
Parameters:
oStart
start length
oEnd
end length
o GetReferenceCurve
public virtual HRESULT GetReferenceCurve(CATISpecObject_var& oCurve) = 0
Gets the curve to which the line will be tangent.
Parameters:
oCurve
curve
o GetStartingPoint
public virtual HRESULT GetStartingPoint(CATISpecObject_var& oPoint) = 0
Gets the starting point of the line.
Parameters:
oPoint
starting point
o GetSupport
public virtual HRESULT GetSupport(CATISpecObject_var& oSupport) = 0
Gets the support surface. If a support surface is given, the line will lie on it.
Parameters:
oSupport
supportting surface
o GetSymmetricalExtension
public virtual HRESULT GetSymmetricalExtension(CATBoolean& oSym) = 0
Gets whether the symmetrical extension of the line is active.
Parameters:
oSym
Symetry flag
o RemoveSupport
public virtual HRESULT RemoveSupport()= 0
Removes the support surface.
o SetLengthType
public virtual HRESULT SetLengthType(CATGSMLineLengthType iType) = 0
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 HRESULT SetLengths( const CATICkeParm_var iStart,
const CATICkeParm_var iEnd) = 0
Sets the start and end lengthes of the line.
Parameters:
iStart
start length
iEnd
end length
o SetReferenceCurve
public virtual HRESULT SetReferenceCurve( const CATISpecObject_var iCurve) = 0
Sets the curve to which the line will be tangent.
Parameters:
iCurve
curve
o SetStartingPoint
public virtual HRESULT SetStartingPoint( const CATISpecObject_var iPoint) = 0
Sets the starting point of the line.
Parameters:
iPoint
starting point
o SetSupport
public virtual HRESULT SetSupport( const CATISpecObject_var iSupport) = 0
Sets the support surface. if a support surface is given, the line will lie on it.
Parameters:
iSupport
supportting surface
o SetSymmetricalExtension
public virtual HRESULT SetSymmetricalExtension(CATBoolean iSym) = 0
Sets the symmetrical extension of the line (start = -end).
Parameters:
iSym
Symetry flag

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

Copyright © 2003, Dassault Systèmes. All rights reserved.