pycatia.hybrid_shape_interfaces.hybrid_shape_circle_center_axis

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_center_axis.HybridShapeCircleCenterAxis(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
HybridShapeCircleCenterAxis

Represents the hybrid shape circle object defined using a point and
axis/line.
Role: To access the data of the hybrid shape circle center axis
object.

This data includes:

Point
Axis/Line
Value of radius/diameter
Diameter Mode
Projection Mode

Use the CATIAHybridShapeFactory to create a HybridShapeCircleCenterAxis
object.

See also:
HybridShapeFactory.AddNewCircleCenterAxis
property axis: Reference

Note

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

Returns or sets the Axis of the circle.

Example:
This example retrieves in CircleAxis the Axis of plane in which circle
is lying from HybShpCircle hybrid shape circle center axis
feature

Dim CircleAxis As Reference
Set CircleAxis = HybShpCircle.Axis
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 center axis 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 center axis
feature


HybShpCircle.DiameterMode = True
Return type:

bool

property point: Reference

Note

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

Returns or sets the Point of the circle.

Example:
This example retrieves in CirclePoint the point used for center
computation from HybShpCircle hybrid shape circle center axis
feature

Dim CirclePoint As Reference
Set CirclePoint = HybShpCircle.Point
Return type:

Reference

property projection_mode: bool

Note

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

Returns or sets the ProjectionMode.
Legal values: True (default) implies point will be projected on to
axis/line False implies that point will be center of the
circle.

Example:

This example sets that the ProjectionMode of
the HybShpCircle hybrid shape circle center axis
feature


HybShpCircle.ProjectionMode = True
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 center axis feature

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

Length