CATGSMUseItf Interface CATIGSMUseSpiral
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMUseSpiral
Interface to Spiral feature.
Role: Allows you to access data of the Spiral feature.
- See also:
-
Method Index
- o
GetAxis(CATIGSMUseDirection_var&)
- Gets the spiral axis.
- o
GetCenterPoint(CATIMmiMechanicalFeature_var&)
- Gets the spiral center point.
- o
GetClockwiseRevolution(CATBoolean&)
- Gets the sense of revolutions.
- o
GetEndingAngle(double&)
- Gets the spiral ending angle.
- o
GetEndingAngle(CATICkeParm_var&)
- Gets the spiral ending angle.
- o
GetEndingRadius(double&)
- Gets the spiral ending radius.
- o
GetEndingRadius(CATICkeParm_var&)
- Gets the spiral ending radius.
- o
GetInvertAxis(CATBoolean&)
- Gets the orientation.
- o
GetPitch(double&)
- Gets the spiral pitch.
- o
GetPitch(CATICkeParm_var&)
- Gets the spiral pitch.
- o
GetRevolutions(double&)
- Gets the revolution number.
- o
GetRevolutions(CATICkeParm_var&)
- Gets the revolution number.
- o
GetStartingRadius(double&)
- Gets the spiral starting radius.
- o
GetStartingRadius(CATICkeParm_var&)
- Gets the spiral starting radius.
- o
GetSupport(CATIMmiMechanicalFeature_var&)
- Gets the spiral planar support.
- o
GetType(enum Type&)
- Gets spiral type.
- o
SetAxis(CATIMmiMechanicalFeature_var)
- Sets the Spiral axis.
- o
SetCenterPoint(CATIMmiMechanicalFeature_var)
- Sets the spiral center point.
- o
SetClockwiseRevolution(CATBoolean)
- Sets the sense of revolutions.
- o
SetEndingAngle(double)
- Sets the spiral ending angle.
- o
SetEndingAngle(CATICkeParm_var)
- Sets the spiral ending angle.
- o
SetEndingRadius(double)
- Sets the spiral ending radius.
- o
SetEndingRadius(CATICkeParm_var)
- Sets the spiral ending radius.
- o
SetInvertAxis(CATBoolean)
- Sets the orientation.
- o
SetPitch(double)
- Sets the spiral pitch.
- o
SetPitch(CATICkeParm_var)
- Sets the spiral pitch.
- o
SetRevolutions(double)
- Sets the revolution number.
- o
SetRevolutions(CATICkeParm_var)
- Sets the revolution number.
- o
SetStartingRadius(double)
- Sets the spiral starting radius.
- o
SetStartingRadius(CATICkeParm_var)
- Sets the spiral starting radius.
- o
SetSupport(CATIMmiMechanicalFeature_var)
- Sets the spiral planar support.
- o
SetType(enum Type)
- Sets spiral type.
Enumerated Type Index
- o
Type
- Type for Spiral definition.
Methods
o GetAxis
| public virtual GetAxis( | | oAxis) |
-
Gets the spiral axis.
- Parameters:
-
- oAxis
-
- See also:
-
o GetCenterPoint
| public virtual GetCenterPoint( | | oElem) |
-
Gets the spiral center point.
- Parameters:
-
- oElem
- Center point.
o GetClockwiseRevolution
| public virtual GetClockwiseRevolution( | | oClockwise) |
-
Gets the sense of revolutions.
- Parameters:
-
- oClockwise
-
: FALSE means that revolutions are counter-clockwise
: TRUE means that revolutions are clockwise
o GetEndingAngle
| public virtual GetEndingAngle( | | oValue) |
-
Gets the spiral ending angle.
- Parameters:
-
- oValue
- Spiral ending angle.
o GetEndingAngle
| public virtual GetEndingAngle( | | oValue) |
-
Gets the spiral ending angle.
- Parameters:
-
- oValue
- Spiral ending angle.
o GetEndingRadius
| public virtual GetEndingRadius( | | oValue) |
-
Gets the spiral ending radius.
- Parameters:
-
- oValue
- Spiral ending radius.
o GetEndingRadius
| public virtual GetEndingRadius( | | oValue) |
-
Gets the spiral ending radius.
- Parameters:
-
- oValue
- Spiral ending radius.
o GetInvertAxis
| public virtual GetInvertAxis( | | oInvert) |
-
Gets the orientation.
- Parameters:
-
- oInvert
-
: FALSE means that there is no invertion (natural orientation)
: TRUE to invert this orientation
o GetPitch
| public virtual GetPitch( | | oPitch) |
-
Gets the spiral pitch.
- Parameters:
-
- oPitch
- Spiral pitch.
o GetPitch
| public virtual GetPitch( | | oPitch) |
-
Gets the spiral pitch.
- Parameters:
-
- oPitch
- Spiral pitch.
o GetRevolutions
| public virtual GetRevolutions( | | oRevolutions) |
-
Gets the revolution number.
- Parameters:
-
- oRevolutions
- Revolutions.
o GetRevolutions
| public virtual GetRevolutions( | | oRevolutions) |
-
Gets the revolution number.
- Parameters:
-
- oRevolutions
- Revolutions.
o GetStartingRadius
| public virtual GetStartingRadius( | | oValue) |
-
Gets the spiral starting radius.
It defines the starting point: distance from the center point on the axis.
- Parameters:
-
- oValue
- Spiral starting radius.
o GetStartingRadius
| public virtual GetStartingRadius( | | oValue) |
-
Gets the spiral starting radius.
- Parameters:
-
- oValue
- Spiral starting radius.
o GetSupport
| public virtual GetSupport( | | oElem) |
-
Gets the spiral planar support.
- Parameters:
-
- oElem
- Planar support.
o GetType
| public virtual GetType( | | oType) |
-
Gets spiral type.
- Parameters:
-
- oType
- Type of spiral (from Type enumeration).
o SetAxis
| public virtual SetAxis( | const | iElem1) |
-
Sets the Spiral axis.
- Parameters:
-
- iElem1
- The new Spiral axis.
o SetCenterPoint
| public virtual SetCenterPoint( | const | iElem) |
-
Sets the spiral center point.
- Parameters:
-
- iElem
- Center point.
o SetClockwiseRevolution
| public virtual SetClockwiseRevolution( | const | iClockwise) |
-
Sets the sense of revolutions.
- Parameters:
-
- iClockwise
-
: FALSE means that revolutions are counter-clockwise
: TRUE means that revolutions are clockwise
o SetEndingAngle
| public virtual SetEndingAngle( | const | iValue) |
-
Sets the spiral ending angle.
- Parameters:
-
- iValue
- Spiral ending angle.
o SetEndingAngle
| public virtual SetEndingAngle( | const | iValue) |
-
Sets the spiral ending angle.
- Parameters:
-
- iValue
- Spiral ending angle.
o SetEndingRadius
| public virtual SetEndingRadius( | const | iValue) |
-
Sets the spiral ending radius.
- Parameters:
-
- iValue
- Spiral ending radius.
o SetEndingRadius
| public virtual SetEndingRadius( | const | iValue) |
-
Sets the spiral ending radius.
- Parameters:
-
- iValue
- Spiral ending radius.
o SetInvertAxis
| public virtual SetInvertAxis( | const | iInvert) |
-
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 SetPitch( | const | iPitch) |
-
Sets the spiral pitch.
- Parameters:
-
- iPitch
- Spiral pitch.
o SetPitch
| public virtual SetPitch( | const | iPitch) |
-
Sets the spiral pitch.
- Parameters:
-
- iPitch
- Spiral pitch.
o SetRevolutions
| public virtual SetRevolutions( | const | iRevolutions) |
-
Sets the revolution number.
- Parameters:
-
- iRevolutions
- The new revolutions value.
o SetRevolutions
| public virtual SetRevolutions( | const | iRevolutions) |
-
Sets the revolution number.
- Parameters:
-
- iRevolutions
- The new revolutions value.
o SetStartingRadius
| public virtual SetStartingRadius( | const | iValue) |
-
Sets the spiral starting radius.
It defines the starting point: distance from the center point on the axis.
- Parameters:
-
- iValue
- Spiral starting radius.
o SetStartingRadius
| public virtual SetStartingRadius( | const | iValue) |
-
Sets the spiral starting radius.
It defines the starting point: distance from the center point on the axis.
- Parameters:
-
- iValue
- Spiral starting radius.
o SetSupport
| public virtual SetSupport( | const | iElem) |
-
Sets the spiral planar support.
- Parameters:
-
- iElem
- Planar support.
o SetType
| public virtual SetType( | const | iType) |
-
Sets spiral type.
- Parameters:
-
- iType
- Type of spiral (from Type enumeration):
- AngleRadius
- AnglePitch
- PitchRadius.
Enumerated Types
o Type
-
enum Type {
AngleRadius,
AnglePitch,
PitchRadius
}
Type for Spiral definition.
Role: Used for Spiral creation and modifications
- Parameters:
-
- AngleRadius
- Angle and Radius.
- AnglePitch
- Angle and Pitch.
- PitchRadius
- Pitch and Radius.
This object is included in the file: CATIGSMUseSpiral.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.