pycatia.hybrid_shape_interfaces.hybrid_shape_extrude¶
Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-07-06 14:02:20.222384
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.hybrid_shape_interfaces.hybrid_shape_extrude.HybridShapeExtrude(com_object)¶
Note
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
System.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectMecModInterfaces.HybridShapeHybridShapeExtrudeThe Extrude feature : an Extrude is made up of a face to process and one Extrude parameter.Role: To access the data of the hybrid shape extrude featureobject.LICENSING INFORMATION: Creation of volume result requires GSOLicenseif GSO License is not granted , setting of Volume context has noteffect- property begin_offset: Length¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property BeginOffset() As Length (Read Only)Role: To get_BeginOffset on the object. For surface extrude, if limit typeis upto, this offset value is not used. In case of Volume Extrude, if the up-toelement is specified, this will act as offset value from the uptoelement.Parameters:oExtrudereturn value for CATScript applications, with (IDLRETVAL) functiontypeSee also:LengthReturns:HRESULT S_OK if Ok E_FAIL else return error code for C++ImplementationsSee also:HybridShapeFactory
- Return type:
- property context: int¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property Context() As longReturns or sets the context on Extrude feature.Legal values:0 This option creates surface of extrusion.1 This option creates volume of extrusion.Note: Setting volume result requires GSO License.Example:This example retrieves in oContext the context for the Extrude1 hybridshape feature.Dim oContextSet oContext = Extrude1.Context
- Return type:
int
- property direction: HybridShapeDirection¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property Direction() As HybridShapeDirectionRole: To get_Direction on the object.Parameters:oDirreturn value for CATScript applications, with (IDLRETVAL) functiontypeSee also:HybridShapeDirectionReturns:HRESULT S_OK if Ok E_FAIL else return error code for C++ImplementationsSee also:HybridShapeFactory
- Return type:
- property end_offset: Length¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property EndOffset() As Length (Read Only)Role: To get_EndOffset on the object. For surface extrude, if limit type isupto, this offset value is not used. In case of Volume Extrude, if the up-toelement is specified, this will act as offset value from the uptoelement.Parameters:oExtrudereturn value for CATScript applications, with (IDLRETVAL) functiontypeSee also:LengthReturns:HRESULT S_OK if Ok E_FAIL else return error code for C++ImplementationsSee also:HybridShapeFactory
- Return type:
- property extruded_object: Reference¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property ExtrudedObject() As ReferenceRole: To get_ExtrudedObject on the object.Parameters:oFaceToExtrudereturn value for CATScript applications, with (IDLRETVAL) functiontypeSee also:ReferenceReturns:HRESULT S_OK if Ok E_FAIL else return error code for C++ImplementationsSee also:HybridShapeFactory
- Return type:
- property first_limit_type: int¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property FirstLimitType() As longReturns or sets the First limit type.Legal values:0Unknown Limit type.1Limit type is Dimension. It implies that limit is defined bylength2Limit type is UptoElement. It implies that limit is defined by ageometrical elementExample:This example retrieves in oLim1Type the first limit type for the Extrudehybrid shape feature.Dim oLim1TypeSet oLim1Type = Extrude.FirstLimitType
- Return type:
int
- property first_upto_element: Reference¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property FirstUptoElement() As ReferenceReturns or sets the First up-to element used to limitextrusion.Example:This example retrieves in Lim1Elem the First up-to element for theExtrude hybrid shape feature.Dim Lim1Elem As ReferenceSet Lim1Elem = Extrude.FirstUptoElement
- Return type:
- property orientation: bool¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property Orientation(boolean iOrientation)Gets or sets orientation of the extrude.Orientation = TRUE : The natural orientation is taken. =FALSE : The opposite orientation is taken This example retrieves in IsInverted orientation of theextrude for the Extrude hybrid shape feature.Dim IsInverted As booleanIsInverted = Extrude.Orientation
- Return type:
bool
- property second_limit_type: int¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property SecondLimitType() As longReturns or sets the Second limit type.Legal values:0Unknown Limit type.1Limit type is Dimension. It implies that limit is defined bylength2Limit type is UptoElement. It implies that limit is defined by ageometrical elementExample:This example retrieves in oLim2Type the second limit type for the Extrudehybrid shape feature.Dim oLim2TypeSet oLim2Type = Extrude.SecondLimitType
- Return type:
int
- property second_upto_element: Reference¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property SecondUptoElement() As ReferenceReturns or sets the Second up-to element used to limitextrusion.Example:This example retrieves in Lim2Elem the Second up-to element for theExtrude hybrid shape feature.Dim Lim2Elem As ReferenceSet Lim2Elem = Extrude.SecondUptoElement
- Return type:
- property symmetrical_extension: bool¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property SymmetricalExtension() As booleanReturns or Sets the Symmetrical Extension of Extrude (Limit 2 = -Limit 1).Parameters:iSymSymetry flag
- Return type:
bool