pycatia.hybrid_shape_interfaces.hybrid_shape_rotate

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_rotate.HybridShapeRotate(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
HybridShapeRotate

Represents the hybrid shape rotate feature object.
Role: To access the data of the hybrid shape rotate feature object. This data
includes:

The element to be rotated
The rotation axis
The angle and its value

LICENSING INFORMATION: Creation of volume result requires GSO
License
if GSO License is not granted , setting of Volume context has not
effect
Use the CATIAHybridShapeFactory to create HybridShapeFeature
object.

See also:
HybridShapeFactory
property angle: pycatia.knowledge_interfaces.angle.Angle

Note

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

Returns the rotation angle.
Return type

Angle

property angle_value: float

Note

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

Returns or sets the rotation angle value.

Example: This example retrieves in AngleValue the angle value for the
Rotate hybrid shape feature.

Dim AngleValue As double
Set AngleValue = Rotate.AngleValue
Return type

float

property axis: pycatia.in_interfaces.reference.Reference

Note

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

Returns or sets the rotation axis.
Sub-element(s) supported (see Boundary object): Edge.

Example: This example retrieves in RotationAxis the rotation axis for the
Rotate hybrid shape feature.

Dim RotationAxis As Reference
Set RotationAxis = Rotate.Axis
Return type

Reference

property elem_to_rotate: pycatia.in_interfaces.reference.Reference

Note

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

Returns or sets the element to be rotated.

Example: This example retrieves in Elem the element to be rotated for the
Rotate hybrid shape feature.

Dim Elem As Reference
Set Elem = Rotate.ElemToRotate
Return type

Reference

property first_element: pycatia.in_interfaces.reference.Reference

Note

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

Returns or sets the first element defining the rotation angle.
Return type

Reference

property first_point: pycatia.in_interfaces.reference.Reference

Note

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

Returns or sets the first point defining the rotation.
Return type

Reference

get_creation_mode() → int

Note

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

Gets the creation mode.
Legal values:

0
CATGSMTransfoModeUnset. Default behavior: creation mode by default for
all features, modification mode for axis system
1
CATGSMTransfoModeCreation. Creation mode.
2
CATGSMTransfoModeModification. Modification mode.

Example:
This example retrieves in oCreation the creation mode for the hybShpRotate
hybrid shape feature.

oCreation = hybShpRotate.GetCreationMode
Return type

int

property orientation_of_first_element: bool

Note

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

Returns or sets the orientation of the first element defining the rotation
angle.
This applies in case of line or plane element.
Return type

bool

property orientation_of_second_element: bool

Note

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

Returns or sets the orientation of the second element defining the rotation
angle.
This applies in case of line or plane element.
Return type

bool

property rotation_type: int

Note

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

Returns or sets the type of the rotation definition.

0= Axis + angle
1= Axis + two elements
2= Three Points
3= Unknown type
Return type

int

property second_element: pycatia.in_interfaces.reference.Reference

Note

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

Returns or sets the second element defining the rotation angle.
Return type

Reference

property second_point: pycatia.in_interfaces.reference.Reference

Note

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

Returns or sets the second point defining the rotation.
Return type

Reference

set_creation_mode(i_creation: bool) → None

Note

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

Sets the creation mode(creation or modification).
Legal values: True if the result is a creation feature and False if the
result is a modification feature.

Example:

This example sets that the mode of
the hybShpRotate hybrid shape rotate to creation


hybShpRotate.SetCreationMode True
Parameters

i_creation (bool) –

Return type

None

property third_point: pycatia.in_interfaces.reference.Reference

Note

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

Returns or sets the third point defining the rotation.
Return type

Reference

property volume_result: bool

Note

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

Returns or sets the volume result.
Legal values: True if the result of Rotate is required as volume (option is
effective only in case of volumes,requires GSO License) and False if it is
needed as surface .

Example:

This example sets that the result of
the hybShpRotate hybrid shape rotate is volume.


hybShpRotate.VolumeResult = True
Return type

bool