All Frameworks  Object Hierarchy  This Framework  Indexes

HybridShapeCircle (Object)

Represents the hybrid shape circle object.
Role: To access the data of the hybrid shape circle object.

This data includes:

All interfaces for different type of circle derivates HybridShapeCircle.

Use the CATIAHybridShapeFactory to create a HybridShapeCircle objects.

See also:
HybridShapeFactory

Property Index

AxisComputation
Returns or sets the axis computation mode.
AxisDirection
Role: To get_Direction on the object.
EndAngle
Returns the circle end angle.
StartAngle
Returns the circle start angle.

Method Index

GetAxis
Returns the axis of the Circle.
GetCenter
Gets the mathematical center of the circle.
GetFreeCenter
Returns the circle center.
GetFreeRadius
Returns the circle radius.
GetLimitation
Gets the limitation type for the circle.
SetLimitation
Set the circle limitation type.

Properties


o Property AxisComputation() As
Returns or sets the axis computation mode.
Example:
This example retrieves the axis computation mode of the hybShpCircle 
 Dim axisComp As Boolean
 axisComp = hybShpCircle.AxisComputation
o Property AxisDirection() As
Role: To get_Direction on the object.
Parameters:
oDir
return value for CATScript applications, with (IDLRETVAL) function type
See also:
HybridShapeDirection
Returns:
HRESULT S_OK if Ok E_FAIL else return error code for C++ Implementations
See also:
HybridShapeFactory
o Property EndAngle() As (Read Only)
Returns the circle end angle.
Example:
This example retrieves in ShpCircleEndAngle the end angle of the ShpCircle hybrid shape circle. 
 Dim ShpCircleEndAngle As Angle
 ShpCircleEndAngle = ShpCircle.EndAngle
o Property StartAngle() As (Read Only)
Returns the circle start angle.
Example:
This example retrieves in ShpCircleStartAngle the end angle of the ShpCircle hybrid shape circle. 
 Dim ShpCircleStartAngle As Angle
 ShpCircleStartAngle = ShpCircle.StartAngle

Methods


o Sub GetAxis( iPosition,
oAxis)
Returns the axis of the Circle.
Parameters:
iType
Type of axis to be retrived. 3 - CATGSMAxisLineType_NormalToCircle 2 - CATGSMAxisLineType_NormalToDirection 1 - CATGSMAxisLineType_AlignedWithDirection
oAxis
Reference to the element.
Example:
This example retrieves the axis of the circle. HybShpCircle hybrid shape circle. 
 Dim AxisRef As Reference
 HybShpCircle.GetAxis 1, AxisRef
o Sub GetCenter( oCenterX,
oCenterY,
oCenterZ)
Gets the mathematical center of the circle. This information is available once the circle has been computed.
Parameters:
oCenterX,
oCenterY, oCenterZ, circle center
o Sub GetFreeCenter( ioCenter)
Returns the circle center.
Parameters:
oCenter
The circle center. It is returned as an array of three coordinates in SafeArrayVariant
Example:
This example retrieves in HybShpCircleCenter the center of the HybShpCircle hybrid shape circle. 
 Dim HybShpCircleCenter
 ReDim HybShpCircleCenter(2)
 ShpCircle.GetFreeRadius(HybShpCircleCenter)

You can access each center coordinate as follows:

  • x is in HybShpCircleCenter(0)
  • y is in HybShpCircleCenter(1)
  • z is in HybShpCircleCenter(2)
o Sub GetFreeRadius( oRadius)
Returns the circle radius.
Parameters:
oRadius
The circle radius
Example:
This example retrieves in HybShpCircleRadius the radius of the HybShpCircle hybrid shape circle. 
 double HybShpCircleRadius
 ShpCircle.GetFreeRadius(HybShpCircleRadius)
o Func GetLimitation() As
Gets the limitation type for the circle.
Parameters:
oLimit
(Angles = 0, Whole = 1, Trimmed = 2, Complementary = 3). circle limitation
o Sub SetLimitation( iLimitation)
Set the circle limitation type.
Parameters:
iLimitation
The circle limitation type
Legal values:
0
Angles
1
Whole
2
Trimmed
3
Complementary
Example:
This example sets the limitiation type of the ShpCircle hybrid shape circle to trimmed. 
 ShpCircle.SetLimitation 2

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