pycatia.hybrid_shape_interfaces.hybrid_shape_affinity¶
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_affinity.HybridShapeAffinity(com_object)¶
Note
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
System.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectMecModInterfaces.HybridShapeHybridShapeAffinityRepresents the hybrid shape affinity feature object.Role: To access the data of the hybrid shape affinity feature object. This dataincludes:The element to transform using the affinityThe affinity reference coordinate system originThe affinity reference coordinate system reference planeThe affinity reference coordinate system first directionThe affinity ratio along the x, y and z directions of the referencecoordinate systemThe element to transform using the affinityThe reference coordinate system is always a direct one.LICENSING INFORMATION: Creation of volume result requires GSOLicenseif GSO License is not granted , setting of Volume context has noteffectUse the CATIAHybridShapeFactory to create a HybridShapeAffinityobject.See also:HybridShapeFactory- property axis_first_direction: Reference¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property AxisFirstDirection() As ReferenceReturns or sets the first direction of the reference coordinatesystem.Sub-element(s) supported (see Boundary object): RectilinearTriDimFeatEdge,RectilinearBiDimFeatEdge or RectilinearMonoDimFeatEdge.Example:This example retrieves in FirstDir the first direction of the referencecoordinate system used by the Affinity hybrid shapefeature.Dim FirstDir As ReferenceSet FirstDir = Affinity.AxisFirstDirection
- Return type:
- property axis_origin: Reference¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property AxisOrigin() As ReferenceReturns or sets the origin of the reference coordinatesystem.Sub-element(s) supported (see Boundary object): Vertex.Example:This example retrieves in Origin the origin of the reference coordinatesystem used by the Affinity hybrid shape feature.Dim Origin As ReferenceSet Origin = Affinity.AxisOrigin
- Return type:
- property axis_plane: Reference¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property AxisPlane() As ReferenceReturns or sets the reference plane of the reference coordinatesystem.Sub-element(s) supported (see Boundary object):PlanarFace.Example:This example retrieves in RefPlane the reference plane of the referencecoordinate system used by the Affinity hybrid shapefeature.Dim RefPlane As ReferenceSet RefPlane = Affinity.AxisPlane
- Return type:
- property creation_mode: bool¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property CreationMode() As booleanReturns or sets the creation mode(creation ormodification).Legal values: True if the result is a creation feature and False if theresult is a modification feature.Example:This example sets that the mode ofthe hybShpAffinity hybrid shape affinity to creationhybShpAffinity.CreationMode = True
- Return type:
bool
- property elem_to_transform: Reference¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property ElemToTransform() As ReferenceReturns or sets the element to transform using theaffinity.Example:This example retrieves in ElementToTransform the element to transformfor the Affinity hybrid shape feature.Dim ElementToTransform As ReferenceSet ElementToTransform = Affinity.ElemToTransform
- Return type:
- property volume_result: bool¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property VolumeResult() As booleanReturns or sets the volume result.Legal values: True if the result of affinity is required as volume (optionis effective only in case of volumes,requires GSO License) and False if it isneeded as surface .Example:This example sets that the result ofthe hybShpAffinity hybrid shape affinity is volume.hybShpAffinity.VolumeResult = True
- Return type:
bool
- property x_ratios: RealParam¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property XRatios() As RealParam (Read Only)Returns the affinity ratio along the X Direction of the referencecoordinate system.Example:This example retrieves in X the ratio of the affinity along the XDirection of the reference coordinate system used by the Affinity hybrid shapefeature.Dim X As RealParamSet X = Affinity.XRatios
- Return type:
- property y_ratios: RealParam¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property YRatios() As RealParam (Read Only)Returns the affinity ratio along the Y Direction of the referencecoordinate system.Example:This example retrieves in Y the ratio of the affinity along the YDirection of the reference coordinate system used by the Affinity hybrid shapefeature.Dim Y As RealParamSet Y = Affinity.YRatios
- Return type:
- property z_ratios: RealParam¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property ZRatios() As RealParam (Read Only)Returns the affinity ratio along the Z Direction of the referencecoordinate system.Example:This example retrieves in Z the ratio of the affinity along the ZDirection of the reference coordinate system used by the Affinity hybrid shapefeature.Dim Z As RealParamSet Z = Affinity.ZRatios
- Return type: