CATGSMUseItf Interface CATIGSMUseMaskFactory
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMUseMaskFactory
Factory for mask objects.
Role : allows to create/get mask set and to create masks in Part.
Method Index
- o
CreateMaskDim(CATIMmiMechanicalFeature_var&,CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATIMmiMechanicalFeature_var&)
- Create Mask which is type "Position & Dimension".
- o
CreateMaskDim(CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATIMmiMechanicalFeature_var&)
- Create Mask which is type "Position & Dimension".
- o
CreateMaskPos(CATIMmiMechanicalFeature_var&,CATIMmiMechanicalFeature_var&,CATIMmiMechanicalFeature_var&)
- Create Mask which is type "2Position"
- o
CreateMaskPos(CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATIMmiMechanicalFeature_var&)
- Create Mask which is type "2Position".
- o
RetrieveMaskSet(int)
- Retrieve or create mask set.
Methods
o CreateMaskDim
| public virtual CreateMaskDim( | const | iOrigin, |
| const | iX, |
| const | iY, |
| const | iZ, |
| const | iAxisSystem | = NULL_var) |
-
Create Mask which is type "Position & Dimension".
- Parameters:
-
- iOrigin
- Center point of mask
- iX
- Mask size of x direction (Length).
- iY
- Mask size of y direction (Width).
- iZ
- Mask size of z direction (Hight).
- Returns:
- The created mask, NULL_var otherwise
o CreateMaskDim
| public virtual CreateMaskDim( | const | iOriginX, |
| const | iOriginY, |
| const | iOriginZ, |
| const | iX, |
| const | iY, |
| const | iZ, |
| const | iAxisSystem | = NULL_var) |
-
Create Mask which is type "Position & Dimension".
- Parameters:
-
- iOriginX
- X coordinate of the origin
- iOriginY
- Y coordinate of the origin
- iOriginZ
- Z coordinate of the origin
- iX
- Mask size of x direction (Length).
- iY
- Mask size of y direction (Width).
- iZ
- Mask size of z direction (Hight).
- Returns:
- The created mask, NULL_var otherwise
o CreateMaskPos
| public virtual CreateMaskPos( | const | iPoint1 | = NULL_var, |
| const | iPoint2 | = NULL_var, |
| const | iAxisSystem | = NULL_var) |
-
Create Mask which is type "2Position"
- Parameters:
-
- iPoint1
- First point
- iPoint2
- Second point
- iAxisSystem
- Axis system. NULL_var : Global axis system
- Returns:
- The created mask, NULL_var otherwise
o CreateMaskPos
| public virtual CreateMaskPos( | const | iPnt1X, |
| const | iPnt1Y, |
| const | iPnt1Z, |
| const | iPnt2X, |
| const | iPnt2Y, |
| const | iPnt2Z, |
| const | iAxisSystem | = NULL_var) |
-
Create Mask which is type "2Position".
- Parameters:
-
- iPnt1X
- X coordinate of the first point
- iPnt1Y
- Y coordinate of the first point
- iPnt1Z
- Z coordinate of the first point
- iPnt2X
- X coordinate of the first point
- iPnt2Y
- Y coordinate of the first point
- iPnt2Z
- Z coordinate of the first point
- iAxisSystem
- Axis system. NULL_var : Global axis system
- Returns:
- The created mask, NULL_var otherwise
o RetrieveMaskSet
| public virtual RetrieveMaskSet( | const | iWithCreation | = 0 ) |
-
Retrieve or create mask set.
- Parameters:
-
- iWithCreation
- Tells if the set has to be created when it does not exist
Note: Only one mask set is created by Part document
- Returns:
- The mask set when it exists or has been created, NULL_var otherwise
This object is included in the file: CATIGSMUseMaskFactory.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.