All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMSweepUnspec

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIGSMSweepUnspec
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIGSMSweepUnspec

Interface to explicit profile sweep feature.
Role: Allows you to access data of swept surface feature created with an explicit profile. In the following, 'initial plane' stands for the initial profile mean plane, and 'target plane' stands for the first sweep plane.

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

See also:
CATGSMPositionMode, CATGSMAxisInversionMode
See also:
CATIGSMPositionTransfo
See also:
CATIGSMFactory.CreateExplicitSweep


Method Index


o DelAngle()
Removes reference surface angle.
o DelGuide()
Removes all guide curves.
o GetAngle(CATICkeParm_var&,int)
Gets the first reference surface angle.
o GetAngle(double&,int)
Gets the first reference surface angle.
o GetAngularLaw(CATICkeLaw_var&)
Gets angular law feature.
o GetAngularLawInversion(CATBoolean&)
Gets information whether reference angle law has to be inverted or not.
o GetAngularLawType(enum CATGSMBasicLawType&)
Gets the type of angular law used for reference angle.
o GetContext(CATGSMFeatureContextType&)
Gets the context of the Sweep.
o GetFittingPoints(CATISpecObject_var&,CATISpecObject_var&)
Gets the fitting points : located in the profile plane, these points are used for two-guide swept surfaces to determine guide intersection locations.
o GetGuide(CATISpecObject_var&)
Gets first guide curve.
o GetGuide(CATISpecObject_var&,int)
Gets a guide curve given its index.
o GetGuideDeviation(CATICkeParm_var&)
Gets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
o GetGuideDeviation(double&)
Gets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
o GetGuideDeviationActivity(CATBoolean&)
Gets information whether a deviation from guide curves is allowed or not during sweeping operation in order to smooth it.
o GetLongitudinalRelimiters(CATISpecObject_var&,CATBoolean&,CATISpecObject_var&,CATBoolean&)
Gets the elements relimiting the spine (or the default spine).
o GetMode(enum CATGSMExplicitSweepCase&)
Gets explicit sweep case number (also called mode).
o GetNbAngle(int&)
Gets the number of reference surface angle (0 or 1).
o GetNbGuide(int&)
Gets the number of guide curves.
o GetNbPosAngle(int&)
Gets the number of numerical positioning parameters corresponding to angles from the default positions of the X axes.
o GetNbPosCoord(int&)
Gets the number of numerical positioning parameters corresponding to coordinates of the new axes systems origins.
o GetPosAngle(CATICkeParm_var&,int)
Gets the numerical positioning parameters corresponding to angles from the default positions of the X axes.
o GetPosCoord(CATICkeParm_var&,int)
Gets the numerical positioning parameters corresponding to coordinates.
o GetPosDirection(CATIGSMDirection_var&)
Gets the positioning direction : initial plane X-axis direction.
o GetPosDirection(CATIGSMDirection_var&,int)
Gets the positioning directions : initial or target plane X-axis direction.
o GetPosMode(enum CATGSMPositionMode&)
Gets the positioning mode.
o GetPosPoint(CATISpecObject_var&)
Gets the point designated as the origin of the initial plane.
o GetPosPoint(CATISpecObject_var&,int)
Gets the points designated as the origins of the initial and target transformation planes.
o GetPosSwapAxes(enum CATGSMAxisInversionMode&)
Gets the positioning parameter : initial plane axes inversion from previous definition.
o GetPosSwapAxes(enum CATGSMAxisInversionMode&,int)
Gets the positioning parameters : axes inversion from previous definition for each transformation plane (initial and target).
o GetPositionedProfile(CATISpecObject_var&)
Gets the positioning transformation.
o GetProfile(CATISpecObject_var&)
Gets the original profile.
o GetProfileXAxisComputationMode(enum CATGSMPositionDirCompMode&)
Gets the computation mode of the X axis (or direction) of the initial axis system (on the profile).
o GetPullingDirection(CATIGSMDirection_var&)
Gets the pulling direction.
o GetReference(CATISpecObject_var&)
Gets the reference surface.
o GetSmoothActivity(CATBoolean&)
Gets information whether sweeping operation is smoothed or not.
o GetSmoothAngleThreshold(CATICkeParm_var&)
Gets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
o GetSmoothAngleThreshold(double&)
Gets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
o GetSolutionNo(int&)
Gets the current solution number of the four possible solutions.
o GetSpine(CATISpecObject_var&)
Gets the spine.
o IsGuideProjected(CATBoolean&)
Allows to know if the guide curve is projected onto the reference plane and used as spine, in pulling direction case only.
o IsSketchAxisUsedAsDefault(CATBoolean&)
Queries status wherere Sketch axis used as default or not.
o RemoveFittingPoints()
Removes the fitting points.
o RemoveSecondFittingPoint()
Remove the second fitting point.
o SetAngle(CATICkeParm_var,int)
Sets the first reference surface angle.
o SetAngle(double,int)
Sets the first reference surface angle.
o SetAngularLaw(CATICkeLaw_var&)
Sets angular law feature.
o SetAngularLawInversion(CATBoolean)
Sets information whether reference angle law has to be inverted or not.
o SetAngularLawType(enum CATGSMBasicLawType)
Sets the type of angular law used for reference angle.
o SetContext(CATGSMFeatureContextType)
Sets the context of the Sweep.
o SetFittingPoints(CATISpecObject_var,CATISpecObject_var)
Sets the fitting points.
o SetGuide(CATISpecObject_var)
Sets first guide curve.
o SetGuide(CATISpecObject_var,int)
Sets a guide curve given its index.
o SetGuideDeviation(CATICkeParm_var&)
Sets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
o SetGuideDeviation(double)
Sets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
o SetGuideDeviationActivity(CATBoolean)
Sets information whether a deviation from guide curves is allowed or not during sweeping operation in order to smooth it.
o SetGuideProjection(CATBoolean)
Sets the projection of the guide curve onto the reference plane in order to use it as spine, in pulling direction case only.
o SetLongitudinalRelimiters(CATISpecObject_var&,CATBoolean,CATISpecObject_var&,CATBoolean)
Sets the elements relimiting the spine (or the default spine).
o SetMode(enum CATGSMExplicitSweepCase)
Sets explicit sweep case number.
o SetPosAngle(CATICkeParm_var,int)
Sets the numerical positioning parameters corresponding to angles from the default positions of the X axes.
o SetPosAngle(double,int)
Sets the numerical positioning parameters corresponding to angles from the default positions of the X axes.
o SetPosCoord(CATICkeParm_var,int)
Sets the numerical positioning parameters corresponding to coordinates.
o SetPosCoord(double,int)
Sets the numerical positioning parameters corresponding to coordinates.
o SetPosDirection(CATIGSMDirection_var)
Sets the positioning direction : initial plane X-axis direction.
o SetPosDirection(CATIGSMDirection_var,int)
Sets the positioning directions : initial or target plane X-axis direction.
o SetPosMode(enum CATGSMPositionMode)
Sets the positioning mode.
o SetPosPoint(CATISpecObject_var)
Sets the point designated as the origin of the initial plane.
o SetPosPoint(CATISpecObject_var,int)
Sets the points designated as the origins of the initial and target transformation planes.
o SetPosSwapAxes(enum CATGSMAxisInversionMode)
Sets the positioning parameter : initial plane axes inversion from previous definition.
o SetPosSwapAxes(enum CATGSMAxisInversionMode,int)
Modify the positioning parameters : axes inversion from previous definition for each transformation plane (initial and target).
o SetPositionedProfile(CATISpecObject_var&)
Sets the positioning transformation.
o SetProfile(CATISpecObject_var)
Sets the original profile.
o SetProfileXAxisComputationMode(enum CATGSMPositionDirCompMode)
Sets the computation mode of the X axis (or direction) of the initial axis system.
o SetPullingDirection(CATIGSMDirection_var&)
Sets the pulling direction.
o SetReference(CATISpecObject_var)
Sets the reference surface.
o SetSmoothActivity(CATBoolean)
Sets information whether sweeping operation is smoothed or not.
o SetSmoothAngleThreshold(CATICkeParm_var&)
Sets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
o SetSmoothAngleThreshold(double)
Sets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
o SetSolutionNo(int)
Sets the current solution number of the four possible solutions.
o SetSpine(CATISpecObject_var)
Sets the spine.
o UseSketchAxisAsDefault(CATBoolean)
Uses Sketch Axis As Default.

Methods


o DelAngle
public virtual HRESULT DelAngle()= 0
Removes reference surface angle.
o DelGuide
public virtual HRESULT DelGuide()= 0
Removes all guide curves.
o GetAngle
public virtual HRESULT GetAngle(CATICkeParm_var& oElem,
const int iI=1) = 0
Gets the first reference surface angle.
Parameters:
oElem
Angle literal feature
See also:
CATICkeParm
o GetAngle
public virtual HRESULT GetAngle(double& oElem,
const int iI=1) = 0
Gets the first reference surface angle.
Parameters:
oElem
Angle value
o GetAngularLaw
public virtual HRESULT GetAngularLaw(CATICkeLaw_var& Elem) = 0
Gets angular law feature.
Parameters:
Elem
Angular law feature
See also:
CATICkeParm
o GetAngularLawInversion
public virtual HRESULT GetAngularLawInversion(CATBoolean& oInversion) = 0
Gets information whether reference angle law has to be inverted or not.
Parameters:
oInversion
TRUE or FALSE (FALSE if not specified).
See also:
CATGSMBasicLawType
o GetAngularLawType
public virtual HRESULT GetAngularLawType(enum CATGSMBasicLawType& eType) = 0
Gets the type of angular law used for reference angle.
Parameters:
eType
Angular law type:
- CATGSMBasicLawType_Constant for constant law (first angle value taken),
- CATGSMBasicLawType_Linear for linear law from first angle to second angle values,
- CATGSMBasicLawType_SType for S type law from first angle to second angle values,
- CATGSMBasicLawType_Advanced for a law specified by a law feature.
See also:
CATGSMBasicLawType
o GetContext
public virtual HRESULT GetContext(CATGSMFeatureContextType& oContext)=0
Gets the context of the Sweep.
Parameters:
oContextType
CATGSMSurfaceCtxt if the result is surface, CATGSMVolumeCtxt if it is volume
See also:
CATGSMFeatureContextType
o GetFittingPoints
public virtual HRESULT GetFittingPoints(CATISpecObject_var& oElem1,
CATISpecObject_var& oElem2) = 0
Gets the fitting points : located in the profile plane, these points are used for two-guide swept surfaces to determine guide intersection locations.
Parameters:
oElem1
Fitting point associated to the first guide
oElem2
Fitting point associated to the second guide
o GetGuide
public virtual HRESULT GetGuide(CATISpecObject_var& oElem) = 0
Gets first guide curve.
Parameters:
oElem
First guide curve feature.
o GetGuide
public virtual HRESULT GetGuide(CATISpecObject_var& oElem,
const int iI) = 0
Gets a guide curve given its index.
Parameters:
oElem
Guide curve feature.
iI
Guide curve index : 1 or 2
o GetGuideDeviation
public virtual HRESULT GetGuideDeviation(CATICkeParm_var& oElem) = 0
Gets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
Parameters:
oElem
Length literal feature.
o GetGuideDeviation
public virtual HRESULT GetGuideDeviation(double& oElem) = 0
Gets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
Parameters:
oElem
Numerical value.
o GetGuideDeviationActivity
public virtual HRESULT GetGuideDeviationActivity(CATBoolean& oActi) = 0
Gets information whether a deviation from guide curves is allowed or not during sweeping operation in order to smooth it.
Parameters:
oSmooth
TRUE or FALSE (FALSE if not specified).
o GetLongitudinalRelimiters
public virtual HRESULT GetLongitudinalRelimiters(CATISpecObject_var& oElem1,
CATBoolean& boInv1,
CATISpecObject_var& oElem2,
CATBoolean& boInv2) = 0
Gets the elements relimiting the spine (or the default spine).
Parameters:
oElem1
First relimiting feature (plane or point)
boInv1
Split direction for the first relimitation
FALSE means that the beginning of the spine (considering its orientation) is removed, TRUE means that the end of the spine is removed
oElem2
Second relimiting feature (plane or point)
boInv2
Split direction for the second relimitation
o GetMode
public virtual HRESULT GetMode(enum CATGSMExplicitSweepCase& oElem) = 0
Gets explicit sweep case number (also called mode). Possible cases are:
- CATGSMExplicitSweep_None: no information on feature and no guide curve (treated as reference surface case or two-guide-curve case depending on the number of guide curves)
- CATGSMExplicitSweep_ReferenceSurface: optional reference surface case, or no information on feature (old feature with no mode) but only one guide curve present
- CATGSMExplicitSweep_TwoGuideCurves: two-guide-curve case, or no information on feature (old feature with no mode) but two guide curves present
- CATGSMExplicitSweep_PullingDirection: pulling direction case
Parameters:
oElem
Case number
See also:
CATGSMExplicitSweepCase
o GetNbAngle
public virtual HRESULT GetNbAngle(int& oI) = 0
Gets the number of reference surface angle (0 or 1).
Parameters:
oI
Number of reference surface angle
o GetNbGuide
public virtual HRESULT GetNbGuide(int& oI) = 0
Gets the number of guide curves.
Parameters:
oI
Number of guide curves
o GetNbPosAngle
public virtual HRESULT GetNbPosAngle(int& oI) = 0
Gets the number of numerical positioning parameters corresponding to angles from the default positions of the X axes.
Parameters:
oI
Number of parameters
o GetNbPosCoord
public virtual HRESULT GetNbPosCoord(int& oI) = 0
Gets the number of numerical positioning parameters corresponding to coordinates of the new axes systems origins.
Parameters:
oI
Number of parameters
o GetPosAngle
public virtual HRESULT GetPosAngle(CATICkeParm_var& oElem,
const int iI) = 0
Gets the numerical positioning parameters corresponding to angles from the default positions of the X axes.
Parameters:
oElem
Numerical parameter (literal feature)
iI
Index of the parameter :
- 1 for direction angle in the initial plane,
- 2 for direction angle in the target plane.
See also:
CATICkeParm
o GetPosCoord
public virtual HRESULT GetPosCoord(CATICkeParm_var& oElem,
const int iI) = 0
Gets the numerical positioning parameters corresponding to coordinates. of the new axes systems origins.
Parameters:
oElem
Numerical parameter (literal feature)
iI
Index of the parameter :
- 1 and 2 for origin coordinates in the initial plane,
- 3 and 4 for origin coordinates in the target plane.
See also:
CATICkeParm
o GetPosDirection
public virtual HRESULT GetPosDirection(CATIGSMDirection_var& oElem) = 0
Gets the positioning direction : initial plane X-axis direction.
Parameters:
oElem
Direction feature
See also:
CATIGSMDirection
o GetPosDirection
public virtual HRESULT GetPosDirection(CATIGSMDirection_var& oElem,
const int iI) = 0
Gets the positioning directions : initial or target plane X-axis direction.
Parameters:
oElem
Direction feature
iI
Plane index : 1 for initial one, 2 for target one
See also:
CATIGSMDirection
o GetPosMode
public virtual HRESULT GetPosMode(enum CATGSMPositionMode& Elem) = 0
Gets the positioning mode.
Parameters:
Elem
CATGSMPositionMode_ExplicitSweep if a positioning operation is operated, CATGSMPositionMode_NoneOrPositioned if not
See also:
CATGSMPositionMode
o GetPosPoint
public virtual HRESULT GetPosPoint(CATISpecObject_var& oElem) = 0
Gets the point designated as the origin of the initial plane.
Parameters:
oElem
Point feature
o GetPosPoint
public virtual HRESULT GetPosPoint(CATISpecObject_var& oElem,
const int iI) = 0
Gets the points designated as the origins of the initial and target transformation planes.
Parameters:
oElem
Point feature
iI
Plane index : 1 for initial one, 2 for target one
o GetPosSwapAxes
public virtual HRESULT GetPosSwapAxes(enum CATGSMAxisInversionMode& oI) = 0
Gets the positioning parameter : initial plane axes inversion from previous definition.
Parameters:
oI
State of axes
See also:
CATGSMAxisInversionMode
o GetPosSwapAxes
public virtual HRESULT GetPosSwapAxes(enum CATGSMAxisInversionMode& oI,
const int iIdx) = 0
Gets the positioning parameters : axes inversion from previous definition for each transformation plane (initial and target).
Parameters:
oI
State of axes :
- CATGSMAxisInversionMode_None : no axis inverted
- CATGSMAxisInversionMode_X : only X axis inverted
- CATGSMAxisInversionMode_Y : only Y axis inverted
- CATGSMAxisInversionMode_Both : both axes inverted
iIdx
Plane index : 1 for initial one, 2 for target one
See also:
CATGSMAxisInversionMode
o GetPositionedProfile
public virtual HRESULT GetPositionedProfile(CATISpecObject_var& oElem) = 0
Gets the positioning transformation.
This method allows to get the user positioned profile.
The result of this feature is the profile positioned in the first sweep plane.
Parameters:
oElem
Positioning transformation feature (or positioned profile)
Note: in case of positionning, The returned objet answer to CATIGSMPositionTransfo interface object.
See also:
CATIGSMPositionTransfo
o GetProfile
public virtual HRESULT GetProfile(CATISpecObject_var& oElem) = 0
Gets the original profile.
Parameters:
oElem
Original profile feature
o GetProfileXAxisComputationMode
public virtual HRESULT GetProfileXAxisComputationMode(enum CATGSMPositionDirCompMode& oDirCompMode) = 0
Gets the computation mode of the X axis (or direction) of the initial axis system (on the profile). Default value (if not specified by SetProfileXAxisComputationMode) is CATGSMPositionDirCompMode_None if GetPosDirection(OutputDirection) gives a NULL_var OutputDirection, and CATGSMPositionDirCompMode_User if OutputDirection is different from NULL_var.
Parameters:
oDirCompMode
Mode :
- CATGSMPositionDirCompMode_None: no X axis specified
- CATGSMPositionDirCompMode_Tangent: the X axis is implicitly the tangent of the profile at the origin (the origin then HAS to be on the profile)
- CATGSMPositionDirCompMode_User: the X axis is specified by a direction via SetPosDirection(UserInputDirection, 1)
See also:
CATIGSMPositionTransfo
o GetPullingDirection
public virtual HRESULT GetPullingDirection(CATIGSMDirection_var& oDir) = 0
Gets the pulling direction. This input replaces the reference surface; indeed, if the direction is specified, the plane normal to this direction is taken as reference surface.
Parameters:
oDir
Pulling direction feature
See also:
CATIGSMDirection
o GetReference
public virtual HRESULT GetReference(CATISpecObject_var& oElem) = 0
Gets the reference surface.
Parameters:
oElem
Reference surface feature
o GetSmoothActivity
public virtual HRESULT GetSmoothActivity(CATBoolean& oSmooth) = 0
Gets information whether sweeping operation is smoothed or not.
Parameters:
oSmooth
TRUE or FALSE (FALSE if not specified).
o GetSmoothAngleThreshold
public virtual HRESULT GetSmoothAngleThreshold(CATICkeParm_var& oElem) = 0
Gets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
Parameters:
oElem
Angular literal feature.
o GetSmoothAngleThreshold
public virtual HRESULT GetSmoothAngleThreshold(double& oElem) = 0
Gets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
Parameters:
oElem
Numerical value.
o GetSolutionNo
public virtual HRESULT GetSolutionNo(int& oSolNo)=0
Gets the current solution number of the four possible solutions.
Parameters:
oSolNo
is the solution number.
o GetSpine
public virtual HRESULT GetSpine(CATISpecObject_var& oElem) = 0
Gets the spine.
Parameters:
oElem
Spine feature
o IsGuideProjected
public virtual HRESULT IsGuideProjected(CATBoolean& obProj) = 0
Allows to know if the guide curve is projected onto the reference plane and used as spine, in pulling direction case only.
Parameters:
obProj
TRUE is projection is required, FALSE if not
o IsSketchAxisUsedAsDefault
public virtual HRESULT IsSketchAxisUsedAsDefault(CATBoolean& oBoolean) = 0
Queries status wherere Sketch axis used as default or not.
In case of a sketch profile, specify if the 2D sketch axis must be used as default planar profile axis (for positioning purpose) or not.
Parameters:
oBoolean
TRUE if the 2D sketch axis must be used, FALSE if not.
o RemoveFittingPoints
public virtual HRESULT RemoveFittingPoints()= 0
Removes the fitting points.
o RemoveSecondFittingPoint
public virtual HRESULT RemoveSecondFittingPoint()= 0
Remove the second fitting point.
o SetAngle
public virtual HRESULT SetAngle( const CATICkeParm_var iElem,
const int iI=1) = 0
Sets the first reference surface angle.
Parameters:
iElem
Angle literal feature
See also:
CATICkeParm
o SetAngle
public virtual HRESULT SetAngle( const double iElem,
const int iI=1) = 0
Sets the first reference surface angle.
Parameters:
iElem
Angle value
o SetAngularLaw
public virtual HRESULT SetAngularLaw( const CATICkeLaw_var& Elem) = 0
Sets angular law feature.
Parameters:
Elem
Angular law feature
See also:
CATICkeParm
o SetAngularLawInversion
public virtual HRESULT SetAngularLawInversion( const CATBoolean iInversion) = 0
Sets information whether reference angle law has to be inverted or not.
Parameters:
iInversion
TRUE or FALSE.
See also:
CATGSMBasicLawType
o SetAngularLawType
public virtual HRESULT SetAngularLawType( const enum CATGSMBasicLawType eType) = 0
Sets the type of angular law used for reference angle.
Parameters:
eType
Angular law type:
- CATGSMBasicLawType_None or CATGSMBasicLawType_Constant for constant law (first angle value taken),
- CATGSMBasicLawType_Linear for linear law from first angle to second angle values,
- CATGSMBasicLawType_SType for S type law from first angle to second angle values,
- CATGSMBasicLawType_Advanced for a law specified by a law feature.
See also:
CATGSMBasicLawType
o SetContext
public virtual HRESULT SetContext( const CATGSMFeatureContextType iContext)=0
Sets the context of the Sweep.
Parameters:
iContextType
CATGSMSurfaceCtxt to generate a surface, CATGSMVolumeCtxt (requires GSO License) to generate a volume
See also:
CATGSMFeatureContextType
o SetFittingPoints
public virtual HRESULT SetFittingPoints( const CATISpecObject_var iElem1,
const CATISpecObject_var iElem2) = 0
Sets the fitting points.
Does not work with NULL_var values, Use RemoveFittingPoints() method instead.
Parameters:
iElem1
Fitting point associated to the first guide (must not be equal to NULL_var)
iElem2
Fitting point associated to the second guide (can be equal to NULL_var)
o SetGuide
public virtual HRESULT SetGuide( const CATISpecObject_var iElem) = 0
Sets first guide curve.
Parameters:
iElem
First guide curve feature.
o SetGuide
public virtual HRESULT SetGuide( const CATISpecObject_var iElem,
const int iI) = 0
Sets a guide curve given its index.
Parameters:
iElem
Guide curve feature.
iI
Guide curve index : 1 or 2
o SetGuideDeviation
public virtual HRESULT SetGuideDeviation( const CATICkeParm_var& iElem) = 0
Sets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
Parameters:
iElem
Length literal feature.
o SetGuideDeviation
public virtual HRESULT SetGuideDeviation( const double iElem) = 0
Sets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
Parameters:
iElem
Numerical value.
o SetGuideDeviationActivity
public virtual HRESULT SetGuideDeviationActivity( const CATBoolean iActi) = 0
Sets information whether a deviation from guide curves is allowed or not during sweeping operation in order to smooth it.
Parameters:
iSmooth
TRUE or FALSE.
o SetGuideProjection
public virtual HRESULT SetGuideProjection( const CATBoolean ibProj) = 0
Sets the projection of the guide curve onto the reference plane in order to use it as spine, in pulling direction case only. Sets the spine to NULL_var if TRUE.
Parameters:
ibProj
TRUE is projection is required, FALSE if not
o SetLongitudinalRelimiters
public virtual HRESULT SetLongitudinalRelimiters( const CATISpecObject_var& iElem1,
const CATBoolean biInv1,
const CATISpecObject_var& iElem2,
const CATBoolean biInv2) = 0
Sets the elements relimiting the spine (or the default spine).
Parameters:
iElem1
First relimiting feature (plane or point)
biInv1
Split direction for the first relimitation
FALSE means that the beginning of the spine (considering its orientation) is removed, TRUE means that the end of the spine is removed
iElem2
Second relimiting feature (plane or point)
biInv2
Split direction for the second relimitation
o SetMode
public virtual HRESULT SetMode( const enum CATGSMExplicitSweepCase iElem) = 0
Sets explicit sweep case number.
Parameters:
iElem
Case number
See also:
CATGSMExplicitSweepCase
o SetPosAngle
public virtual HRESULT SetPosAngle( const CATICkeParm_var iElem,
const int iI) = 0
Sets the numerical positioning parameters corresponding to angles from the default positions of the X axes.
Parameters:
iElem
Numerical parameter (literal feature)
iI
Index of the parameter :
- 1 for direction angle in the initial plane,
- 2 for direction angle in the target plane.
See also:
CATICkeParm
o SetPosAngle
public virtual HRESULT SetPosAngle( const double iElem,
const int iI) = 0
Sets the numerical positioning parameters corresponding to angles from the default positions of the X axes.
Parameters:
iElem
Numerical value
iI
Index of the parameter :
- 1 for direction angle in the initial plane,
- 2 for direction angle in the target plane.
o SetPosCoord
public virtual HRESULT SetPosCoord( const CATICkeParm_var iElem,
const int iI) = 0
Sets the numerical positioning parameters corresponding to coordinates. of the new axes systems origins.
Parameters:
iElem
Numerical parameter (literal feature)
iI
Index of the parameter :
- 1 and 2 for origin coordinates in the initial plane,
- 3 and 4 for origin coordinates in the target plane.
See also:
CATICkeParm
o SetPosCoord
public virtual HRESULT SetPosCoord( const double iElem,
const int iI) = 0
Sets the numerical positioning parameters corresponding to coordinates. of the new axes systems origins.
Parameters:
iElem
Numerical value
iI
Index of the parameter :
- 1 and 2 for origin coordinates in the initial plane,
- 3 and 4 for origin coordinates in the target plane.
o SetPosDirection
public virtual HRESULT SetPosDirection( const CATIGSMDirection_var iElem) = 0
Sets the positioning direction : initial plane X-axis direction.
Parameters:
iElem
Direction feature
See also:
CATIGSMDirection
o SetPosDirection
public virtual HRESULT SetPosDirection( const CATIGSMDirection_var iElem,
const int iI) = 0
Sets the positioning directions : initial or target plane X-axis direction.
Parameters:
iElem
Direction feature
iI
Plane index : 1 for initial one, 2 for target one
See also:
CATIGSMDirection
o SetPosMode
public virtual HRESULT SetPosMode( const enum CATGSMPositionMode Elem) = 0
Sets the positioning mode.
Parameters:
Elem
CATGSMPositionMode_ExplicitSweep if a positioning operation is operated, CATGSMPositionMode_NoneOrPositioned if not
See also:
CATGSMPositionMode
o SetPosPoint
public virtual HRESULT SetPosPoint( const CATISpecObject_var iElem) = 0
Sets the point designated as the origin of the initial plane.
Parameters:
iElem
Point feature
o SetPosPoint
public virtual HRESULT SetPosPoint( const CATISpecObject_var iElem,
const int iI) = 0
Sets the points designated as the origins of the initial and target transformation planes.
Parameters:
iElem
Point feature
iI
Plane index : 1 for initial one, 2 for target one
o SetPosSwapAxes
public virtual HRESULT SetPosSwapAxes( const enum CATGSMAxisInversionMode iII) = 0
Sets the positioning parameter : initial plane axes inversion from previous definition.
Parameters:
iII
State of axes
See also:
CATGSMAxisInversionMode
o SetPosSwapAxes
public virtual HRESULT SetPosSwapAxes( const enum CATGSMAxisInversionMode iI,
const int iIdx) = 0
Modify the positioning parameters : axes inversion from previous definition for each transformation plane (initial and target).
Parameters:
iI
State of axes :
- CATGSMAxisInversionMode_None : no axis inverted
- CATGSMAxisInversionMode_X : only X axis inverted
- CATGSMAxisInversionMode_Y : only Y axis inverted
- CATGSMAxisInversionMode_Both : both axes inverted
iIdx
Plane index : 1 for initial one, 2 for target one
See also:
CATGSMAxisInversionMode
o SetPositionedProfile
public virtual HRESULT SetPositionedProfile(CATISpecObject_var& iElem) = 0
Sets the positioning transformation.
Parameters:
iElem
Positioning transformation feature
o SetProfile
public virtual HRESULT SetProfile( const CATISpecObject_var iElem) = 0
Sets the original profile.
Parameters:
iElem
Original profile feature
o SetProfileXAxisComputationMode
public virtual HRESULT SetProfileXAxisComputationMode( const enum CATGSMPositionDirCompMode iDirCompMode) = 0
Sets the computation mode of the X axis (or direction) of the initial axis system. If CATGSMPositionDirCompMode_None or CATGSMPositionDirCompMode_Tangent is specified, a SetPosDirection(NULL_var, 1) is performed. Specifying CATGSMPositionDirCompMode_User is useless: if a direction has previously been specified, the mode has already been set.
Parameters:
iDirCompMode
Mode
See also:
CATIGSMPositionTransfo
o SetPullingDirection
public virtual HRESULT SetPullingDirection( const CATIGSMDirection_var& iDir) = 0
Sets the pulling direction. This input replaces the reference surface; indeed, if the direction is specified, the plane normal to this direction is taken as reference surface.
Parameters:
iDir
Pulling direction feature
See also:
CATIGSMDirection
o SetReference
public virtual HRESULT SetReference( const CATISpecObject_var iElem) = 0
Sets the reference surface.
Parameters:
iElem
Reference surface feature
o SetSmoothActivity
public virtual HRESULT SetSmoothActivity( const CATBoolean iSmooth) = 0
Sets information whether sweeping operation is smoothed or not.
Parameters:
iSmooth
TRUE or FALSE.
o SetSmoothAngleThreshold
public virtual HRESULT SetSmoothAngleThreshold( const CATICkeParm_var& iElem) = 0
Sets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
Parameters:
iElem
Angular literal feature.
o SetSmoothAngleThreshold
public virtual HRESULT SetSmoothAngleThreshold( const double iElem) = 0
Sets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
Parameters:
iElem
Numerical value.
o SetSolutionNo
public virtual HRESULT SetSolutionNo(int iSolNo)=0
Sets the current solution number of the four possible solutions.
Parameters:
iSolNo
is the solution number.
o SetSpine
public virtual HRESULT SetSpine( const CATISpecObject_var iElem) = 0
Sets the spine.
Parameters:
iElem
Spine feature
o UseSketchAxisAsDefault
public virtual HRESULT UseSketchAxisAsDefault( const CATBoolean iBoolean= TRUE) = 0
Uses Sketch Axis As Default.
In case of a sketch profile, specify if the 2D sketch axis must be used as default planar profile axis (for positioning purpose) or not.
Parameters:
iBoolean
TRUE if the 2D sketch axis must be used, FALSE if not.

This object is included in the file: CATIGSMSweepUnspec.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces

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