pycatia.hybrid_shape_interfaces.hybrid_shape_circle_ctr_rad

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_ctr_rad.HybridShapeCircleCtrRad(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
CATGSMIDLItf.HybridShapeCircle
HybridShapeCircleCtrRad

Represents the hybrid shape circle object defined using a center and a
radius.
Role: To access the data of the hybrid shape circle object.

This data includes:

The circle center
The circle radius
The surface that supports the circle

Use the CATIAHybridShapeFactory to create a HybridShapeCircleCtrRad
object.

See also:
HybridShapeFactory
property center: Reference

Note

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

Returns or sets the circle center.
Sub-element(s) supported (see Boundary object): Vertex.

Example:
This example retrieves in HybShpCircleCenter the center of the
HybShpCircle hybrid shape circle.

Dim HybShpCircleCenter As Reference
HybShpCircleCenter = HybShpCircle.Center
Return type:

Reference

property diameter: Length

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Diameter() As Length (Read Only)

Returns the circle diameter.
It is expressed as a Length literal. Succeeds only if DiameterMode is set
to True.

Example:
This example retrieves in HybShpCircleDiameter the diameter of the
HybShpCircle hybrid shape circle feature

Dim HybShpCircleDiameter As Length
HybShpCircleDiameter = HybShpCircle.Diameter
Return type:

Length

property diameter_mode: bool

Note

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

Returns or sets the DiameterMode.
Legal values: True implies diameter False implies radius (default). When
DiameterMode is changed, Radius/Diameter value, which is stored will not be
modified.

Example:

This example sets that the DiameterMode of
the HybShpCircle hybrid shape circle feature


HybShpCircle.DiameterMode = True
Return type:

bool

property first_direction: HybridShapeDirection

Note

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

Returns or sets the first direction used to set the angles reference.


Example:
This example retrieves in myHybridShapeDirection the first direction of the
HybShpCircle hybrid shape circle feature

Dim myHybridShapeDirection As CATIAHybridShapeDirection
myHybridShapeDirection = HybShpCircle.FirstDirection


See also:
HybridShapeDirection
Return type:

HybridShapeDirection

get_second_direction(o_dir_x: float, o_dir_y: float, o_dir_z: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetSecondDirection(double oDirX,
double oDirY,
double oDirZ)

Gets the second direction on the plane to compute the point (for
stability).
This direction has to be kept perpendicular to the first
direction

Parameters:

oDirX,
oDirY, oDirZ. second direction

See also:
HybridShapeDirection
Parameters:

  • o_dir_x (float) –

  • o_dir_y (float) –

  • o_dir_z (float) –

Return type:

None

is_geodesic() → bool

Note

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

Queries whether the circle is geodesic or not.

Parameters:

oGeod
geodesic type : when TRUE, the circle is geodesic.
Return type:

bool

property radius: Length

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Radius() As Length (Read Only)

Returns the circle radius. It is expressed as a Length literal. Succeeds
only if DiameterMode is set to False.

Example:
This example retrieves in HybShpCircleRadius the radius of the HybShpCircle
hybrid shape circle.

Dim HybShpCircleRadius As Length
HybShpCircleRadius = HybShpCircle.Radius
Return type:

Length

set_geometry_on_support() → None

Note

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

Sets GeometryOnSupport of circle.
It puts the circle on the surface.
Return type:

None

set_second_direction(i_dir_x: float, i_dir_y: float, i_dir_z: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetSecondDirection(double iDirX,
double iDirY,
double iDirZ)

Sets the second direction on the plane to compute the point (for
stability).
This direction has to be kept perpendicular to the first
direction

Parameters:

iDirX,
iDirY, iDirZ. second direction

See also:
HybridShapeDirection
Parameters:

  • i_dir_x (float) –

  • i_dir_y (float) –

  • i_dir_z (float) –

Return type:

None

property support: Reference

Note

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

Returns or sets the circle support surface.
Sub-element(s) supported (see Boundary object): Face.

Example:
This example retrieves in HybShpCircleSupportSurf the support surface
of the HybShpCircle hybrid shape circle.

Dim HybShpCircleSupportSurf As Reference
HybShpCircleSupportSurf = HybShpCircle.Support
Return type:

Reference

unset_geometry_on_support() → None

Note

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

Inactivates GeometryOnSupport of circle.
Note: The circle becomes euclidean.
Return type:

None