All Frameworks Class Hierarchy This Framework Previous Next Indexes
GSMInterfaces Interface CATIGSMDirection
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIGSMDirection
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMDirection
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:
- CATIGSMFactory.CreateDirection
Method Index
- o
GetCoordinates(CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&)
- Gets vector direction using literal parameters.
- o
GetCoordinates(double&,double&,double&)
- Gets vector direction.
- 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(CATISpecObject_var&)
- Gets the reference Axis.
- o
IsDirectionSpecified()
- Queries if the direction is valid or not.
- o
SetCoordinates(CATICkeParm_var,CATICkeParm_var,CATICkeParm_var)
- Sets vector direction using literal parameters.
- o
SetCoordinates(double,double,double)
- Sets vector direction.
- o
SetDirectionElement(CATISpecObject_var)
- Sets direction reference element.
- o
SetLocalCoordinates(double,double,double)
- Sets vector direction in local axis system.
- o
SetReferenceAxis(CATISpecObject_var&)
- Sets the reference Axis.
Methods
o GetCoordinates
public virtual HRESULT GetCoordinates( | CATICkeParm_var& | oLitX, |
| CATICkeParm_var& | oLitY, |
| CATICkeParm_var& | oLitZ) = 0 |
-
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:
- CATICkeParm
o GetCoordinates
public virtual HRESULT GetCoordinates( | double& | oX, |
| double& | oY, |
| double& | oZ) = 0 |
-
Gets vector direction.
- Parameters:
-
- oX
- X coordinate
- oY
- Y coordinate
- oZ
- Z coordinate
o GetDirectionElement
-
Gets direction reference element.
- Returns:
- reference feature
o GetDirectionType
public virtual int GetDirectionType( | )= 0 |
-
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 HRESULT GetLocalCoordinates( | double& | oX, |
| double& | oY, |
| double& | oZ) = 0 |
-
Gets vector direction in local axis system.
- Parameters:
-
- oX
- X coordinate
- oY
- Y coordinate
- oZ
- Z coordinate
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 IsDirectionSpecified
public virtual CATBoolean IsDirectionSpecified( | )= 0 |
-
Queries if the direction is valid or not.
- Returns:
- direction exist (TRUE) or not (FALSE)
o SetCoordinates
-
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:
- CATICkeParm
o SetCoordinates
public virtual HRESULT SetCoordinates( | double | iX, |
| double | iY, |
| double | iZ) = 0 |
-
Sets vector direction.
- Parameters:
-
- iX
- X coordinate
- iY
- Y coordinate
- iZ
- Z coordinate
o SetDirectionElement
-
Sets direction reference element.
- Parameters:
-
- iSpecElemDir
- reference feature
o SetLocalCoordinates
public virtual HRESULT SetLocalCoordinates( | double | oX, |
| double | oY, |
| double | oZ) = 0 |
-
Sets vector direction in local axis system.
- Parameters:
-
- oX
- X coordinate
- oY
- Y coordinate
- oZ
- Z coordinate
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.
This object is included in the file: CATIGSMDirection.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces