All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMTranslate

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

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


interface CATIGSMTranslate

Translation.
Role: Allows to access data of the Translation feature created by using an element, a direction and a distance value

See also:
CATIGSMFactory.CreateTranslate


Method Index


o GetCoordX(CATICkeParm_var&)
Gets the X coordinate value.
o GetCoordX(double&)
Gets the X coordinate value.
o GetCoordY(CATICkeParm_var&)
Gets the Y coordinate value.
o GetCoordY(double&)
Gets the Y coordinate value.
o GetCoordZ(CATICkeParm_var&)
Gets the Z coordinate value.
o GetCoordZ(double&)
Gets the Z coordinate value.
o GetCreationMode(enum CATGSMTransfoMode&)
Gets the Creation Mode.
o GetDirection(CATIGSMDirection_var&)
Gets the direction.
o GetDistance(CATICkeParm_var&)
Gets the distance value.
o GetDistance(double&)
Gets the distance value.
o GetElemToTranslate(CATISpecObject_var&)
Gets the feature to translate.
o GetFirstPoint(CATISpecObject_var&)
Gets the first point defining the translation vector.
o GetReferenceAxis(CATISpecObject_var&)
Gets the reference Axis.
o GetSecondPoint(CATISpecObject_var&)
Gets the second point defining the translation vector.
o GetVectorType(CATGSMTranslateVectorType&)
Gets the type of the translation vector definition.
o SetCoordX(CATICkeParm_var)
Sets the X coordinate value.
o SetCoordX(double)
Sets the X coordinate value.
o SetCoordY(CATICkeParm_var)
Sets the Y coordinate value.
o SetCoordY(double)
Sets the Y coordinate value.
o SetCoordZ(CATICkeParm_var)
Sets the Z coordinate value.
o SetCoordZ(double)
Sets the Z coordinate value.
o SetCreationMode(CATBoolean)
Sets the Creation Mode.
o SetDirection(CATIGSMDirection_var)
Sets the direction.
o SetDistance(CATICkeParm_var)
Sets the distance value.
o SetDistance(double)
Sets the distance value.
o SetElemToTranslate(CATISpecObject_var)
Sets the feature to translate.
o SetFirstPoint(CATISpecObject_var)
Sets the first point defining the translation vector.
o SetReferenceAxis(CATISpecObject_var&)
Sets the reference Axis.
o SetSecondPoint(CATISpecObject_var)
Sets the second point defining the translation vector.
o SetVectorType(CATGSMTranslateVectorType)
Sets the type of the translation vector definition.

Methods


o GetCoordX
public virtual HRESULT GetCoordX(CATICkeParm_var& oCoordX) = 0
Gets the X coordinate value.
Parameters:
oCoordX
oCoordX value
See also:
CATICkeParm
o GetCoordX
public virtual HRESULT GetCoordX(double& oCoordX) = 0
Gets the X coordinate value.
Parameters:
oCoordX
X coordinate value
o GetCoordY
public virtual HRESULT GetCoordY(CATICkeParm_var& oCoordY) = 0
Gets the Y coordinate value.
Parameters:
oCoordY
oCoordY value
See also:
CATICkeParm
o GetCoordY
public virtual HRESULT GetCoordY(double& oCoordY) = 0
Gets the Y coordinate value.
Parameters:
oCoordY
Y coordinate value
o GetCoordZ
public virtual HRESULT GetCoordZ(CATICkeParm_var& oCoordZ) = 0
Gets the Z coordinate value.
Parameters:
oCoordZ
oCoordZ value
See also:
CATICkeParm
o GetCoordZ
public virtual HRESULT GetCoordZ(double& oCoordZ) = 0
Gets the Z coordinate value.
Parameters:
oCoordZ
Z coordinate value
o GetCreationMode
public virtual HRESULT GetCreationMode(enum CATGSMTransfoMode& oMode)= 0
Gets the Creation Mode.
Parameters:
oMode
flag for transformation type (from CATGSMTransfoMode enumeration) : - CATGSMTransfoModeUnset - CATGSMTransfoModeCreation - CATGSMTransfoModeModification
o GetDirection
public virtual HRESULT GetDirection(CATIGSMDirection_var& oDirection)= 0
Gets the direction.
Parameters:
oDirection
direction
See also:
CATIGSMDirection
o GetDistance
public virtual HRESULT GetDistance(CATICkeParm_var& oDistance) = 0
Gets the distance value.
Parameters:
oDistance
Distance value
See also:
CATICkeParm
o GetDistance
public virtual HRESULT GetDistance(double& oDistance) = 0
Gets the distance value.
Parameters:
oDistance
Distance value
o GetElemToTranslate
public virtual HRESULT GetElemToTranslate(CATISpecObject_var& oElem)= 0
Gets the feature to translate.
Parameters:
oElem
feature to translate
o GetFirstPoint
public virtual HRESULT GetFirstPoint(CATISpecObject_var& oElem) = 0
Gets the first point defining the translation vector.
Parameters:
oElem
The first point.
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 GetSecondPoint
public virtual HRESULT GetSecondPoint(CATISpecObject_var& oElem) = 0
Gets the second point defining the translation vector.
Parameters:
oElem
The second point.
o GetVectorType
public virtual HRESULT GetVectorType(CATGSMTranslateVectorType& oType)= 0
Gets the type of the translation vector definition.
(1= Direction+ Distance, 2= Point+ Point, 3= Coordinates)
Parameters:
oType
type of the translation vector
o SetCoordX
public virtual HRESULT SetCoordX( const CATICkeParm_var iX)= 0
Sets the X coordinate value.
Parameters:
iX
X coordinate value
See also:
CATICkeParm
o SetCoordX
public virtual HRESULT SetCoordX(double iX) = 0
Sets the X coordinate value.
Parameters:
iX
X coordinate value
o SetCoordY
public virtual HRESULT SetCoordY( const CATICkeParm_var iY)= 0
Sets the Y coordinate value.
Parameters:
iY
Y coordinate value
See also:
CATICkeParm
o SetCoordY
public virtual HRESULT SetCoordY(double iY) = 0
Sets the Y coordinate value.
Parameters:
iY
Y coordinate value
o SetCoordZ
public virtual HRESULT SetCoordZ( const CATICkeParm_var iZ)= 0
Sets the Z coordinate value.
Parameters:
iZ
Z coordinate value
See also:
CATICkeParm
o SetCoordZ
public virtual HRESULT SetCoordZ(double iZ) = 0
Sets the Z coordinate value.
Parameters:
iZ
Z coordinate value
o SetCreationMode
public virtual HRESULT SetCreationMode( const CATBoolean iMode)= 0
Sets the Creation Mode.
Parameters:
iMode
flag for transformation type (creation or modification)
o SetDirection
public virtual HRESULT SetDirection( const CATIGSMDirection_var iDirection)= 0
Sets the direction.
Parameters:
iDirection
The new direction of translation.
See also:
CATIGSMDirection
o SetDistance
public virtual HRESULT SetDistance( const CATICkeParm_var iDistance)= 0
Sets the distance value.
Parameters:
iDistance
Distance value
See also:
CATICkeParm
o SetDistance
public virtual HRESULT SetDistance(double iDistance) = 0
Sets the distance value.
Parameters:
iDistance
Distance value
o SetElemToTranslate
public virtual HRESULT SetElemToTranslate( const CATISpecObject_var iElem) = 0
Sets the feature to translate.
Parameters:
iElem
The new feature to translate.
o SetFirstPoint
public virtual HRESULT SetFirstPoint( const CATISpecObject_var iElem) = 0
Sets the first point defining the translation vector.
Parameters:
iElem
The first point.
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 SetSecondPoint
public virtual HRESULT SetSecondPoint( const CATISpecObject_var iElem) = 0
Sets the second point defining the translation vector.
Parameters:
iElem
The second point.
o SetVectorType
public virtual HRESULT SetVectorType(CATGSMTranslateVectorType iType)= 0
Sets the type of the translation vector definition.
(1= Direction+ Distance, 2= Point+ Point, 3= Coordinates)
Parameters:
iType
type of the translation vector

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

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