pycatia.cat_tps_interfaces.dimension_3d

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

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.cat_tps_interfaces.dimension_3d.Dimension3D(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

Dimension3D

Interface Managing Semantic Dimension.

controled_radius() → ControlledRadius

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func ControledRadius() As ControledRadius

Get the Dimension on the Controled Radius interface.

Parameters:

oContRadius

The Controled Radius.

Return type:

ControledRadius

dimension_limit() → DimensionLimit

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func DimensionLimit() As DimensionLimit

Gets the Dimension on the DimensionLimit interface.

Parameters:

oDimLim

The Dimension Limits.

Return type:

DimensionLimit

dimension_pattern() → DimensionPattern

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func DimensionPattern() As DimensionPattern

Gets the Dimension on the DimensionPattern interface.

Parameters:

oDimPatt

The Dimension Pattern.

Return type:

DimensionPattern

envelope_condition() → EnvelopeCondition

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func EnvelopCondition() As EnvelopCondition

Gets the Dimension on the EnvelopCondition interface.

Parameters:

oEnvCond

The Envelop Condition.

Return type:

EnvelopCondition

get_2d_annot() → DrawingDimension

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func Get2dAnnot() As DrawingDimension

Retrieves Drafting Dimension.

Parameters:

oDim

The Drafting Dimension.

Return type:

DrawingDimension

has_a_controlled_radius() → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func HasAControledRadius() As boolean

Checks if the Dimension has a Controled Radius.

Parameters:

oHasConRad

TRUE: The dimension has a Controled Radius

FALSE: The dimension has not a Controled

Radius

Return type:

bool

has_an_envelope_condition() → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func HasAnEnvelopCondition() As boolean

Checks if the Annotation has an Envelop Condition.

Parameters:

oHasEnvCond

TRUE: The dimension has an Envelop Condition

FALSE: The dimension has not an Envelop

Condition

Return type:

bool

has_dimension_limit() → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func HasDimensionLimit() As boolean

Checks if the Dimension has a Dimension Limit.

Parameters:

oHasDimLim

TRUE: Dimension Limit exists

FALSE: Dimension Limit does not exist

Return type:

bool

is_a_dimension_pattern() → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func IsADimensionPattern() As boolean

Checks if the Semantic Dimension is a Dimension Pattern.

Parameters:

oIsADimPatt

TRUE: The dimension is a Dimension Pattern

FALSE: The dimension is not a Dimension

Pattern

Return type:

bool

move_value(x: float, y: float, sub_part: int, dim_angle_behavior: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub MoveValue(double X,

double Y,

long SubPart,

long DimAngleBehavior)

Moves the dimension value at a given point.

Returns:

HRESULT error returned code If the modification of the vertical offset value can not be performed because the parameter is locked in the current standard, the method return HRESULT = S_READ_ONLY.

Parameters:

X

Point abscissa on which the dimension value will be positionned.

Y

Point ordinate on which the dimension value will be positionned.

SubPart

Defines which part of the dimension should be

moved

-1 = Value (vertical move is take account according ptPos coordinates)

0 = Both dimension line and value

1 = Value

2 = Dimension line

3 = Secondary part

4 = Secondary part and value

5 = Secondary part and dimension line

6 = Secondary part, dimension line and value

7 = Value leader (for dimension line with leader one part or two parts)

DimAngleBehavior

Defines angle dimension line behavior.

0 = Sector angle is switched when ptPos is in opposite sector (Default)

1 = Sector angle is kept what ever ptPos placement

Example:

This example move dimension value MyDimension

path.

MyDimension.MoveValue(X, Y, SubPart,

DimAngleBehavior)

Parameters:

• x (float) –

• y (float) –

• sub_part (int) –

• dim_angle_behavior (int) –

Return type:

None