All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GeometricObjects Interface CATLine

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---GeometricObjects.CATICGMUnknown
        |
        +---GeometricObjects.CATICGMObject
          |
          +---GeometricObjects.CATGeometry
            |
            +---GeometricObjects.CATCurve
              |
              +---CATLine
 

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


interface CATLine

Interface representing a geometric 3D line.

A CATLine is created by the CreateLine method of the CATGeoFactory interface and deleted with the Remove method. A line is defined with:
CATMathPoint O The origin point
CATMathDirection U The direction
CATCrvParam iStart The low limitation
CATCrvParam iEnd The high limitation


Method Index


o GetDirection()
Retrieves the direction of this CATLine.
o GetDirection(CATMathDirection&)
Retrieves the direction of this CATLine.
o GetOrigin()
Retrieves the origin of this CATLine.
o GetOrigin(CATMathPoint&)
Retrieves the origin of this CATLine.
o Set(CATMathPoint&,CATMathDirection&)
Modifies the origin and the direction of this CATLine.
o Set(CATMathPoint&,CATMathPoint&)
Defines limitations on this CATLine.
o SetDirection(CATMathDirection&)
Modifies the direction of this CATLine.
o SetOrigin(CATMathPoint&)
Modifies the origin of this CATLine.

Methods


o GetDirection
public virtual CATMathDirection GetDirection()const =0
Retrieves the direction of this CATLine. The signature which returns the CATMathDirection in output argument should be preferably used.
Returns:
The origin.
o GetDirection
public virtual void GetDirection(CATMathDirection& ioDirection) const =0
Retrieves the direction of this CATLine.
Parameters:
ioDirection
The direction.
o GetOrigin
public virtual CATMathPoint GetOrigin()const =0
Retrieves the origin of this CATLine. The signature which returns the CATMathPoint in output argument should be preferably used.
Returns:
The origin.
o GetOrigin
public virtual void GetOrigin(CATMathPoint& ioOrigin) const =0
Retrieves the origin of this CATLine.
Parameters:
ioOrigin
The origin.
o Set
public virtual void Set( const CATMathPoint& iNewOrigin,
const CATMathDirection& iNewDirection) =0
Modifies the origin and the direction of this CATLine.
Parameters:
iNewOrigin
The new origin.
iNewDirection
The new direction.
o Set
public virtual void Set( const CATMathPoint& iSegmentLimit1,
const CATMathPoint& iSegmentLimit2)=0
Defines limitations on this CATLine.
Parameters:
iSegmentLimit1
The first limitation.
iSegmentLimit2
The end limitation.
o SetDirection
public virtual void SetDirection( const CATMathDirection& iNewDirection) =0
Modifies the direction of this CATLine.
Parameters:
iNewDirection
The new direction.
o SetOrigin
public virtual void SetOrigin( const CATMathPoint& iNewOrigin) =0
Modifies the origin of this CATLine.
Parameters:
iNewOrigin
The new origin.

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

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