All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDrwDimFrame

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

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


interface CATIDrwDimFrame

Manages the dimension frame.


Method Index


o GetFramedElement()
Gets the framed element for main value.
o GetFramedGroup()
Gets the framed Group.
o GetGap()
Gets gap.
o GetType()
Gets frame type.
o SetFramedElement(int)
Sets the framed element for main value.
o SetFramedGroup(int)
Sets the framed group for dual value.
o SetGap(double)
Sets gap.
o SetType(int)
Sets frame type.

Methods


o GetFramedElement
public virtual int GetFramedElement()const = 0
Gets the framed element for main value.
Returns:
Framed element for main value (see define definition file).
Framed element legal values are:
CATDrwDimFraValue
the framing mode is applied to the value only.
CATDrwDimFraValTol
the framing mode is applied to the value and the tolerance.
CATDrwDimFraValTolText
the framing mode is applied to the value, the tolerance and the text.
o GetFramedGroup
public virtual int GetFramedGroup()const = 0
Gets the framed Group.
Returns:
Framed group (see define definition file).
Framed group legal values are:
CATDrwDimFraMain
The framing mode is applied to the main value only.
CATDrwDimFraDual
The framing mode is applied to the dual value only.
CATDrwDimFraMainAndDual
The framing mode is applied to the main and dual values (2 frames).
CATDrwDimFraBoth
The framing mode is applied globally to the main and dual values (1 frames).
o GetGap
public virtual double GetGap()const = 0
Gets gap.
Returns:
Gap value.
o GetType
public virtual int GetType()const = 0
Gets frame type.
Returns:
Frame type.
Legal values are (see define definition file):
CATDrwDimFraNone
None.
CATDrwDimFraCircle
Circle.
CATDrwDimFraScoredCircle
Scored circle.
CATDrwDimFraDiamondShaped
Diamond shape.
CATDrwDimFraSquare
Square.
CATDrwDimFraRectangle
Rectangle.
CATDrwDimFraOblong
Oblong.
CATDrwDimFraRightFlag
Right flag.
CATDrwDimFraTriangle
Triangle.
o SetFramedElement
public virtual void SetFramedElement( const int iFramedElement)= 0
Sets the framed element for main value.
Parameters:
iFramedElement
Framed element for main value (see define definition file).
Framed element legal values are:
CATDrwDimFraValue
the framing mode is applied to the value only.
CATDrwDimFraValTol
the framing mode is applied to the value and the tolerance.
CATDrwDimFraValTolText
the framing mode is applied to the value, the tolerance and the text.
o SetFramedGroup
public virtual void SetFramedGroup( const int iFramedGroup)= 0
Sets the framed group for dual value.
Parameters:
iFramedGroup
Framed group for dual value (see define definition file).
Framed group legal values are:
CATDrwDimFraMain
the framing mode is applied to the main value only.
CATDrwDimFraDual
the framing mode is applied to the dual value only.
CATDrwDimFraMainAndDual
the framing mode is applied to the main and dual values.
CATDrwDimFraBoth
the framing mode is applied globally to the main and dual values.
o SetGap
public virtual void SetGap( const double gap) = 0
Sets gap.
Parameters:
gap
Gap value.
o SetType
public virtual void SetType( const int iType)= 0
Sets frame type.
Parameters:
iType
Frame type.
Legal values are (see define definition file):
CATDrwDimFraNone
None.
CATDrwDimFraCircle
Circle.
CATDrwDimFraScoredCircle
Scored circle.
CATDrwDimFraDiamondShaped
Diamond shape.
CATDrwDimFraSquare
Square.
CATDrwDimFraRectangle
Rectangle.
CATDrwDimFraOblong
Oblong.
CATDrwDimFraRightFlag
Right flag.
CATDrwDimFraTriangle
Triangle.

This object is included in the file: CATIDrwDimFrame.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces

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