All Frameworks Class Hierarchy This Framework Indexes Previous Next

DraftingUseItf Interface CATIDrwCalloutAccess

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

interface CATIDrwCalloutAccess

Interface to manage callout

Callout represents an operation that has been performed on a generative view (such as a section cut for example).
Callout is associated to the following view type: Section view, section cut, detail view, auxiliary view and break view. This interface manages main characteristics of callout. CATIVisProperties interface may be used to manage the whole visualization properties of callout.

See also:: , ,

Method Index

o GetArrowsAttachment(CATDftArrowExtremity&): Returns attachment of callout arrows.
o GetArrowsPosition(int&): Returns the Position of Callout Arrows.
o GetArrowsThickness(int,int&): Returns the thickness of Callout Arrows.
o GetAssociatedView(CATIDftView**): Returns the associated view to callout.
o GetCalloutText(int,CATIDftText**): Returns text.
o GetCalloutType(CATDrwCalloutType&): Returns the type of callout.
o GetCornerLength(double&): Returns the length of corner.
o GetCornerLineType(int&): Returns the line type of corner.
o GetCornerThickness(int&): Returns the thickness of corner.
o GetInfoOfArrow(int,double*,double&,double&,CATSymbolType&,double&,double&): Returns informations of one arrow.
o GetNumberOfArrow(int&): Returns the number of arrows.
o GetNumberOfTexts(int&): Returns the number of texts.
o GetProfileLineType(int&): Returns the line type of profile.
o GetProfileThickness(int&): Returns the thickness of profile.
o GetVisibility(int&): Returns the visibility of the profile.
o SetArrowsAttachment(CATDftArrowExtremity): Sets attachment of callout arrows.
o SetArrowsPosition(int): Sets the Position of Callout Arrows.
o SetArrowsThickness(int,int): Sets the thickness of Callout Arrows.
o SetCornerLength(double): Sets the length of corner.
o SetCornerLineType(int): Sets the line type of corner.
o SetCornerThickness(int): Sets the thickness of corner.
o SetInfoOfArrow(int,double,CATSymbolType,double,double): Sets informations of one arrow.
o SetProfileLineType(int): Sets the line type of profile.
o SetProfileThickness(int): Sets the thickness of profile.
o SetVisibility(int): Sets the visibility of the profile.

o CATDrwCalloutType: Kind of callout.

Methods

o GetArrowsAttachment

public virtual GetArrowsAttachment( oAttachmentType)

Returns attachment of callout arrows. Role: Returns attachment of callout arrows.

Parameters:

oAttachmentType: Attachment type.

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior or no attachment notion available for this callout.

o GetArrowsPosition

public virtual GetArrowsPosition( oArrowPosition)

Returns the Position of Callout Arrows. Role: Returns the Position of Callout Arrows.

Parameters:

oArrowPosition: Position value.
Legal values: 0 = Start Position. 50 = Middle Position.

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior.

o GetArrowsThickness

public virtual GetArrowsThickness(	const	`iNumArrow`,
		`oArrowThickness`)

Returns the thickness of Callout Arrows. Role: Returns the thickness of Callout Arrows.

Parameters:

iNumArrow: Number of arrow.
oArrowThickness: Thickness value [1 to 8].

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior.

o GetAssociatedView

public virtual GetAssociatedView( oAssociatedView)

Returns the associated view to callout. Role: Returns the view defined by the callout.
Postcondition: Don't forget to RELEASE the resulting oAssociatedView after use.

Parameters:

oAssociatedView: [out, CATBaseUnknown#Release] View defined by the callout.

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior or no view found or view doesn' exist for this type of callout.

o GetCalloutText

public virtual GetCalloutText(	const	`iNumText`,
		`oText`)

Returns text. Role: Returns text objet defined by iNumText.
Postcondition: Don't forget to RELEASE the resulting oText after use.

Parameters:

iNumText: Number of text: Start to 1 to Number of texts returned by GetNumberOfTexts method.
oText: [out, CATBaseUnknown#Release] Text instance.

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior.
E_INVALIDARG: Wrong number of texts.

o GetCalloutType

public virtual GetCalloutType( oCalloutType)

Returns the type of callout. Role: Returns the type of callout.

Parameters:

oCalloutType: Type of the callout.

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior.

o GetCornerLength

public virtual GetCornerLength( oLengthCorner)

Returns the length of corner. Role: Returns the length of corner defined the callout.

Parameters:

oLengthCorner: length value.

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior or Corner doesn't exist for this type of callout

o GetCornerLineType

public virtual GetCornerLineType( oLineType)

Returns the line type of corner. Role: Returns the line type of corner defined the callout.

Parameters:

oLineType: line type value [1 to 63].

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior or Corner doesn't exist for this type of callout.

o GetCornerThickness

public virtual GetCornerThickness( oThickness)

Returns the thickness of corner. Role: Returns the thickness of corner defined the callout.

Parameters:

oThickness: Thickness value [1 to 55].

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior or Corner doesn't exist for this type of callout.

o GetInfoOfArrow

public virtual GetInfoOfArrow(	const	`iNumArrow`,
		`oHeadPosition`,
		`oOrientation`,
		`oLength`,
		`oTypeSymb`,
		`oLengthSymb`,
		`oAngleSymb`)

Returns informations of one arrow. Role: Returns informations of arrow defined by iNumArrow.

Parameters:

iNumArrow: Number of arrow.
oHeadPostion: Head of arrow coordinates.
oOrientation: Arrow orientation.
oLength: Length of the arrow.
oTypeSymb: Type of extremity symbol.

See also:

oLengthSymb

Length of extremity symbol.

oAngleSymb

Angle extremity symbol.

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior.
E_INVALIDARG: Wrong number of arrows.

o GetNumberOfArrow

public virtual GetNumberOfArrow( oNbOfArrows)

Returns the number of arrows. Role: Returns the number of arrows available for this callout.

Parameters:

oNbOfArrows: Number of arrows.

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior.

o GetNumberOfTexts

public virtual GetNumberOfTexts( oNbOfTexts)

Returns the number of texts. Role: Returns the number of texts available for this callout.

Parameters:

oNbOfTexts: Number of texts available for this callout.

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior.

o GetProfileLineType

public virtual GetProfileLineType( oLineType)

Returns the line type of profile. Role: Returns the line type of profile defining the callout.

Parameters:

oLineType: line type value [1 to 63].

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior.

o GetProfileThickness

public virtual GetProfileThickness( oThickness)

Returns the thickness of profile. Role: Returns the thickness of profile defining the callout.

Parameters:

oThickness: Thickness value [1 to 55].

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior.

o GetVisibility

public virtual GetVisibility( oVisibility)

Returns the visibility of the profile. Role: Returns the visibility of the profile.

Parameters:

oVisibility: visibility value.
Legal values: 1 = Callout is completely drawn. 2 = Callout is partially drawn. 3 = Callout is minimal.

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior or Visibility doesn't exist for this type of callout.

o SetArrowsAttachment

public virtual SetArrowsAttachment( const iAttachmentType)

Sets attachment of callout arrows. Role: Sets attachment of callout arrows.

Parameters:

iAttachmentType: Attachment type.

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior or no attachment notion available for this callout.

o SetArrowsPosition

public virtual SetArrowsPosition( const iArrowPosition)

Sets the Position of Callout Arrows. Role: Sets the Position of Callout Arrows.

Parameters:

iArrowPosition: Position value.
Legal values: 0 = Start Position. 50 = Middle Position.

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior.

o SetArrowsThickness

public virtual SetArrowsThickness(	const	`iNumArrow`,
	const	`iArrowThickness`)

Sets the thickness of Callout Arrows. Role: Sets the thickness of Callout Arrows.

Parameters:

iNumArrow: Number of arrow.
iArrowThickness: Thickness value [1 to 8].

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior.

o SetCornerLength

public virtual SetCornerLength( const iLengthCorner)

Sets the length of corner. Role: Sets the length of corner defined the callout.

Parameters:

iLengthCorner: length value.

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior or Corner doesn't exist for this type of callout

o SetCornerLineType

public virtual SetCornerLineType( const iLineType)

Sets the line type of corner. Role: Sets the line type of corner defined the callout.

Parameters:

iLineType: line type value [1 to 63].

Returns:

HRESULT

S_OK: Method correctly executed.
E_INVALIDARG: Wrong line type value.
E_FAIL: Abnormal behavior or Corner doesn't exist for this type of callout.

o SetCornerThickness

public virtual SetCornerThickness( const iThickness)

Sets the thickness of corner. Role: Sets the thickness of corner defined the callout.

Parameters:

iThickness: Thickness value [1 to 55].

Returns:

HRESULT

S_OK: Method correctly executed.
E_INVALIDARG: Wrong thickness value.
E_FAIL: Abnormal behavior or Corner doesn't exist for this type of callout.

o SetInfoOfArrow

public virtual SetInfoOfArrow(	const	`iNumArrow`,
	const	`iLength`,
	const	`iTypeSymb`,
	const	`iLengthSymb`,
	const	`iAngleSymb`)

Sets informations of one arrow. Role: Sets informations of arrow defined by iNumArrow.

Parameters:

iNumArrow: Number of arrow.
oLength: Length of the arrow.
oTypeSymb: Type of extremity symbol.
Legal values : - FILLED_ARROW - BLANKED_ARROW - UNFILLED_ARROW - OPEN_ARROW

See also:

oLengthSymb

Length of extremity symbol.

oAngleSymb

Angle extremity symbol.

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior.
E_INVALIDARG: Wrong number of arrows.

o SetProfileLineType

public virtual SetProfileLineType( const iLineType)

Sets the line type of profile. Role: Sets the line type of profile defining the callout.

Parameters:

iLineType: line type value [1 to 63].

Returns:

HRESULT

S_OK: Method correctly executed.
E_INVALIDARG: Wrong line type value.
E_FAIL: Abnormal behavior.

o SetProfileThickness

public virtual SetProfileThickness( const iThickness)

Sets the thickness of profile. Role: Sets the thickness of profile defining the callout.

Parameters:

iThickness: Thickness value [1 to 55].

Returns:

HRESULT

S_OK: Method correctly executed.
E_INVALIDARG: Wrong thickness value.
E_FAIL: Abnormal behavior.

o SetVisibility

public virtual SetVisibility( const iVisibility)

Sets the visibility of the profile. Role: Sets the visibility of the profile.

Parameters:

iVisibility: visibility value.
Legal values: 1 = Callout is completely drawn. 2 = Callout is partially drawn. 3 = Callout is minimal.

Returns:

HRESULT

S_OK: Method correctly executed.
E_FAIL: Abnormal behavior or Visibility doesn't exist for this type of callout.

Enumerated Types

o CATDrwCalloutType

enum CATDrwCalloutType {
  SectionCallout,
  BreakCallout,
  DetailCallout,
  ProjectionCallout
}

Kind of callout.

Parameters:

SectionCallout: Callout defining section view or section cut.
BreakCallout: Callout defining break view.
DetailCallout: Callout defining Detail view.
ProjectionCallout: Callout defining auxiliary view.

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

DraftingUseItf Interface CATIDrwCalloutAccess

Method Index

Enumerated Type Index

Methods

Enumerated Types