All Frameworks  Object Hierarchy  This Framework  Indexes

HybridShapeSplit (Object)

Represents the hybrid shape split feature object.
Role: To access data of the hybrid shape split feature. This data includes:

LICENSING INFORMATION: Creation of volume result requires GSO License
if GSO License is not granted , settting of Volume context has not effect
Use the CATIAHybridShapeFactory to create HybridShapeFeature object.

See also:
HybridShapeFactory

Property Index

AutomaticExtrapolationMode
Gets or sets the automatic extrapolation mode status.
BothSidesMode
Gets or sets both sides computation mode.
CuttingElem
Returns or sets the cutting element.
ElemToCut
Returns or sets the element to cut.
IntersectionComputation
Gets or sets Intersection computation mode.
Orientation
Returns or sets the orientation used to compute the split.
Support
Returns or sets the support element.
VolumeResult
Returns or sets the Result Type.

Method Index

AddCuttingElem
Adds a cutting feature.
AddElementToKeep
Adds an element to specifications.
AddElementToRemove
Adds an element to specifications.
GetCuttingElem
Gets the cutting feature at a given index (a point, a curve or a surface).
GetIntersection
Gets the intersection at a given index.
GetKeptElem
Gets the kept feature at a given index.
GetNbCuttingElem
Gets the number of cutting features.
GetNbElementsToKeep
Gets the number of elements to keep.
GetNbElementsToRemove
Gets the number of elements to remove.
GetOrientation
Gets Orientation used to compute the split.
GetOtherSide
Gets the other side.
GetRemovedElem
Gets the removed feature at a given index.
InvertOrientation
Inverts the orientation used to compute the split.
RemoveCuttingElem
Removes a cutting feature.
RemoveElementToKeep
Removes an element from specifications.
RemoveElementToRemove
Removes an element from specifications.
SetOrientation
Sets the orientation used to compute the split.

Properties


o Property AutomaticExtrapolationMode() As
Gets or sets the automatic extrapolation mode status. AutomaticExtrapolationMode = TRUE : Automatic extrapolation mode is on. = FALSE : Automatic extrapolation mode is off. This example retrieves in AutoExtrapolMode the automatic extrapolation mode status for the Split hybrid shape feature. 
 Dim AutoExtrapolMode As boolean
 AutoExtrapolMode = Split.AutomaticExtrapolationMode
o Property BothSidesMode() As
Gets or sets both sides computation mode. BothSidesMode = TRUE : Both sides are computed. = FALSE : Both sides are not computed. This example retrieves in BothSides the both sides computation mode for the Split hybrid shape feature. 
 Dim BothSides As boolean
 BothSides = Split.BothSidesMode
o Property CuttingElem() As
Returns or sets the cutting element.
Sub-element(s) supported (see Boundary object): Face, TriDimFeatEdge, BiDimFeatEdge or Vertex.
Example:
This example retrieves in CuttingElement the cutting element for the Split hybrid shape feature. 
 Dim CuttingElement As Reference
 Set CuttingElement = Split.CuttingElem
o Property ElemToCut() As
Returns or sets the element to cut.
Example:
This example retrieves in Element the element to cut for the Split hybrid shape feature. 
 Dim Element As Reference
 Set Element = Split.ElemToCut
o Property IntersectionComputation() As
Gets or sets Intersection computation mode. IntersectionComputation = TRUE : Intersection is computed. = FALSE : Intersection is not computed. This example retrieves in Intersection the Intersection computation mode for the Split hybrid shape feature. 
 Dim Intersection As boolean
 Intersection = Split.IntersectionComputation
o Property Orientation() As
Returns or sets the orientation used to compute the split. Role:
Orientation specifies kept parts of cut feature.

When splitting a surface by a surface :
- If orientation value is 1: kept parts are specified by the "natural" normal to the cutting feature
- If orientation value -1: kept parts are specified by the inverse of the "natural" normal to the cutting feature

When splitting a surface by a curve :
- If orientation value is 1: kept parts are specified by the result of the cross product : normal(surface)^tangent(curve)
- If orientation value is -1: Kept parts are specified by the inverse of the result of the cross product : normal(surface)^tangent(curve)

When splitting a curve by a point or a curve (without support specified) :
- If orientation value is 1: Kept parts are from beginning of the curve to the first intersection,
and, if there is one, from the second to the third intersection and so on until the end of the curve.
- If orientation value is -1: Kept parts are from the first intersection to the second (if there is one),
and, if there is one, from the third to the fourth and so on until the end of the curve.

When splitting a curve on support:
- If orientation value is 1: Kept parts are specified by the result of the cross product : normal(support surface)^tangent(cutting curve)
- If orientation value is -1: Kept parts are specified by the inverse of the result of the cross product : normal(support surface)^tangent(cutting curve)

When splitting a curve by a surface:
- If orientation value is 1: Kept parts are specified by the inverse of the normal to the surface
- If orientation value is -1: Kept parts are specified by the normal to the surface

Example
This example retrieves in OrientValue the orientation value for the Split hybrid shape feature. 
 Dim OrientValue As long
 Set OrientValue = Split.Orientation
o Property Support() As
Returns or sets the support element.
This support element may not exist.
Sub-element(s) supported (see Boundary object): Face.
Example:
This example retrieves in Element the support element for the Split hybrid shape feature. 
 Dim Element As Reference
 Set Element = Split.Support
o Property VolumeResult() As
Returns or sets the Result Type.
Result type:
  • : 0 -> Surface
  • : 1 -> Volume
    • , The resultant split will be volume. If input is element to cut is volume.

Note: Setting volume result requires GSO License.
Example: This example retrieves in ResultType the result type for the Split hybrid shape feature. 
 Dim RType As long
 Set RType = Split.ResultType

Methods


o Sub AddCuttingElem( iElem,
iOrientation)
Adds a cutting feature.
Parameters:
iElem
cutting feature
iOrientation
Orientation iOrientation = 1 : SameOrientation = -1 : InvertOrientation = 2 : KoOrientation
o Sub AddElementToKeep( iElement)
Adds an element to specifications. This element will be kept.
Parameters:
iElement
Element to keep.
o Sub AddElementToRemove( iElement)
Adds an element to specifications. This element will be removed.
Parameters:
iElement
Element to remove.
o Func GetCuttingElem( iRank) As
Gets the cutting feature at a given index (a point, a curve or a surface).
Parameters:
oElem
cutting feature
iRank
Index of one of the cutting features
o Func GetIntersection( iRank) As
Gets the intersection at a given index.
Parameters:
oElem
Intersection
iRank
Index of one of the intersection features
o Func GetKeptElem( iRank) As
Gets the kept feature at a given index.
Parameters:
oElem
Kept feature
iRank
Index of one of the kept features
o Func GetNbCuttingElem() As
Gets the number of cutting features.
Parameters:
oNbCuttingElem
Number of cutting features
o Func GetNbElementsToKeep() As
Gets the number of elements to keep.
Parameters:
oNbElementsToKeep
Number of elements to keep
o Func GetNbElementsToRemove() As
Gets the number of elements to remove.
Parameters:
oNbElementsToRemove
Number of elements to remove
o Func GetOrientation( iRank) As
Gets Orientation used to compute the split.
Parameters:
oOrientation
Orientation
iRank
index of the cutting feature oOrientation = 1 : SameOrientation = -1 : InvertOrientation = 2 : KoOrientation
o Func GetOtherSide() As
Gets the other side.
Parameters:
oElem
Other side
o Func GetRemovedElem( iRank) As
Gets the removed feature at a given index.
Parameters:
oElem
Removed feature
iRank
Index of one of the removed features
o Sub InvertOrientation()
Inverts the orientation used to compute the split.
o Sub RemoveCuttingElem( iElem)
Removes a cutting feature.
Parameters:
iElem
cutting feature
o Sub RemoveElementToKeep( iRank)
Removes an element from specifications.
Parameters:
iRank
Index of the kept element.
o Sub RemoveElementToRemove( iRank)
Removes an element from specifications.
Parameters:
iRank
Index of the removed element.
o Sub SetOrientation( iRank,
iOrientation)
Sets the orientation used to compute the split.
Parameters:
iOrientation
Orientation
iRank
index of the cutting feature iOrientation = 1 : SameOrientation = -1 : InvertOrientation = 2 : KoOrientation

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