All Frameworks Class Hierarchy This Framework Previous Next Indexes
GSMInterfaces Interface CATIGSMExtrude
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIGSMExtrude
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMExtrude
Interface to extrusion feature.
Role: Allows you to access data of the Extrusion feature
created by using an element, a direction and two length values
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.CreateExtrude
Method Index
- o
GetContext(CATGSMFeatureContextType&)
- Gets the context of the extrude.
- o
GetDir()
- Gets the extrusion direction.
- o
GetFirstLimitType(CATGSMFeatureLimitType&)
- Gets First Limit Type.
- o
GetFirstLimitValue(CATICkeParm_var&)
- Gets the first length value.
- o
GetFirstLimitValue(double&)
- Gets the first length value.
- o
GetFirstUptoElement(CATISpecObject_var&)
- Gets the up-to element used as Limit1.
- o
GetOrientation(CATBoolean&)
- Gets the orientation of the extrude.
- o
GetProfil()
- Gets the feature that has been extruded.
- o
GetSecondLimitType(CATGSMFeatureLimitType&)
- Gets Second Limit Type.
- o
GetSecondLimitValue(CATICkeParm_var&)
- Gets the second length value.
- o
GetSecondLimitValue(double&)
- Gets the second length value.
- o
GetSecondUptoElement(CATISpecObject_var&)
- Gets the up-to element used as Limit2.
- o
InvertOrientation()
- Inverts the orientation of the extrude.
- o
SetContext(CATGSMFeatureContextType)
- Sets the context of the extrude.
- o
SetDir(CATIGSMDirection_var)
- Sets the direction of the extrusion.
- o
SetFirstLimitType(CATGSMFeatureLimitType&)
- Sets First Limit Type.
- o
SetFirstLimitValue(CATICkeParm_var)
- Sets the first length value.
- o
SetFirstLimitValue(double)
- Sets the first length value.
- o
SetFirstUptoElement(CATISpecObject_var&)
- Sets the up-to element to be used as Limit1.
- o
SetOrientation(CATBoolean)
- Sets the orientation of the extrude.
- o
SetProfil(CATISpecObject_var)
- Sets the element that will be extruded.
- o
SetSecondLimitType(CATGSMFeatureLimitType&)
- Sets Second Limit Type.
- o
SetSecondLimitValue(CATICkeParm_var)
- Sets the second length value.
- o
SetSecondLimitValue(double)
- Sets the second length value.
- o
SetSecondUptoElement(CATISpecObject_var&)
- Sets the up-to element to be used as Limit2.
Methods
o GetContext
-
Gets the context of the extrude.
- Parameters:
-
- oContextType
- CATGSMSurfaceCtxt if the result is surface, CATGSMVolumeCtxt if it is volume
- See also:
- CATGSMFeatureContextType
o GetDir
-
Gets the extrusion direction.
- Returns:
- direction
o GetFirstLimitType
-
Gets First Limit Type.
- Parameters:
-
- oLim1Type
- Limit Type specified
enum CATGSMFeatureLimitType { CATGSMFeatureLimitType_Unknown = 0,
o GetFirstLimitValue
public virtual HRESULT GetFirstLimitValue( | CATICkeParm_var& | oOfs1)=0 |
-
Gets the first length value. For surface extrude, if limit type is upto, limit's value is not used.
In case of Volume Extrude, if the up-to element is specified, value of Limit will act as offset value from that upto element
- Parameters:
-
- Ofs1
- first length value
- See also:
- CATICkeParm
o GetFirstLimitValue
public virtual HRESULT GetFirstLimitValue( | double& | oOfs1) = 0 |
-
Gets the first length value. For surface extrude, if limit type is upto, limit's value is not used.
In case of Volume Extrude, if the up-to element is specified, value of Limit will act as offset value from that upto element
- Parameters:
-
- Ofs1
- first length value
o GetFirstUptoElement
public virtual HRESULT GetFirstUptoElement( | CATISpecObject_var& | ohUptoElem1) = 0 |
-
Gets the up-to element used as Limit1.
- Parameters:
-
- ohUptoElem1
- up-to element used to limit extrusion
o GetOrientation
-
Gets the orientation of the extrude.
TRUE means that the natural orientation of the direction
is the right one.
- Parameters:
-
- oOrient
- Extrude orientation
o GetProfil
-
Gets the feature that has been extruded.
- Returns:
- extruded feature
o GetSecondLimitType
-
Gets Second Limit Type.
- Parameters:
-
- oLim2Type
- Limit Type specified
enum CATGSMFeatureLimitType { CATGSMFeatureLimitType_Unknown = 0,
o GetSecondLimitValue
public virtual HRESULT GetSecondLimitValue( | CATICkeParm_var& | oOfs2)=0 |
-
Gets the second length value. For surface extrude, if limit type is upto, limit's value is not used.
In case of Volume Extrude, if the up-to element is specified, value of Limit will act as offset value from that upto element
- Parameters:
-
- Ofs2
- second length value
- See also:
- CATICkeParm
o GetSecondLimitValue
public virtual HRESULT GetSecondLimitValue( | double& | oOfs2) = 0 |
-
Gets the second length value. For surface extrude, if limit type is upto, limit's value is not used.
In case of Volume Extrude, if the up-to element is specified, value of Limit will act as offset value from that upto element
- Parameters:
-
- Ofs2
- first length value
o GetSecondUptoElement
public virtual HRESULT GetSecondUptoElement( | CATISpecObject_var& | ohUptoElem2) = 0 |
-
Gets the up-to element used as Limit2.
- Parameters:
-
- ohUptoElem2
- up-to element used to limit extrusion
o InvertOrientation
public virtual HRESULT InvertOrientation( | )=0 |
-
Inverts the orientation of the extrude.
TRUE means that the direction is inverted
o SetContext
-
Sets the context of the extrude.
- Parameters:
-
- iContextType
- CATGSMSurfaceCtxt to generate a surface, CATGSMVolumeCtxt (requires GSO License) to generate a volume
- See also:
- CATGSMFeatureContextType
o SetDir
-
Sets the direction of the extrusion.
- Parameters:
-
- iElem1
- Direction of the extrusion
- See also:
- CATIGSMDirection
o SetFirstLimitType
-
Sets First Limit Type.
- Parameters:
-
- iLim1Type
- Limit Type specified
enum CATGSMFeatureLimitType { CATGSMFeatureLimitType_Unknown = 0,
o SetFirstLimitValue
-
Sets the first length value. For surface extrude, if limit type is upto, limit's value is not used.
In case of Volume Extrude, if the up-to element is specified, value of Limit will act as offset value from that upto element
- Parameters:
-
- iOfs1
- New first length value
- See also:
- CATICkeParm
o SetFirstLimitValue
public virtual HRESULT SetFirstLimitValue( | double | iElem1) = 0 |
-
Sets the first length value. For surface extrude, if limit type is upto, limit's value is not used.
In case of Volume Extrude, if the up-to element is specified, value of Limit will act as offset value from that upto element
- Parameters:
-
- iElem1
- New first length value
o SetFirstUptoElement
public virtual HRESULT SetFirstUptoElement( | const CATISpecObject_var& | ihUptoElem1) = 0 |
-
Sets the up-to element to be used as Limit1.
- Parameters:
-
- ihUptoElem1
- up-to element which is used to limit extrusion
o SetOrientation
-
Sets the orientation of the extrude.
TRUE means that the direction is inverted
- Parameters:
-
- iOrient
- TRUE or FALSE
o SetProfil
-
Sets the element that will be extruded.
- Parameters:
-
- iElem1
- Element to be extruded
o SetSecondLimitType
-
Sets Second Limit Type.
- Parameters:
-
- iLim2Type
- Limit Type specified
enum CATGSMFeatureLimitType { CATGSMFeatureLimitType_Unknown = 0,
o SetSecondLimitValue
-
Sets the second length value. For surface extrude, if limit type is upto, limit's value is not used.
In case of Volume Extrude, if the up-to element is specified, value of Limit will act as offset value from that upto element
- Parameters:
-
- iOfs2
- New second length value
- See also:
- CATICkeParm
o SetSecondLimitValue
public virtual HRESULT SetSecondLimitValue( | double | iElem1) = 0 |
-
Sets the second length value. For surface extrude, if limit type is upto, limit's value is not used.
In case of Volume Extrude, if the up-to element is specified, value of Limit will act as offset value from that upto element
- Parameters:
-
- iElem1
- New second length value
o SetSecondUptoElement
public virtual HRESULT SetSecondUptoElement( | const CATISpecObject_var& | ihUptoElem2) = 0 |
-
Sets the up-to element to be used as Limit2.
- Parameters:
-
- ihUptoElem2
- up-to element which is used to limit extrusion
This object is included in the file: CATIGSMExtrude.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces