CIP JAVA documentation for class "com.ptc.pfc.pfcDrawing.Drawing"

Interface Drawing

package com.ptc.pfc.pfcDrawing; public interface Drawing extends com.ptc.pfc.pfcModel2D.Model2D

Description

This class describes a drawing.

Direct Known Subclasses:: WDrawing

Method Summary
`Dimension`	`ConvertLinearDimensionToBaseline (Dimension Dim, Vector2D Location)` Converts an existing linear dimension to ordinate baseline. To use this method drawing must be displayed.
`void`	`ConvertLinearDimensionToOrdinate (Dimension Dim, Dimension BaselineDimension)` Converts an existing linear dimension to ordinate. To use this method drawing must be displayed.
`void`	`ConvertOrdinateDimensionToLinear (Dimension Dim)` Converts an existing ordinate dimension to linear. To use this method drawing must be displayed.
`void`	`EraseDimension (Dimension Dim)` Erase dimension from specified drawing.
`/optional/ Dimension`	`GetBaselineDimension (Dimension Dim)` Checks if dimension is an ordinate dimension and if it is ordinate then returns baseline dimension.
`DimensionAttachments`	`GetDimensionAttachPoints (Dimension Dim)` Gets attachment information of dimension.
`Point3D`	`GetDimensionLocation (Dimension Dim)` Get location of dimension text in specified drawing.
`DimOrientationHint`	`GetDimensionOrientHint (Dimension Dim)` Gets orientation of dimension
`DimSenses`	`GetDimensionSenses (Dimension Dim)` Gets sense information of dimension.
`/optional/ View2D`	`GetDimensionView (Dimension Dim)` Get drawing view of dimension.
`boolean`	`IsDimensionAssociative (Dimension Dim)` Checks if solid dimension shown in drawing is associative.
`boolean`	`IsDimensionShown (Dimension Dim)` Checks if dimension is shown in a specified drawing.
`boolean`	`IsDimensionToleranceDisplayed (Dimension Dim)` Indicates whether a drawing dimension's tolerance is visible or not.
`void`	`SetDimensionLocation (Dimension Dim, Point3D ToLocation)` Changes location of dimension text.
`void`	`SwitchDimensionView (Dimension Dim, View2D View)` Change view of the dimension in specified drawing.

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.pfcObject.Parent`
`GetChild`

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.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

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

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

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

IsDimensionAssociative

boolean IsDimensionAssociative (Dimension Dim)

Checks if solid dimension shown in drawing is associative.

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

Parameters:

Dim: Solid dimension shown in the drawing.

Returns:: xtrue if dimension is associative.

IsDimensionToleranceDisplayed

boolean IsDimensionToleranceDisplayed (Dimension Dim)

Indicates whether a drawing dimension's tolerance is visible or not.

Manual References:: Drawings: Drawing Dimensions Information

Parameters:

Dim: Dimension.

Returns:: xtrue if dimension's tolerance is visible.

GetBaselineDimension

/*optional*/ Dimension GetBaselineDimension (Dimension Dim)

Checks if dimension is an ordinate dimension and if it is ordinate then returns baseline dimension.

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

Parameters:

Dim: Dimension.

Returns:: NULL value means dimension is not ordinate. For ordinate dimension returns its baseline.

GetDimensionSenses

DimSenses GetDimensionSenses (Dimension Dim)

Gets sense information of dimension.

Exceptions thrown (but not limited to):

XToolkitInvalidItem - the dimension specified is not a valid dimension created in drawing mode.

XToolkitInvalidType - the dimension sense type is not supported with this function.

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

Parameters:

Dim: Dimension.

Returns:: Array of sense.

GetDimensionAttachPoints

DimensionAttachments GetDimensionAttachPoints (Dimension Dim)

Gets attachment information of dimension.

Exceptions thrown (but not limited to):

XToolkitInvalidItem - the dimension specified is not a valid dimension created in drawing mode.

XToolkitInvalidType - the dimension sense type is not supported with this function.

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

Parameters:

Dim: Dimension.

Returns:: Attachment information

GetDimensionOrientHint

DimOrientationHint GetDimensionOrientHint (Dimension Dim)

Gets orientation of dimension

Exceptions thrown (but not limited to):

XToolkitInvalidItem - the dimension specified is not a valid dimension created in drawing mode.

XToolkitInvalidType - the dimension sense type is not supported with this function.

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

Parameters:

Dim: Dimension

Returns:: orientation

ConvertOrdinateDimensionToLinear

void ConvertOrdinateDimensionToLinear (Dimension Dim)

Converts an existing ordinate dimension to linear. To use this method drawing must be displayed.

Exceptions thrown (but not limited to):

XToolkitCantWrite - Could not modify the given item because it has read-only access.

Manual References:: Drawings: Drawing Dimensions Operations, Drawings: Drawing Dimensions Operations

Parameters:

Dim: Dimension.

Returns:

ConvertLinearDimensionToOrdinate

void ConvertLinearDimensionToOrdinate (Dimension Dim, Dimension BaselineDimension)

Converts an existing linear dimension to ordinate. To use this method drawing must be displayed.

Exceptions thrown (but not limited to):

XToolkitCantWrite - Could not modify the given item because it has read-only access.

Manual References:: Drawings: Drawing Dimensions Operations, Drawings: Drawing Dimensions Operations

Parameters:

Dim: Linear dimension.
BaselineDimension: Baseline dimension.

Returns:

ConvertLinearDimensionToBaseline

Dimension ConvertLinearDimensionToBaseline (Dimension Dim, Vector2D Location)

Converts an existing linear dimension to ordinate baseline. To use this method drawing must be displayed.

Parameters:

Dim: Linear dimension.
Location: A point on one of the extension lines of the linear dimension.

Returns:

SetDimensionLocation

void SetDimensionLocation (Dimension Dim, Point3D ToLocation)

Changes location of dimension text.

Exceptions thrown (but not limited to):

XToolkitCantWrite - Could not modify the given item because it has read-only access.

Parameters:

Dim: Dimension to be moved.
ToLocation: New location.

Returns:

GetDimensionLocation

Point3D GetDimensionLocation (Dimension Dim)

Get location of dimension text in specified drawing.

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

Parameters:

Dim: Dimension

Returns:: Location.

GetDimensionView

/*optional*/ View2D GetDimensionView (Dimension Dim)

Get drawing view of dimension.

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:

Dim

Returns:: A drawing view.

SwitchDimensionView

void SwitchDimensionView (Dimension Dim, View2D View)

Change view of the dimension in specified drawing.

Exceptions thrown (but not limited to):

XToolkitCantWrite - Could not delete the given item because it has read-only access.

Manual References:: Drawings: Drawing Dimensions Operations, Drawings: Drawing Dimensions Operations

Parameters:

Dim: Dimension.
View: New drawing view.

Returns:

IsDimensionShown

boolean IsDimensionShown (Dimension Dim)

Checks if dimension is shown in a specified drawing.

Parameters:

Dim: Dimension.

Returns:: xtrue if it is shown.

EraseDimension

void EraseDimension (Dimension Dim)

Erase dimension from specified drawing.

Exceptions thrown (but not limited to):

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

Manual References:: Drawings: Drawing Dimensions Operations, Drawings: Drawing Dimensions Operations

Parameters:

Dim: Dimension

Returns: