CIP C++ documentation for class "wfcAnnotation"

Class wfcAnnotation

# include <wfcAnnotation.h> class wfcAnnotation : public virtual wfcLayerItem, : public virtual wfcWModelItem { xaideclare(wfcAnnotation) ... };

Description

This interface represent various type of annotations such as Dimension,Note,Symbols,SetDatumTag,Surface Finish.

Direct Known Subclasses:: wfcSetDatumTag, wfcSurfaceFinish, wfcGTol, wfcWDimension, wfcWDetailNoteItem, wfcWDetailSymbolInstItem

Method Summary


`void`	`ConvertLegacy ()`
	Converts annotation created before Creo 4.0 or created using deprecated APIs ProGtolCreate or ProSetdatumtagCreate.

`void`	`Display ()`
	Displays annotation which is temporarily undisplayed by `wfcAnnotation::Undisplay()`. This method must be called after making changes in an annotation.

`void`	`DisplayInDrawing (pfcDrawing_ptr DrawingModel, optional pfcView2D_ptr DrawingView, optional pfcComponentPath_ptr CompPath)`
	Displays annotation owned by solid and shown in drawing which is temporarily undisplayed by `wfcAnnotation::Undisplay()`. This method must be called after making changes in an annotation.

`optional wfcAnnotationElement_ptr`	`GetAnnotationElement ()`
	LICENSE: 222

`wfcAnnotationAttachmentAssociativity`	`GetAttachmentAssociativity (pfcDrawing_ptr Drawing)`
	LICENSE: 222

`xbool`	`GetSecurityMarking ()`
	Gets Security Marking option for Notes and Symbols

`optional pfcAnnotationTextStyle_ptr`	`GetTextStyle ()`
	LICENSE: 222 Get textstyle information of annotation.

`optional pfcAnnotationTextStyle_ptr`	`GetTextStyleInDrawing (pfcDrawing_ptr Drawing, optional pfcComponentPath_ptr CompPath, optional pfcView2D_ptr View)`
	LICENSE: 222 Get textstyle information of annotation in specified drawing.

`xbool`	`IsAssociative (pfcDrawing_ptr Drawing)`
	LICENSE: 222

`xbool`	`IsInactive ()`
	LICENSE: 222

`xbool`	`IsShown (optional pfcDrawing_ptr DrawingModel)`
	Checks if annotation is shown in owner or specified drawing.

`xbool`	`IsUsingXSecReference ()`
	Identifies if the annotation is created on or attached to a cross-sectional edge.

`xbool`	`NeedsConversion ()`
	Returns if the annotation is created before Creo 4.0 or is created using deprecated APIs ProGtolCreate or ProSetdatumtagCreate and needs conversion. Call `wfcAnnotation::ConvertLegacy()` only if this API returns true.

`void`	`Rotate (xreal Angle)`
	LICENSE: 222

`void`	`SetSecurityMarking (xbool Marking)`
	Gets Security Marking option for Notes and Symbols

`void`	`SetTextStyle (pfcAnnotationTextStyle_ptr TextStyle)`
	LICENSE: 222 Get textstyle information of annotation.

`void`	`SetTextStyleInDrawing (pfcAnnotationTextStyle_ptr TextStyle, pfcDrawing_ptr Drawing, optional pfcComponentPath_ptr CompPath, optional pfcView2D_ptr View)`
	LICENSE: 222 Set textstyle information of annotation in specified drawing.

`void`	`ShowInDrawing (pfcView2D_ptr DrawingView, optional pfcComponentPath_ptr CompPath)`
	Show annotation owned by solid in a drawing.

`void`	`Undisplay ()`
	Undisplays annotation temporarily. This method must be called before making any changes in an annotation.

`void`	`UndisplayInDrawing (pfcDrawing_ptr DrawingModel, optional pfcComponentPath_ptr CompPath)`
	Undisplays annotation owned by solid and shown in drawing temporarily. This method must be called before making any changes in an annotation.

`void`	`Update (optional pfcDrawing_ptr DrawingModel)`
	Updates the display of the annotation, but does not actually display it anywhere. If the annotation is not currently displayed (because its hidden by layer status or inactive geometry) the text extracted from the annotation with mode pfcDIM_DISPLAY_NUMERIC may include callout symbols instead of the text shown to the user. This method will tell Creo Parametric to update the contents of the annotation to cross-reference these callout values.

`void`	`UpdateAttachment (pfcDrawing_ptr Drawing)`
	LICENSE: 222 Updates the attachment of the drawing annotation and makes it associative to the attachment of the annotation in the 3D model.

`void`	`UpdatePosition (pfcDrawing_ptr Drawing)`
	LICENSE: 222 Updates the position of the drawing annotation and makes it associative to the position of the annotation in the 3D model.

Methods Inherited from Class wfcLayerItem:: IsLayerItemVisible, RemoveNoUpdate, GetLayers, AddNoUpdate

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class wfcWParameterOwner:: ExportParameterTable, ApplyParameterTableset

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class wfcWRelationOwner:: GetRelationConstraints, UnitsUsed, UseUnits, EvaluateExpressionWithUnits

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Methods Inherited from Class wfcWModelItem:: DeleteUserDefinedName, Unhide, Hide, IsHidden, IsNameReadOnly, IsZoneFeature, GetDefaultName

Method Detail

void ShowInDrawing (pfcView2D_ptr DrawingView, optional pfcComponentPath_ptr CompPath)

Show annotation owned by solid in a drawing.

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - The annotation is already shown in the target model.

pfcXToolkitInvalidMatrix - The annotation cannot be shown due to orientation conflicts in the view.

pfcXToolkitNoLicense - License check failure.

pfcXToolkitNotDisplayed - Annotation is present on hidden or blank layer and so can't be shown.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Surface Finish Annotations, Drawings: Ordinate Dimensions

Parameters:

DrawingView: A drawing view where annotation will be shown.
CompPath: Component path for solid owner.

Returns:

void Display ()

Displays annotation which is temporarily undisplayed by wfcAnnotation::Undisplay(). This method must be called after making changes in an annotation.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidMatrix - The annotation cannot be shown due to orientation conflicts in theview.

pfcXToolkitNoLicense - License check failure.

pfcXToolkitNotDisplayed - Annotation is present on hidden or blank layer and so can't be shown.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Annotations

Returns:

void DisplayInDrawing (pfcDrawing_ptr DrawingModel, optional pfcView2D_ptr DrawingView, optional pfcComponentPath_ptr CompPath)

Displays annotation owned by solid and shown in drawing which is temporarily undisplayed by wfcAnnotation::Undisplay(). This method must be called after making changes in an annotation.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidMatrix - The annotation cannot be shown due to orientation conflicts in theview.

pfcXToolkitNoLicense - License check failure.

pfcXToolkitNotDisplayed - Annotation is present on hidden or blank layer and so can't be shown.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Annotations

Parameters:

DrawingModel: Drawing where annotation is shown.
DrawingView: Drawing view where annotation is temporarily displayed. Pass null to toggle in existing view.
CompPath: Component path of solid owner.

Returns:

void Undisplay ()

Undisplays annotation temporarily. This method must be called before making any changes in an annotation.

Exceptions thrown (but not limited to):

pfcXToolkitNoLicense - License check failure.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Annotations

Returns:

void UndisplayInDrawing (pfcDrawing_ptr DrawingModel, optional pfcComponentPath_ptr CompPath)

Undisplays annotation owned by solid and shown in drawing temporarily. This method must be called before making any changes in an annotation.

Exceptions thrown (but not limited to):

pfcXToolkitNoLicense - License check failure.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Annotations

Parameters:

DrawingModel: Drawing view where annotation is shown.
CompPath: Component path of solid owner.

Returns:

xbool IsShown (optional pfcDrawing_ptr DrawingModel)

Checks if annotation is shown in owner or specified drawing.

Exceptions thrown (but not limited to):

pfcXToolkitNoLicense - License check failure.

Parameters:

DrawingModel: Drawing.

Returns:

void Update (optional pfcDrawing_ptr DrawingModel)

Updates the display of the annotation, but does not actually display it anywhere. If the annotation is not currently displayed (because its hidden by layer status or inactive geometry) the text extracted from the annotation with mode pfcDIM_DISPLAY_NUMERIC may include callout symbols instead of the text shown to the user. This method will tell Creo Parametric to update the contents of the annotation to cross-reference these callout values.

This method currently supports '3D model notes' and 'detail notes' only.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Locating and Collecting 3D Symbols and Symbol Definitions, Models: Custom Checks, Interface: Associative Topology Bus Enabled Models and Features, Drawings: Repeat Regions

Parameters:

DrawingModel: The drawing where it is to be displayed. Pass null if the owner of the annotation is the same as the model where it would be displayed.

Returns:

optional pfcAnnotationTextStyle_ptr GetTextStyle ()

LICENSE: 222

Get textstyle information of annotation.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No shown version of annotation was found in the drawing

pfcXToolkitAmbiguous - Multiple shown versions of the annotation were found with different text styles.

Manual References:: Annotations: Annotation Features and Annotations: Annotation Text Styles, Annotations: Annotation Features and Annotations: Annotation Text Styles

Returns:: TextStyle.

void SetTextStyle (pfcAnnotationTextStyle_ptr TextStyle)

LICENSE: 222

Get textstyle information of annotation.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No shown version of annotation was found in the drawing

Manual References:: Annotations: Annotation Features and Annotations: Annotation Text Styles, Annotations: Annotation Features and Annotations: Annotation Text Styles

Parameters:

TextStyle: TextStyle

Returns:

optional pfcAnnotationTextStyle_ptr GetTextStyleInDrawing (pfcDrawing_ptr Drawing, optional pfcComponentPath_ptr CompPath, optional pfcView2D_ptr View)

LICENSE: 222

Get textstyle information of annotation in specified drawing.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No shown version of annotation was found in the drawing

pfcXToolkitAmbiguous - Multiple shown versions of the annotation were found with different text styles.

Manual References:: Annotations: Annotation Features and Annotations: Annotation Text Styles, Annotations: Annotation Features and Annotations: Annotation Text Styles

Parameters:

Drawing: Drawing.
CompPath: Component path of owner solid.
View: Reserved for future expansion. Pass null.

Returns:: TextStyle

void SetTextStyleInDrawing (pfcAnnotationTextStyle_ptr TextStyle, pfcDrawing_ptr Drawing, optional pfcComponentPath_ptr CompPath, optional pfcView2D_ptr View)

LICENSE: 222

Set textstyle information of annotation in specified drawing.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No shown version of annotation was found in the drawing

Manual References:: Annotations: Annotation Features and Annotations: Annotation Text Styles, Annotations: Annotation Features and Annotations: Annotation Text Styles

Parameters:

TextStyle: TextStyle.
Drawing: Drawing.
CompPath: Component path of owner solid.
View: Reserved for future expansion. Pass null.

Returns:

void UpdateAttachment (pfcDrawing_ptr Drawing)

LICENSE: 222

Updates the attachment of the drawing annotation and makes it associative to the attachment of the annotation in the 3D model.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The annotation is not shown in the drawing.

Manual References:: Annotations: Annotation Features and Annotations: Annotation Associativity

Parameters:

Drawing: The drawing

Returns:

void UpdatePosition (pfcDrawing_ptr Drawing)

LICENSE: 222

Updates the position of the drawing annotation and makes it associative to the position of the annotation in the 3D model.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The annotation is not shown in the drawing.

Manual References:: Annotations: Annotation Features and Annotations: Annotation Associativity, Annotations: Annotation Features and Annotations: Annotation Associativity

Parameters:

Drawing: The drawing

Returns:

xbool IsAssociative (pfcDrawing_ptr Drawing)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The annotation is not shown in the drawing.

Manual References:: Annotations: Annotation Features and Annotations: Annotation Associativity, Annotations: Annotation Features and Annotations: Annotation Associativity

Parameters:

Drawing

Returns:

wfcAnnotationAttachmentAssociativity GetAttachmentAssociativity (pfcDrawing_ptr Drawing)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The annotation is not shown in the drawing.

Manual References:: Annotations: Annotation Features and Annotations: Annotation Associativity, Annotations: Annotation Features and Annotations: Annotation Associativity

Parameters:

Drawing

Returns:

optional wfcAnnotationElement_ptr GetAnnotationElement ()

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The annotation is not contained in any annotation element.

pfcXToolkitNotExist - The annotation element owner of the annotation does not exist.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Returns:

xbool IsInactive ()

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitNoLicense - License check failure.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Annotations

Returns:

void Rotate (xreal Angle)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The annotation does not support assigned rotation angles.

pfcXToolkitCantWrite - Could not modify the given item because it has read-only access.

Manual References:: Annotations: Annotation Features and Annotations: Annotation Orientation, Annotations: Annotation Features and Annotations: Annotation Orientation

Parameters:

Angle

Returns:

void ConvertLegacy ()

Converts annotation created before Creo 4.0 or created using deprecated APIs ProGtolCreate or ProSetdatumtagCreate.

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - The annotation is not legacy.

Manual References:: Annotations: Annotation Features and Annotations: Converting Annotations to Latest Version

Returns:

xbool NeedsConversion ()

Returns if the annotation is created before Creo 4.0 or is created using deprecated APIs ProGtolCreate or ProSetdatumtagCreate and needs conversion. Call wfcAnnotation::ConvertLegacy() only if this API returns true.

Manual References:: Annotations: Annotation Features and Annotations: Converting Annotations to Latest Version, Annotations: Annotation Features and Annotations: Converting Annotations to Latest Version

Returns:: TRUE if the annotation needs conversion FALSE if the annotation is already converted

xbool GetSecurityMarking ()

Gets Security Marking option for Notes and Symbols

Manual References:: Annotations: Annotation Features and Annotations: Annotation Security

Returns:: If true then specified annotation is marked for security check

void SetSecurityMarking (xbool Marking)

Gets Security Marking option for Notes and Symbols

Manual References:: Annotations: Annotation Features and Annotations: Annotation Security, Annotations: Annotation Features and Annotations: Annotation Security

Parameters:

Marking: True if the annotation refers a cross-section geometry.

Returns:

xbool IsUsingXSecReference ()

Identifies if the annotation is created on or attached to a cross-sectional edge.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Annotations

Returns:: True if the annotation refers a cross-section geometry.