All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMHelix

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

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


interface CATIGSMHelix

Interface to helix feature.
Role: Allows you to access data of the Helix feature created by using an axis, a starting point, a pitch, a height and 2 angle values.

See also:
CATIGSMFactory.CreateHelix


Method Index


o GetAxis()
Gets the helix axis.
o GetHeight(CATICkeParm_var&)
Gets the height of the helix.
o GetHeight(double&)
Gets the height of the helix.
o GetInvertAxis(CATBoolean&)
Gets the orientation.
o GetPitch(CATICkeParm_var&)
Gets the pitch of the helix.
o GetPitch(double&)
Gets the pitch of the helix.
o GetPitch2(CATICkeParm_var&)
Gets the second pitch of the helix.
o GetPitch2(double&)
Gets the second pitch of the helix.
o GetPitchLawType(enum CATGSMBasicLawType&)
Gets pitch law type.
o GetProfile()
Gets the profile of the helix.
o GetRevolutions(CATICkeParm_var&)
Gets the revolution number of the helix.
o GetRevolutions(double&)
Gets the revolution number of the helix.
o GetStartingAngle(CATICkeParm_var&)
Gets the helix starting angle.
o GetStartingAngle(double&)
Gets the helix starting angle.
o GetStartingPoint()
Gets the starting point of the helix.
o GetTaperAngle(CATICkeParm_var&)
Gets the helix taper angle.
o GetTaperAngle(double&)
Gets the helix taper angle.
o GetTaperOutward(CATBoolean&)
Gets the taper angle sense of variation.
o InvertAxis()
Inverts the orientation of the axis.
o SetAxis(CATISpecObject_var)
Sets the helix axis.
o SetClockwiseRevolution(CATBoolean)
Sets the sense of revolutions.
o SetHeight(CATICkeParm_var)
Sets the helix height.
o SetHeight(double)
Sets the helix height.
o SetInvertAxis(CATBoolean)
Sets the orientation.
o SetPitch(CATICkeParm_var)
Sets the helix pitch.
o SetPitch(double)
Sets the helix pitch.
o SetPitch2(CATICkeParm_var)
Sets the helix second pitch.
o SetPitch2(double)
Sets the helix second pitch.
o SetPitchLawType(enum CATGSMBasicLawType)
Sets pitch law type.
o SetProfile(CATISpecObject_var)
Sets the profile.
o SetRevolutions(CATICkeParm_var)
Sets the revolution number.
o SetRevolutions(double)
Sets the revolution number.
o SetStartingAngle(CATICkeParm_var)
Sets the starting angle.
o SetStartingAngle(double)
Sets the starting angle.
o SetStartingPoint(CATISpecObject_var)
Sets the starting point.
o SetTaperAngle(CATICkeParm_var)
Sets the taper angle.
o SetTaperAngle(double)
Sets the taper angle.
o SetTaperOutward(CATBoolean)
Sets the taper angle sense of variation.

Methods


o GetAxis
public virtual CATISpecObject_var GetAxis()= 0
Gets the helix axis. T
Note: he starting point must not be on the helix axis
Returns:
The helix axis
o GetHeight
public virtual HRESULT GetHeight(CATICkeParm_var& oHeight) = 0
Gets the height of the helix.
Parameters:
oHeight
The helix height.
o GetHeight
public virtual HRESULT GetHeight(double& oHeight) = 0
Gets the height of the helix.
Parameters:
oHeight
The helix height.
o GetInvertAxis
public virtual HRESULT GetInvertAxis(CATBoolean& oInvert) = 0
Gets the orientation.
Parameters:
oInvert

: FALSE means that there is no invertion (natural orientation)
: TRUE to invert this orientation
o GetPitch
public virtual HRESULT GetPitch(CATICkeParm_var& oPitch) = 0
Gets the pitch of the helix.
Parameters:
oPitch
The helix pitch.
o GetPitch
public virtual HRESULT GetPitch(double& oPitch) = 0
Gets the pitch of the helix.
Parameters:
oPitch
The helix pitch.
o GetPitch2
public virtual HRESULT GetPitch2(CATICkeParm_var& oPitch) = 0
Gets the second pitch of the helix.
Parameters:
oPitch
The helix second pitch.
o GetPitch2
public virtual HRESULT GetPitch2(double& oPitch) = 0
Gets the second pitch of the helix.
Parameters:
oPitch
The helix second pitch.
o GetPitchLawType
public virtual HRESULT GetPitchLawType(enum CATGSMBasicLawType& oType) = 0
Gets pitch law type.
Parameters:
oType
Type of law (from CATGSMBasicLawType enumeration).
See also:
CATGSMBasicLawType
o GetProfile
public virtual CATISpecObject_var GetProfile()= 0
Gets the profile of the helix.
Returns:
The profile
o GetRevolutions
public virtual HRESULT GetRevolutions(CATICkeParm_var& oRevolutions) = 0
Gets the revolution number of the helix.
Parameters:
oRevolutions
Revolutions.
o GetRevolutions
public virtual HRESULT GetRevolutions(double& oRevolutions) = 0
Gets the revolution number of the helix.
Parameters:
oRevolutions
Revolutions.
o GetStartingAngle
public virtual HRESULT GetStartingAngle(CATICkeParm_var& oStartingAngle) = 0
Gets the helix starting angle.
Parameters:
oStartingAngle
The starting angle.
o GetStartingAngle
public virtual HRESULT GetStartingAngle(double& oStartingAngle) = 0
Gets the helix starting angle.
Parameters:
oStartingAngle
The starting angle.
o GetStartingPoint
public virtual CATISpecObject_var GetStartingPoint()= 0
Gets the starting point of the helix.
Note: The starting point must not be on the helix axis
Returns:
The starting point
o GetTaperAngle
public virtual HRESULT GetTaperAngle(CATICkeParm_var& oTaperAngle) = 0
Gets the helix taper angle.
Parameters:
oTaperAngle
The taper angle.
o GetTaperAngle
public virtual HRESULT GetTaperAngle(double& oTaperAngle) = 0
Gets the helix taper angle.
Parameters:
oTaperAngle
The taper angle.
o GetTaperOutward
public virtual HRESULT GetTaperOutward(CATBoolean& oTaperOutward) = 0
Gets the taper angle sense of variation.
Parameters:
oTaperOutward

: FALSE means that helix radius decreases
: TRUE means that helix radius increases
o InvertAxis
public virtual HRESULT InvertAxis()=0
Inverts the orientation of the axis.
o SetAxis
public virtual HRESULT SetAxis( const CATISpecObject_var iElem1) = 0
Sets the helix axis.
Parameters:
iElem1
The new helix axis.
o SetClockwiseRevolution
public virtual HRESULT SetClockwiseRevolution(CATBoolean iClockwise) = 0
Sets the sense of revolutions.
Parameters:
iClockwise

: FALSE means that revolutions are counter-clockwise
: TRUE means that revolutions are clockwise
o SetHeight
public virtual HRESULT SetHeight( const CATICkeParm_var iHeight) = 0
Sets the helix height.
Parameters:
iHeight
The new height value.
o SetHeight
public virtual HRESULT SetHeight(double iHeight) = 0
Sets the helix height.
Parameters:
iHeight
The new height value.
o SetInvertAxis
public virtual HRESULT SetInvertAxis(CATBoolean iInvert) = 0
Sets the orientation.
Parameters:
iInvert

: FALSE means that there is no invertion of the natural orientation
: TRUE to invert this orientation
o SetPitch
public virtual HRESULT SetPitch( const CATICkeParm_var iPitch) = 0
Sets the helix pitch.
Parameters:
iPitch
The new second pitch value.
o SetPitch
public virtual HRESULT SetPitch(double iPitch) = 0
Sets the helix pitch.
Parameters:
iPitch
The new pitch value.
o SetPitch2
public virtual HRESULT SetPitch2( const CATICkeParm_var iPitch) = 0
Sets the helix second pitch.
Parameters:
iPitch
The new second pitch value.
o SetPitch2
public virtual HRESULT SetPitch2(double iPitch) = 0
Sets the helix second pitch.
Parameters:
iPitch
The new second pitch value.
o SetPitchLawType
public virtual HRESULT SetPitchLawType( const enum CATGSMBasicLawType iType) = 0
Sets pitch law type.
Parameters:
iType
Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_SType.
See also:
CATGSMBasicLawType
o SetProfile
public virtual HRESULT SetProfile( const CATISpecObject_var iElem1) = 0
Sets the profile.
Parameters:
iElem1
New profile.
Note: iElem1 = NULL_var unsets the profile.
o SetRevolutions
public virtual HRESULT SetRevolutions( const CATICkeParm_var iRevolutions) = 0
Sets the revolution number.
Parameters:
iRevolutions
The new revolutions value.
o SetRevolutions
public virtual HRESULT SetRevolutions(double iRevolutions) = 0
Sets the revolution number.
Parameters:
iRevolutions
The new revolutions value.
o SetStartingAngle
public virtual HRESULT SetStartingAngle( const CATICkeParm_var iStartingAngle) = 0
Sets the starting angle.
Parameters:
iStartingAngle
The new starting angle value.
o SetStartingAngle
public virtual HRESULT SetStartingAngle(double iStartingAngle) = 0
Sets the starting angle.
Parameters:
iStartingAngle
The new starting angle value.
o SetStartingPoint
public virtual HRESULT SetStartingPoint( const CATISpecObject_var iElem1) = 0
Sets the starting point.
Parameters:
iElem1
New starting point.
o SetTaperAngle
public virtual HRESULT SetTaperAngle( const CATICkeParm_var iTaperAngle) = 0
Sets the taper angle.
Parameters:
iTaperAngle
The new taper angle value.
o SetTaperAngle
public virtual HRESULT SetTaperAngle(double iTaperAngle) = 0
Sets the taper angle.
Parameters:
iTaperAngle
The new taper angle value.
o SetTaperOutward
public virtual HRESULT SetTaperOutward(CATBoolean iTaperOutward) = 0
Sets the taper angle sense of variation.
Parameters:
iTaperOutward

: FALSE means that helix radius decreases
: TRUE means that helix radius increases

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

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