Indexes  Previous Next

HybridShapeExtractMulti (Object)

Represents the hybrid shape ExtractMulti feature object.
Role: To access the data of the hybrid shape ExtractMulti feature object.

Use the CATIAHybridShapeFactory to create a HybridShapeExtractMulti object.

See also:
HybridShapeFactory.AddNewExtractMulti

Method Index

AddConstraintTolerant
Adds a constraint to the list of Extracted Elements.
AddConstraint
GetAngularThresholdActivity
Returns the AngularThresholdActivity of the list of constraints at specified position.
GetAngularThreshold
Returns the AngularThreshold of the list of constraints at specified position.
GetComplementaryExtractMulti
Returns the Complementary flag checked/unchecked of the list of constraints at specified position.
GetCurvatureThresholdActivity
Returns the CurvatureThresholdActivity of the list of constraints at specified position.
GetCurvatureThreshold
Returns the CurvatureThreshold of the list of constraints at specified position.
GetDistanceThresholdActivity
Returns the DistanceThresholdActivity of the list of constraints at specified position.
GetDistanceThreshold
Returns the DistanceThreshold of the list of constraints at specified position.
GetElement
Returns the sub element used as init for the propagation.
GetIsFederated
Returns the IsFederated flag checked/unchecked of the list of constraints at specified position.
GetListOfConstraints
Returns the list of Extracted Elements.
GetNbConstraints
Returns number of constraints in the list of Extracted Elements.
GetPropagationType
Returns the type of propagation of the list of constraints at specified position.
GetSupport
Returns the support of the list of constraints at specified position.
RemoveElement
Removes the body to be extracted from the list of constraints at specified position.
ReplaceElement
Replaces an element to extract in the list of constraints at specified position.
SetAngularThresholdActivity
Sets the AngularThresholdActivity in the list of constraints at specified position.
SetAngularThreshold
Sets the AngularThreshold in the list of constraints at specified position.
SetComplementaryExtractMulti
Sets the Complementary flag checked/unchecked in the list of constraints at specified position.
SetCurvatureThresholdActivity
Sets the CurvatureThresholdActivity in the list of constraints at specified position.
SetCurvatureThreshold
Sets the CurvatureThreshold in the list of constraints at specified position.
SetDistanceThresholdActivity
Sets the DistanceThresholdActivity in the list of constraints at specified position.
SetDistanceThreshold
Sets the DistanceThreshold in the list of constraints at specified position.
SetElement
Sets the sub element used as init for the propagation.
SetIsFederated
Sets the IsFederated flag checked/unchecked in the list of constraints at specified position.
SetPropagationType
Sets the type of propagation for the ExtractMulti in the list of constraints at specified position.
SetSupport
Sets the support of the list of constraints at specified position.

Methods


o Sub AddConstraintTolerant(Reference iConstraint,
long iType,
boolean iComplementaire,
boolean iIsFederated,
double iDistreThsld,
double iAngtreThsld,
double iCrvtreThsld,
long iPos)
Adds a constraint to the list of Extracted Elements.
Parameters:
iConstraint
The constraint to add.
iType
the type of propagation for the ExtractMulti.
iComplementaire
the Complementary flag checked/unchecked for for the constraint.
iIsFederated
the Federated flag checked/unchecked for the constraint.
iDistreThsld
the DistanceThreshold for the constraint.
iAngtreThsld
the AngularThreshold for the constraint.
iCrvtreThsld
the CurvatureThreshold for the constraint.
iPos
The position at which the element is to be added in the list of constraints.
Example:
This example adds a body in the list of constraints at specified position with the type of propagation, the Federated flag and the CurvatureThreshold of the HybShpExtractMulti hybrid shape ExtractMulti. 
 Dim iType as long 
 Dim iComplementaire as boolean 
 Dim iIsFederated as boolean 
 Dim iDistreThsld as double
 Dim iAngtreThsld as double
 Dim iCrvtreThsld as double
 HybShpExtractMulti.AddConstraintTolerant iCst  iType  iComplementaire iIsFederated iCrvtreThsld  1
o Sub AddConstraint(Reference iConstraint,
long iType,
boolean iComplementaire,
boolean iIsFederated,
double iCrvtreThsld,
long iPos)
Deprecated:
V5R16 CATIAHybridShapeExtractMulti#AddConstraintTolerant Adds a constraint to the list of Extracted Elements.
Parameters:
iConstraint
The constraint to add.
iType
the type of propagation for the ExtractMulti.
iComplementaire
the Complementary flag checked/unchecked for for the constraint.
iIsFederated
the Federated flag checked/unchecked for the constraint.
iCrvtreThsld
the CurvatureThreshold for the constraint.
iPos
The position at which the element is to be added in the list of constraints.
Example:
This example adds a body in the list of constraints at specified position with the type of propagation, the Federated flag and the CurvatureThreshold of the HybShpExtractMulti hybrid shape ExtractMulti. 
 Dim iType as long 
 Dim iComplementaire as boolean 
 Dim iIsFederated as boolean 
 Dim iCrvtreThsld as double
 HybShpExtractMulti.AddConstraint iCst  iType  iComplementaire iIsFederated iCrvtreThsld  1
o Func GetAngularThresholdActivity(long iPos) As boolean
Returns the AngularThresholdActivity of the list of constraints at specified position.
Example:
This example retrieves the AngularThresholdActivity of the list of constraints at specified position of the hybShpExtractMulti in AngularActivity . 
 Dim oAngtreThsldActivity as boolean 
 oAngtreThsldActivity  = HybShpExtractMulti.GetAngularThresholdActivity (1)
o Func GetAngularThreshold(long iPos) As double
Returns the AngularThreshold of the list of constraints at specified position.
Example:
This example retrieves the AngularThreshold in the list of constraints at specified position of the hybShpExtractMulti in AngularThH. 
 Dim oAngtreThsld as double
 AngularThH = HybShpExtractMulti.GetAngularThreshold(1)
o Func GetComplementaryExtractMulti(long iPos) As boolean
Returns the Complementary flag checked/unchecked of the list of constraints at specified position.
Example:
This example retrieves the Complementary flag in the list of constraints at specified position of the hybShpExtractMulti in Complementaire. 
 Dim oComplementaire as boolean
 oComplementaire  = HybShpExtractMulti.GetComplementaryExtractMulti(1)
o Func GetCurvatureThresholdActivity(long iPos) As boolean
Returns the CurvatureThresholdActivity of the list of constraints at specified position.
Example:
This example retrieves the CurvatureThresholdActivity of the list of constraints at specified position of the hybShpExtractMulti in CurvatureActivity . 
 Dim oCrvtreThsldActivity as boolean 
 oCrvtreThsldActivity  = HybShpExtractMulti.GetCurvatureThresholdActivity (1)
o Func GetCurvatureThreshold(long iPos) As double
Returns the CurvatureThreshold of the list of constraints at specified position.
Example:
This example retrieves the CurvatureThreshold in the list of constraints at specified position of the hybShpExtractMulti in CurvatureThH. 
 Dim oCrvtreThsld as double
 CurvatureThH = HybShpExtractMulti.GetCurvatureThreshold(1)
o Func GetDistanceThresholdActivity(long iPos) As boolean
Returns the DistanceThresholdActivity of the list of constraints at specified position.
Example:
This example retrieves the DistanceThresholdActivity of the list of constraints at specified position of the hybShpExtractMulti in DistanceActivity . 
 Dim oDistreThsldActivity as boolean 
 oDistreThsldActivity  = HybShpExtractMulti.GetDistanceThresholdActivity (1)
o Func GetDistanceThreshold(long iPos) As double
Returns the DistanceThreshold of the list of constraints at specified position.
Example:
This example retrieves the DistanceThreshold in the list of constraints at specified position of the hybShpExtractMulti in DistanceThH. 
 Dim oDistreThsld as double
 DistanceThH = HybShpExtractMulti.GetDistanceThreshold(1)
o Func GetElement(long iPos) As Reference
Returns the sub element used as init for the propagation.
Example:
This example retrieves the sub element in the list of constraints at specified position of the hybShpExtractMulti in Elem. 
 Dim oElem as CATIAReference
 oElem = HybShpExtractMulti.GetElement(1)
See also:
HybridShapeFactory
o Func GetIsFederated(long iPos) As boolean
Returns the IsFederated flag checked/unchecked of the list of constraints at specified position.
Example:
This example retrieves the federated flag in the list of constraints at specified position of the hybShpExtractMulti in IsFederated. 
 Dim oIsFederated as boolean 
 oIsFederated  = HybShpExtractMulti.GetIsFederated(1)
o Sub GetListOfConstraints(CATSafeArrayVariant oListOfExtractedConstraints)
Returns the list of Extracted Elements.
Parameters:
oListOfExtractedConstraints
The list of constraints. It is returned as an array of nbconstraints in SafeArrayVariant.
Example:
This example returns the list of constraints of the HybShpExtractMulti hybrid shape ExtractMulti. 
 Dim oListOfExtractedConstraints as CATSafeArrayVariant 
 HybShpExtractMulti.GetListOfConstraints (oListOfExtractedConstraints)

Note: You can access each constraint as follows:

  • 1 is in oListOfExtractedConstraints(0)
  • 2 is in oListOfExtractedConstraints(1)
  • nbconstraints is in oListOfExtractedConstraints(nbconstraints-1)
o Sub GetNbConstraints(long oNbConstraints)
Returns number of constraints in the list of Extracted Elements.
Parameters:
oNbConstraints
number of constraints in the list of Extracted Elements.
Example:
This example returns number of constraints in the list of constraints of the HybShpExtractMulti hybrid shape ExtractMulti. 
 Dim oNbConstraints as long 
 HybShpExtractMulti.GetNbConstraints (oNbConstraints )
o Func GetPropagationType(long iPos) As long
Returns the type of propagation of the list of constraints at specified position.
The propagation types for the ExtractMulti can have the following values:
  • 1 for extraction propagation in point continuity
  • 2 for extraction propagation in tangent continuity
  • 3 for extraction without propagation
  • 4 for extraction propagation in curvature continuity
Example:
This example retrieves the PropagationType in the list of constraints at specified position of the hybShpExtractMulti in TypePropag. 
 Dim oTypePropag as long 
 oTypePropag  = HybShpExtractMulti.GetPropagationType(1)
o Func GetSupport(long iPos) As Reference
Returns the support of the list of constraints at specified position.
Parameters:
oSupport
The support.
o Sub RemoveElement(long iPosition)
Removes the body to be extracted from the list of constraints at specified position.
Parameters:
iPosition
Position at which the body is to be removed
Example:
This example removes the body from the list of constraints at specified position of the HybShpExtractMulti hybrid shape ExtractMulti. 
 HybShpExtractMulti.RemoveElement  1
o Sub ReplaceElement(Reference iExtractToReplace,
Reference iNewExtract,
long iPos)
Replaces an element to extract in the list of constraints at specified position.
Parameters:
iExtractToReplace
The element to replace.
iNewExtract
The new element.
iPos
The position at which the element is to be replaced in the list of constraints.
Example:
This example replaces the body from the list of constraints at specified position of the HybShpExtractMulti hybrid shape ExtractMulti. 
 Dim RefToRep  as CATIAReference
 Dim RefNewExtract  as CATIAReference
 HybShpExtractMulti.ReplaceElement RefToRep  RefNewExtract 1
o Sub SetAngularThresholdActivity(long iPos,
boolean iAngtreThsldActivity)
Sets the AngularThresholdActivity in the list of constraints at specified position.
Example:
This example sets the AngularThresholdActivity in the list of constraints at specified position of the hybShpExtractMulti in AngularActivity . 
 Dim iAngtreThsldActivity as boolean 
 iAngtreThsldActivity = TRUE 
 HybShpExtractMulti.SetAngularThresholdActivity 1  iAngtreThsldActivity
o Sub SetAngularThreshold(long iPos,
double iAngtreThsld)
Sets the AngularThreshold in the list of constraints at specified position.
Example:
This example sets the AngularThreshold of the list of constraints at specified position of the hybShpExtractMulti in AngularThH. 
 Dim iAngtreThsld as double
 HybShpExtractMulti.SetAngularThreshold 1 iAngtreThsld
o Sub SetComplementaryExtractMulti(long iPos,
boolean iComplementaire)
Sets the Complementary flag checked/unchecked in the list of constraints at specified position.
Example:
This example sets the Complementary flag of the list of constraints at specified position of the hybShpExtractMulti in Complementaire. 
 Dim iComplementaire as boolean
 iComplementaire  = TRUE 
 HybShpExtractMulti.SetComplementaryExtractMulti 1   iComplementaire
o Sub SetCurvatureThresholdActivity(long iPos,
boolean iCrvtreThsldActivity)
Sets the CurvatureThresholdActivity in the list of constraints at specified position.
Example:
This example sets the CurvatureThresholdActivity in the list of constraints at specified position of the hybShpExtractMulti in CurvatureActivity . 
 Dim iCrvtreThsldActivity as boolean 
 iCrvtreThsldActivity = TRUE 
 HybShpExtractMulti.SetCurvatureThresholdActivity 1  iCrvtreThsldActivity
o Sub SetCurvatureThreshold(long iPos,
double iCrvtreThsld)
Sets the CurvatureThreshold in the list of constraints at specified position.
Example:
This example sets the CurvatureThreshold of the list of constraints at specified position of the hybShpExtractMulti in CurvatureThH. 
 Dim iCrvtreThsld as double
 HybShpExtractMulti.SetCurvatureThreshold 1 iCrvtreThsld
o Sub SetDistanceThresholdActivity(long iPos,
boolean iDistreThsldActivity)
Sets the DistanceThresholdActivity in the list of constraints at specified position.
Example:
This example sets the DistanceThresholdActivity in the list of constraints at specified position of the hybShpExtractMulti in DistanceActivity . 
 Dim iDistreThsldActivity as boolean 
 iDistreThsldActivity = TRUE 
 HybShpExtractMulti.SetDistanceThresholdActivity 1  iDistreThsldActivity
o Sub SetDistanceThreshold(long iPos,
double iDistreThsld)
Sets the DistanceThreshold in the list of constraints at specified position.
Example:
This example sets the DistanceThreshold of the list of constraints at specified position of the hybShpExtractMulti in DistanceThH. 
 Dim iDistreThsld as double
 HybShpExtractMulti.SetDistanceThreshold 1 iDistreThsld
o Sub SetElement(long iPos,
Reference iElem)
Sets the sub element used as init for the propagation.
Example:
This example sets the sub element in the list of constraints at specified position of the hybShpExtractMulti in Elem. 
 Dim iPos as long 
 Dim iElem as CATIAReference
 HybShpExtractMulti.SetElement 1 iElem
See also:
HybridShapeFactory
o Sub SetIsFederated(long iPos,
boolean iIsFederated)
Sets the IsFederated flag checked/unchecked in the list of constraints at specified position.
Example:
This example sets the federated flag in the list of constraints at specified position of the hybShpExtractMulti in IsFederated. 
 Dim iIsFederated as boolean 
  iIsFederated = TRUE 
 HybShpExtractMulti.SetIsFederated 1  iIsFederated
o Sub SetPropagationType(long iPos,
long iTypePropag)
Sets the type of propagation for the ExtractMulti in the list of constraints at specified position.
The propagation types for the ExtractMulti can have the following values:
  • 1 for extraction propagation in point continuity
  • 2 for extraction propagation in tangent continuity
  • 3 for extraction without propagation
  • 4 for extraction propagation in curvature continuity
Example:
This example sets the PropagationType of the list of constraints at specified position of the hybShpExtractMulti in TypePropag. 
 Dim iTypePropag as long 
 iTypePropag = 1 
 HybShpExtractMulti.SetPropagationType 1 iTypePropag
o Sub SetSupport(long iPos,
Reference iSupport)
Sets the support of the list of constraints at specified position.
Parameters:
oSupport
The support.

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