All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMSweep

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

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


interface CATIGSMSweep

Interface to sweep definition feature.
Role: Allows you to access common data for sweeps Sweep types:

Legal values :
SweepUnspec = 0
SweepSegment = 1
SweepCircle = 2


Method Index


o AddCutPoints(CATISpecObject_var&,CATISpecObject_var&)
Sets two cut points on the master guide.
o AddFillPoints(CATISpecObject_var&,CATISpecObject_var&)
Sets two cut points on the master guide.
o GetCutPoints(CATListValCATISpecObject_var&)
Gets the list of cut points on the master guide (even number of elements).
o GetFillPoints(CATListValCATISpecObject_var&)
Gets the list of filling points on the master guide (even number of elements).
o GetFillTwistedAreas(CATGSMSweepFillMode&)
Gets the fill twisted areas mode.
o GetSetbackValue(double&)
Gets the setback value of the twisted areas (in percentage of the guide length (from 0 to 100%).
o GetSweepType(int&)
Gets type of Sweep.
o RemoveAllCutPoints()
Removes all cut points.
o RemoveAllFillPoints()
Removes all fill points.
o RemoveFillPoints(CATISpecObject_var&,CATISpecObject_var&)
Removes a fill point.
o SetFillTwistedAreas(CATGSMSweepFillMode)
Sets the fill twisted areas mode.
o SetSetbackValue(double)
Sets the setback value of the twisted areas (in percentage of the guide length (from 0 to 100%).

Methods


o AddCutPoints
public virtual HRESULT AddCutPoints( const CATISpecObject_var& iPt1,
const CATISpecObject_var& iPt2) = 0
Sets two cut points on the master guide. These points define a zone to be kept on the final swept surface.
Parameters:
iPt1
First / start cut point.
iPt2
Second / end cut point.
o AddFillPoints
public virtual HRESULT AddFillPoints( const CATISpecObject_var& iPt1,
const CATISpecObject_var& iPt2) = 0
Sets two cut points on the master guide. These points define a zone to be filled on the final swept surface.
Parameters:
iPt1
First / start fill point.
iPt2
Second / end fill point.
o GetCutPoints
public virtual HRESULT GetCutPoints(CATListValCATISpecObject_var& oPtsList) = 0
Gets the list of cut points on the master guide (even number of elements). These points define zones to be kept on the final swept surface.
Parameters:
oPtsList
Cut points list.
o GetFillPoints
public virtual HRESULT GetFillPoints(CATListValCATISpecObject_var& oPtsList) = 0
Gets the list of filling points on the master guide (even number of elements). These points define zones to be filled on the final swept surface.
Parameters:
oPtsList
Fill points list.
o GetFillTwistedAreas
public virtual HRESULT GetFillTwistedAreas(CATGSMSweepFillMode& oMode) = 0
Gets the fill twisted areas mode.
Parameters:
oMode
Fill mode.
See also:
CATGSMSweepFillMode
o GetSetbackValue
public virtual HRESULT GetSetbackValue(double& oValue) = 0
Gets the setback value of the twisted areas (in percentage of the guide length (from 0 to 100%).
Parameters:
oValue
Setback value.
o GetSweepType
public virtual void GetSweepType(int& oT) = 0
Gets type of Sweep.
Parameters:
oT
Sweep type
o RemoveAllCutPoints
public virtual HRESULT RemoveAllCutPoints()= 0
Removes all cut points.
o RemoveAllFillPoints
public virtual HRESULT RemoveAllFillPoints()= 0
Removes all fill points.
o RemoveFillPoints
public virtual HRESULT RemoveFillPoints( const CATISpecObject_var& iPt1,
const CATISpecObject_var& iPt2) = 0
Removes a fill point.
Parameters:
iPt1
First fill point to remove.
iPt2
Second fill point to remove.
o SetFillTwistedAreas
public virtual HRESULT SetFillTwistedAreas(CATGSMSweepFillMode iMode) = 0
Sets the fill twisted areas mode.
Parameters:
iMode
Fill mode.
See also:
CATGSMSweepFillMode
o SetSetbackValue
public virtual HRESULT SetSetbackValue(double iValue) = 0
Sets the setback value of the twisted areas (in percentage of the guide length (from 0 to 100%).
Parameters:
iValue
Setback value.

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

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