CATGSMUseItf Interface CATIGSMUsePlane
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMUsePlane
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
SetPlaneType(int,CATListValCATIMmiMechanicalFeature_var*,int*)
- Sets the plane type.
- o
SetPosition(double,double,double)
- Sets the position where the plane is displayed.
Methods
o GetOrientation
| public virtual GetOrientation( | | oOrient) |
-
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 GetPlaneType( | | oT) |
-
Gets the plane type.
- Parameters:
-
- oT
- Type of Plane
o GetPosition
| public virtual GetPosition( | | oX, |
| | oY, |
| | oZ) |
-
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 GetPositionWithoutProjection( | | oX, |
| | oY, |
| | oZ) |
-
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 InvertOrientation( | ) |
-
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 IsARefPlane( | ) |
-
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 RemovePosition( | ) |
-
Removes reference position of a plane.
Note:
When removed, the plane is displayed at its default position.
o SetOrientation
| public virtual SetOrientation( | const | iOrient) |
-
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 SetPlaneType
| public virtual SetPlaneType( | | iType, |
| | iElems | = NULL, |
| | iReportedSpecPositionTab | = NULL) |
-
Sets the plane type.
- Parameters:
-
- iType
- The new feature type
- iElems
- The list of specs to prepare for report to new feature
- iReportedSpecPositionTab
- Array containing for each feature the position in the new feature attributes structure.
Example : iReportedSpecPositionTab[0] = 2,
means that the first feature of iElems list (iElems[1]) has the second position
in the new feature, according to the replace acceptance
(a point can only be replaced by a point, for instance).
if iReportedSpecPositionTab[i]=0 the replace for ith element could not be done.
Array has to be allocated by calling method.
- See also:
-
o SetPosition
| public virtual SetPosition( | | iX, |
| | iY, |
| | iZ) |
-
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: CATIGSMUsePlane.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.