CIP JavaScript documentation for class " pfcDrawing"

Class pfcDrawing

Description

This class describes a drawing.

Direct Parent Classes:: pfcModel2D

Method Summary


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

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

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

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

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

`pfcDimensionAttachments`	`GetDimensionAttachPoints (pfcDimension Dim)`
	Gets attachment information of dimension.

`pfcPoint3D`	`GetDimensionLocation (pfcDimension Dim)`
	Get location of dimension text in specified drawing.

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

`pfcDimSenses`	`GetDimensionSenses (pfcDimension Dim)`
	Gets sense information of dimension.

`/* optional */ pfcView2D`	`GetDimensionView (pfcDimension Dim)`
	Get drawing view of dimension.

`boolean`	`IsDimensionAssociative (pfcDimension Dim)`
	Checks if solid dimension shown in drawing is associative.

`boolean`	`IsDimensionShown (pfcDimension Dim)`
	Checks if dimension is shown in a specified drawing.

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

`void`	`SetDimensionLocation (pfcDimension Dim, pfcPoint3D ToLocation)`
	Changes location of dimension text.

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

Method Detail

pfcDimension ConvertLinearDimensionToBaseline (pfcDimension Dim, pfcVector2D 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 ConvertLinearDimensionToOrdinate (pfcDimension Dim, pfcDimension 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.

Parameters:

Dim: Linear dimension.
BaselineDimension: Baseline dimension.

void ConvertOrdinateDimensionToLinear (pfcDimension 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.

Parameters:

Dim: Dimension.

void EraseDimension (pfcDimension Dim)

Erase dimension from specified drawing.

Exceptions thrown (but not limited to):

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

Parameters:

Dim: Dimension

/* optional */ pfcDimension GetBaselineDimension (pfcDimension Dim)

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

Parameters:

Dim: Dimension.

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

pfcDimensionAttachments GetDimensionAttachPoints (pfcDimension 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.

Parameters:

Dim: Dimension.

Returns:: Attachment information

pfcPoint3D GetDimensionLocation (pfcDimension Dim)

Get location of dimension text in specified drawing.

Parameters:

Dim: Dimension

Returns:: Location.

pfcDimOrientationHint GetDimensionOrientHint (pfcDimension 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.

Parameters:

Dim: Dimension

Returns:: orientation

pfcDimSenses GetDimensionSenses (pfcDimension 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.

Parameters:

Dim: Dimension.

Returns:: Array of sense.

/* optional */ pfcView2D GetDimensionView (pfcDimension Dim)

Get drawing view of dimension.

Exceptions thrown (but not limited to):

pfcXToolkitNotDisplayed - The dimension is not displayed in the drawing.

Parameters:

Dim

Returns:: A drawing view.

boolean IsDimensionAssociative (pfcDimension Dim)

Checks if solid dimension shown in drawing is associative.

Parameters:

Dim: Solid dimension shown in the drawing.

Returns:: xtrue if dimension is associative.

boolean IsDimensionShown (pfcDimension Dim)

Checks if dimension is shown in a specified drawing.

Parameters:

Dim: Dimension.

Returns:: xtrue if it is shown.

boolean IsDimensionToleranceDisplayed (pfcDimension Dim)

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

Parameters:

Dim: Dimension.

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

void SetDimensionLocation (pfcDimension Dim, pfcPoint3D 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.

void SwitchDimensionView (pfcDimension Dim, pfcView2D 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.

Parameters:

Dim: Dimension.
View: New drawing view.