pycatia3dx.part.shape_factory

Module initially auto generated using DSYAutomation files from CATIA 3DX R2025x on 2025-09-28 13:20:20.191090

Warning

The notes denoted “3DEXPERIENCE Automation 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 pycatia3dx.part.shape_factory.ShapeFactory(com_object)
add_new_add(i_body_to_add: Body) → Add
Parameters:

i_body_to_add (Body)

Returns:

Add

add_new_affinity2(x_ratio: float, y_ratio: float, z_ratio: float) → AnyObject
Parameters:
  • x_ratio (float)

  • y_ratio (float)

  • z_ratio (float)

Returns:

AnyObject

add_new_assemble(i_body_to_assemble: Body) → Assemble
Parameters:

i_body_to_assemble (Body)

Returns:

Assemble

add_new_auto_draft(i_draft_angle: float) → AutoDraft
Parameters:

i_draft_angle (float)

Returns:

AutoDraft

add_new_auto_fillet(i_fillet_radius: float, i_round_radius: float) → AutoFillet
Parameters:
  • i_fillet_radius (float)

  • i_round_radius (float)

Returns:

AutoFillet

add_new_axis_to_axis2(i_reference: Reference, i_target: Reference) → AnyObject
Parameters:
Returns:

AnyObject

add_new_blend() → AnyObject
Returns:

AnyObject

add_new_chamfer(i_object_to_chamfer: Reference, i_propagation: int, i_mode: int, i_orientation: int, i_length1: float, i_length2_or_angle: float) → Chamfer
Parameters:
  • i_object_to_chamfer (Reference)

  • i_propagation (int)

  • i_mode (int)

  • i_orientation (int)

  • i_length1 (float)

  • i_length2_or_angle (float)

Returns:

Chamfer

add_new_circ_pattern(i_shape_to_copy: AnyObject, i_nb_of_copies_in_radial_dir: int, i_nb_of_copies_in_angular_dir: int, i_step_in_radial_dir: float, i_step_in_angular_dir: float, i_shape_to_copy_position_along_radial_dir: int, i_shape_to_copy_position_along_angular_dir: int, i_rotation_center: Reference, i_rotation_axis: Reference, i_is_reversed_rotation_axis: bool, i_rotation_angle: float, i_is_radius_aligned: bool) → CircPattern
Parameters:
  • i_shape_to_copy (AnyObject)

  • i_nb_of_copies_in_radial_dir (int)

  • i_nb_of_copies_in_angular_dir (int)

  • i_step_in_radial_dir (float)

  • i_step_in_angular_dir (float)

  • i_shape_to_copy_position_along_radial_dir (int)

  • i_shape_to_copy_position_along_angular_dir (int)

  • i_rotation_center (Reference)

  • i_rotation_axis (Reference)

  • i_is_reversed_rotation_axis (bool)

  • i_rotation_angle (float)

  • i_is_radius_aligned (bool)

Returns:

CircPattern

add_new_circ_pattern_of_list(i_shape_to_copy: AnyObject, i_nb_of_copies_in_radial_dir: int, i_nb_of_copies_in_angular_dir: int, i_step_in_radial_dir: float, i_step_in_angular_dir: float, i_shape_to_copy_position_along_radial_dir: int, i_shape_to_copy_position_along_angular_dir: int, i_rotation_center: Reference, i_rotation_axis: Reference, i_is_reversed_rotation_axis: bool, i_rotation_angle: float, i_is_radius_aligned: bool) → CircPattern
Parameters:
  • i_shape_to_copy (AnyObject)

  • i_nb_of_copies_in_radial_dir (int)

  • i_nb_of_copies_in_angular_dir (int)

  • i_step_in_radial_dir (float)

  • i_step_in_angular_dir (float)

  • i_shape_to_copy_position_along_radial_dir (int)

  • i_shape_to_copy_position_along_angular_dir (int)

  • i_rotation_center (Reference)

  • i_rotation_axis (Reference)

  • i_is_reversed_rotation_axis (bool)

  • i_rotation_angle (float)

  • i_is_radius_aligned (bool)

Returns:

CircPattern

add_new_close_surface(i_close_element: Reference) → CloseSurface
Parameters:

i_close_element (Reference)

Returns:

CloseSurface

add_new_defeaturing() → Defeaturing
Returns:

Defeaturing

add_new_draft(i_face_to_draft: Reference, i_neutral: Reference, i_neutral_mode: int, i_parting: Reference, i_dir_x: float, i_dir_y: float, i_dir_z: float, i_mode: int, i_angle: float, i_multiselection_mode: int) → Draft
Parameters:
  • i_face_to_draft (Reference)

  • i_neutral (Reference)

  • i_neutral_mode (int)

  • i_parting (Reference)

  • i_dir_x (float)

  • i_dir_y (float)

  • i_dir_z (float)

  • i_mode (int)

  • i_angle (float)

  • i_multiselection_mode (int)

Returns:

Draft

add_new_edge_fillet_with_constant_radius(i_edge_to_fillet: Reference, i_propag_mode: int, i_radius: float) → ConstRadEdgeFillet
Parameters:
  • i_edge_to_fillet (Reference)

  • i_propag_mode (int)

  • i_radius (float)

Returns:

ConstRadEdgeFillet

add_new_edge_fillet_with_varying_radius(i_edge_to_fillet: Reference, i_propag_mode: int, i_variation_mode: int, i_default_radius: float) → VarRadEdgeFillet
Parameters:
  • i_edge_to_fillet (Reference)

  • i_propag_mode (int)

  • i_variation_mode (int)

  • i_default_radius (float)

Returns:

VarRadEdgeFillet

add_new_face_fillet(i_f1: Reference, i_f2: Reference, i_radius: float) → FaceFillet
Parameters:
Returns:

FaceFillet

add_new_groove(i_sketch: Sketch) → Groove
Parameters:

i_sketch (Sketch)

Returns:

Groove

add_new_groove_from_ref(i_profile_elt: Reference) → Groove
Parameters:

i_profile_elt (Reference)

Returns:

Groove

add_new_gsd_circ_pattern(i_shape_to_copy: AnyObject, i_nb_of_copies_in_radial_dir: int, i_nb_of_copies_in_angular_dir: int, i_step_in_radial_dir: float, i_step_in_angular_dir: float, i_shape_to_copy_position_along_radial_dir: int, i_shape_to_copy_position_along_angular_dir: int, i_rotation_center: Reference, i_rotation_axis: Reference, i_is_reversed_rotation_axis: bool, i_rotation_angle: float, i_is_radius_aligned: bool, i_complete_crown: bool, i_type: float) → CircPattern
Parameters:
  • i_shape_to_copy (AnyObject)

  • i_nb_of_copies_in_radial_dir (int)

  • i_nb_of_copies_in_angular_dir (int)

  • i_step_in_radial_dir (float)

  • i_step_in_angular_dir (float)

  • i_shape_to_copy_position_along_radial_dir (int)

  • i_shape_to_copy_position_along_angular_dir (int)

  • i_rotation_center (Reference)

  • i_rotation_axis (Reference)

  • i_is_reversed_rotation_axis (bool)

  • i_rotation_angle (float)

  • i_is_radius_aligned (bool)

  • i_complete_crown (bool)

  • i_type (float)

Returns:

CircPattern

add_new_gsd_rect_pattern(i_shape_to_copy: AnyObject, i_nb_of_copies_in_dir1: int, i_nb_of_copies_in_dir2: int, i_step_in_dir1: float, i_step_in_dir2: float, i_shape_to_copy_position_along_dir1: int, i_shape_to_copy_position_along_dir2: int, i_dir1: Reference, i_dir2: Reference, i_is_reversed_dir1: bool, i_is_reversed_dir2: bool, i_rotation_angle: float, i_type: float) → RectPattern
Parameters:
  • i_shape_to_copy (AnyObject)

  • i_nb_of_copies_in_dir1 (int)

  • i_nb_of_copies_in_dir2 (int)

  • i_step_in_dir1 (float)

  • i_step_in_dir2 (float)

  • i_shape_to_copy_position_along_dir1 (int)

  • i_shape_to_copy_position_along_dir2 (int)

  • i_dir1 (Reference)

  • i_dir2 (Reference)

  • i_is_reversed_dir1 (bool)

  • i_is_reversed_dir2 (bool)

  • i_rotation_angle (float)

  • i_type (float)

Returns:

RectPattern

add_new_hole(i_support: Reference, i_depth: float) → Hole
Parameters:
Returns:

Hole

add_new_hole_from_point(i_x: float, i_y: float, i_z: float, i_support: Reference, i_depth: float) → Hole
Parameters:
  • i_x (float)

  • i_y (float)

  • i_z (float)

  • i_support (Reference)

  • i_depth (float)

Returns:

Hole

add_new_hole_from_ref_point(i_origin: Reference, i_support: Reference, i_depth: float) → Hole
Parameters:
Returns:

Hole

add_new_hole_from_sketch(i_sketch: Sketch, i_depth: float) → Hole
Parameters:
  • i_sketch (Sketch)

  • i_depth (float)

Returns:

Hole

add_new_hole_with2_constraints(i_x: float, i_y: float, i_z: float, i_edge1: Reference, i_edge2: Reference, i_support: Reference, i_depth: float) → Hole
Parameters:
Returns:

Hole

add_new_hole_with_constraint(i_x: float, i_y: float, i_z: float, i_edge: Reference, i_support: Reference, i_depth: float) → Hole
Parameters:
  • i_x (float)

  • i_y (float)

  • i_z (float)

  • i_edge (Reference)

  • i_support (Reference)

  • i_depth (float)

Returns:

Hole

add_new_intersect(i_body_to_intersect: Body) → Intersect
Parameters:

i_body_to_intersect (Body)

Returns:

Intersect

add_new_loft() → Loft
Returns:

Loft

add_new_manu_or_auto_partition(i_volume_to_be_partitioned: Reference, i_auto_mode: bool, i_cutting_element: Reference, i_limit: int) → Partition
Parameters:
  • i_volume_to_be_partitioned (Reference)

  • i_auto_mode (bool)

  • i_cutting_element (Reference)

  • i_limit (int)

Returns:

Partition

add_new_mirror(i_mirroring_element: Reference) → Mirror
Parameters:

i_mirroring_element (Reference)

Returns:

Mirror

add_new_pad(i_sketch: Sketch, i_height: float) → Pad
Parameters:
  • i_sketch (Sketch)

  • i_height (float)

Returns:

Pad

add_new_pad_from_ref(i_profile_elt: Reference, i_height: float) → Pad
Parameters:
Returns:

Pad

add_new_partition(i_splitting_element: Reference, i_split_side: int) → Split
Parameters:
  • i_splitting_element (Reference)

  • i_split_side (int)

Returns:

Split

add_new_pocket(i_sketch: Sketch, i_height: float) → Pocket
Parameters:
  • i_sketch (Sketch)

  • i_height (float)

Returns:

Pocket

add_new_pocket_from_ref(i_profile_elt: Reference, i_height: float) → Pocket
Parameters:
Returns:

Pocket

add_new_rect_pattern(i_shape_to_copy: AnyObject, i_nb_of_copies_in_dir1: int, i_nb_of_copies_in_dir2: int, i_step_in_dir1: float, i_step_in_dir2: float, i_shape_to_copy_position_along_dir1: int, i_shape_to_copy_position_along_dir2: int, i_dir1: Reference, i_dir2: Reference, i_is_reversed_dir1: bool, i_is_reversed_dir2: bool, i_rotation_angle: float) → RectPattern
Parameters:
  • i_shape_to_copy (AnyObject)

  • i_nb_of_copies_in_dir1 (int)

  • i_nb_of_copies_in_dir2 (int)

  • i_step_in_dir1 (float)

  • i_step_in_dir2 (float)

  • i_shape_to_copy_position_along_dir1 (int)

  • i_shape_to_copy_position_along_dir2 (int)

  • i_dir1 (Reference)

  • i_dir2 (Reference)

  • i_is_reversed_dir1 (bool)

  • i_is_reversed_dir2 (bool)

  • i_rotation_angle (float)

Returns:

RectPattern

add_new_rect_patternof_list(i_shape_to_copy: AnyObject, i_nb_of_copies_in_dir1: int, i_nb_of_copies_in_dir2: int, i_step_in_dir1: float, i_step_in_dir2: float, i_shape_to_copy_position_along_dir1: int, i_shape_to_copy_position_along_dir2: int, i_dir1: Reference, i_dir2: Reference, i_is_reversed_dir1: bool, i_is_reversed_dir2: bool, i_rotation_angle: float) → RectPattern
Parameters:
  • i_shape_to_copy (AnyObject)

  • i_nb_of_copies_in_dir1 (int)

  • i_nb_of_copies_in_dir2 (int)

  • i_step_in_dir1 (float)

  • i_step_in_dir2 (float)

  • i_shape_to_copy_position_along_dir1 (int)

  • i_shape_to_copy_position_along_dir2 (int)

  • i_dir1 (Reference)

  • i_dir2 (Reference)

  • i_is_reversed_dir1 (bool)

  • i_is_reversed_dir2 (bool)

  • i_rotation_angle (float)

Returns:

RectPattern

add_new_remove(i_body_to_remove: Body) → Remove
Parameters:

i_body_to_remove (Body)

Returns:

Remove

add_new_remove_face(i_keep_faces: Reference, i_remove_faces: Reference) → RemoveFace
Parameters:
Returns:

RemoveFace

add_new_removed_blend() → AnyObject
Returns:

AnyObject

add_new_removed_loft() → AnyObject
Returns:

AnyObject

add_new_replace_face(i_split_plane: Reference, i_remove_face: Reference, i_splitting_side: int) → ReplaceFace
Parameters:
Returns:

ReplaceFace

add_new_rib(i_sketch: Sketch, i_center_curve: Sketch) → Rib
Parameters:
Returns:

Rib

add_new_rib_from_ref(i_profile: Reference, i_center_curve: Reference) → Rib
Parameters:
Returns:

Rib

add_new_scaling(i_scaling_reference: Reference, i_factor: float) → Scaling
Parameters:
  • i_scaling_reference (Reference)

  • i_factor (float)

Returns:

Scaling

add_new_sew_surface(i_sewing_element: Reference, i_sewing_side: int) → SewSurface
Parameters:
  • i_sewing_element (Reference)

  • i_sewing_side (int)

Returns:

SewSurface

add_new_shaft(i_sketch: Sketch) → Shaft
Parameters:

i_sketch (Sketch)

Returns:

Shaft

add_new_shaft_from_ref(i_profile_elt: Reference) → Shaft
Parameters:

i_profile_elt (Reference)

Returns:

Shaft

add_new_shell(i_face_to_remove: Reference, i_internal_thickness: float, i_external_thickness: float) → Shell
Parameters:
  • i_face_to_remove (Reference)

  • i_internal_thickness (float)

  • i_external_thickness (float)

Returns:

Shell

add_new_slot(i_sketch: Sketch, i_center_curve: Sketch) → Slot
Parameters:
Returns:

Slot

add_new_slot_from_ref(i_profile: Reference, i_center_curve: Reference) → Slot
Parameters:
Returns:

Slot

add_new_solid_combine(i_profile_elt_first: Reference, i_profile_elt_second: Reference) → SolidCombine
Parameters:
Returns:

SolidCombine

add_new_solid_edge_fillet_with_constant_radius(i_edge_to_fillet: Reference, i_propag_mode: int, i_radius: float) → ConstRadEdgeFillet
Parameters:
  • i_edge_to_fillet (Reference)

  • i_propag_mode (int)

  • i_radius (float)

Returns:

ConstRadEdgeFillet

add_new_solid_edge_fillet_with_varying_radius(i_edge_to_fillet: Reference, i_propag_mode: int, i_variation_mode: int, i_default_radius: float) → VarRadEdgeFillet
Parameters:
  • i_edge_to_fillet (Reference)

  • i_propag_mode (int)

  • i_variation_mode (int)

  • i_default_radius (float)

Returns:

VarRadEdgeFillet

add_new_solid_face_fillet(i_f1: Reference, i_f2: Reference, i_radius: float) → FaceFillet
Parameters:
Returns:

FaceFillet

add_new_solid_tritangent_fillet(i_f1: Reference, i_f2: Reference, i_removed_face: Reference) → TritangentFillet
Parameters:
Returns:

TritangentFillet

add_new_split(i_splitting_element: Reference, i_split_side: int) → Split
Parameters:
  • i_splitting_element (Reference)

  • i_split_side (int)

Returns:

Split

add_new_stiffener(i_sketch: Sketch) → Stiffener
Parameters:

i_sketch (Sketch)

Returns:

Stiffener

add_new_stiffener_from_ref(i_profile_elt: Reference) → Stiffener
Parameters:

i_profile_elt (Reference)

Returns:

Stiffener

add_new_surface_edge_fillet_with_constant_radius(i_edge_to_fillet: Reference, i_propag_mode: int, i_radius: float) → ConstRadEdgeFillet
Parameters:
  • i_edge_to_fillet (Reference)

  • i_propag_mode (int)

  • i_radius (float)

Returns:

ConstRadEdgeFillet

add_new_surface_edge_fillet_with_varying_radius(i_edge_to_fillet: Reference, i_propag_mode: int, i_variation_mode: int, i_default_radius: float) → VarRadEdgeFillet
Parameters:
  • i_edge_to_fillet (Reference)

  • i_propag_mode (int)

  • i_variation_mode (int)

  • i_default_radius (float)

Returns:

VarRadEdgeFillet

add_new_surface_face_fillet(i_f1: Reference, i_f2: Reference, i_radius: float) → FaceFillet
Parameters:
Returns:

FaceFillet

add_new_surface_tritangent_fillet(i_f1: Reference, i_f2: Reference, i_removed_face: Reference) → TritangentFillet
Parameters:
Returns:

TritangentFillet

add_new_surfacic_auto_fillet(i_fillet_radius: float) → AutoFillet
Parameters:

i_fillet_radius (float)

Returns:

AutoFillet

add_new_surfacic_circ_pattern(i_shape_to_copy: AnyObject, i_nb_of_copies_in_radial_dir: int, i_nb_of_copies_in_angular_dir: int, i_step_in_radial_dir: float, i_step_in_angular_dir: float, i_shape_to_copy_position_along_radial_dir: int, i_shape_to_copy_position_along_angular_dir: int, i_rotation_center: Reference, i_rotation_axis: Reference, i_is_reversed_rotation_axis: bool, i_rotation_angle: float, i_is_radius_aligned: bool, i_complete_crown: bool) → CircPattern
Parameters:
  • i_shape_to_copy (AnyObject)

  • i_nb_of_copies_in_radial_dir (int)

  • i_nb_of_copies_in_angular_dir (int)

  • i_step_in_radial_dir (float)

  • i_step_in_angular_dir (float)

  • i_shape_to_copy_position_along_radial_dir (int)

  • i_shape_to_copy_position_along_angular_dir (int)

  • i_rotation_center (Reference)

  • i_rotation_axis (Reference)

  • i_is_reversed_rotation_axis (bool)

  • i_rotation_angle (float)

  • i_is_radius_aligned (bool)

  • i_complete_crown (bool)

Returns:

CircPattern

add_new_surfacic_rect_pattern(i_shape_to_copy: AnyObject, i_nb_of_copies_in_dir1: int, i_nb_of_copies_in_dir2: int, i_step_in_dir1: float, i_step_in_dir2: float, i_shape_to_copy_position_along_dir1: int, i_shape_to_copy_position_along_dir2: int, i_dir1: Reference, i_dir2: Reference, i_is_reversed_dir1: bool, i_is_reversed_dir2: bool, i_rotation_angle: float) → RectPattern
Parameters:
  • i_shape_to_copy (AnyObject)

  • i_nb_of_copies_in_dir1 (int)

  • i_nb_of_copies_in_dir2 (int)

  • i_step_in_dir1 (float)

  • i_step_in_dir2 (float)

  • i_shape_to_copy_position_along_dir1 (int)

  • i_shape_to_copy_position_along_dir2 (int)

  • i_dir1 (Reference)

  • i_dir2 (Reference)

  • i_is_reversed_dir1 (bool)

  • i_is_reversed_dir2 (bool)

  • i_rotation_angle (float)

Returns:

RectPattern

add_new_surfacic_sew_surface(i_type: int, i_support_surface: Reference, i_sewing_element: Reference, i_sewing_side: int) → SewSurface
Parameters:
  • i_type (int)

  • i_support_surface (Reference)

  • i_sewing_element (Reference)

  • i_sewing_side (int)

Returns:

SewSurface

add_new_surfacic_user_pattern(i_shape_to_copy: AnyObject, i_nb_of_copies: int) → UserPattern
Parameters:
  • i_shape_to_copy (AnyObject)

  • i_nb_of_copies (int)

Returns:

UserPattern

add_new_thick_surface(i_offset_element: Reference, i_isens_offset: int, i_top_offset: float, i_bot_offset: float) → ThickSurface
Parameters:
  • i_offset_element (Reference)

  • i_isens_offset (int)

  • i_top_offset (float)

  • i_bot_offset (float)

Returns:

ThickSurface

add_new_thickness(i_face_to_thicken: Reference, i_offset: float) → Thickness
Parameters:
  • i_face_to_thicken (Reference)

  • i_offset (float)

Returns:

Thickness

add_new_thread_with_out_ref() → Thread
Returns:

Thread

add_new_thread_with_ref(i_lateral_face: Reference, i_limit_face: Reference) → Thread
Parameters:
Returns:

Thread

add_new_trim(i_body_to_trim: Body) → Trim
Parameters:

i_body_to_trim (Body)

Returns:

Trim

add_new_tritangent_fillet(i_f1: Reference, i_f2: Reference, i_removed_face: Reference) → TritangentFillet
Parameters:
Returns:

TritangentFillet

add_new_user_pattern(i_shape_to_copy: AnyObject, i_nb_of_copies: int) → UserPattern
Parameters:
  • i_shape_to_copy (AnyObject)

  • i_nb_of_copies (int)

Returns:

UserPattern

add_new_user_pattern_of_list(i_shape_to_copy: AnyObject, i_nb_of_copies: int) → UserPattern
Parameters:
  • i_shape_to_copy (AnyObject)

  • i_nb_of_copies (int)

Returns:

UserPattern

add_new_volume_add(i_body1: Reference, i_body2: Reference, i_type: float) → Add
Parameters:
Returns:

Add

add_new_volume_close_surface(i_close_element: Reference) → CloseSurface
Parameters:

i_close_element (Reference)

Returns:

CloseSurface

add_new_volume_intersect(i_body1: Reference, i_body2: Reference, i_type: float) → Intersect
Parameters:
Returns:

Intersect

add_new_volume_remove(i_body1: Reference, i_body2: Reference, i_type: float) → Remove
Parameters:
Returns:

Remove

add_new_volume_sew_surface(i_type: int, i_support_volume: Reference, i_sewing_element: Reference, i_sewing_side: int) → SewSurface
Parameters:
  • i_type (int)

  • i_support_volume (Reference)

  • i_sewing_element (Reference)

  • i_sewing_side (int)

Returns:

SewSurface

add_new_volume_shell(i_face_to_remove: Reference, i_internal_thickness: float, i_external_thickness: float, i_volume_support: Reference) → Shell
Parameters:
  • i_face_to_remove (Reference)

  • i_internal_thickness (float)

  • i_external_thickness (float)

  • i_volume_support (Reference)

Returns:

Shell

add_new_volume_thick_surface(i_offset_element: Reference, i_isens_offset: int, i_top_offset: float, i_bot_offset: float) → ThickSurface
Parameters:
  • i_offset_element (Reference)

  • i_isens_offset (int)

  • i_top_offset (float)

  • i_bot_offset (float)

Returns:

ThickSurface

add_new_volume_thickness(i_face_to_thicken: Reference, i_offset: float, i_type: int, i_volume_support: Reference) → Thickness
Parameters:
  • i_face_to_thicken (Reference)

  • i_offset (float)

  • i_type (int)

  • i_volume_support (Reference)

Returns:

Thickness

add_new_volume_trim(i_support_volume: Reference, i_cutting_volume: Reference) → Trim
Parameters:
Returns:

Trim

add_new_volumic_draft(i_face_to_draft: Reference, i_neutral: Reference, i_neutral_mode: int, i_parting: Reference, i_dir_x: float, i_dir_y: float, i_dir_z: float, i_mode: int, i_angle: float, i_multiselection_mode: int, i_type: int, i_volume_support: Reference) → Draft
Parameters:
  • i_face_to_draft (Reference)

  • i_neutral (Reference)

  • i_neutral_mode (int)

  • i_parting (Reference)

  • i_dir_x (float)

  • i_dir_y (float)

  • i_dir_z (float)

  • i_mode (int)

  • i_angle (float)

  • i_multiselection_mode (int)

  • i_type (int)

  • i_volume_support (Reference)

Returns:

Draft