All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMLoft

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

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


interface CATIGSMLoft

Interface to loft surface feature.
Role: Allows you to access data of the Loft feature.

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

See also:
CATIGSMFactory.CreateLoft


Method Index


o AddGuide(CATISpecObject_var,CATGSMLoftAddType,CATISpecObject_var)
Adds guide to the lofted surface.
o AddSection(CATISpecObject_var,CATGSMLoftAddType,CATISpecObject_var)
Adds section to the lofted surface.
o AddSection(CATISpecObject_var,CATISpecObject_var&,CATISpecObject_var&,CATGSMClosingPointCreationDiag&,CATGSMLoftAddType,CATISpecObject_var)
Adds section to the lofted surface.
o GetAllGuides(CATLISTV(CATISpecObject_var)&)
Gets informations about the guides of the lofted surface.
o GetAllGuides(CATLISTV(CATISpecObject_var)&,CATLISTV(CATISpecObject_var)&)
Gets informations about the guides of the lofted surface.
o GetAllSections(CATLISTV(CATISpecObject_var)&,CATListOfInt&,CATLISTV(CATISpecObject_var)&,CATISpecObject_var&,CATISpecObject_var&)
Gets informations about the sections of the lofted surface.
o GetBooleanOperation(int&)
Gets boolean operation for closed lofted surface.
o GetCanonicalDetection(CATGSMCanonicalSurfaceDetection&)
Gets information about detection of canonical surfaces of the output surface.
o GetCompSectionTangent(CATGSMComputedTangentType&,CATGSMComputedTangentType&)
Gets if the tangent is a computed tangent surface to the start section or end section from the lofted surface.
o GetContext(CATGSMFeatureContextType&)
Gets context type for existing feature.
o GetFacesForClosing(CATISpecObject_var&,CATISpecObject_var&)
Gets if the tangent is a computed tangent surface to the start section or end section from the lofted surface.
o GetRelimitation(int&)
Gets informations about relimitation of the lofted surface.
o GetSectionCoupling(int&)
Gets informations about the coupling between section of the lofted surface.
o GetSmoothAngleThreshold(CATICkeParm_var&)
Gets angular threshold value (angle) allowed during lofting operation in order to smooth it.
o GetSmoothAngleThreshold(double&)
Gets angular threshold value (angle) allowed during lofting operation in order to smooth it.
o GetSmoothAngleThresholdActivity(CATBoolean&)
Gets information whether a angular threshold is allowed or not during lofting operation in order to smooth it.
o GetSmoothDeviation(CATICkeParm_var&)
Gets deviation value (length) allowed during lofting operation in order to smooth it.
o GetSmoothDeviation(double&)
Gets deviation value (length) allowed during lofting operation in order to smooth it.
o GetSmoothDeviationActivity(CATBoolean&)
Gets information whether a deviation is allowed or not during lofting operation in order to smooth it.
o GetSpine(int&,CATISpecObject_var&)
Gets the spine of the lofted surface.
o ModifyGuideCurve(CATISpecObject_var,CATISpecObject_var)
Modifies the curve of a guide from the lofted surface.
o ModifySectionCurve(CATISpecObject_var,CATISpecObject_var)
Modifies the curve of section from the lofted surface.
o ModifySectionCurve(CATISpecObject_var,CATISpecObject_var,CATISpecObject_var&,CATISpecObject_var&,CATGSMClosingPointCreationDiag&)
Modifies the curve of section from the lofted surface.
o ModifySectionOrient(CATISpecObject_var,CATGSMOrientation)
Modifies the orientation of the curve of a section from the lofted surface.
o RemoveFaceForClosing(CATISpecObject_var)
Removes face used to close the lofted surface.
o RemoveGuide(CATISpecObject_var)
Removes guide from the lofted surface.
o RemoveGuideTangent(CATISpecObject_var)
Removes a tangent surface of a guide from the lofted surface.
o RemoveSection(CATISpecObject_var)
Removes section from the lofted surface.
o RemoveSectionPoint(CATISpecObject_var)
Removes a closing point of a section from the lofted surface.
o RemoveSectionTangent(CATISpecObject_var)
Removes the tangent surface of a section from the lofted surface.
o SetBooleanOperation(CATGSMLoftBooleanOp)
Sets boolean operation for closed lofted surface.
o SetCanonicalDetection(CATGSMCanonicalSurfaceDetection)
Sets information about detection of canonical surfaces of the output surface.
o SetCompSectionTangent(CATISpecObject_var,CATGSMComputedTangentType)
Sets a computed tangent surface to the start section or end section.
o SetContext(CATGSMFeatureContextType)
Sets context type to generate a Surface or Volume.
o SetFaceForClosing(CATISpecObject_var,CATISpecObject_var)
Sets face for closing the lofted surface.
o SetGuideTangent(CATISpecObject_var,CATISpecObject_var)
Sets a tangent surface to a guide from the lofted surface.
o SetRelimitation(CATGSMLoftRelimitationType)
Sets informations about relimitation of the lofted surface.
o SetSectionCoupling(CATGSMCouplingType)
Sets informations about the coupling between section of the lofted surface.
o SetSectionPoint(CATISpecObject_var,CATISpecObject_var)
Sets a closing point to a section from the lofted surface.
o SetSectionTangent(CATISpecObject_var,CATISpecObject_var)
Sets a tangent surface to a section from the lofted surface.
o SetSmoothAngleThreshold(CATICkeParm_var&)
Sets angular threshold value (angle) allowed during lofting operation in order to smooth it.
o SetSmoothAngleThreshold(double)
Sets angular threshold value (angle) allowed during lofting operation in order to smooth it.
o SetSmoothAngleThresholdActivity(CATBoolean)
Sets information whether a angular threshold is allowed or not during lofting operation in order to smooth it.
o SetSmoothDeviation(CATICkeParm_var&)
Sets deviation value (length) allowed during lofting operation in order to smooth it.
o SetSmoothDeviation(double)
Sets deviation value (length) allowed during lofting operation in order to smooth it.
o SetSmoothDeviationActivity(CATBoolean)
Sets information whether a deviation is allowed or not during lofting operation in order to smooth it.
o SetSpine(CATGSMLoftSpineType,CATISpecObject_var)
Sets the spine to the lofted surface.

Methods


o AddGuide
public virtual HRESULT AddGuide( const CATISpecObject_var iGuide,
const CATGSMLoftAddType iAddType= CATGSMLoftAdd ,
const CATISpecObject_var iGuideRef= NULL_var )= 0
Adds guide to the lofted surface.
Parameters:
iGuide
guide curve to be added
iAddType
type of adding : CATGSMLoftAdd, iSection will be added at the end of the guide list. CATGSMLoftAddAfter, iGuide will be added after iGuideRef. CATGSMLoftAddBefore, iGuide will be added before iGuideRef.
See also:
CATGSMLoftAddType
iGuideRef
guide curve used as a reference for CATGSMLoftAddAfter and CATGSMLoftAddBefore adding type
o AddSection
public virtual HRESULT AddSection( const CATISpecObject_var iSection,
const CATGSMLoftAddType iAddType= CATGSMLoftAdd ,
const CATISpecObject_var iSectionRef= NULL_var )= 0
Adds section to the lofted surface.
Parameters:
iSection
section curve to be added
iAddType
type of adding : CATGSMLoftAdd, iSection will be added at the end of the section list. CATGSMLoftAddAfter, iSection will be added after iSectionRef. CATGSMLoftAddBefore, iSection will be added before iSectionRef.
See also:
CATGSMLoftAddType
iSectionRef
section curve used as a reference for CATGSMLoftAddAfter and CATGSMLoftAddBefore adding type
o AddSection
public virtual HRESULT AddSection( const CATISpecObject_var iSection,
CATISpecObject_var& oCurveSection,
CATISpecObject_var& oClosingPoint,
CATGSMClosingPointCreationDiag& oPtDiag,
const CATGSMLoftAddType iAddType= CATGSMLoftAdd ,
const CATISpecObject_var iSectionRef= NULL_var )= 0
Adds section to the lofted surface.
Parameters:
iSection
section to be added : curve or face.
oCurveSection
if iSection is a face, oCurveSection is the boundary of the face. oCurveSection is used as section curve. if Part design, the face is used to close the Loft.
oClosingPoint
if iSection is a closed curve, oClosingPoint is a new closing point of iSection. if iSection is a face, oClosingPoint is a new closing point the boundary of iSection.
oPtDiag
Closing Point diagnosis.
See also:
CATGSMClosingPointCreationDiag
iAddType
type of adding : CATGSMLoftAdd, iSection will be added at the end of the section list. CATGSMLoftAddAfter, iSection will be added after iSectionRef. CATGSMLoftAddBefore, iSection will be added before iSectionRef.
See also:
CATGSMLoftAddType
iSectionRef
section curve used as a reference for CATGSMLoftAddAfter and CATGSMLoftAddBefore adding type
o GetAllGuides
public virtual HRESULT GetAllGuides(CATLISTV(CATISpecObject_var)& oGuides)= 0
Gets informations about the guides of the lofted surface.
Parameters:
oGuides
list of the guides curves.
o GetAllGuides
public virtual HRESULT GetAllGuides(CATLISTV(CATISpecObject_var)& oGuides,
CATLISTV(CATISpecObject_var)& oGuideTangents)= 0
Gets informations about the guides of the lofted surface.
Parameters:
oGuides
list of the guides curves.
oGuideTangents
list of the tangents corresponding to the guides curves.
o GetAllSections
public virtual HRESULT GetAllSections(CATLISTV(CATISpecObject_var)& oSections,
CATListOfInt& oOrientation,
CATLISTV(CATISpecObject_var)& oPoint,
CATISpecObject_var& oStartSectionTangent,
CATISpecObject_var& oEndSectionTangent)= 0
Gets informations about the sections of the lofted surface.
Parameters:
oSections
list of the section curves.
oOrientation
list of the orientations of the section curves.
oPoint
list of the closing points corresponding to the section curves.
oStartSectionTangent
tangent surface at start section.
oEndSectionTangent
tangent surface at end section.
o GetBooleanOperation
public virtual HRESULT GetBooleanOperation(int& oOperation)= 0
Gets boolean operation for closed lofted surface. TO BE USED ONLY for Part Loft (closed loft)
Parameters:
oOperation
type of operation.
See also:
CATGSMLoftBooleanOp
o GetCanonicalDetection
public virtual HRESULT GetCanonicalDetection(CATGSMCanonicalSurfaceDetection& oDetection) =0
Gets information about detection of canonical surfaces of the output surface.
Parameters:
oDetection
if canonical surfaces are detected and converted into plane or not and how; possible values are CATGSMNoDetection, CATGSMPlaneOnlyDetection and CATGSMCanonicalDetection.
See also:
CATGSMCanonicalSurfaceDetection
o GetCompSectionTangent
public virtual HRESULT GetCompSectionTangent(CATGSMComputedTangentType& oStartCompSectionTangent,
CATGSMComputedTangentType& oEndCompSectionTangent)= 0
Gets if the tangent is a computed tangent surface to the start section or end section from the lofted surface. The section must have been set as a face.
Parameters:
oStartCompSectionTangent
start section tangent is computed or not,
See also:
CATGSMComputedTangentType
oEndCompSectionTangent
end section tangent is computed or not,
See also:
CATGSMComputedTangentType
o GetContext
public virtual HRESULT GetContext(CATGSMFeatureContextType& oContextType) = 0
Gets context type for existing feature.
Parameters:
oContextType
CATGSMSurfaceCtxt if the result is surface, CATGSMVolumeCtxt if it is volume
See also:
CATGSMFeatureContextType
o GetFacesForClosing
public virtual HRESULT GetFacesForClosing(CATISpecObject_var& oStartFace,
CATISpecObject_var& oEndFace)= 0
Gets if the tangent is a computed tangent surface to the start section or end section from the lofted surface. The section must have been set as a face.
Parameters:
oStartFace
start face used to close the loft. NULL_var, if there is no start face.
oEndFace
end face used to close the loft. NULL_var, if there is no end face.
o GetRelimitation
public virtual HRESULT GetRelimitation(int& oRelimitation)=0
Gets informations about relimitation of the lofted surface.
Parameters:
oRelimitation
type of relimitation.
See also:
CATGSMLoftRelimitationType
o GetSectionCoupling
public virtual HRESULT GetSectionCoupling(int& oCoupling)= 0
Gets informations about the coupling between section of the lofted surface.
Parameters:
oCoupling
type of coupling between section.
See also:
CATGSMCouplingType
o GetSmoothAngleThreshold
public virtual HRESULT GetSmoothAngleThreshold(CATICkeParm_var& ohSmoothAngleThresholdCkeParm) =0
Gets angular threshold value (angle) allowed during lofting operation in order to smooth it.
Parameters:
ohSmoothAngleThresholdCkeParm
Length literal feature.
o GetSmoothAngleThreshold
public virtual HRESULT GetSmoothAngleThreshold(double& oSmoothAngleThreshold) =0
Gets angular threshold value (angle) allowed during lofting operation in order to smooth it.
Parameters:
oSmoothAngleThreshold
Numerical value.
o GetSmoothAngleThresholdActivity
public virtual HRESULT GetSmoothAngleThresholdActivity(CATBoolean& isSmoothAngleThresholdActivity) =0
Gets information whether a angular threshold is allowed or not during lofting operation in order to smooth it.
Parameters:
isSmoothAngleThresholdActivity
TRUE or FALSE (FALSE if not specified).
o GetSmoothDeviation
public virtual HRESULT GetSmoothDeviation(CATICkeParm_var& ohSmoothDeviationCkeParm) =0
Gets deviation value (length) allowed during lofting operation in order to smooth it.
Parameters:
ohSmoothDeviationCkeParm
Length literal feature.
o GetSmoothDeviation
public virtual HRESULT GetSmoothDeviation(double& oSmoothDeviation) =0
Gets deviation value (length) allowed during lofting operation in order to smooth it.
Parameters:
oSmoothDeviation
Numerical value.
o GetSmoothDeviationActivity
public virtual HRESULT GetSmoothDeviationActivity(CATBoolean& isSmoothDeviationActivity) =0
Gets information whether a deviation is allowed or not during lofting operation in order to smooth it.
Parameters:
isSmoothDeviationActivity
TRUE or FALSE (FALSE if not specified).
o GetSpine
public virtual HRESULT GetSpine(int& oSpineType,
CATISpecObject_var& oSpine)= 0
Gets the spine of the lofted surface.
Parameters:
oSpineType
type of spine.
See also:
CATGSMLoftSpineType
oSpine
curve used as a spine, if iSpineType = CATGSMLoftUserSpine
o ModifyGuideCurve
public virtual HRESULT ModifyGuideCurve( const CATISpecObject_var iGuide,
const CATISpecObject_var iNewGuide)= 0
Modifies the curve of a guide from the lofted surface.
Parameters:
iGuide
guide curve to be replaced.
iNewGuide
guide curve, will replace iGuide.
o ModifySectionCurve
public virtual HRESULT ModifySectionCurve( const CATISpecObject_var iSection,
const CATISpecObject_var iNewSection)= 0
Modifies the curve of section from the lofted surface.
Parameters:
iSection
section curve to be replaced.
iNewSection
section curve, will replace iSection.
o ModifySectionCurve
public virtual HRESULT ModifySectionCurve( const CATISpecObject_var iSection,
const CATISpecObject_var iNewSection,
CATISpecObject_var& oCurveSection,
CATISpecObject_var& oClosingPoint,
CATGSMClosingPointCreationDiag& oPtDiag)= 0
Modifies the curve of section from the lofted surface.
Parameters:
iSection
section curve to be replaced.
iNewSection
section will replace iSection, can be a curve or a face
oCurveSection
if iSection is a face, oCurveSection is the boundary of the face. oCurveSection is used as section curve. if Part design, the face is used to close the Loft.
oClosingPoint
if iSection is a closed curve, oClosingPoint is a new closing point of iSection. if iSection is a face, oClosingPoint is a new closing point the boundary of iSection.
o ModifySectionOrient
public virtual HRESULT ModifySectionOrient( const CATISpecObject_var iSection,
CATGSMOrientation iOrient= CATGSMSameOrientation )= 0
Modifies the orientation of the curve of a section from the lofted surface.
Parameters:
iSection
section curve to be replaced.
iOrient
orientation of the section curve :
See also:
CATGSMOrientation
o RemoveFaceForClosing
public virtual HRESULT RemoveFaceForClosing( const CATISpecObject_var iSection)= 0
Removes face used to close the lofted surface.
Parameters:
iSection
section curve.
o RemoveGuide
public virtual HRESULT RemoveGuide( const CATISpecObject_var iGuide)= 0
Removes guide from the lofted surface.
Parameters:
iGuide
guide curve to be removed, if this guide has a tangent surface it will be removed too.
o RemoveGuideTangent
public virtual HRESULT RemoveGuideTangent( const CATISpecObject_var iGuide)= 0
Removes a tangent surface of a guide from the lofted surface.
Parameters:
iGuide
guide curve of the guide to which the surface will be removed.
o RemoveSection
public virtual HRESULT RemoveSection( const CATISpecObject_var iSection)= 0
Removes section from the lofted surface.
Parameters:
iSection
section curve to be removed, if this section has a closing point it will be removed too.
o RemoveSectionPoint
public virtual HRESULT RemoveSectionPoint( const CATISpecObject_var iSection)= 0
Removes a closing point of a section from the lofted surface. The curve section must be closed curve.
Parameters:
iSection
section curve of the section to which the point will be removed.
o RemoveSectionTangent
public virtual HRESULT RemoveSectionTangent( const CATISpecObject_var iSection)= 0
Removes the tangent surface of a section from the lofted surface. The section must be the start section or the end section of the loft.
Parameters:
iSection
section curve of the section to which the tangent will be removed.
o SetBooleanOperation
public virtual HRESULT SetBooleanOperation( const CATGSMLoftBooleanOp iOperation= CATGSMLoftBooleanUnion )= 0
Sets boolean operation for closed lofted surface. TO BE USED ONLY for Part Loft (closed loft)
Parameters:
iOperation
type of operation.
See also:
CATGSMLoftBooleanOp
o SetCanonicalDetection
public virtual HRESULT SetCanonicalDetection( const CATGSMCanonicalSurfaceDetection iDetection= CATGSMCanonicalDetection) =0
Sets information about detection of canonical surfaces of the output surface.
Parameters:
iDetection
if canonical surfaces are detected and converted into plane or not and how; possible values are CATGSMNoDetection, CATGSMPlaneOnlyDetection and CATGSMCanonicalDetection.
See also:
CATGSMCanonicalSurfaceDetection
o SetCompSectionTangent
public virtual HRESULT SetCompSectionTangent( const CATISpecObject_var iSection,
const CATGSMComputedTangentType iCompSectionTangent)=0
Sets a computed tangent surface to the start section or end section. from the lofted surface. The section must have been set as a face.
Parameters:
iSection
section curve of the section to which the tangent will be computed.
iCompSectionTangent
section tangent is computed or not,
See also:
CATGSMComputedTangentType
o SetContext
public virtual HRESULT SetContext( const CATGSMFeatureContextType iContextType) = 0
Sets context type to generate a Surface or Volume.
Parameters:
iContextType
CATGSMSurfaceCtxt to generate a surface, CATGSMVolumeCtxt (requires GSO License) to generate a volume
See also:
CATGSMFeatureContextType
o SetFaceForClosing
public virtual HRESULT SetFaceForClosing( const CATISpecObject_var iSection,
const CATISpecObject_var iFace)= 0
Sets face for closing the lofted surface.
Parameters:
iSection
section curve.
iFace
End face used to close the loft.
o SetGuideTangent
public virtual HRESULT SetGuideTangent( const CATISpecObject_var iGuide,
const CATISpecObject_var iTangentGuide)= 0
Sets a tangent surface to a guide from the lofted surface.
Parameters:
iGuide
guide curve of the guide to which the tangent will be added
iTangentGuide
tangent surface to be added, the curve must be layed on the surface.
o SetRelimitation
public virtual HRESULT SetRelimitation( const CATGSMLoftRelimitationType iRelimitation= CATGSMLoftRelimitOnLimitSections )=0
Sets informations about relimitation of the lofted surface.
Parameters:
iRelimitation
type of relimitation.
See also:
CATGSMLoftRelimitationType
o SetSectionCoupling
public virtual HRESULT SetSectionCoupling( const CATGSMCouplingType iCoupling= CATGSMRatioCoupling )= 0
Sets informations about the coupling between section of the lofted surface.
Parameters:
iCoupling
type of coupling between section.
See also:
CATGSMCouplingType
o SetSectionPoint
public virtual HRESULT SetSectionPoint( const CATISpecObject_var iSection,
const CATISpecObject_var iPointSection)= 0
Sets a closing point to a section from the lofted surface. The curve section must be closed curve.
Parameters:
iSection
section curve of the section to which the point will be added.
iPointSection
point to be added
o SetSectionTangent
public virtual HRESULT SetSectionTangent( const CATISpecObject_var iSection,
const CATISpecObject_var iTangentSection)= 0
Sets a tangent surface to a section from the lofted surface. The section must be the start section or the end section of the loft.
Parameters:
iSection
section curve of the section to which the tangent will be added
iTangentSection
tangent surface to be added, the curve must be layed on the surface.
o SetSmoothAngleThreshold
public virtual HRESULT SetSmoothAngleThreshold( const CATICkeParm_var& ihSmoothAngleThresholdCkeParm) =0
Sets angular threshold value (angle) allowed during lofting operation in order to smooth it.
Parameters:
ohSmoothAngleThresholdCkeParm
Length literal feature.
o SetSmoothAngleThreshold
public virtual HRESULT SetSmoothAngleThreshold( const double iSmoothAngleThreshold) =0
Sets angular threshold value (angle) allowed during lofting operation in order to smooth it.
Parameters:
iSmoothAngleThreshold
Numerical value.
o SetSmoothAngleThresholdActivity
public virtual HRESULT SetSmoothAngleThresholdActivity( const CATBoolean isSmoothAngleThresholdActivity) =0
Sets information whether a angular threshold is allowed or not during lofting operation in order to smooth it.
Parameters:
isSmoothAngleThresholdActivity
TRUE or FALSE (FALSE if not specified).
o SetSmoothDeviation
public virtual HRESULT SetSmoothDeviation( const CATICkeParm_var& ihSmoothDeviationCkeParm) =0
Sets deviation value (length) allowed during lofting operation in order to smooth it.
Parameters:
ihSmoothDeviationCkeParm
Length literal feature.
o SetSmoothDeviation
public virtual HRESULT SetSmoothDeviation( const double iSmoothDeviation) =0
Sets deviation value (length) allowed during lofting operation in order to smooth it.
Parameters:
iSmoothDeviation
Numerical value.
o SetSmoothDeviationActivity
public virtual HRESULT SetSmoothDeviationActivity( const CATBoolean isSmoothDeviationActivity) =0
Sets information whether a deviation is allowed or not during lofting operation in order to smooth it.
Parameters:
isSmoothDeviationActivity
TRUE or FALSE.
o SetSpine
public virtual HRESULT SetSpine( const CATGSMLoftSpineType iSpineType= CATGSMLoftCalculatedSpine ,
const CATISpecObject_var iSpine= NULL_var )= 0
Sets the spine to the lofted surface.
Parameters:
iSpineType
type of spine.
See also:
CATGSMLoftSpineType
iSpine
curve to be added as a spine, if iSpineType = CATGSMLoftUserSpine

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

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