All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMMaskFactory

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

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


interface CATIGSMMaskFactory

Factory for mask objects.
Role : allows to create/get mask set and to create masks in Part.


Method Index


o CreateMaskDim(CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATISpecObject_var&)
Create Mask which is type "Position & Dimension".
o CreateMaskDim(CATISpecObject_var&,CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATISpecObject_var&)
Create Mask which is type "Position & Dimension".
o CreateMaskPos(CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&,CATISpecObject_var&)
Create Mask which is type "2Position".
o CreateMaskPos(CATISpecObject_var&,CATISpecObject_var&,CATISpecObject_var&)
Create Mask which is type "2Position"
o RetrieveMaskSet(int)
Retrieve or create mask set.

Methods


o CreateMaskDim
public virtual CATIGSMMask_var CreateMaskDim( const CATICkeParm_var& iOriginX,
const CATICkeParm_var& iOriginY,
const CATICkeParm_var& iOriginZ,
const CATICkeParm_var& iX,
const CATICkeParm_var& iY,
const CATICkeParm_var& iZ,
const CATISpecObject_var& iAxisSystem= NULL_var) = 0
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 CreateMaskDim
public virtual CATIGSMMask_var CreateMaskDim( const CATISpecObject_var& iOrigin,
const CATICkeParm_var& iX,
const CATICkeParm_var& iY,
const CATICkeParm_var& iZ,
const CATISpecObject_var& iAxisSystem= NULL_var) = 0
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 CreateMaskPos
public virtual CATIGSMMask_var CreateMaskPos( const CATICkeParm_var& iPnt1X,
const CATICkeParm_var& iPnt1Y,
const CATICkeParm_var& iPnt1Z,
const CATICkeParm_var& iPnt2X,
const CATICkeParm_var& iPnt2Y,
const CATICkeParm_var& iPnt2Z,
const CATISpecObject_var& iAxisSystem= NULL_var) = 0
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 CreateMaskPos
public virtual CATIGSMMask_var CreateMaskPos( const CATISpecObject_var& iPoint1= NULL_var,
const CATISpecObject_var& iPoint2= NULL_var,
const CATISpecObject_var& iAxisSystem= NULL_var) = 0
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 RetrieveMaskSet
public virtual CATIGSMMaskSet_var RetrieveMaskSet( const int iWithCreation= 0 )= 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: CATIGSMMaskFactory.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces

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