All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMLinePtPt

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

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


interface CATIGSMLinePtPt

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

See also:
CATIGSMFactory.CreateLine


Method Index


o GetFirstPoint(CATISpecObject_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(CATISpecObject_var&)
Gets the second point.
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 SetFirstPoint(CATISpecObject_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(CATISpecObject_var)
Sets the second point.
o SetSupport(CATISpecObject_var)
Sets the support surface.
o SetSymmetricalExtension(CATBoolean)
Sets the symmetrical extension of the line (start = -end).

Methods


o GetFirstPoint
public virtual HRESULT GetFirstPoint(CATISpecObject_var& oFirstPoint) = 0
Gets the first point.
Parameters:
oFirstPoint
first point
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. 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 HRESULT GetSecondPoint(CATISpecObject_var& oSecondPoint) = 0
Gets the second point.
Parameters:
oSecondPoint
second 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
support 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 SetFirstPoint
public virtual HRESULT SetFirstPoint( const CATISpecObject_var iFirstPoint) = 0
Sets the first point.
Parameters:
iFirstPoint
first point
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. 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 HRESULT SetSecondPoint( const CATISpecObject_var iSecondPoint) = 0
Sets the second point.
Parameters:
iSecondPoint
second 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
support 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: CATIGSMLinePtPt.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces

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