pycatia.hybrid_shape_interfaces.hybrid_shape_circle

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-07-06 14:02:20.222384

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.hybrid_shape_interfaces.hybrid_shape_circle.HybridShapeCircle(com_object)

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
MecModInterfaces.HybridShape
HybridShapeCircle

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

This data includes:

The circle radius
Two circle center
The circle arc limitation mode
The circle start and end angles

All interfaces for different type of circle derivates
HybridShapeCircle.

Use the CATIAHybridShapeFactory to create a HybridShapeCircle
objects.

See also:
HybridShapeFactory
property axis_computation: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property AxisComputation() As boolean

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
Return type:

bool

property axis_direction: HybridShapeDirection

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property AxisDirection() As HybridShapeDirection

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
Return type:

HybridShapeDirection

property end_angle: Angle

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property EndAngle() As Angle (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
Return type:

Angle

get_axis(i_position: int, o_axis: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetAxis(long iPosition,
Reference 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
Parameters:

  • i_position (int) –

  • o_axis (Reference) –

Return type:

None

get_center(o_center_x: float, o_center_y: float, o_center_z: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetCenter(double oCenterX,
double oCenterY,
double oCenterZ)

Gets the mathematical center of the circle. This information is available
once the circle has been computed.

Parameters:

oCenterX,
oCenterY, oCenterZ, circle center
Parameters:

  • o_center_x (float) –

  • o_center_y (float) –

  • o_center_z (float) –

Return type:

None

get_free_center() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetFreeCenter(CATSafeArrayVariant 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)
Return type:

tuple

get_free_radius() → float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetFreeRadius(double 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)
Return type:

float

get_limitation() → int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetLimitation() As long

Gets the limitation type for the circle.

Parameters:

oLimit
(Angles = 0, Whole = 1, Trimmed = 2, Complementary = 3). circle limitation
Return type:

int

set_limitation(i_limitation: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetLimitation(long 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
Parameters:

i_limitation (int) –

Return type:

None

property start_angle: Angle

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property StartAngle() As Angle (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
Return type:

Angle