All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMPlaneEquation

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

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


interface CATIGSMPlaneEquation

Interface to plane feature defined by an equation plane.
Role: Allows you to access data of the plane feature created by its cartesian equation. Plane equation is Ax+By+Cz = D.

See also:
CATIGSMFactory.CreatePlane


Method Index


o GetCoefficients(CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&)
Gets plane coefficients : A, B, C, D.
o GetReferenceAxis(CATISpecObject_var&)
Gets the reference Axis.
o GetReferencePoint(CATISpecObject_var&)
Gets the reference point.
o SetCoefficients(CATICkeParm_var,CATICkeParm_var,CATICkeParm_var,CATICkeParm_var)
Sets plane coefficients : A, B, C, D.
o SetReferenceAxis(CATISpecObject_var&)
Sets the reference Axis.
o SetReferencePoint(CATISpecObject_var)
Sets the reference point.

Methods


o GetCoefficients
public virtual HRESULT GetCoefficients(CATICkeParm_var& oA,
CATICkeParm_var& oB,
CATICkeParm_var& oC,
CATICkeParm_var& oD) = 0
Gets plane coefficients : A, B, C, D. A, B, C are reals, D is a length.
Parameters:
oA
A Coefficient of cartesian plane
oB
B Coefficient of cartesian plane
oC
C Coefficient of cartesian plane
oD
D Coefficient of cartesian plane
o GetReferenceAxis
public virtual HRESULT GetReferenceAxis(CATISpecObject_var& oRefAxis) = 0
Gets the reference Axis. This data is not mandatory, if oRefAxis is null, then absolute axis system is considered as reference axis system.
o GetReferencePoint
public virtual HRESULT GetReferencePoint(CATISpecObject_var& oReferencePoint) = 0
Gets the reference point.
Parameters:
oReferencePoint
reference point
o SetCoefficients
public virtual HRESULT SetCoefficients( const CATICkeParm_var iA,
const CATICkeParm_var iB,
const CATICkeParm_var iC,
const CATICkeParm_var iD) = 0
Sets plane coefficients : A, B, C, D. A, B, C are reals, D is a length.
Parameters:
iA
A Coefficient of cartesian plane
iB
B Coefficient of cartesian plane
iC
C Coefficient of cartesian plane
iD
D Coefficient of cartesian plane
o SetReferenceAxis
public virtual HRESULT SetReferenceAxis( const CATISpecObject_var& iRefAxis) = 0
Sets the reference Axis. This data is not mandatory, if iRefAxis is null, then absolute axis system is considered as reference axis system.
o SetReferencePoint
public virtual HRESULT SetReferencePoint( const CATISpecObject_var iReferencePoint) = 0
Sets the reference point.
Parameters:
iReferencePoint
reference point

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

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