All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMOffset

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

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


interface CATIGSMOffset

Interface to offset surface feature.
Role: Allows you to gets or/and sets the definition elements of a surface offset: a surface, an orientation and an offset value.
Note: Methodolpgy of remove of "tricky" face at offset update : Use of the suppress mode has to be handle carefully in Offset
- If Supppress mode is active: Each time the offset is updated, the operator will identify automatically the "tricky" faces and removes them Example: This mode is the standard behaviour in Part Design (Offset is used in "Thick" operator)
- If Supppress mode is in-active: Each time the offset is update, if a face has to be removed and this face is not declared in the "tricky" faces the update failed Example: This mode is the standard behaviour in Gsd in Offset : Each time some face has to be removed, the offset failed if it is not declared as tricky face In the Gsd interactive offset command, a pop-up window is proposed in order to validate the insertion of "tricky" identified faces in the list The list of all tricky face are then kept in the offset data , and are reused at update

See also:
CATIGSMFactory.CreateOffset


Method Index


o AddTrickyFace(CATISpecObject_var)
Adds a tricky face object on the object.
o GetCkeOffsetDeviation(CATICkeParm_var&)
Gets the offset deviation value.
o GetCkeOffsetValue(CATICkeParm_var&)
Gets the offset value.
o GetInvertDirection(CATBoolean&)
Gets the orientation.
o GetOffsetDeviation(double&)
Gets the offset deviation value.
o GetOffsetType(CATGSMOffsetType&)
Gets Offset type.
o GetOffsetValue(double&)
Gets the offset value.
o GetProfil(CATISpecObject_var&)
Gets the reference surface.
o GetSuppressMode(CATBoolean&)
Gets 'suppress mode'.
o GetTrickyFaces(CATLISTV(CATISpecObject_var)&)
Returns the tricky faces object on the object.
o RemoveTrickyFaces(int)
Remove the tricky face object on the object.
o SetInvertDirection(CATBoolean)
Sets the orientation.
o SetOffsetDeviation(CATICkeParm_var)
Sets the offset deviation value.
o SetOffsetDeviation(double)
Sets the offset deviation value.
o SetOffsetType(CATGSMOffsetType)
Sets the type of Offset.
o SetOffsetValue(CATICkeParm_var)
Sets the offset value.
o SetOffsetValue(double)
Sets the offset value.
o SetProfil(CATISpecObject_var)
Sets the reference surface.
o SetSuppressMode(CATBoolean)
Sets the suppress mode.

Methods


o AddTrickyFace
public virtual HRESULT AddTrickyFace( const CATISpecObject_var iTrickyFace) = 0
Adds a tricky face object on the object.
Parameters:
iTrickyFace
Offset invalid face
o GetCkeOffsetDeviation
public virtual HRESULT GetCkeOffsetDeviation(CATICkeParm_var& oOffDeviation) = 0
Gets the offset deviation value.
Parameters:
oOffDeviation
Offset deviation value (Cke Parameter)
o GetCkeOffsetValue
public virtual HRESULT GetCkeOffsetValue(CATICkeParm_var& oOffValue) = 0
Gets the offset value.
Parameters:
oOffValue
Offset value
o GetInvertDirection
public virtual HRESULT GetInvertDirection(CATBoolean& oInvert) = 0
Gets the orientation.
Parameters:
oInvert
: False means that there is no invertion of the surface orientation (orientation is the normal on the surface) : True to invert this orientation
o GetOffsetDeviation
public virtual HRESULT GetOffsetDeviation(double& oOffDeviation) = 0
Gets the offset deviation value.
Parameters:
oOffDeviation
Offset deviation value
o GetOffsetType
public virtual HRESULT GetOffsetType(CATGSMOffsetType& oType) = 0
Gets Offset type.
Normal or smooth tyoe.
Parameters:
oType
Offset type : CATGSMOffset_Constant (=0) -> Normal : CATGSMOffset_Rough (=1) -> Rough : CATGSMOffset_Smooth (=2) -> Smooth
See also:
CATGSMOffsetType
o GetOffsetValue
public virtual HRESULT GetOffsetValue(double& oOffValue) = 0
Gets the offset value.
Parameters:
oOffValue
Offset value
o GetProfil
public virtual HRESULT GetProfil(CATISpecObject_var& oElem) = 0
Gets the reference surface.
Parameters:
oElem
Offset Surface
o GetSuppressMode
public virtual HRESULT GetSuppressMode(CATBoolean& oSuppressMode) = 0
Gets 'suppress mode'.
Parameters:
oSuppressMode
CATTrue = erroneous elements are removed from the result autonmatically at update CATFalse = error if erroneous elements, (not declared tricky faces)
See also:
CATBoolean
o GetTrickyFaces
public virtual HRESULT GetTrickyFaces(CATLISTV(CATISpecObject_var)& oTrickyFaces) = 0
Returns the tricky faces object on the object.
Parameters:
oTrickyFaces
Offset invalid faces
o RemoveTrickyFaces
public virtual HRESULT RemoveTrickyFaces(int iRank) = 0
Remove the tricky face object on the object.
Parameters:
iRank
position of the face in the list of TrickyFaces
o SetInvertDirection
public virtual HRESULT SetInvertDirection(CATBoolean iInvert) = 0
Sets the orientation.
Parameters:
iInvert
: False means that there is no invertion of the curve orientation (orientation is the product of the tangent of the curve by the normal on the support) : True to invert this orientation
o SetOffsetDeviation
public virtual HRESULT SetOffsetDeviation( const CATICkeParm_var iOffDeviation) = 0
Sets the offset deviation value.
Parameters:
iOffDeviation
Offset deviation value (Cke Parameter)
o SetOffsetDeviation
public virtual HRESULT SetOffsetDeviation( const double iOffDeviation) = 0
Sets the offset deviation value.
Parameters:
iOffDeviation
Offset deviation value
o SetOffsetType
public virtual HRESULT SetOffsetType(CATGSMOffsetType iType) = 0
Sets the type of Offset.
It modifies the Offset type either "Normal" or "Rough" or "Smooth"
Parameters:
iType
Offset type : CATGSMOffset_Constant (=0) -> Normal : CATGSMOffset_Rough (=1) -> Rough : CATGSMOffset_Smooth (=2) -> Smooth
See also:
CATGSMOffsetType
o SetOffsetValue
public virtual HRESULT SetOffsetValue( const CATICkeParm_var iOffValue) = 0
Sets the offset value.
Parameters:
iOffValue
Offset value
o SetOffsetValue
public virtual HRESULT SetOffsetValue(double iOffValue) = 0
Sets the offset value.
Parameters:
iOffValue
Offset value
o SetProfil
public virtual HRESULT SetProfil( const CATISpecObject_var iElem) = 0
Sets the reference surface.
Parameters:
iElem
new reference surface
o SetSuppressMode
public virtual HRESULT SetSuppressMode(CATBoolean iSuppressMode) = 0
Sets the suppress mode.
Parameters:
iSuppressMode
CATTrue = erroneous elements are removed from the result autonmatically at update CATFalse = error if erroneous elements, (not declared tricky faces)
Note:
- If Supppress mode is active: Each time the offset is updated, the operator will identify automatically the "tricky" faces and removes them Example: This mode is the standard behaviour in Part Design (Offset is used in "Thick" operator)
- If Supppress mode is in-active: Each time the offset is update, if a face has to be removed and this face is not declared in the "tricky" faces the update failed Example: This mode is the standard behaviour in Gsd in Offset : Each time some face has to be removed, the offset failed if it is not declared as tricky face In the Gsd interactive offset command, a pop-up window is proposed in order to validate the insertion of "tricky" identified faces in the list The list of all tricky face are then kept in the offset data , and are reused at update
See also:
CATBoolean

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

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