pycatia.part_interfaces.prism

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.prism.Prism(com_object)

Note

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

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
MecModInterfaces.Shape
PartInterfaces.SketchBasedShape
Prism

Prism-based features in Part Design : base for pad or pocket.
property direction_orientation: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property DirectionOrientation() As CatPrismOrientation

Returns the prism direction orientation.

Returns:
oOrientation The direction orientation (see CatPrismOrientation for
list of possible types)

Example:
The following example saves in dirOrientation the direction
orientation of prism firstPrism, and then sets it so that the direction will be
now inversed :

Set dirOrientation = firstPrism.DirectionOrientation
firstPrism.DirectionOrientation = catInverseOrientation
Returns:

enum cat_prism_orientation

Return type:

int

property direction_type: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property DirectionType() As CatPrismExtrusionDirection

Returns the prism direction type.

Returns:
oDirType The direction type (see CatPrismExtrusionDirection for list of
possible types)

Example:
The following example saves in dirType the direction type of prism
firstPrism, and then sets it so that the direction will be now normal to the
sketch :

Set dirType = firstPrism.DirectionType
firstPrism.DirectionType = catNormalToSketchDirection
Returns:

enum cat_prism_extrusion_direction

Return type:

int

property first_limit: Limit

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property FirstLimit() As Limit (Read Only)

Returns the first prism limit (one of the two).
This limit manages the way the prism is ended.

Returns:
oFirstLimit The first limit (see Limit for more
information)

Example:
The following example returns in firstLimit the first limit of
prism firstPrism:

Set firstLimit = firstPrism.FirstLimit
Return type:

Limit

get_direction(io_direction: tuple) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetDirection(CATSafeArrayVariant ioDirection)

Returns the prism direction with absolute coordinates.
It needs a safe array with 3 elements : X, Y, Z direction coordinates
The array must be previously initialized

Returns:
ioDirection The direction coordinates

Example:
The following example returns in dirArray the direction coordinates
of prism firstPrism:

Dim dirArray(2)
Call firstPrism.GetDirection(dirArray)
Set x = dirArray[1]
Set y = dirArray[2]
Set z = dirArray[3]
Parameters:

io_direction (tuple) –

Return type:

None

property is_symmetric: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property IsSymmetric() As boolean

Returns the prism symmetry flag.
It returns TRUE if the prism is symmetric (from the base sketch), FALSE if
not.

Returns:
oIsSymmetric The symmetry flag as a boolean

Example:
The following example saves in symFlag the symmetry flag of prism
firstPrism, and then sets it so that it will be now symmetric (from the base
sketch) :

Set symFlag = firstPrism.IsSymmetric
firstPrism.IsSymmetric = TRUE
Return type:

bool

property is_thin: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property IsThin() As boolean

Returns the prism thin flag.
It returns TRUE if the prism is a thin prism , FALSE if
not.

Returns:
oIsThin The thin flag as a boolean

Example:
The following example saves in thinFlag the thin flag of prism
firstPrism, and then sets it so that it will be now thin
:

Set thinFlag = firstPrism.IsThin
firstPrism.IsThin = TRUE
Return type:

bool

property merge_end: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property MergeEnd() As boolean

Returns the prism merge end flag (for thin prism only).
It returns TRUE if merge ends is required , FALSE if not.

Returns:
oIsMergeEnd The merge end flag as a boolean

Example:
The following example saves in MergeEndFlag the merge end flag of
prism firstPrism, and then sets it so that merge end will be required
:

Set MergeEndFlag = firstPrism.IsMergeEnd
firstPrism.IsMergeEnd = TRUE
Return type:

bool

property neutral_fiber: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property NeutralFiber() As boolean

Returns the prism neutral fiber flag (for thin prism
only).
It returns TRUE if the prism is a neutral fiber prism , FALSE if
not.

Returns:
oIsNeutralFiber The neutral fiber flag as a boolean

Example:
The following example saves in NeutralFiberFlag the neutral fiber
flag of prism firstPrism, and then sets it so that it will be now neutral fiber
:

Set NeutralFiberFlag = firstPrism.IsNeutralFiber
firstPrism.IsNeutralFiber = TRUE
Return type:

bool

reverse_inner_side() → None

Note

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

Reverses the prism inner side when the profile is open. This is useful for
finding the shape to reach.

Example:
The following example reverses the current inner side of prism
firstPrism :

firstPrism.ReverseInnerSide
Return type:

None

property second_limit: Limit

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property SecondLimit() As Limit (Read Only)

Returns the second prism limit (one of the two).
This limit manages the way the prism is ended.

Returns:
oSecondLimit The second limit (see Limit for more
information)

Example:
The following example returns in secondLimit the second limit of
prism firstPrism:

Set secondLimit = firstPrism.SecondLimit
Return type:

Limit

set_direction(i_line: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetDirection(Reference iLine)

Sets the prism associative direction.

Parameters:

iLine
The support direction reference (see

Reference for more information)
This reference can be valuated with a reference to a line or an
edge.
The following Boundary objects are supported: PlanarFace,
RectilinearTriDimFeatEdge and
RectilinearBiDimFeatEdge.

Example:
The following example sets the prism direction reference of prism
firstPrism with prismDirRef line :

firstPrism.SetDirection prismDirRef
Parameters:

i_line (Reference) –

Return type:

None