pycatia3dx.tps.annotation

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.tps.annotation.Annotation(com_object)
add_leader() → None
Returns:

None

apply_referenced_geom_color(i_releated_r: int, i_releated_g: int, i_releated_b: int) → None
Parameters:
  • i_releated_r (int)

  • i_releated_g (int)

  • i_releated_b (int)

Returns:

None

apply_referenced_init_color() → None
Returns:

None

associated_ref_frame() → AssociatedRefFrame
Returns:

AssociatedRefFrame

composite_tolerance() → CompositeTolerance
Returns:

CompositeTolerance

controled_radius() → ControlledRadius
Returns:

ControledRadius

datum_simple() → DatumSimple
Returns:

DatumSimple

datum_target() → DatumTarget
Returns:

DatumTarget

default_annotation() → DefaultAnnotation
Returns:

DefaultAnnotation

dimension3_d() → Dimension3D
Returns:

Dimension3D

dimension_limit() → DimensionLimit
Returns:

DimensionLimit

dimension_pattern() → DimensionPattern
Returns:

DimensionPattern

envelop_condition() → EnvelopCondition
Returns:

EnvelopCondition

flag_note() → FlagNote
Returns:

FlagNote

free_state() → FreeState
Returns:

FreeState

get_geometrical_component_name(i_index: int) → str
Parameters:

i_index (int)

Returns:

str

get_nbr_of_geometrical_component() → int
Returns:

int

get_surfaces() → tuple
Returns:

tuple

get_surfaces_count() → float
Returns:

float

has_a_controled_radius() → bool
Returns:

bool

has_a_free_state() → bool
Returns:

bool

has_a_material_condition() → bool
Returns:

bool

has_a_numerical_display_format() → bool
Returns:

bool

has_a_particular_tol_elem() → bool
Returns:

bool

has_a_tolerance_per_unit_basis_restrictive_value() → bool
Returns:

bool

has_an_envelop_condition() → bool
Returns:

bool

has_dimension_limit() → bool
Returns:

bool

is_a_composite_tolerance() → bool
Returns:

bool

is_a_default_annotation() → bool
Returns:

bool

is_a_dimension_pattern() → bool
Returns:

bool

is_a_projected_tolerance_zone() → bool
Returns:

bool

is_a_shifted_profile_tolerance() → bool
Returns:

bool

is_a_tangent_plane() → bool
Returns:

bool

is_a_tolerance_unit_basis_value() → bool
Returns:

bool

is_a_tolerance_zone() → bool
Returns:

bool

is_an_associated_ref_frame() → bool
Returns:

bool

material_condition() → MaterialCondition
Returns:

MaterialCondition

modify_visu() → None
Returns:

None

noa() → Noa
Returns:

Noa

numerical_display_format() → NumericalDisplayFormat
Returns:

NumericalDisplayFormat

particular_tol_elem() → ParticularTolElem
Returns:

ParticularTolElem

projected_tolerance_zone() → ProjectedToleranceZone
Returns:

ProjectedToleranceZone

reference_frame() → ReferenceFrame
Returns:

ReferenceFrame

roughness() → Roughness
Returns:

Roughness

set_geometrical_component_name(i_index: int, i_new_name: str, i_check_name_unicity_option: bool) → None
Parameters:
  • i_index (int)

  • i_new_name (str)

  • i_check_name_unicity_option (bool)

Returns:

None

set_xy(i_x: float, i_y: float) → None
Parameters:
  • i_x (float)

  • i_y (float)

Returns:

None

shifted_profile_tolerance() → ShiftedProfileTolerance
Returns:

ShiftedProfileTolerance

property super_type: str
Returns:

str

tangent_plane() → TangentPlane
Returns:

TangentPlane

text() → Text
Returns:

Text

tolerance_per_unit_basis_restrictive_value() → TolerancePerUnitBasisRestrictiveValue
Returns:

TolerancePerUnitBasisRestrictiveValue

tolerance_unit_basis_value() → ToleranceUnitBasisValue
Returns:

ToleranceUnitBasisValue

tolerance_zone() → ToleranceZone
Returns:

ToleranceZone

property tps_status: str
Returns:

str

transfert_to_view(i_view: TPSView) → None
Parameters:

i_view (TPSView)

Returns:

None

property type: str
Returns:

str

property z: None
Returns:

None