CIP C++ documentation for class "pfcDrawing"

Class pfcDrawing

# include <pfcDrawing.h> class pfcDrawing : public virtual pfcModel2D { xaideclare(pfcDrawing) ... };

Description

This class describes a drawing.

Direct Known Subclasses:: wfcWDrawing

Method Summary


`pfcDimension_ptr`	`ConvertLinearDimensionToBaseline (pfcDimension_ptr Dim, pfcVector2D_ptr Location)`
	Converts an existing linear dimension to ordinate baseline. To use this method drawing must be displayed.

`void`	`ConvertLinearDimensionToOrdinate (pfcDimension_ptr Dim, pfcDimension_ptr BaselineDimension)`
	Converts an existing linear dimension to ordinate. To use this method drawing must be displayed.

`void`	`ConvertOrdinateDimensionToLinear (pfcDimension_ptr Dim)`
	Converts an existing ordinate dimension to linear. To use this method drawing must be displayed.

`void`	`EraseDimension (pfcDimension_ptr Dim)`
	Erase dimension from specified drawing.

`optional pfcDimension_ptr`	`GetBaselineDimension (pfcDimension_ptr Dim)`
	Checks if dimension is an ordinate dimension and if it is ordinate then returns baseline dimension.

`pfcDimensionAttachments_ptr`	`GetDimensionAttachPoints (pfcDimension_ptr Dim)`
	Gets attachment information of dimension.

`pfcPoint3D_ptr`	`GetDimensionLocation (pfcDimension_ptr Dim)`
	Get location of dimension text in specified drawing.

`pfcDimOrientationHint`	`GetDimensionOrientHint (pfcDimension_ptr Dim)`
	Gets orientation of dimension

`pfcDimSenses_ptr`	`GetDimensionSenses (pfcDimension_ptr Dim)`
	Gets sense information of dimension.

`optional pfcView2D_ptr`	`GetDimensionView (pfcDimension_ptr Dim)`
	Get drawing view of dimension.

`xbool`	`IsDimensionAssociative (pfcDimension_ptr Dim)`
	Checks if solid dimension shown in drawing is associative.

`xbool`	`IsDimensionShown (pfcDimension_ptr Dim)`
	Checks if dimension is shown in a specified drawing.

`xbool`	`IsDimensionToleranceDisplayed (pfcDimension_ptr Dim)`
	Indicates whether a drawing dimension's tolerance is visible or not.

`void`	`SetDimensionLocation (pfcDimension_ptr Dim, pfcPoint3D_ptr ToLocation)`
	Changes location of dimension text.

`void`	`SwitchDimensionView (pfcDimension_ptr Dim, pfcView2D_ptr View)`
	Change view of the dimension in specified drawing.

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 pfcParent:: GetChild

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 pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

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

xbool IsDimensionAssociative (pfcDimension_ptr 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.

xbool IsDimensionToleranceDisplayed (pfcDimension_ptr 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.

optional pfcDimension_ptr GetBaselineDimension (pfcDimension_ptr 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.

pfcDimSenses_ptr GetDimensionSenses (pfcDimension_ptr Dim)

Gets sense information of dimension.

Exceptions thrown (but not limited to):

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

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

pfcDimensionAttachments_ptr GetDimensionAttachPoints (pfcDimension_ptr Dim)

Gets attachment information of dimension.

Exceptions thrown (but not limited to):

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

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

pfcDimOrientationHint GetDimensionOrientHint (pfcDimension_ptr Dim)

Gets orientation of dimension

Exceptions thrown (but not limited to):

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

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

void ConvertOrdinateDimensionToLinear (pfcDimension_ptr Dim)

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

Exceptions thrown (but not limited to):

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

void ConvertLinearDimensionToOrdinate (pfcDimension_ptr Dim, pfcDimension_ptr BaselineDimension)

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

Exceptions thrown (but not limited to):

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

pfcDimension_ptr ConvertLinearDimensionToBaseline (pfcDimension_ptr Dim, pfcVector2D_ptr 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:

void SetDimensionLocation (pfcDimension_ptr Dim, pfcPoint3D_ptr ToLocation)

Changes location of dimension text.

Exceptions thrown (but not limited to):

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

Parameters:

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

Returns:

pfcPoint3D_ptr GetDimensionLocation (pfcDimension_ptr Dim)

Get location of dimension text in specified drawing.

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

Parameters:

Dim: Dimension

Returns:: Location.

optional pfcView2D_ptr GetDimensionView (pfcDimension_ptr Dim)

Get drawing view of dimension.

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:

Dim

Returns:: A drawing view.

void SwitchDimensionView (pfcDimension_ptr Dim, pfcView2D_ptr View)

Change view of the dimension in specified drawing.

Exceptions thrown (but not limited to):

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

xbool IsDimensionShown (pfcDimension_ptr Dim)

Checks if dimension is shown in a specified drawing.

Parameters:

Dim: Dimension.

Returns:: xtrue if it is shown.

void EraseDimension (pfcDimension_ptr Dim)

Erase dimension from specified drawing.

Exceptions thrown (but not limited to):

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

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

Parameters:

Dim: Dimension

Returns: