All Frameworks Class Hierarchy This Framework Previous Next Indexes
GSMInterfaces Interface CATIGSMSpiral
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIGSMSpiral
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMSpiral
Interface to Spiral feature.
Role: Allows you to access data of the Spiral feature.
- See also:
- CATIGSMFactory.CreateSpiral
Method Index
- o
GetAxis(CATIGSMDirection_var&)
- Gets the spiral axis.
- o
GetCenterPoint(CATISpecObject_var&)
- Gets the spiral center point.
- o
GetClockwiseRevolution(CATBoolean&)
- Gets the sense of revolutions.
- o
GetEndingAngle(CATICkeParm_var&)
- Gets the spiral ending angle.
- o
GetEndingAngle(double&)
- Gets the spiral ending angle.
- o
GetEndingRadius(CATICkeParm_var&)
- Gets the spiral ending radius.
- o
GetEndingRadius(double&)
- Gets the spiral ending radius.
- o
GetInvertAxis(CATBoolean&)
- Gets the orientation.
- o
GetPitch(CATICkeParm_var&)
- Gets the spiral pitch.
- o
GetPitch(double&)
- Gets the spiral pitch.
- o
GetRevolutions(CATICkeParm_var&)
- Gets the revolution number.
- o
GetRevolutions(double&)
- Gets the revolution number.
- o
GetStartingRadius(CATICkeParm_var&)
- Gets the spiral starting radius.
- o
GetStartingRadius(double&)
- Gets the spiral starting radius.
- o
GetSupport(CATISpecObject_var&)
- Gets the spiral planar support.
- o
GetType(enum Type&)
- Gets spiral type.
- o
SetAxis(CATISpecObject_var)
- Sets the Spiral axis.
- o
SetCenterPoint(CATISpecObject_var)
- Sets the spiral center point.
- o
SetClockwiseRevolution(CATBoolean)
- Sets the sense of revolutions.
- o
SetEndingAngle(CATICkeParm_var)
- Sets the spiral ending angle.
- o
SetEndingAngle(double)
- Sets the spiral ending angle.
- o
SetEndingRadius(CATICkeParm_var)
- Sets the spiral ending radius.
- o
SetEndingRadius(double)
- Sets the spiral ending radius.
- o
SetInvertAxis(CATBoolean)
- Sets the orientation.
- o
SetPitch(CATICkeParm_var)
- Sets the spiral pitch.
- o
SetPitch(double)
- Sets the spiral pitch.
- o
SetRevolutions(CATICkeParm_var)
- Sets the revolution number.
- o
SetRevolutions(double)
- Sets the revolution number.
- o
SetStartingRadius(CATICkeParm_var)
- Sets the spiral starting radius.
- o
SetStartingRadius(double)
- Sets the spiral starting radius.
- o
SetSupport(CATISpecObject_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 HRESULT GetAxis( | CATIGSMDirection_var& | oAxis) =0 |
-
Gets the spiral axis.
- Parameters:
-
- oAxis
-
- See also:
- CATIGSMDirection
o GetCenterPoint
public virtual HRESULT GetCenterPoint( | CATISpecObject_var& | oElem) = 0 |
-
Gets the spiral center point.
- Parameters:
-
- oElem
- Center point.
o GetClockwiseRevolution
-
Gets the sense of revolutions.
- Parameters:
-
- oClockwise
-
: FALSE means that revolutions are counter-clockwise
: TRUE means that revolutions are clockwise
o GetEndingAngle
public virtual HRESULT GetEndingAngle( | CATICkeParm_var& | oValue) = 0 |
-
Gets the spiral ending angle.
- Parameters:
-
- oValue
- Spiral ending angle.
o GetEndingAngle
public virtual HRESULT GetEndingAngle( | double& | oValue) = 0 |
-
Gets the spiral ending angle.
- Parameters:
-
- oValue
- Spiral ending angle.
o GetEndingRadius
public virtual HRESULT GetEndingRadius( | CATICkeParm_var& | oValue) = 0 |
-
Gets the spiral ending radius.
- Parameters:
-
- oValue
- Spiral ending radius.
o GetEndingRadius
public virtual HRESULT GetEndingRadius( | double& | oValue) = 0 |
-
Gets the spiral ending radius.
- Parameters:
-
- oValue
- Spiral ending radius.
o GetInvertAxis
-
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 spiral pitch.
- Parameters:
-
- oPitch
- Spiral pitch.
o GetPitch
public virtual HRESULT GetPitch( | double& | oPitch) = 0 |
-
Gets the spiral pitch.
- Parameters:
-
- oPitch
- Spiral pitch.
o GetRevolutions
public virtual HRESULT GetRevolutions( | CATICkeParm_var& | oRevolutions) = 0 |
-
Gets the revolution number.
- Parameters:
-
- oRevolutions
- Revolutions.
o GetRevolutions
public virtual HRESULT GetRevolutions( | double& | oRevolutions) = 0 |
-
Gets the revolution number.
- Parameters:
-
- oRevolutions
- Revolutions.
o GetStartingRadius
public virtual HRESULT GetStartingRadius( | CATICkeParm_var& | oValue) = 0 |
-
Gets the spiral starting radius.
- Parameters:
-
- oValue
- Spiral starting radius.
o GetStartingRadius
public virtual HRESULT GetStartingRadius( | double& | oValue) = 0 |
-
Gets the spiral starting radius.
It defines the starting point: distance from the center point on the axis.
- Parameters:
-
- oValue
- Spiral starting radius.
o GetSupport
public virtual HRESULT GetSupport( | CATISpecObject_var& | oElem) = 0 |
-
Gets the spiral planar support.
- Parameters:
-
- oElem
- Planar support.
o GetType
public virtual HRESULT GetType( | enum Type& | oType) = 0 |
-
Gets spiral type.
- Parameters:
-
- oType
- Type of spiral (from Type enumeration).
o SetAxis
-
Sets the Spiral axis.
- Parameters:
-
- iElem1
- The new Spiral axis.
o SetCenterPoint
-
Sets the spiral center point.
- Parameters:
-
- iElem
- Center point.
o SetClockwiseRevolution
-
Sets the sense of revolutions.
- Parameters:
-
- iClockwise
-
: FALSE means that revolutions are counter-clockwise
: TRUE means that revolutions are clockwise
o SetEndingAngle
-
Sets the spiral ending angle.
- Parameters:
-
- iValue
- Spiral ending angle.
o SetEndingAngle
public virtual HRESULT SetEndingAngle( | const double | iValue) = 0 |
-
Sets the spiral ending angle.
- Parameters:
-
- iValue
- Spiral ending angle.
o SetEndingRadius
-
Sets the spiral ending radius.
- Parameters:
-
- iValue
- Spiral ending radius.
o SetEndingRadius
public virtual HRESULT SetEndingRadius( | const double | iValue) = 0 |
-
Sets the spiral ending radius.
- Parameters:
-
- iValue
- Spiral ending radius.
o SetInvertAxis
-
Sets the orientation.
- Parameters:
-
- iInvert
-
: FALSE means that there is no invertion of the natural orientation
: TRUE to invert this orientation
o SetPitch
-
Sets the spiral pitch.
- Parameters:
-
- iPitch
- Spiral pitch.
o SetPitch
public virtual HRESULT SetPitch( | const double | iPitch) = 0 |
-
Sets the spiral pitch.
- Parameters:
-
- iPitch
- Spiral pitch.
o SetRevolutions
-
Sets the revolution number.
- Parameters:
-
- iRevolutions
- The new revolutions value.
o SetRevolutions
public virtual HRESULT SetRevolutions( | const double | iRevolutions) = 0 |
-
Sets the revolution number.
- Parameters:
-
- iRevolutions
- The new revolutions value.
o SetStartingRadius
-
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 HRESULT SetStartingRadius( | const double | iValue) = 0 |
-
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
-
Sets the spiral planar support.
- Parameters:
-
- iElem
- Planar support.
o SetType
public virtual HRESULT SetType( | const enum Type | iType) = 0 |
-
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: CATIGSMSpiral.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces