CIP JAVA documentation for class "com.ptc.wfc.wfcModel.WModel2D"

Interface WModel2D

package com.ptc.wfc.wfcModel; public interface WModel2D extends com.ptc.wfc.wfcModel.WModel, com.ptc.pfc.pfcModel2D.Model2D

Description

Direct Known Subclasses:: WReport, WLayout, WDrawing

Method Summary
`void`	`CollapseTree (int WindowId)` Collapse the tree for the drawing.
`int`	`CopyDrawingSheet (int Sheet)` Create a copy of a drawing sheet.
`DetailNoteItem`	`CreateLeaderWithArrowTypeNote (DetailTextLines TextLines, Attachment NoteAttach, DetailLeaderAttachments LeaderAttachs, LeaderArrowTypes Types)` `LICENSE: 222`
`void`	`ExpandTree (int WindowId)` Expand the tree for the drawing.
`FormatSizeData`	`GetFormatSize (int Sheet)`
`String`	`GetLocationGridColumnFromPosition (Point3D Position, int Sheet)` Outputs the location grid column for a specified location in screen coordinates.
`String`	`GetLocationGridRowFromPosition (Point3D Position, int Sheet)` Outputs the location grid row for a specified location in screen coordinates.
`IndustryStandard`	`GetToleranceStandard ()` Get the assigned tolerance standard of a drawing.
`boolean`	`IsSheetFormatBlanked (int Sheet)` Checks if the sheet format is blanked.
`boolean`	`IsSheetFormatShown (int Sheet)`
`void`	`RefreshTree (int WindowId)` Refresh the tree for the drawing.
`void`	`SetFormatSize (FormatSizeData Data, int Sheet)`
`void`	`SetToleranceStandard (IndustryStandard Standard)` Set the assigned tolerance standard of a drawing.
`void`	`ShowSheetFormat (boolean Show, int Sheet)`

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WParameterOwner`
`ExportParameterTable`, `ApplyParameterTableset`, `MathcadParametersSet`, `MathcadInputParametersGet`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WRelationOwner`
`GetRelationConstraints`, `UnitsUsed`, `UseUnits`, `EvaluateExpressionWithUnits`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItemOwner`
`GetItemByName`, `GetItemById`, `ListItems`

Methods Inherited from Interface `com.ptc.pfc.pfcView.ViewOwner`
`RetrieveView`, `GetView`, `SaveView`, `GetCurrentViewTransform`, `SetCurrentViewTransform`, `CurrentViewRotate`, `ListViews`, `GetCurrentView`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcModel.Model`
`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 Interface com.ptc.pfc.pfcModel.Model

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 Interface `com.ptc.wfc.wfcModel.WModel`
`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 Interface com.ptc.wfc.wfcModel.WModel

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 Interface `com.ptc.pfc.pfcSheet.SheetOwner`
`GetNumberOfSheets`, `GetCurrentSheetNumber`, `SetCurrentSheetNumber`, `AddSheet`, `ReorderSheet`, `GetSheetData`, `GetSheetInfo`, `GetSheetTransform`, `RegenerateSheet`, `DeleteSheet`, `GetSheetScale`, `SetSheetScale`, `GetSheetFormat`, `SetSheetFormat`, `GetSheetBackgroundView`, `GetSheetUnits`, `GetSheetFormatDescr`

Methods Inherited from Interface `com.ptc.pfc.pfcDetail.DetailItemOwner`
`ListDetailItems`, `GetDetailItem`, `CreateDetailItem`, `CreateFreeNote`, `CreateOffsetNote`, `CreateOnItemNote`, `CreateLeaderNote`, `RetrieveSymbolDefinition`, `RetrieveSymbolDefItem`, `AllowReadonlyNoteSelection`

Methods Inherited from Interface `com.ptc.pfc.pfcTable.TableOwner`
`ListTables`, `GetTable`, `CreateTable`, `RetrieveTable`, `RetrieveTableByOrigin`, `UpdateTables`, `DeleteTable`

Methods Inherited from Interface `com.ptc.pfc.pfcModel2D.Model2D`
`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 Interface com.ptc.pfc.pfcModel2D.Model2D

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

SetFormatSize

void SetFormatSize (FormatSizeData Data, int Sheet)

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

Parameters:

Data
Sheet

Returns:

GetFormatSize

FormatSizeData GetFormatSize (int Sheet)

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

Parameters:

Sheet

Returns:

ShowSheetFormat

void ShowSheetFormat (boolean Show, int Sheet)

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

Parameters:

Show
Sheet

Returns:

IsSheetFormatShown

boolean IsSheetFormatShown (int Sheet)

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

Parameters:

Sheet

Returns:

IsSheetFormatBlanked

boolean IsSheetFormatBlanked (int 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.

SetToleranceStandard

void SetToleranceStandard (IndustryStandard 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:

GetToleranceStandard

IndustryStandard GetToleranceStandard ()

Get the assigned tolerance standard of a drawing.

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

Returns:: The tolerance standard.

ExpandTree

void ExpandTree (int WindowId)

Expand the tree for the drawing.

Exceptions thrown (but not limited to):

XToolkitNoChange - 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:

CollapseTree

void CollapseTree (int WindowId)

Collapse the tree for the drawing.

Exceptions thrown (but not limited to):

XToolkitNoChange - 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:

RefreshTree

void RefreshTree (int WindowId)

Refresh the tree for the drawing.

Exceptions thrown (but not limited to):

XToolkitNoChange - 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:

CopyDrawingSheet

int CopyDrawingSheet (int Sheet)

Create a copy of a drawing sheet.

Exceptions thrown (but not limited to):

XToolkitInvalidType - Invalid model type specified.

XToolkitCantModify - Drawing can't be modified.

XToolkitCantWrite - 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.

GetLocationGridColumnFromPosition

String GetLocationGridColumnFromPosition (Point3D Position, int Sheet)

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

Exceptions thrown (but not limited to):

XToolkitNotExist - No location grid is defined on the specified sheet

XToolkitOutOfRange - '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.

GetLocationGridRowFromPosition

String GetLocationGridRowFromPosition (Point3D Position, int Sheet)

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

Exceptions thrown (but not limited to):

XToolkitNotExist - No location grid is defined on the specified sheet

XToolkitOutOfRange - '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.

CreateLeaderWithArrowTypeNote

DetailNoteItem CreateLeaderWithArrowTypeNote (DetailTextLines TextLines, Attachment NoteAttach, DetailLeaderAttachments LeaderAttachs, LeaderArrowTypes Types)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - Not enough memory.

Manual References:: Drawings: Drawing Sheet Operations

Parameters:

TextLines
NoteAttach
LeaderAttachs
Types

Returns: