HybridShapeUnfold (Object)

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

Use the CATIAHybridShapeFactory to create a HybridShapeUnfold object.

See also:

Properties


Property DirectionToUnfold() As
Returns or sets the direction to unfold.
Property EdgeToTearPositioningOrientation() As
Returns or sets the positioning orientation when the reference origin is located on an edge to tear.
  • 0= The orientation is undefined
  • 1= The orientation is the default one
  • 2= The orientation is inversed
Property OriginToUnfold() As
Returns or sets the origin to unfold.
Property SurfaceToUnfold() As
Returns or sets the surface to unfold.
Sub-element(s) supported (see object): , and .
Property SurfaceType() As
Returns or sets the type of surface to unfold.
  • 0= The type of surface is not defined
  • 1= The type of surface is ruled
  • 2= The type of surface is all
Property TargetDirection() As
Role: Retrieves target direction on the object.
Parameters:
oDir
return value for CATScript applications, with (IDLRETVAL) function type
See also:
Returns:
HRESULT S_OK if Ok E_FAIL else return error code for C++ Implementations
See also:
Property TargetOrientationMode() As
Returns or sets the mode for target surface orientation.
  • 0= No axis inversion
  • 1= U inversion axis
  • 2= V inversion axis
  • 3= U inversion axis and V inversion axis
  • 4= U inversion axis and swap U and V axis
  • 5= V inversion axis and swap U and V axis
  • 6= U inversion axis, V inversion axis and swap U and V axis
  • 7= Swap U and V axis
Property TargetOrigin() As
Role: Retrieves target origin on the object.
Parameters:
oElem
return value for CATScript applications, with (IDLRETVAL) function type
See also:
Returns:
HRESULT S_OK if Ok E_FAIL else return error code for C++ Implementations
See also:
Property TargetPlane() As
Returns or sets the target plane.
Sub-element(s) supported (see object):

Methods


Sub AddEdgeToTear( iElement)
Adds an edge to tear.
Parameters:
iEdge
The edge to tear to add to the hybrid shape feature object.
Sub-element(s) supported (see object):
Examples:
The following example adds the iElement feature object to the HybridShapeUnfold object. 
 HybridShapeUnfold.AddEdgeToTear iElement
Sub AddElementToTransfer( iElement, iTypeOfTransfer)
Appends an element to transfer.
Parameters:
iElement
Specification to transfer
iTypeOfTransfer
type of tranfer
  • 0= No transfer mode specified
  • 1= Folded to unfolded
  • 2= Unfolded to folded
Func GetEdgeToTear( iRank) As
Retrieves an element used by the hybrid shape unfold feature object.
Parameters:
iRank
The rank of the element to read.
Examples:
The following example gets the oElement feature object of the HybridShapeUnfold object at the position iRank. 
 Dim oElement As Reference
 Set oElement = HybridShapeUnfold.GetEdgeToTear (iRank).
Sub GetElementToTransfer( iRank, opElement, oTypeOfTransfer)
Gets an element to transfer.
Parameters:
iRank
the position of the specification to get
opElement
Specification to transfer
oTypeOfTransfer
type of tranfer
  • 0= No transfer mode specified
  • 1= Folded to unfolded
  • 2= Unfolded to folded
Sub RemoveEdgeToTear( iRank)
Removes an element used by the hybrid shape unfold feature object.
Parameters:
iRank
The rank of the element to remove.
Examples:
The following example removes the feature object from the HybridShapeUnfold object at the position iRank. 
 HybridShapeUnfold.RemoveEdgeToTear iRank.
Sub RemoveElementToTransfer( iRank)
Remove an elements to transfer.
Parameters:
iRank
the position of the specification to remove
Sub ReplaceElementsToTransfer( iRank, iElement)
Replace an elements to transfer.
Parameters:
iRank
the position of the specification to replace
iElement
the specification to transfer to append.