CIP C++ documentation for class "wfcWModel2D"

Class wfcWModel2D

# include <wfcModel.h> class wfcWModel2D : public virtual wfcWModel, : public virtual pfcModel2D { xaideclare(wfcWModel2D) ... };

Description

Direct Known Subclasses:: wfcWReport, wfcWLayout, wfcWDrawing

Method Summary


`void`	`CollapseTree (xint WindowId)`
	Collapse the tree for the drawing.

`xint`	`CopyDrawingSheet (xint Sheet)`
	Create a copy of a drawing sheet.

`pfcDetailNoteItem_ptr`	`CreateLeaderWithArrowTypeNote (pfcDetailTextLines_ptr TextLines, pfcAttachment_ptr NoteAttach, pfcDetailLeaderAttachments_ptr LeaderAttachs, wfcLeaderArrowTypes_ptr Types)`
	LICENSE: 222

`void`	`ExpandTree (xint WindowId)`
	Expand the tree for the drawing.

`wfcFormatSizeData_ptr`	`GetFormatSize (xint Sheet)`


`xstring`	`GetLocationGridColumnFromPosition (pfcPoint3D_ptr Position, xint Sheet)`
	Outputs the location grid column for a specified location in screen coordinates.

`xstring`	`GetLocationGridRowFromPosition (pfcPoint3D_ptr Position, xint Sheet)`
	Outputs the location grid row for a specified location in screen coordinates.

`wfcIndustryStandard`	`GetToleranceStandard ()`
	Get the assigned tolerance standard of a drawing.

`xbool`	`IsSheetFormatBlanked (xint Sheet)`
	Checks if the sheet format is blanked.

`xbool`	`IsSheetFormatShown (xint Sheet)`


`void`	`RefreshTree (xint WindowId)`
	Refresh the tree for the drawing.

`void`	`SetFormatSize (wfcFormatSizeData_ptr Data, xint Sheet)`


`void`	`SetToleranceStandard (wfcIndustryStandard Standard)`
	Set the assigned tolerance standard of a drawing.

`void`	`ShowSheetFormat (xbool Show, xint Sheet)`

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

Method Detail

void SetFormatSize (wfcFormatSizeData_ptr Data, xint Sheet)

Manual References:: Drawings: Drawing Format Files, Drawings: Drawing Format Files

Parameters:

Data
Sheet

Returns:

wfcFormatSizeData_ptr GetFormatSize (xint Sheet)

Manual References:: Drawings: Drawing Format Files, Drawings: Drawing Format Files

Parameters:

Sheet

Returns:

void ShowSheetFormat (xbool Show, xint Sheet)

Manual References:: Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

Parameters:

Show
Sheet

Returns:

xbool IsSheetFormatShown (xint Sheet)

Manual References:: Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

Parameters:

Sheet

Returns:

xbool IsSheetFormatBlanked (xint Sheet)

Checks if the sheet format is blanked.

Manual References:: Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

Parameters:

Sheet: The sheet number. Set this to a value less than 1 for the current sheet.

Returns:: Boolean indicating whether the sheet is blanked or not.

void SetToleranceStandard (wfcIndustryStandard Standard)

Set the assigned tolerance standard of a drawing.

in the regular UI, this operation asks whether to regenerate the drawing. This function will not itself perform regeneration.

Manual References:: Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

Parameters:

Standard: The tolerance standard to set.

Returns:

wfcIndustryStandard GetToleranceStandard ()

Get the assigned tolerance standard of a drawing.

Manual References:: Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

Returns:: The tolerance standard.

void ExpandTree (xint WindowId)

Expand the tree for the drawing.

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - There is no change in the drawing tree

Manual References:: Drawings: Drawing Tree, Drawings: Drawing Tree

Parameters:

WindowId: Id of the window which contains the drawing. Use -1 to expand the drawing tree in the active window.

Returns:

void CollapseTree (xint WindowId)

Collapse the tree for the drawing.

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - There is no change in the drawing tree.

Manual References:: Drawings: Drawing Tree, Drawings: Drawing Tree

Parameters:

WindowId: Id of the window which contains the drawing. Use -1 to collapse the drawing tree in the active window.

Returns:

void RefreshTree (xint WindowId)

Refresh the tree for the drawing.

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - There is no change in the drawing tree

Manual References:: Drawings: Drawing Tree

Parameters:

WindowId: Id of the window which contains the drawing. Use -1 to refresh the drawing tree in the active window.

Returns:

xint CopyDrawingSheet (xint Sheet)

Create a copy of a drawing sheet.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType - Invalid model type specified.

pfcXToolkitCantModify - Drawing can't be modified.

pfcXToolkitCantWrite - Drawing sheet copy attempt failed.

Manual References:: Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

Parameters:

Sheet: The sheet number of the sheet to create a copy of. Set this to a value less than 1 for the current sheet.

Returns:: The sheet number of the copy.

xstring GetLocationGridColumnFromPosition (pfcPoint3D_ptr Position, xint Sheet)

Outputs the location grid column for a specified location in screen coordinates.

Exceptions thrown (but not limited to):

pfcXToolkitNotExist - No location grid is defined on the specified sheet

pfcXToolkitOutOfRange - 'Position' is outside of the location grid

Manual References:: Drawings: Access Drawing Location in Grid, Drawings: Access Drawing Location in Grid

Parameters:

Position: The location in screen coordinates.
Sheet: The sheet number. If not provided, the current sheet will be used.

Returns:: The label on the corresponding location grid column.

xstring GetLocationGridRowFromPosition (pfcPoint3D_ptr Position, xint Sheet)

Outputs the location grid row for a specified location in screen coordinates.

Exceptions thrown (but not limited to):

pfcXToolkitNotExist - No location grid is defined on the specified sheet

pfcXToolkitOutOfRange - 'Position' is outside of the location grid

Manual References:: Drawings: Access Drawing Location in Grid

Parameters:

Position: The location in screen coordinates.
Sheet: The sheet number. If not provided, the current sheet will be used.

Returns:: The label on the corresponding location grid row.

pfcDetailNoteItem_ptr CreateLeaderWithArrowTypeNote (pfcDetailTextLines_ptr TextLines, pfcAttachment_ptr NoteAttach, pfcDetailLeaderAttachments_ptr LeaderAttachs, wfcLeaderArrowTypes_ptr Types)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - Not enough memory.

Manual References:: Drawings: Drawing Sheet Operations

Parameters:

TextLines
NoteAttach
LeaderAttachs
Types

Returns: