CIP C++ documentation for class "wfcWDetailSymbolInstItem"

Class wfcWDetailSymbolInstItem

# include <wfcDetail.h> class wfcWDetailSymbolInstItem : public virtual wfcAnnotation, : public virtual pfcDetailSymbolInstItem { xaideclare(wfcWDetailSymbolInstItem) ... };

Description

Extends the functionality of pfcDetailSymbolInstItem

This is the actual type of Detail SymbolInst Items in Object Toolkit.

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Method Summary


`void`	`AddLeader (pfcAttachment_ptr LeaderAttach)`


`void`	`AddVarText (pfcDetailVariantText_ptr Text)`
	Add variable text to the symbol instance.

`wfcAnnotationPlane_ptr`	`GetAnnotationPlane ()`
	LICENSE: 222

`optional pfcDimension_ptr`	`GetAttachedDimension ()`
	Finds the dimension to which the symbol instance is directly attached.

`pfcDetailEntityInstructions_ptr`	`GetEntityInstructions (pfcDetailEntityItem_ptr Item)`
	LICENSE: 222 Gets data of an entity in the symbol instance.

`optional pfcFeature_ptr`	`GetFeature ()`
	Return the feature that is shown the detail symbol instance.

`pfcDetailNoteInstructions_ptr`	`GetNoteInstructions (pfcDetailNoteItem_ptr Item, pfcDimDisplayMode DispMode)`
	LICENSE: 222 Gets data of a note in the symbol instance.

`void`	`SetAnnotationPlane (wfcAnnotationPlane_ptr AnnotPlane)`
	LICENSE: 222

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

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener

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

Methods Inherited from Class wfcAnnotation:: ShowInDrawing, Display, DisplayInDrawing, Undisplay, UndisplayInDrawing, IsShown, Update, GetTextStyle, SetTextStyle, GetTextStyleInDrawing, SetTextStyleInDrawing, UpdateAttachment, UpdatePosition, IsAssociative, GetAttachmentAssociativity, GetAnnotationElement, IsInactive, Rotate

Methods Inherited from Class pfcDetailItem:: GetDetailType, Delete

Methods Inherited from Class pfcDetailSymbolInstItem:: Draw, Erase, Show, Remove, GetInstructions, Modify, ListGroups

Method Detail

optional pfcDimension_ptr GetAttachedDimension ()

Finds the dimension to which the symbol instance is directly attached.

Manual References:: Drawings: Symbol Instance Data, Drawings: Symbol Instance Data, Technical Summary of Changes for Creo 4.0 F000: Detail Items

Returns:: The dimension to which the symbol instance is directly attached.

void AddLeader (pfcAttachment_ptr LeaderAttach)

Manual References:: Drawings: Symbol Instance Data, Drawings: Symbol Instance Data, Technical Summary of Changes for Creo 4.0 F000: Detail Items

Parameters:

LeaderAttach

Returns:

void AddVarText (pfcDetailVariantText_ptr Text)

Add variable text to the symbol instance.

Manual References:: Drawings: Symbol Instance Data, Drawings: Symbol Instance Data, Technical Summary of Changes for Creo 4.0 F000: Detail Items

Parameters:

Text: The variable text.

Returns:

optional pfcFeature_ptr GetFeature ()

Return the feature that is shown the detail symbol instance.

Manual References:: Drawings: Cross-referencing Weld Symbols and Drawing Annotations, Technical Summary of Changes for Creo 4.0 F000: Detail Items

Returns:: The feature (i.e. weld feature) that produces the symbol.

void SetAnnotationPlane (wfcAnnotationPlane_ptr AnnotPlane)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Creating, Reading and Modifying 3D Symbols, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

AnnotPlane

Returns:

wfcAnnotationPlane_ptr GetAnnotationPlane ()

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Creating, Reading and Modifying 3D Symbols, Annotations: Annotation Features and Annotations: Creating, Reading and Modifying 3D Symbols, Technical Summary of Changes for Creo 4.0 F000: Annotations

Returns:

pfcDetailEntityInstructions_ptr GetEntityInstructions (pfcDetailEntityItem_ptr Item)

LICENSE: 222

Gets data of an entity in the symbol instance.

Manual References:: Drawings: Symbol Instance Data, Technical Summary of Changes for Creo 4.0 F000: Detail Items

Parameters:

Item: The entity attached to symbol instance.

Returns:: The entity data in symbol instance space.

pfcDetailNoteInstructions_ptr GetNoteInstructions (pfcDetailNoteItem_ptr Item, pfcDimDisplayMode DispMode)

LICENSE: 222

Gets data of a note in the symbol instance.

Manual References:: Drawings: Symbol Instance Data, Drawings: Symbol Instance Data, Technical Summary of Changes for Creo 4.0 F000: Detail Items

Parameters:

Item: The pfcDetailNoteItem attached to symbol instance.
DispMode: The display mode.

Returns:: The note data in symbol instance space encapsulated in pfcDetailNoteInstructions_ptr.