All Frameworks Class Hierarchy This Framework Previous Next Indexes
GSMInterfaces Interface CATIGSMMask
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIGSMMask
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMMask
Mask feature.
Role : allows to manipulate the masks of the model
Method Index
- o
GetAxis(CATISpecObject_var&)
- Gets axis system.
- o
GetDatumMode(int&)
- Gets datum mode for mask .
- o
GetMaskType(CATGSMMaskType&)
- Gets type of the mask.
- o
GetOrigin(CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&)
- Gets Origin by coordinate.
- o
GetOrigin(CATISpecObject_var&)
- Gets Origin by object.
- o
GetRefPoint1(CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&)
- Gets Point1 by coordinate.
- o
GetRefPoint1(CATISpecObject_var&)
- Gets Point1 by object.
- o
GetRefPoint2(CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&)
- Gets Point2 by coordinate.
- o
GetRefPoint2(CATISpecObject_var&)
- Gets Point2 by object.
- o
GetSize(CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&)
- Gets mask size.
- o
SetAxis(CATISpecObject_var&)
- Sets axis system.
- o
SetDatumMode(int)
- Sets datum mode for mask .
- o
SetMaskType(CATGSMMaskType)
- Sets type of the mask.
- o
SetOrigin(CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&)
- Sets Origin by coordinate.
- o
SetOrigin(CATISpecObject_var&)
- Sets Origin by object.
- o
SetRefPoint1(CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&)
- Sets Point1 by coordinate.
- o
SetRefPoint1(CATISpecObject_var&)
- Sets Point1 by object.
- o
SetRefPoint2(CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&)
- Sets Point2 by coordinate.
- o
SetRefPoint2(CATISpecObject_var&)
- Sets Point2 by object.
- o
SetSize(CATICkeParm_var&,CATICkeParm_var&,CATICkeParm_var&)
- Sets mask size.
Methods
o GetAxis
public virtual HRESULT GetAxis( | CATISpecObject_var& | oAxisSystem) = 0 |
-
Gets axis system.
- Parameters:
-
- oAxisSystem
- Axis system.
o GetDatumMode
public virtual HRESULT GetDatumMode( | int& | oMode) = 0 |
-
Gets datum mode for mask .
- Parameters:
-
- oMode
- Datum mode 1: ON 0: OFF
o GetMaskType
-
Gets type of the mask.
- Parameters:
-
- oMaskType
- Type of the mask.
o GetOrigin
public virtual HRESULT GetOrigin( | CATICkeParm_var& | oX, |
| CATICkeParm_var& | oY, |
| CATICkeParm_var& | oZ) = 0 |
-
Gets Origin by coordinate.
- Parameters:
-
- oX
- X coordinate of origin of mask box.
- oY
- Y coordinate of origin of mask box.
- oZ
- Z coordinate of origin of mask box.
o GetOrigin
public virtual HRESULT GetOrigin( | CATISpecObject_var& | oOrigin) = 0 |
-
Gets Origin by object.
- Parameters:
-
- oOrigin
- Origin of mask box.
o GetRefPoint1
public virtual HRESULT GetRefPoint1( | CATICkeParm_var& | oX, |
| CATICkeParm_var& | oY, |
| CATICkeParm_var& | oZ) = 0 |
-
Gets Point1 by coordinate.
- Parameters:
-
- oX
- X coordinate of Point1.
- oY
- Y coordinate of Point1.
- oZ
- Z coordinate of Point1.
o GetRefPoint1
public virtual HRESULT GetRefPoint1( | CATISpecObject_var& | oPoint1) = 0 |
-
Gets Point1 by object.
- Parameters:
-
- oPoint1
- Point1.
o GetRefPoint2
public virtual HRESULT GetRefPoint2( | CATICkeParm_var& | oX, |
| CATICkeParm_var& | oY, |
| CATICkeParm_var& | oZ) = 0 |
-
Gets Point2 by coordinate.
- Parameters:
-
- oX
- X coordinate of Point2.
- oY
- Y coordinate of Point2.
- oZ
- Z coordinate of Point2.
o GetRefPoint2
public virtual HRESULT GetRefPoint2( | CATISpecObject_var& | oPoint2) = 0 |
-
Gets Point2 by object.
- Parameters:
-
- oPoint2
- Point2.
o GetSize
public virtual HRESULT GetSize( | CATICkeParm_var& | oX, |
| CATICkeParm_var& | oY, |
| CATICkeParm_var& | oZ) = 0 |
-
Gets mask size.
- Parameters:
-
- oX
- Size of x direction (Length).
- oY
- Size of y direction (Width).
- oZ
- Size of z direction (Hight).
o SetAxis
public virtual HRESULT SetAxis( | const CATISpecObject_var& | iAxisSystem) = 0 |
-
Sets axis system.
- Parameters:
-
- iAxisSystem
- Axis system.
o SetDatumMode
public virtual HRESULT SetDatumMode( | const int | iMode) = 0 |
-
Sets datum mode for mask .
- Parameters:
-
- iMode
- Datum mode 1: ON 0: OFF
o SetMaskType
-
Sets type of the mask.
- Parameters:
-
- iMaskType
- Type of the mask.
o SetOrigin
public virtual HRESULT SetOrigin( | const CATICkeParm_var& | iX, |
| const CATICkeParm_var& | iY, |
| const CATICkeParm_var& | iZ) = 0 |
-
Sets Origin by coordinate.
- Parameters:
-
- iX
- X coordinate of origin of mask box.
- iY
- Y coordinate of origin of mask box.
- iZ
- Z coordinate of origin of mask box.
o SetOrigin
public virtual HRESULT SetOrigin( | const CATISpecObject_var& | iOrigin) = 0 |
-
Sets Origin by object.
- Parameters:
-
- iOrigin
- Origin of mask box.
o SetRefPoint1
public virtual HRESULT SetRefPoint1( | const CATICkeParm_var& | iX, |
| const CATICkeParm_var& | iY, |
| const CATICkeParm_var& | iZ) = 0 |
-
Sets Point1 by coordinate.
- Parameters:
-
- iX
- X coordinate of Point1.
- iY
- Y coordinate of Point1.
- iZ
- Z coordinate of Point1.
o SetRefPoint1
public virtual HRESULT SetRefPoint1( | const CATISpecObject_var& | iPoint1) = 0 |
-
Sets Point1 by object.
- Parameters:
-
- iPoint1
- Point1.
o SetRefPoint2
public virtual HRESULT SetRefPoint2( | const CATICkeParm_var& | iX, |
| const CATICkeParm_var& | iY, |
| const CATICkeParm_var& | iZ) = 0 |
-
Sets Point2 by coordinate.
- Parameters:
-
- iX
- X coordinate of Point2.
- iY
- Y coordinate of Point2.
- iZ
- Z coordinate of Point2.
o SetRefPoint2
public virtual HRESULT SetRefPoint2( | const CATISpecObject_var& | iPoint2) = 0 |
-
Sets Point2 by object.
- Parameters:
-
- iPoint2
- Point2.
o SetSize
public virtual HRESULT SetSize( | const CATICkeParm_var& | iX, |
| const CATICkeParm_var& | iY, |
| const CATICkeParm_var& | iZ) = 0 |
-
Sets mask size.
- Parameters:
-
- iX
- Size of x direction (Length).
- iY
- Size of y direction (Width).
- iZ
- Size of z direction (Hight).
This object is included in the file: CATIGSMMask.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces