All Frameworks  Object Hierarchy  This Framework  Indexes

HybridShapeAffinity (Object)

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 , settting of Volume context has not effect

Use the CATIAHybridShapeFactory to create a HybridShapeAffinity object.

See also:: HybridShapeFactory

AxisFirstDirection: Returns or sets the first direction of the reference coordinate system.
AxisOrigin: Returns or sets the origin of the reference coordinate system.
AxisPlane: Returns or sets the reference plane of the reference coordinate system.
CreationMode: Returns or sets the creation mode(creation or modification).
ElemToTransform: Returns or sets the element to transform using the affinity.
VolumeResult: Returns or sets the volume result.
XRatios: Returns the affinity ratio along the X Direction of the reference coordinate system.
YRatios: Returns the affinity ratio along the Y Direction of the reference coordinate system.
ZRatios: Returns the affinity ratio along the Z Direction of the reference coordinate system.

Properties

o Property AxisFirstDirection(

) As

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

o Property AxisOrigin(

) As

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

o Property AxisPlane(

) As

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

o Property CreationMode(

) As

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

o Property ElemToTransform(

) As

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

o Property VolumeResult(

) As

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

o Property XRatios(

) As (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

o Property YRatios(

) As (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

o Property ZRatios(

) As (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

HybridShapeAffinity (Object)

Property Index

Properties