pycatia.part_interfaces.circ_pattern

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.part_interfaces.circ_pattern.CircPattern(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

MecModInterfaces.Shape

PartInterfaces.TransformationShape

PartInterfaces.Pattern

CircPattern

Represents the circular pattern.

The shape is duplicated along concentric circles to build crowns. A linear

repartition object defines the duplication along radial directions, thus

determining the number of crowns. An angular repartition object defines the

duplication on the crowns.

See also:

LinearRepartition, AngularRepartition

property angular_direction_row: IntParam

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property AngularDirectionRow() As IntParam (Read Only)

Returns the position of the shape to be copied along the angular

direction.

Example:

The following example returns in AngularDirPos the position of the

shape to be copied along the angular direction.

Set AngularDirPos = firstPattern.AngularDirectionRow

Return type:

IntParam

property angular_repartition: AngularRepartition

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property AngularRepartition() As AngularRepartition (Read

Only)

Returns the angular repartition. The angular repartition is the repartition

on a crown.

Example:

The following example returns in repartA the angular repartition of the

circular pattern firstPattern:

Set repartA = firstPattern.AngularRepartition

Return type:

AngularRepartition

property circular_pattern_parameters: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property CircularPatternParameters() As

CatCircularPatternParameters

Returns or sets the circular pattern parameters required to define the

pattern. These parameters are used when reading the CATIAAngularRepartition

properties.

Example:

The following example returns in parameters the circular pattern

parameters of the firstPattern circular pattern, and then sets it to

catCompleteCrown, so that only the number of instances is used to define the

Pattern:

Set parameters = firstPattern.CircularPatternParameters

Set firstPattern.CircularPatternParameters = catCompleteCrown

Returns:

enum cat_circular_pattern_parameters

Return type:

int

get_rotation_axis(io_rotation_axis: tuple) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetRotationAxis(CATSafeArrayVariant ioRotationAxis)

Returns the rotation axis. The rotation axis is returned as an array

containing the rotation axis vector components. Assume this array is

oRotationAxis. It contains:

oRotationAxis[0],oRotationAxis[1],oRotationAxis[2]

The X, Y, and Z rotation axis vector components

Example:

The following example returns in axisArray the rotation axis components

of the circular pattern firstPattern:

Call firstPattern.GetRotationAxis(axisArray)

Set x = axisArray[0]

Set y = axisArray[1]

Set z = axisArray[2]

Parameters:

io_rotation_axis (tuple) –

Return type:

None

get_rotation_center(io_rotation_center: tuple) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetRotationCenter(CATSafeArrayVariant

ioRotationCenter)

Returns the rotation center if the user defined it. Returns E_FAIL if no

rotation center has been defined The rotation center is returned as an array

containing the rotation center coordinates. Assume this array is

oRotationCenter. It contains:

oRotationCenter[0],oRotationCenter[1],oRotationCenter[2]

The X, Y, and Z rotation center coordinates

Example:

The following example returns in centerArray the rotation center

coordinates of the circular pattern firstPattern, and saves them in

variables:

Call firstPattern.GetRotationCenter(centerArray)

x = centerArray[0]

y = centerArray[1]

z = centerArray[2]

Parameters:

io_rotation_center (tuple) –

Return type:

None

property radial_alignment: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property RadialAlignment() As boolean

Returns or sets whether the copied shapes should be rotated or radial

aligned with respect to the original one.

True if the copied shapes are rotated.

Example:

The following example returns in alignedR the radial alignment of the

circular pattern firstPattern, and then sets it to

False:

Set alignedR = firstPattern.RadialAlignment

firstPattern.RadialAlignment = False

Return type:

bool

property radial_direction_row: IntParam

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property RadialDirectionRow() As IntParam (Read Only)

Returns the position of the shape to be copied along the radial

direction.

Example:

The following example returns in RadialDirPos the position of the shape

to be copied along the radial direction.

Set RadialDirPos = firstPattern.RadialDirectionRow

Return type:

IntParam

property radial_repartition: LinearRepartition

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property RadialRepartition() As LinearRepartition (Read

Only)

Returns the radial repartition. The radial repartition is the repartition

along a radius.

Example:

The following example returns in repartR the radial repartition of the

circular pattern firstPattern:

Set repartR = firstPattern.RadialRepartition

Return type:

LinearRepartition

property rotation_orientation: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property RotationOrientation() As boolean

Returns or sets whether the shapes are copied clockwise on the crowns with

respect to the rotation axis direction.

True if the shapes are copied counterclockwise when the rotation axis

direction goes towards you when you look at the crown.

Example:

The following example returns in alignedAxis whether the circular

pattern firstPattern is built clockwise, and then sets it to

True:

alignedAxis = firstPattern.RotationOrientation

firstPattern.RotationOrientation = True

Return type:

bool

set_instance_angular_spacing(i_instance_number: int, i_angular_spacing: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetInstanceAngularSpacing(long iInstanceNumber,

double iAngularSpacing)

Sets the InstanceAngularSpacing.

Parameters:

iInstanceNumber

The Instance Number

iAngularSpacing

The Angular Spacing

Example:

The following example sets the InstanceAngularSpacing of the circular

pattern

Parameters:

• i_instance_number (int) –

• i_angular_spacing (float) –

Return type:

None

set_rotation_axis(i_rotation_axis: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetRotationAxis(Reference iRotationAxis)

Sets the rotation axis.

Parameters:

iRotationAxis

The rotation axis. It is passed as reference and can be valuated

with a line, an edge or a plane reference: in this case the plane normal is

taken into account.

The following

Boundary objects are supported: PlanarFace, CylindricalFace

RectilinearTriDimFeatEdge and RectilinearBiDimFeatEdge.

Example:

The following example sets the rotation axis of the circular pattern

firstPattern with the refLine1 reference:

firstPattern.SetRotationAxis refLine1

Parameters:

i_rotation_axis (Reference) –

Return type:

None

set_rotation_center(i_rotation_center: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetRotationCenter(Reference iRotationCenter)

Sets the rotation center.

Parameters:

iRotationCenter

The rotation center

Example:

The following example sets the rotation center of the circular pattern

firstPattern with point1Ref point:

firstPattern.SetRotationCenter point1Ref

Parameters:

i_rotation_center (Reference) –

Return type:

None

set_unequal_instance_number(i_instance_number: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetUnequalInstanceNumber(long iInstanceNumber)

Sets the Instance Number.

Parameters:

iInstanceNumber

The Instance Number

Example:

The following example modifies the instance number for unequal angular

spacing

Parameters:

i_instance_number (int) –

Return type:

None

set_unequal_step(i_instance_number: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetUnequalStep(long iInstanceNumber)

This method is deprecated Sets the UnequalStep.

Parameters:

iInstanceNumber

The Instance Number

Example:

The following example creates the number of pattern spacing objects in

pattern object

Parameters:

i_instance_number (int) –

Return type:

None