CIP JAVA documentation for class "com.ptc.wfc.wfcDrawing.WDrawing"

Interface WDrawing

package com.ptc.wfc.wfcDrawing; public interface WDrawing extends com.ptc.wfc.wfcModel.WModel2D, com.ptc.pfc.pfcDrawing.Drawing

Description

Extends the functionality of Drawing

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

Method Summary
`void`	`CleanupDimensions ( /optional/ View2D View)` Clean up dimensions for input view or for all views if input view is not supplied.
`Dimensions`	`CreateAutoOrdinateDimensions (Selections Surfaces, Selection Baseline)`
`View2D`	`CreateAuxiliaryView (AuxiliaryViewInstructions Instructions)`
`View2D`	`CreateDetailView (DetailViewInstructions Instructions, Point3D Location)`
`View2D`	`CreateRevolveView (RevolveViewInstructions Instructions)`
`void`	`EraseAnnotation (Annotation Annot)`
`Selection`	`Get2DAxis (Selection Axis3DSel, Point3D PointOnAxis)`
`Selection`	`Get3DAxis (Selection Axis2DSel)`
`Point3D`	`Get3DAxisLocation (Selection Axis2DSel)`
`ComponentPath`	`GetDimensionPath (Dimension Dimension)`
`View2D`	`GetDrawingView (int Id)`
`DualDimensionGlobalOptions`	`GetDualDimensionOptions ()`
`EdgeDisplay`	`GetEdgeDisplay (Selection Edge)`
`int`	`GetFormatSheet (int SheetNumber)`
`String`	`GetSheetName (int SheetNumber)`
`boolean`	`IsEdgeDisplayGlobal (Selection Edge)`
`/optional/ SetDatumTags`	`ListSetDatumTags ()` `LICENSE: 222` Gets datum tag annotations in a drawing.
`void`	`Merge (Drawing Drawing)`
`boolean`	`NeedsRegen ( /optional/ View2D View)`
`void`	`SetEdgeDisplay (Selection Edge, EdgeDisplay EdgeDisplay)`
`void`	`SetEdgeDisplayGlobal (Selection Edge, boolean makeGlobal)`
`Status`	`VisitDrawingModels (VisitingClient visitingClient)` Visits all models in a drawing.

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

Methods Inherited from Interface `com.ptc.wfc.wfcModel.WModel2D`
`SetFormatSize`, `GetFormatSize`, `ShowSheetFormat`, `IsSheetFormatShown`, `IsSheetFormatBlanked`, `SetToleranceStandard`, `GetToleranceStandard`, `ExpandTree`, `CollapseTree`, `RefreshTree`, `CopyDrawingSheet`, `GetLocationGridColumnFromPosition`, `GetLocationGridRowFromPosition`, `CreateLeaderWithArrowTypeNote`

Methods Inherited from Interface `com.ptc.pfc.pfcDrawing.Drawing`
`IsDimensionAssociative`, `IsDimensionToleranceDisplayed`, `GetBaselineDimension`, `GetDimensionSenses`, `GetDimensionAttachPoints`, `GetDimensionOrientHint`, `ConvertOrdinateDimensionToLinear`, `ConvertLinearDimensionToOrdinate`, `ConvertLinearDimensionToBaseline`, `SetDimensionLocation`, `GetDimensionLocation`, `GetDimensionView`, `SwitchDimensionView`, `IsDimensionShown`, `EraseDimension`

Method Detail

NeedsRegen

boolean NeedsRegen ( /*optional*/ View2D View)

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

Parameters:

View

Returns:

GetEdgeDisplay

EdgeDisplay GetEdgeDisplay (Selection Edge)

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

Parameters:

Edge

Returns:

SetEdgeDisplay

void SetEdgeDisplay (Selection Edge, EdgeDisplay EdgeDisplay)

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

Parameters:

Edge
EdgeDisplay

Returns:

SetEdgeDisplayGlobal

void SetEdgeDisplayGlobal (Selection Edge, boolean makeGlobal)

Manual References:: Drawings: Drawing Edges

Parameters:

Edge
makeGlobal

Returns:

IsEdgeDisplayGlobal

boolean IsEdgeDisplayGlobal (Selection Edge)

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

Parameters:

Edge

Returns:

GetDrawingView

View2D GetDrawingView (int Id)

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

Parameters:

Id

Returns:

Merge

void Merge (Drawing Drawing)

Manual References:: Drawings: Merge Drawings

Parameters:

Drawing

Returns:

CreateDetailView

View2D CreateDetailView (DetailViewInstructions Instructions, Point3D Location)

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

Parameters:

Instructions
Location

Returns:

CreateRevolveView

View2D CreateRevolveView (RevolveViewInstructions Instructions)

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

Parameters:

Instructions

Returns:

CreateAuxiliaryView

View2D CreateAuxiliaryView (AuxiliaryViewInstructions Instructions)

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

Parameters:

Instructions

Returns:

CreateAutoOrdinateDimensions

Dimensions CreateAutoOrdinateDimensions (Selections Surfaces, Selection Baseline)

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

Parameters:

Surfaces
Baseline

Returns:

CleanupDimensions

void CleanupDimensions ( /*optional*/ View2D View)

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

Exceptions thrown (but not limited to):

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

VisitDrawingModels

Status VisitDrawingModels (VisitingClient 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 WSession.ReleaseVisitor(VisitingClient) on it.

Exceptions thrown (but not limited to):

XToolkitNotFound - No drawing models were found

Manual References:: Drawings: Drawing Models

Parameters:

visitingClient: The visiting client.

Returns:

EraseAnnotation

void EraseAnnotation (Annotation Annot)

Exceptions thrown (but not limited to):

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

GetSheetName

String GetSheetName (int SheetNumber)

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

Parameters:

SheetNumber

Returns:

GetFormatSheet

int GetFormatSheet (int SheetNumber)

Exceptions thrown (but not limited to):

XToolkitNotFound - The sheet does not have a format

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

Parameters:

SheetNumber

Returns:

Get3DAxis

Selection Get3DAxis (Selection Axis2DSel)

Parameters:

Axis2DSel

Returns:

Get3DAxisLocation

Point3D Get3DAxisLocation (Selection Axis2DSel)

Parameters:

Axis2DSel

Returns:

Get2DAxis

Selection Get2DAxis (Selection Axis3DSel, Point3D PointOnAxis)

Parameters:

Axis3DSel
PointOnAxis

Returns:

GetDimensionPath

ComponentPath GetDimensionPath (Dimension Dimension)

Exceptions thrown (but not limited to):

XToolkitNotDisplayed - The dimension is not displayed in the drawing.

Exceptions thrown (but not limited to):

XToolkitNotDisplayed - The dimension is not displayed in the drawing.

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

Parameters:

Dimension

Returns:

GetDualDimensionOptions

DualDimensionGlobalOptions GetDualDimensionOptions ()

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

Returns:

ListSetDatumTags

/*optional*/ SetDatumTags ListSetDatumTags ()

LICENSE: 222

Gets datum tag annotations in a drawing.

Returns:: Returns wfcSetDatumTags_ptr