CIP C++ documentation for class "wfcWDrawing"

Class wfcWDrawing

# include <wfcDrawing.h> class wfcWDrawing : public virtual wfcWModel2D, : public virtual pfcDrawing { xaideclare(wfcWDrawing) ... };

Description

Extends the functionality of pfcDrawing

This is the actual type of in Object Toolkit to represent models of pfcMDL_DRAWING type.

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

Method Summary


`void`	`CleanupDimensions (optional pfcView2D_ptr View)`
	Clean up dimensions for input view or for all views if input view is not supplied.

`pfcDimensions_ptr`	`CreateAutoOrdinateDimensions (pfcSelections_ptr Surfaces, pfcSelection_ptr Baseline)`


`pfcView2D_ptr`	`CreateAuxiliaryView (wfcAuxiliaryViewInstructions_ptr Instructions)`


`pfcView2D_ptr`	`CreateDetailView (wfcDetailViewInstructions_ptr Instructions, pfcPoint3D_ptr Location)`


`pfcView2D_ptr`	`CreateRevolveView (wfcRevolveViewInstructions_ptr Instructions)`


`void`	`EraseAnnotation (wfcAnnotation_ptr Annot)`


`pfcSelection_ptr`	`Get2DAxis (pfcSelection_ptr Axis3DSel, pfcPoint3D_ptr PointOnAxis)`


`pfcSelection_ptr`	`Get3DAxis (pfcSelection_ptr Axis2DSel)`


`pfcPoint3D_ptr`	`Get3DAxisLocation (pfcSelection_ptr Axis2DSel)`


`pfcComponentPath_ptr`	`GetDimensionPath (pfcDimension_ptr Dimension)`


`pfcView2D_ptr`	`GetDrawingView (xint Id)`


`wfcDualDimensionGlobalOptions_ptr`	`GetDualDimensionOptions ()`


`wfcEdgeDisplay_ptr`	`GetEdgeDisplay (pfcSelection_ptr Edge)`


`xint`	`GetFormatSheet (xint SheetNumber)`


`xstring`	`GetSheetName (xint SheetNumber)`


`xbool`	`IsEdgeDisplayGlobal (pfcSelection_ptr Edge)`


`optional wfcSetDatumTags_ptr`	`ListSetDatumTags ()`
	LICENSE: 222 Gets datum tag annotations in a drawing.

`void`	`Merge (pfcDrawing_ptr Drawing)`


`xbool`	`NeedsRegen (optional pfcView2D_ptr View)`


`void`	`SetEdgeDisplay (pfcSelection_ptr Edge, wfcEdgeDisplay_ptr EdgeDisplay)`


`void`	`SetEdgeDisplayGlobal (pfcSelection_ptr Edge, xbool makeGlobal)`


`wfcStatus`	`VisitDrawingModels (wfcVisitingClient_ptr visitingClient)`
	Visits all models in a drawing.

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 pfcModelItemOwner:: GetItemByName, GetItemById, ListItems

Methods Inherited from Class pfcViewOwner:: RetrieveView, GetView, SaveView, GetCurrentViewTransform, SetCurrentViewTransform, CurrentViewRotate, ListViews, GetCurrentView

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcModel:: GetDescr, GetRelationId, GetIsModified, GetVersionStamp, GetRevision, GetVersion, GetBranch, GetReleaseLevel, GetCommonName, SetCommonName, IsCommonNameModifiable, GetFullName, GetInstanceName, GetGenericName, GetType, GetFileName, Backup, Copy, CopyAndRetrieve, Rename, Save, Erase, EraseWithDependencies, Delete, Display, DisplayInNewWindow, ListDependencies, ListDeclaredModels, CreateLayer, Export, Import, AccessExternalData, TerminateExternalData, CheckIsSaveAllowed, CheckIsModifiable, GetOrigin, GetPostRegenerationRelations, SetPostRegenerationRelations, RegeneratePostRegenerationRelations, DeletePostRegenerationRelations, CleanupDependencies, IsNativeModel, ExportIntf3D, SetIntf3DLayerSetupFile, IsIntf3DLayerSetupFileIgnored, IsIntf3DCsysIgnored, ClearIntf3DModelData

Methods Inherited from Class wfcWModel:: VerifyATB, MarkATBModelAsOutOfDate, UpdateATB, RelinkATB, GetAnnotationPlanesFromGallery, GetAnnotationPlanes, GetAnnotationPlaneByName, AddAnnotationPlaneToGallery, RemoveAnnotationPlaneFromGallery, GetActiveAnnotationPlane, GetTIMInfo, ConvertOldXSectionsToNew, CanCreateSectionFeature, ListLayers, SaveLayerDisplayStatus, GetLayerItem, GetSubType, GetDefaultName, IsVariantFeatModel, CreateUnitByExpression, ComputeRayIntersections, CollectParamTablesets, GenerateSelectionsFromCollection, MarkForSaving, RefreshMdlTree, GetMdlfileDescriptor, IsStandardLocation, DesignateSymbol, UndesignateSymbol, IsDesignatedSymbol, VisitItems, VisitDetailItems, CreateSurfaceFinish, CreateGTol, CreateSetDatumTag, MatchLayerRules, CopyLayerRules, ExecuteLayerRules

Methods Inherited from Class pfcSheetOwner:: GetNumberOfSheets, GetCurrentSheetNumber, SetCurrentSheetNumber, AddSheet, ReorderSheet, GetSheetData, GetSheetInfo, GetSheetTransform, RegenerateSheet, DeleteSheet, GetSheetScale, SetSheetScale, GetSheetFormat, SetSheetFormat, GetSheetBackgroundView, GetSheetUnits, GetSheetFormatDescr

Methods Inherited from Class pfcDetailItemOwner:: ListDetailItems, GetDetailItem, CreateDetailItem, CreateFreeNote, CreateOffsetNote, CreateOnItemNote, CreateLeaderNote, RetrieveSymbolDefinition, RetrieveSymbolDefItem, AllowReadonlyNoteSelection

Methods Inherited from Class pfcTableOwner:: ListTables, GetTable, CreateTable, RetrieveTable, RetrieveTableByOrigin, UpdateTables, DeleteTable

Methods Inherited from Class pfcModel2D:: GetTextHeight, SetTextHeight, List2DViews, GetViewByName, GetViewDisplaying, CreateView, SetViewDisplaying, GetCurrentSolid, SetCurrentSolid, ListModels, AddModel, DeleteModel, Regenerate, ReplaceModel, CreateDrawingDimension, ListShownDimensions, CreateDimension, CreateRefDimension, CollectShownDimensions, CollectShownRefDimensions, ListSimplifiedReps, AddSimplifiedRep, DeleteSimplifiedRep

Methods Inherited from Class wfcWModel2D:: SetFormatSize, GetFormatSize, ShowSheetFormat, IsSheetFormatShown, IsSheetFormatBlanked, SetToleranceStandard, GetToleranceStandard, ExpandTree, CollapseTree, RefreshTree, CopyDrawingSheet, GetLocationGridColumnFromPosition, GetLocationGridRowFromPosition, CreateLeaderWithArrowTypeNote

Methods Inherited from Class pfcDrawing:: IsDimensionAssociative, IsDimensionToleranceDisplayed, GetBaselineDimension, GetDimensionSenses, GetDimensionAttachPoints, GetDimensionOrientHint, ConvertOrdinateDimensionToLinear, ConvertLinearDimensionToOrdinate, ConvertLinearDimensionToBaseline, SetDimensionLocation, GetDimensionLocation, GetDimensionView, SwitchDimensionView, IsDimensionShown, EraseDimension

Method Detail

xbool NeedsRegen (optional pfcView2D_ptr View)

Manual References:: Drawings: Listing Drawing Views, Drawings: Listing Drawing Views

Parameters:

View

Returns:

wfcEdgeDisplay_ptr GetEdgeDisplay (pfcSelection_ptr Edge)

Manual References:: Drawings: Drawing Edges, Drawings: Drawing Edges

Parameters:

Edge

Returns:

void SetEdgeDisplay (pfcSelection_ptr Edge, wfcEdgeDisplay_ptr EdgeDisplay)

Manual References:: Drawings: Drawing Edges, Drawings: Drawing Edges

Parameters:

Edge
EdgeDisplay

Returns:

void SetEdgeDisplayGlobal (pfcSelection_ptr Edge, xbool makeGlobal)

Manual References:: Drawings: Drawing Edges

Parameters:

Edge
makeGlobal

Returns:

xbool IsEdgeDisplayGlobal (pfcSelection_ptr Edge)

Manual References:: Drawings: Drawing Edges, Drawings: Drawing Edges

Parameters:

Edge

Returns:

pfcView2D_ptr GetDrawingView (xint Id)

Manual References:: Drawings: Listing Drawing Views, Drawings: Listing Drawing Views

Parameters:

Id

Returns:

void Merge (pfcDrawing_ptr Drawing)

Manual References:: Drawings: Merge Drawings, Drawings: Merge Drawings

Parameters:

Drawing

Returns:

pfcView2D_ptr CreateDetailView (wfcDetailViewInstructions_ptr Instructions, pfcPoint3D_ptr Location)

Manual References:: Drawings: Detailed Views, Drawings: Detailed Views

Parameters:

Instructions
Location

Returns:

pfcView2D_ptr CreateRevolveView (wfcRevolveViewInstructions_ptr Instructions)

Manual References:: Drawings: Revolved Views, Drawings: Revolved Views

Parameters:

Instructions

Returns:

pfcView2D_ptr CreateAuxiliaryView (wfcAuxiliaryViewInstructions_ptr Instructions)

Manual References:: Drawings: Auxiliary Views, Drawings: Auxiliary Views

Parameters:

Instructions

Returns:

pfcDimensions_ptr CreateAutoOrdinateDimensions (pfcSelections_ptr Surfaces, pfcSelection_ptr Baseline)

Manual References:: Annotations: Annotation Features and Annotations: Ordinate Dimensions, Annotations: Annotation Features and Annotations: Ordinate Dimensions

Parameters:

Surfaces
Baseline

Returns:

void CleanupDimensions (optional pfcView2D_ptr View)

Clean up dimensions for input view or for all views if input view is not supplied.

Exceptions thrown (but not limited to):

pfcXToolkitNotDisplayed - Drawing in which dimensions will be cleaned up is not displayed in the current session.

Manual References:: Dimensions and Parameters: Cleaning Up Dimensions

Parameters:

View: View for which dimensions should be cleaned up. If no view is supplied, dimensions in all views will be cleaned up.

Returns:

wfcStatus VisitDrawingModels (wfcVisitingClient_ptr visitingClient)

Visits all models in a drawing.

If ApplyAction of the visiting client returns a value other than TK_NO_ERROR, this method returns.

If ApplyFilter returns TK_CONTINUE, the item is skipped (not passed to ApplyAction).

In C++ Object Toolkit, use wfcStatusToPro and wfcStatusFromPro to convert the returned status to ProError and back.

To facilitate the implementation of the visiting client, a default visiting client class is provided. The application can subclass it and override only those methods which it needs.

In ApplyAction & ApplyFilter of the visiting client, pfcObject pointer must be cast to the correct visiting type as follows:

SOLID - pfcSolid

Casting as other types may lead to unexpected behaviour.

Warning: After this method returns, the visiting client stays alive (that is, will not be subject to memory release), to make its data and its methods available for the application. After the applicatoin finishes using the client, it should call wfcWSession::ReleaseVisitor(wfcVisitingClient_ptr) on it.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No drawing models were found

Manual References:: Drawings: Drawing Models

Parameters:

visitingClient: The visiting client.

Returns:

void EraseAnnotation (wfcAnnotation_ptr Annot)

Exceptions thrown (but not limited to):

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

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

Parameters:

Annot

Returns:

xstring GetSheetName (xint SheetNumber)

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information

Parameters:

SheetNumber

Returns:

xint GetFormatSheet (xint SheetNumber)

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The sheet does not have a format

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information

Parameters:

SheetNumber

Returns:

pfcSelection_ptr Get3DAxis (pfcSelection_ptr Axis2DSel)

Parameters:

Axis2DSel

Returns:

pfcPoint3D_ptr Get3DAxisLocation (pfcSelection_ptr Axis2DSel)

Parameters:

Axis2DSel

Returns:

pfcSelection_ptr Get2DAxis (pfcSelection_ptr Axis3DSel, pfcPoint3D_ptr PointOnAxis)

Parameters:

Axis3DSel
PointOnAxis

Returns:

pfcComponentPath_ptr GetDimensionPath (pfcDimension_ptr Dimension)

Exceptions thrown (but not limited to):

pfcXToolkitNotDisplayed - The dimension is not displayed in the drawing.

Exceptions thrown (but not limited to):

pfcXToolkitNotDisplayed - The dimension is not displayed in the drawing.

Manual References:: Drawings: Drawing Dimensions Information, Drawings: Drawing Dimensions Information

Parameters:

Dimension

Returns:

wfcDualDimensionGlobalOptions_ptr GetDualDimensionOptions ()

Manual References:: Drawings: Drawing Dimensions Information, Drawings: Drawing Dimensions Information

Returns:

optional wfcSetDatumTags_ptr ListSetDatumTags ()

LICENSE: 222

Gets datum tag annotations in a drawing.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Returns:: Returns wfcSetDatumTags_ptr