pycatia.part_interfaces.draft_domain

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.draft_domain.DraftDomain(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

DraftDomain

Represents the draft domain.

A draft domain is a basic object used by a draft shape. It contains objects

such as an angle, a pulling direction, and a collection of faces to be

drafted.

add_face_to_draft(i_face: Reference) → None

Note

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

o Sub AddFaceToDraft(Reference iFace)

Adds a face to those to be drafted.

Parameters:

iFace

The face to add to those to be drafted

The following

Boundary object is supported: ScFace.

Example:

The following example adds the face NewFaceToDraft to the draft domain

CurrentDraftDomain:

CurrentDraftDomain.AddFaceToDraft(NewFaceToDraft)

Parameters:

i_face (Reference) –

Return type:

None

property draft_angle: Angle

Note

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

o Property DraftAngle() As Angle (Read Only)

Returns the draft angle.

Example:

The following example returns in angle the draft angle of the draft

domain firstDraftDomain:

Set angle = firstDraftDomain.DraftAngle

Return type:

Angle

property faces_to_draft: References

Note

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

o Property FacesToDraft() As References (Read Only)

Returns the faces to be drafted. They are returned as a collection of

reference geometric elements.

Example:

The following example returns the collection of faces to be drafted of

the draft domain firstDraftDomain in list:

Set list = firstDraftDomain.FacesToDraft

Return type:

References

get_pulling_direction(io_pulling_direction: tuple) → None

Note

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

o Sub GetPullingDirection(CATSafeArrayVariant

ioPullingDirection)

Returns the draft pulling direction. The pulling direction is returned as

an array containing the pulling direction vector components. Assume this array

is PullDir. It contains:

PullDir[0],PullDir[1],PullDir[2]

The X, Y, and Z pulling direction vector components

Example:

The following example returns in PullDir the pulling direction vector

components of the draft domain firstDraftDomain:

Set PullDir = firstDraftDomain.PullingDirection

Set x = PullDir[0]

Set y = PullDir[1]

Set z = PullDir[2]

Parameters:

io_pulling_direction (tuple) –

Return type:

None

property multiselection_mode: int

Note

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

o Property MultiselectionMode() As CatDraftMultiselectionMode

Changes the multiselection mode.

Parameters:

iMultiselectionMode.

The elements to be drafted can be selected explicitly

(CATNoneDraftMultiselectionMode) or can implicitly selected as neighbors of the

neutral face (CATMultiselectionByNeutralMode)

Example:

The following example returns in MultiselMode the

multiselection mode of the draft domain firstDraftDomain, and then sets it to

CATMultiselectionByNeutralMode

Set MultiselMode = firstDraftDomain.MultiselectionMode

firstDraftDomain.MultiselectionMode = CATMultiselectionByNeutralMode

Returns:

enum cat_draft_multiselection_mode

Return type:

int

property neutral_element: Reference

Note

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

o Property NeutralElement() As Reference

Returns or sets the draft neutral element.

To set the property, you can use the following Boundary object:

PlanarFace.

Example:

The following example returns in neutral the neutral element of the

draft domain firstDraftDomain, and then sets it to

newNeutral:

Set neutral = firstDraftDomain.NeutralElement

firstDraftDomain.NeutralElement = newNeutral

Return type:

Reference

property neutral_propagation_mode: int

Note

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

o Property NeutralPropagationMode() As

CatDraftNeutralPropagationMode

Returns or sets the neutral element propagation mode. This mode is used

when computing the needed neutral elements.

Example:

The following example returns in propMode the neutral propagation mode

of the draft domain firstDraftDomain, and then sets it to

CATSmoothDraftNeutralPropagationMode so that the neutral propagation will now

be smooth:

Set propMode = firstDraftDomain.NeutralPropagationMode

firstDraftDomain.NeutralPropagationMode = CATSmoothDraftNeutralPropagationMode

Returns:

enum cat_draft_neutral_propagation_mode

Return type:

int

property pulling_direction_element: Reference

Note

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

o Property PullingDirectionElement() As Reference

Returns or sets the draft pulling direction element.

To set the property, you can use one of the following Boundary objects:

PlanarFace or RectilinearTriDimFeatEdge.

Example:

The following example returns in pullingdirection the pulling direction

element of the draft domain firstDraftDomain, and then sets it to

newPullingDirection:

Set pullingdirection = firstDraftDomain.NeutralElement

firstDraftDomain.PullingDirectionElement = newPullingDirection

Return type:

Reference

remove_face_to_draft(i_face: Reference) → None

Note

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

o Sub RemoveFaceToDraft(Reference iFace)

Removes a face from those to be drafted.

Parameters:

iFace

The face to be removed from those to be drafted

The following

Boundary object is supported: Face.

Example:

The following example removes the face FaceToRemove from the draft domain

CurrentDraftDomain:

CurrentDraftDomain.RemoveFaceToDraft(FaceToRemove)

Parameters:

i_face (Reference) –

Return type:

None

set_pulling_direction(i_x: float, i_y: float, i_z: float) → None

Note

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

o Sub SetPullingDirection(double iX,

double iY,

double iZ)

Sets the draft pulling direction.

Parameters:

iX,iY,iZ

The X, Y, and Z pulling direction vector components

Example:

The following example sets the draft pulling direction of the draft

domain firstDraftDomain to the direction with the vector components 10, -5,

10:

firstDraftDomain.PullingDirection 10, -5, 10

Parameters:

• i_x (float) –

• i_y (float) –

• i_z (float) –

Return type:

None

set_volume_support(i_volume_support: Reference) → None

Note

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

o Sub SetVolumeSupport(Reference iVolumeSupport)

Value the support of draft.

Parameters:

iVolumeSupport

Parameters:

i_volume_support (Reference) –

Return type:

None