All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMRotate

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

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


interface CATIGSMRotate

Rotate feature.
Role: Allows to access data of the Rotate feature created by using an element, an axis (a line) and an angle.

See also:
CATIGSMFactory.CreateRotate


Method Index


o GetAngle(CATICkeParm_var&)
Gets the angle.
o GetAngle(double&)
Gets the angle.
o GetAxis(CATISpecObject_var&)
Gets the axis.
o GetCreationMode(enum CATGSMTransfoMode&)
Gets the Creation Mode.
o GetElemToRotate(CATISpecObject_var&)
Gets the feature to rotate.
o GetFirstElement(CATISpecObject_var&)
Gets the first element defining the rotation angle.
o GetFirstPoint(CATISpecObject_var&)
Gets the first point defining the rotation.
o GetOrientationOfFirstElement(CATBoolean&)
Gets the orientation of the first element (line or plane).
o GetOrientationOfSecondElement(CATBoolean&)
Gets the orientation of the second element (line or plane).
o GetRotationType(enum CATGSMRotationType&)
Gets the type of the rotation definition.
o GetSecondElement(CATISpecObject_var&)
Gets the second element defining the rotation angle.
o GetSecondPoint(CATISpecObject_var&)
Gets the second point defining the rotation.
o GetThirdPoint(CATISpecObject_var&)
Gets the third point defining the rotation.
o SetAngle(CATICkeParm_var)
Sets the angle value.
o SetAngle(double)
Sets the angle value.
o SetAxis(CATISpecObject_var)
Sets the axis.
o SetCreationMode(CATBoolean)
Sets the Creation Mode.
o SetElemToRotate(CATISpecObject_var)
Sets the element that is rotated.
o SetFirstElement(CATISpecObject_var)
Sets the first element defining the rotation angle.
o SetFirstPoint(CATISpecObject_var)
Sets the first point defining the rotation.
o SetOrientationOfFirstElement(CATBoolean)
Sets the orientation of the first element (line or plane).
o SetOrientationOfSecondElement(CATBoolean)
Sets the orientation of the second element (line or plane).
o SetRotationType(enum CATGSMRotationType)
Sets the type of the rotation definition.
o SetSecondElement(CATISpecObject_var)
Sets the second element defining the rotation angle.
o SetSecondPoint(CATISpecObject_var)
Sets the second point defining the rotation.
o SetThirdPoint(CATISpecObject_var)
Sets the third point defining the rotation.

Methods


o GetAngle
public virtual HRESULT GetAngle(CATICkeParm_var& oAngle) = 0
Gets the angle.
Parameters:
oAngle
angle value
o GetAngle
public virtual HRESULT GetAngle(double& oAngle)= 0
Gets the angle.
Parameters:
oAngle
angle value
o GetAxis
public virtual HRESULT GetAxis(CATISpecObject_var& oElem) = 0
Gets the axis.
Parameters:
oElem
axis
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 GetElemToRotate
public virtual HRESULT GetElemToRotate(CATISpecObject_var& oElem) = 0
Gets the feature to rotate.
Parameters:
oElem
feature to transform
o GetFirstElement
public virtual HRESULT GetFirstElement(CATISpecObject_var& oElem1) = 0
Gets the first element defining the rotation angle.
Parameters:
oElem1
The first element.
o GetFirstPoint
public virtual HRESULT GetFirstPoint(CATISpecObject_var& oPoint1) = 0
Gets the first point defining the rotation.
Parameters:
oPoint1
The first point.
o GetOrientationOfFirstElement
public virtual HRESULT GetOrientationOfFirstElement(CATBoolean& oOrient1)=0
Gets the orientation of the first element (line or plane).
Parameters:
oOrient
: False means that there is no invertion of the orientation : True to invert this orientation
o GetOrientationOfSecondElement
public virtual HRESULT GetOrientationOfSecondElement(CATBoolean& oOrient2)=0
Gets the orientation of the second element (line or plane).
Parameters:
oOrient
: False means that there is no invertion of the orientation : True to invert this orientation
o GetRotationType
public virtual HRESULT GetRotationType(enum CATGSMRotationType& oType)= 0
Gets the type of the rotation definition.
Parameters:
oType
Type of rotation :
- CATGSMAxisAngle,
- CATGSMAxisTwoElem,
- CATGSMThreePoints,
- CATGSMUnknownRotationType.
See also:
CATGSMRotationType
o GetSecondElement
public virtual HRESULT GetSecondElement(CATISpecObject_var& oElem2) = 0
Gets the second element defining the rotation angle.
Parameters:
oElem2
The second element.
o GetSecondPoint
public virtual HRESULT GetSecondPoint(CATISpecObject_var& oPoint2) = 0
Gets the second point defining the rotation.
Parameters:
oPoint2
The second point.
o GetThirdPoint
public virtual HRESULT GetThirdPoint(CATISpecObject_var& oPoint3) = 0
Gets the third point defining the rotation.
Parameters:
oPoint3
The third point.
o SetAngle
public virtual HRESULT SetAngle( const CATICkeParm_var iAngle) = 0
Sets the angle value.
Parameters:
iAngle
new angle value
o SetAngle
public virtual HRESULT SetAngle(double iAngle) = 0
Sets the angle value.
Parameters:
iAngle
new angle value
o SetAxis
public virtual HRESULT SetAxis( const CATISpecObject_var iElem) = 0
Sets the axis.
Parameters:
iElem
new axis
o SetCreationMode
public virtual HRESULT SetCreationMode( const CATBoolean iMode)= 0
Sets the Creation Mode.
Parameters:
iMode
flag for transformation type (creation or modification)
o SetElemToRotate
public virtual HRESULT SetElemToRotate( const CATISpecObject_var iElem) = 0
Sets the element that is rotated.
Parameters:
iElem
new element that is rotated
o SetFirstElement
public virtual HRESULT SetFirstElement( const CATISpecObject_var iElem1) = 0
Sets the first element defining the rotation angle.
Parameters:
oElem1
The first element.
o SetFirstPoint
public virtual HRESULT SetFirstPoint( const CATISpecObject_var iPoint1) = 0
Sets the first point defining the rotation.
Parameters:
oPoint1
The first point.
o SetOrientationOfFirstElement
public virtual HRESULT SetOrientationOfFirstElement( const CATBoolean iOrient1)=0
Sets the orientation of the first element (line or plane).
Parameters:
iOrient
: False means that there is no invertion of the orientation : True to invert this orientation
o SetOrientationOfSecondElement
public virtual HRESULT SetOrientationOfSecondElement( const CATBoolean iOrient2)=0
Sets the orientation of the second element (line or plane).
Parameters:
iOrient
: False means that there is no invertion of the orientation : True to invert this orientation
o SetRotationType
public virtual HRESULT SetRotationType( const enum CATGSMRotationType iType)= 0
Sets the type of the rotation definition.
Parameters:
iType
Type of rotation :
- CATGSMAxisAngle,
- CATGSMAxisTwoElem,
- CATGSMThreePoints,
- CATGSMUnknownRotationType.
See also:
CATGSMRotationType
o SetSecondElement
public virtual HRESULT SetSecondElement( const CATISpecObject_var iElem2) = 0
Sets the second element defining the rotation angle.
Parameters:
oElem2
The second element.
o SetSecondPoint
public virtual HRESULT SetSecondPoint( const CATISpecObject_var iPoint2) = 0
Sets the second point defining the rotation.
Parameters:
oPoint.2
The second point.
o SetThirdPoint
public virtual HRESULT SetThirdPoint( const CATISpecObject_var iPoint3) = 0
Sets the third point defining the rotation.
Parameters:
oPoint.3
The third point.

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

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