All Frameworks  Object Hierarchy  This Framework  Indexes

HybridShapeExtrude (Object)

The 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 feature object.

LICENSING INFORMATION: Creation of volume result requires GSO License
if GSO License is not granted , settting of Volume context has not effect

Property Index

BeginOffset
Role: To get_BeginOffset on the object.
Context
Returns or sets the context on Extrude feature.
Direction
Role: To get_Direction on the object.
EndOffset
Role: To get_EndOffset on the object.
ExtrudedObject
Role: To get_ExtrudedObject on the object.
FirstLimitType
Returns or sets the First limit type.
FirstUptoElement
Returns or sets the First up-to element used to limit extrusion.
Orientation
Gets or sets orientation of the extrude.
SecondLimitType
Returns or sets the Second limit type.
SecondUptoElement
Returns or sets the Second up-to element used to limit extrusion.
SymmetricalExtension
Returns or sets the symmetrical extension on Extrude limits.

Properties


o Property BeginOffset() As (Read Only)
Role: To get_BeginOffset on the object. For surface extrude, if limit type is upto, this offset value is not used. In case of Volume Extrude, if the up-to element is specified, this will act as offset value from the upto element.
Parameters:
oExtrude
return value for CATScript applications, with (IDLRETVAL) function type
See also:
Length
Returns:
HRESULT S_OK if Ok E_FAIL else return error code for C++ Implementations
See also:
HybridShapeFactory
o Property Context() As
Returns 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 hybrid shape feature. 
 Dim oContext
 Set oContext = Extrude1.Context
o Property Direction() As
Role: To get_Direction on the object.
Parameters:
oDir
return value for CATScript applications, with (IDLRETVAL) function type
See also:
HybridShapeDirection
Returns:
HRESULT S_OK if Ok E_FAIL else return error code for C++ Implementations
See also:
HybridShapeFactory
o Property EndOffset() As (Read Only)
Role: To get_EndOffset on the object. For surface extrude, if limit type is upto, this offset value is not used. In case of Volume Extrude, if the up-to element is specified, this will act as offset value from the upto element.
Parameters:
oExtrude
return value for CATScript applications, with (IDLRETVAL) function type
See also:
Length
Returns:
HRESULT S_OK if Ok E_FAIL else return error code for C++ Implementations
See also:
HybridShapeFactory
o Property ExtrudedObject() As
Role: To get_ExtrudedObject on the object.
Parameters:
oFaceToExtrude
return value for CATScript applications, with (IDLRETVAL) function type
See also:
Reference
Returns:
HRESULT S_OK if Ok E_FAIL else return error code for C++ Implementations
See also:
HybridShapeFactory
o Property FirstLimitType() As
Returns or sets the First limit type.
Legal values:
0
Unknown Limit type.
1
Limit type is Dimension. It implies that limit is defined by length
2
Limit type is UptoElement. It implies that limit is defined by a geometrical element
Example:
This example retrieves in oLim1Type the first limit type for the Extrude hybrid shape feature. 
 Dim oLim1Type
 Set oLim1Type = Extrude.FirstLimitType
o Property FirstUptoElement() As
Returns or sets the First up-to element used to limit extrusion.
Example:
This example retrieves in Lim1Elem the First up-to element for the Extrude hybrid shape feature. 
 Dim Lim1Elem As Reference 
 Set Lim1Elem = Extrude.FirstUptoElement
o Property Orientation( 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 the extrude for the Extrude hybrid shape feature. 
 Dim IsInverted As boolean
 IsInverted = Extrude.Orientation
o Property SecondLimitType() As
Returns or sets the Second limit type.
Legal values:
0
Unknown Limit type.
1
Limit type is Dimension. It implies that limit is defined by length
2
Limit type is UptoElement. It implies that limit is defined by a geometrical element
Example:
This example retrieves in oLim2Type the second limit type for the Extrude hybrid shape feature. 
 Dim oLim2Type
 Set oLim2Type = Extrude.SecondLimitType
o Property SecondUptoElement() As
Returns or sets the Second up-to element used to limit extrusion.
Example:
This example retrieves in Lim2Elem the Second up-to element for the Extrude hybrid shape feature. 
 Dim Lim2Elem As Reference 
 Set Lim2Elem = Extrude.SecondUptoElement
o Property SymmetricalExtension() As
Returns or sets the symmetrical extension on Extrude limits.
Example:
This example retrieves IsSymmetrical the SymmetricalExtension status set on of Limits for the Extrude hybrid shape feature. 
 Dim IsSymmetrical As boolean
 Set IsSymmetrical = Extrude.SymmetricalExtension

Copyright © 2003, Dassault Systèmes. All rights reserved.