Library | Module

Interface IpfcDrawing



Description

This class describes a drawing.
Direct Parent Classes:
IpfcModel2D



Method Summary

FunctionConvertLinearDimensionToBaseline (Dim as IpfcDimension, Location as IpfcVector2D) as IpfcDimension
Converts an existing linear dimension to ordinate baseline. To use this method drawing must be displayed.
SubConvertLinearDimensionToOrdinate (Dim as IpfcDimension, BaselineDimension as IpfcDimension)
Converts an existing linear dimension to ordinate. To use this method drawing must be displayed.
SubConvertOrdinateDimensionToLinear (Dim as IpfcDimension)
Converts an existing ordinate dimension to linear. To use this method drawing must be displayed.
SubEraseDimension (Dim as IpfcDimension)
Erase dimension from specified drawing.
FunctionGetBaselineDimension (Dim as IpfcDimension) as IpfcDimension [optional]
Checks if dimension is an ordinate dimension and if it is ordinate then returns baseline dimension.
FunctionGetDimensionAttachPoints (Dim as IpfcDimension) as IpfcDimensionAttachments
Gets attachment information of dimension.
FunctionGetDimensionLocation (Dim as IpfcDimension) as IpfcPoint3D
Get location of dimension text in specified drawing.
FunctionGetDimensionOrientHint (Dim as IpfcDimension) as IpfcDimOrientationHint
Gets orientation of dimension
FunctionGetDimensionSenses (Dim as IpfcDimension) as IpfcDimSenses
Gets sense information of dimension.
FunctionGetDimensionView (Dim as IpfcDimension) as IpfcView2D [optional]
Get drawing view of dimension.
FunctionIsDimensionAssociative (Dim as IpfcDimension) as Boolean
Checks if solid dimension shown in drawing is associative.
FunctionIsDimensionShown (Dim as IpfcDimension) as Boolean
Checks if dimension is shown in a specified drawing.
FunctionIsDimensionToleranceDisplayed (Dim as IpfcDimension) as Boolean
Indicates whether a drawing dimension's tolerance is visible or not.
SubSetDimensionLocation (Dim as IpfcDimension, ToLocation as IpfcPoint3D)
Changes location of dimension text.
SubSwitchDimensionView (Dim as IpfcDimension, View as IpfcView2D)
Change view of the dimension in specified drawing.



Method Detail


FunctionConvertLinearDimensionToBaseline (Dim as IpfcDimension, Location as IpfcVector2D) as IpfcDimension

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:
 



SubConvertLinearDimensionToOrdinate (Dim as IpfcDimension, BaselineDimension as IpfcDimension)

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

Exceptions thrown (but not limited to):

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


Parameters:
Dim
Linear dimension.
BaselineDimension
Baseline dimension.



SubConvertOrdinateDimensionToLinear (Dim as IpfcDimension)

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

Exceptions thrown (but not limited to):

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


Parameters:
Dim
Dimension.



SubEraseDimension (Dim as IpfcDimension)

Erase dimension from specified drawing.

Exceptions thrown (but not limited to):

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


Parameters:
Dim
Dimension



FunctionGetBaselineDimension (Dim as IpfcDimension) as IpfcDimension [optional]

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.



FunctionGetDimensionAttachPoints (Dim as IpfcDimension) as IpfcDimensionAttachments

Gets attachment information of dimension.

Exceptions thrown (but not limited to):

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

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


Parameters:
Dim
Dimension.
Returns:
Attachment information



FunctionGetDimensionLocation (Dim as IpfcDimension) as IpfcPoint3D

Get location of dimension text in specified drawing.
Parameters:
Dim
Dimension
Returns:
Location.



FunctionGetDimensionOrientHint (Dim as IpfcDimension) as IpfcDimOrientationHint

Gets orientation of dimension

Exceptions thrown (but not limited to):

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

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


Parameters:
Dim
Dimension
Returns:
orientation



FunctionGetDimensionSenses (Dim as IpfcDimension) as IpfcDimSenses

Gets sense information of dimension.

Exceptions thrown (but not limited to):

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

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


Parameters:
Dim
Dimension.
Returns:
Array of sense.



FunctionGetDimensionView (Dim as IpfcDimension) as IpfcView2D [optional]

Get drawing view of dimension.

Exceptions thrown (but not limited to):

IpfcXToolkitNotDisplayed - The dimension is not displayed in the drawing.


Parameters:
Dim
 
Returns:
A drawing view.



FunctionIsDimensionAssociative (Dim as IpfcDimension) as Boolean

Checks if solid dimension shown in drawing is associative.
Parameters:
Dim
Solid dimension shown in the drawing.
Returns:
xtrue if dimension is associative.



FunctionIsDimensionShown (Dim as IpfcDimension) as Boolean

Checks if dimension is shown in a specified drawing.
Parameters:
Dim
Dimension.
Returns:
xtrue if it is shown.



FunctionIsDimensionToleranceDisplayed (Dim as IpfcDimension) as Boolean

Indicates whether a drawing dimension's tolerance is visible or not.
Parameters:
Dim
Dimension.
Returns:
xtrue if dimension's tolerance is visible.



SubSetDimensionLocation (Dim as IpfcDimension, ToLocation as IpfcPoint3D)

Changes location of dimension text.

Exceptions thrown (but not limited to):

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


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



SubSwitchDimensionView (Dim as IpfcDimension, View as IpfcView2D)

Change view of the dimension in specified drawing.

Exceptions thrown (but not limited to):

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


Parameters:
Dim
Dimension.
View
New drawing view.