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.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
MecModInterfaces.HybridShape
HybridShapeAffinity

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

The element to transform using the affinity
The affinity reference coordinate system origin
The affinity reference coordinate system reference plane
The affinity reference coordinate system first direction
The affinity ratio along the x, y and z directions of the reference
coordinate system
The element to transform using the affinity

The reference coordinate system is always a direct one.

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 a HybridShapeAffinity
object.

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 Reference

Returns or sets the first direction of the reference coordinate
system.
Sub-element(s) supported (see Boundary object): RectilinearTriDimFeatEdge,
RectilinearBiDimFeatEdge or RectilinearMonoDimFeatEdge.

Example:
This example retrieves in FirstDir the first direction of the reference
coordinate system used by the Affinity hybrid shape
feature.

Dim FirstDir As Reference
Set FirstDir = Affinity.AxisFirstDirection
Return type:

Reference

property axis_origin: Reference

Note

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

Returns or sets the origin of the reference coordinate
system.
Sub-element(s) supported (see Boundary object): Vertex.

Example:
This example retrieves in Origin the origin of the reference coordinate
system used by the Affinity hybrid shape feature.

Dim Origin As Reference
Set Origin = Affinity.AxisOrigin
Return type:

Reference

property axis_plane: Reference

Note

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

Returns or sets the reference plane of the reference coordinate
system.
Sub-element(s) supported (see Boundary object):
PlanarFace.

Example:
This example retrieves in RefPlane the reference plane of the reference
coordinate system used by the Affinity hybrid shape
feature.

Dim RefPlane As Reference
Set RefPlane = Affinity.AxisPlane
Return type:

Reference

property creation_mode: bool

Note

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

Returns or 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 hybShpAffinity hybrid shape affinity to creation


hybShpAffinity.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 Reference

Returns or sets the element to transform using the
affinity.

Example:
This example retrieves in ElementToTransform the element to transform
for the Affinity hybrid shape feature.

Dim ElementToTransform As Reference
Set ElementToTransform = Affinity.ElemToTransform
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 affinity 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 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 reference
coordinate system.

Example:
This example retrieves in X the ratio of the affinity along the X
Direction of the reference coordinate system used by the Affinity hybrid shape
feature.

Dim X As RealParam
Set X = Affinity.XRatios
Return type:

RealParam

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 reference
coordinate system.

Example:
This example retrieves in Y the ratio of the affinity along the Y
Direction of the reference coordinate system used by the Affinity hybrid shape
feature.

Dim Y As RealParam
Set Y = Affinity.YRatios
Return type:

RealParam

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 reference
coordinate system.

Example:
This example retrieves in Z the ratio of the affinity along the Z
Direction of the reference coordinate system used by the Affinity hybrid shape
feature.

Dim Z As RealParam
Set Z = Affinity.ZRatios
Return type:

RealParam