CATPartUseItf Interface CATIPdgUseOffset
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPdgUseOffset
Interface to represent the offset feature.
Role: The offset feature allows users to create a thick surface
above a surfacic feature.
The result of the operation is a mechanical feature.
Method Index
- o
GetBotOffset()
- Returns the distance between the bottom skin of the offset feature
and the surfacic feature.
- o
GetIsensOffset()
- Retrieves the offset orientation value of the offset feature.
- o
GetRegularizationType(CATPrtOffsetRegularisationType&)
- Gets the regularization type
- o
GetSurfaceOffset()
- Retrieves the surfacic feature to be offseted.
- o
GetTopOffset()
- Returns the distance between the top skin of the offset feature
and the surfacic feature.
- o
ModifyBotOffset(double)
- Modifies the distance between the bottom skin of the offset feature
and the surfacic feature.
- o
ModifyTopOffset(double)
- Modifies the distance between the top skin of the offset feature
and the surfacic feature.
- o
ReverseOffdir()
- Invert the offset orientation.
- o
SetRegularizationType(CATPrtOffsetRegularisationType&)
- Sets the regularization type
- o
SwapSurface(CATBaseUnknown_var)
- Sets or swaps the surfacic feature to be offseted.
Methods
o GetBotOffset
| public virtual GetBotOffset( | ) |
-
Returns the distance between the bottom skin of the offset feature
and the surfacic feature.
- Returns:
- the bottom skin distance
o GetIsensOffset
| public virtual GetIsensOffset( | ) |
-
Retrieves the offset orientation value of the offset feature.
- Returns:
- the offset orientation value
Legal values: if it equals NormalSide (=0) then
the offset direction is the same as the normal vector of the surfacic
feature.
If it equals InverseNormalSide (=1) then the offset direction is
the opposite of the normal vector of the surfacic feature.
o GetRegularizationType
| public virtual GetRegularizationType( | | oRegul) |
-
Gets the regularization type
- Parameters:
-
- oRegul
- CATPrtRegularization_Undefined if the regularization is not defined
CATPrtRegularization_Local if the regularization is local
CATPrtRegularization_Global if the regularization is global
o GetSurfaceOffset
| public virtual GetSurfaceOffset( | ) |
-
Retrieves the surfacic feature to be offseted.
- Returns:
- the surfacic feature
Legal values: CATISpecObject_var if
the surfacic feature exists
or
NULL_var if it does not.
o GetTopOffset
| public virtual GetTopOffset( | ) |
-
Returns the distance between the top skin of the offset feature
and the surfacic feature.
- Returns:
- the top skin distance
o ModifyBotOffset
| public virtual ModifyBotOffset( | | iBotOffset) |
-
Modifies the distance between the bottom skin of the offset feature
and the surfacic feature.
- Parameters:
-
- iBotOffset
- The distance between the surfacic feature and the bottom
skin of the offset feature.
o ModifyTopOffset
| public virtual ModifyTopOffset( | | iTopOffset) |
-
Modifies the distance between the top skin of the offset feature
and the surfacic feature.
- Parameters:
-
- iTopOffset
- The distance between the surfacic feature and the top
skin of the offset feature.
o ReverseOffdir
| public virtual ReverseOffdir( | ) |
-
Invert the offset orientation.
Legal values: if it equals NormalSide (=0) then
the offset direction becomes InverseNormalSide.
If it equals InverseNormalSide (=1) then the offset direction
becomes InverseNormalSide.
o SetRegularizationType
| public virtual SetRegularizationType( | const | iRegul) |
-
Sets the regularization type
- Parameters:
-
- oRegul
- CATPrtRegularization_Undefined if the regularization is not defined
CATPrtRegularization_Local if the regularization is local
CATPrtRegularization_Global if the regularization is global
o SwapSurface
| public virtual SwapSurface( | const | ihSurface_input) |
-
Sets or swaps the surfacic feature to be offseted.
- Parameters:
-
- ihSurface
- The surfacic feature to be offseted.
This object is included in the file: CATIPdgUseOffset.h
If needed, your Imakefile.mk should include the module: CATPartUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.