All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMPlane

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

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


interface CATIGSMPlane

Interface to plane feature.
Role: - set/change the type of the plane and - modify the orientation of the plane (in case of offset/angle type planes). - define the position of the plane for its representation Plane types:
Legal values :
PlaneEquation = 0
PlaneThrg3 = 1
PlaneThrg2 = 2
Plane1Pt1Ln = 3
PlaneThrg1 = 4
PlaneTangency = 5
PlaneNormal = 6
PlaneOffset = 7
PlaneOffsetPt = 8
PlaneAngle = 9
PlaneMean = 10
PlaneExplicit = 30


Method Index


o GetOrientation(CATGSMOrientation&)
Gets the plane orientation.
o GetPlaneType(int&)
Gets the plane type.
o GetPosition(double&,double&,double&)
Gets the position where the plane is displayed.
o GetPositionWithoutProjection(double&,double&,double&)
Gets Position set by SetPosition method.
o InvertOrientation()
Inverts the plane orientation.
o IsARefPlane()
Queries whether the plan is a reference plane (fixed axis plane).
o RemovePosition()
Removes reference position of a plane.
o SetOrientation(CATGSMOrientation)
Sets the plane orientation.
o SetPosition(double,double,double)
Sets the position where the plane is displayed.

Methods


o GetOrientation
public virtual HRESULT GetOrientation(CATGSMOrientation& oOrient) = 0
Gets the plane orientation.
The plane orientation allows to reverse the plane from the reference plane.
Note: It can only be used for offset or angle type planes.
Parameters:
oOrient
orientation
o GetPlaneType
public virtual HRESULT GetPlaneType(int& oT) = 0
Gets the plane type.
Parameters:
oT
Type of Plane
o GetPosition
public virtual HRESULT GetPosition(double& oX,
double& oY,
double& oZ) = 0
Gets the position where the plane is displayed.
Parameters:
oX
X coordinates
oY
Y coordinates
oZ
Z coordinates
Returns:
S_OK if the position has been set before, E_FAIL else.
o GetPositionWithoutProjection
public virtual HRESULT GetPositionWithoutProjection(double& oX,
double& oY,
double& oZ) = 0
Gets Position set by SetPosition method. Caution: The position returned by this method may not lie on the plane. Use GetPosition method if point lying on the plane is required.
Parameters:
oX
X coordinates
oY
Y coordinates
oZ
Z coordinates
Returns:
S_OK if the position has been set before, E_FAIL else.
o InvertOrientation
public virtual HRESULT InvertOrientation()= 0
Inverts the plane orientation.
Note: The plane orientation is only used for offset or angle type planes: this method is then only available on offset an angle planes.
o IsARefPlane
public virtual int IsARefPlane()= 0
Queries whether the plan is a reference plane (fixed axis plane).
Returns:
=0 when the plane is a reference plane, 1 else.
o RemovePosition
public virtual HRESULT RemovePosition()= 0
Removes reference position of a plane.
Note: When removed, the plane is displayed at its default position.
o SetOrientation
public virtual HRESULT SetOrientation( const CATGSMOrientation iOrient) = 0
Sets the plane orientation.
The plane orientation allows to reverse the plane from the reference plane.
Note: It can only be used for offset or angle type planes.
Parameters:
iOrient
orientation
o SetPosition
public virtual HRESULT SetPosition(double iX,
double iY,
double iZ) = 0
Sets the position where the plane is displayed.
Parameters:
iX
X coordinates
iY
Y coordinates
iZ
Z coordinates

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

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