CATGSMUseItf Interface CATIGSMUseDirection
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMUseDirection
Direction for GSM feature.
Role: allows to manipulate direction
Note:
GetDirectionType returns
- 0 if the direction is specified by an element (a line or a plane;
in the case of a plane, the direction is the normal to the plane),
- 1 if the direction is specified by coordinates.
SetDirectionElement automatically sets the direction type
to 0 (the direction is specified by an element).
SetCoordinates automatically sets the direction type
to 1 (the direction is specified by coordinates).
- See also:
-
Method Index
- o
GetCoordinates(double&,double&,double&)
- Gets vector direction.
- o
GetCoordinates(CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&)
- Gets vector direction using literal parameters.
- o
GetDirectionElement()
- Gets direction reference element.
- o
GetDirectionType()
- Gets direction type.
- o
GetLocalCoordinates(double&,double&,double&)
- Gets vector direction in local axis system.
- o
GetReferenceAxis(CATIMmiMechanicalFeature_var&)
- Gets the reference Axis.
- o
IsDirectionSpecified()
- Queries if the direction is valid or not.
- o
SetCoordinates(double,double,double)
- Sets vector direction.
- o
SetCoordinates(CATICkeParm_var,CATICkeParm_var,CATICkeParm_var)
- Sets vector direction using literal parameters.
- o
SetDirectionElement(CATIMmiMechanicalFeature_var)
- Sets direction reference element.
- o
SetLocalCoordinates(double,double,double)
- Sets vector direction in local axis system.
- o
SetReferenceAxis(CATIMmiMechanicalFeature_var&)
- Sets the reference Axis.
Methods
o GetCoordinates
| public virtual GetCoordinates( | | oX, |
| | oY, |
| | oZ) |
-
Gets vector direction.
- Parameters:
-
- oX
- X coordinate
- oY
- Y coordinate
- oZ
- Z coordinate
o GetCoordinates
| public virtual GetCoordinates( | | oLitX, |
| | oLitY, |
| | oLitZ) |
-
Gets vector direction using literal parameters.
- Parameters:
-
- oLitX
- X coordinate in a literal parameter
- oLitY
- Y coordinate in a literal parameter
- oLitZ
- Z coordinate in a literal parameter
- See also:
-
o GetDirectionElement
| public virtual GetDirectionElement( | ) |
-
Gets direction reference element.
- Returns:
- reference feature
o GetDirectionType
| public virtual GetDirectionType( | ) |
-
Gets direction type.
- Parameters:
-
- iElem
- solid feature
- Returns:
- type direction
: 0 if the direction is specified by an element (a line or a plane;
in the case of a plane, the direction is the normal to the plane),
: 1 if the direction is specified by coordinates.
o GetLocalCoordinates
| public virtual GetLocalCoordinates( | | oX, |
| | oY, |
| | oZ) |
-
Gets vector direction in local axis system.
- Parameters:
-
- oX
- X coordinate
- oY
- Y coordinate
- oZ
- Z coordinate
o GetReferenceAxis
| public virtual GetReferenceAxis( | | oRefAxis) |
-
Gets the reference Axis.
This data is not mandatory, if oRefAxis is null, then absolute axis system is considered as reference axis system.
o IsDirectionSpecified
| public virtual IsDirectionSpecified( | ) |
-
Queries if the direction is valid or not.
- Returns:
- direction exist (TRUE) or not (FALSE)
o SetCoordinates
| public virtual SetCoordinates( | | iX, |
| | iY, |
| | iZ) |
-
Sets vector direction.
- Parameters:
-
- iX
- X coordinate
- iY
- Y coordinate
- iZ
- Z coordinate
o SetCoordinates
| public virtual SetCoordinates( | const | iLitX, |
| const | iLitY, |
| const | iLitZ) |
-
Sets vector direction using literal parameters.
- Parameters:
-
- iLitX
- X coordinate in a literal parameter
- iLitY
- Y coordinate in a literal parameter
- iLitZ
- Z coordinate in a literal parameter
- See also:
-
o SetDirectionElement
| public virtual SetDirectionElement( | const | iSpecElemDir) |
-
Sets direction reference element.
- Parameters:
-
- iSpecElemDir
- reference feature
o SetLocalCoordinates
| public virtual SetLocalCoordinates( | | oX, |
| | oY, |
| | oZ) |
-
Sets vector direction in local axis system.
- Parameters:
-
- oX
- X coordinate
- oY
- Y coordinate
- oZ
- Z coordinate
o SetReferenceAxis
| public virtual SetReferenceAxis( | const | iRefAxis) |
-
Sets the reference Axis.
This data is not mandatory, if iRefAxis is null, then absolute axis system is considered as reference axis system.
This object is included in the file: CATIGSMUseDirection.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.