CIP Visual Basic.NET documentation for interface "IpfcDimension2D"

Interface IpfcDimension2D

DEPRECATED: since Creo 4SUCCESSOR(S): DimensionDescription

This interface represents a dimension or reference dimension in a drawing.

See Also:: IpfcModel2D.CreateDrawingDimension(), IpfcModelItemOwner.GetItemById(), IpfcModelItemOwner.ListItems()

Direct Parent Classes:: IpfcBaseDimension

Property Summary


`Property`	`IsAssociative`	`as Boolean`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Drawing.IsDimensionAssociative`
Whether or not the dimension is associative.

`Property`	`IsDisplayed`	`as Boolean`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): <reference 1 to unknown entity pfcDrawing::Drawing::IsDimensionDisplayed>`
Whether or not the dimension is current displayed in the drawing.

`Property`	`IsToleranceDisplayed`	`as Boolean`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Drawing.IsDimensionToleranceDisplayed`
Whether or not the dimension's tolerance is displayed in the drawing.

`Property`	`Location`	`as IpfcPoint3D`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Drawing.SetDimensionLocation`
The placement location of the dimension.

Method Summary


`Function`	`ConvertToBaseline (Location as IpfcVector2D) as IpfcDimension2D`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Drawing.ConvertLinearDimensionToBaseline`
Converts a location on a linear drawing dimension to be used as an ordinate baseline dimension. The linear dimension will be converted to ordinate.

`Sub`	`ConvertToLinear ()`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Drawing.ConvertOrdinateDimensionToLinear`
Converts an ordinate drawing dimension to a linear dimension.

`Sub`	`ConvertToOrdinate (BaselineDimension as IpfcDimension2D)`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Drawing.ConvertLinearDimensionToOrdinate`
Converts a linear drawing dimension to ordinate.

`Sub`	`EraseFromModel2D ()`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Drawing.EraseDimension`
Erases the dimension from drawing permanently.

`Function`	`GetAttachmentPoints () as IpfcSelections`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Drawing.GetDimensionAttachPoints`
Returns the attachment locations for a drawing dimension.

`Function`	`GetBaselineDimension () as IpfcDimension2D [optional]`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Drawing.GetBaselineDimension`
Returns the baseline dimension for an ordinate drawing dimension.

`Function`	`GetDimensionSenses () as IpfcDimensionSenses`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Drawing.GetDimensionSenses`
Returns the dimension senses for the drawing dimension.

`Function`	`GetIsReference () as Boolean`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Dimension.IsReference`
Determines if a drawing dimension is a reference dimension.

`Function`	`GetOrientationHint () as IpfcOrientationHint`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Drawing.GetDimensionOrientHint`
Returns the orientation hint used for placing the drawing dimension.

`Function`	`GetTolerance () as IpfcDimTolerance [optional]`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): <reference 1 to unknown entity pfcDimension::Dimension::Tolerance>`
Retrieves parameters of a specified dimension.

`Function`	`GetView () as IpfcView2D [optional]`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Drawing.GetDimensionView`
Returns the view associated with a drawing dimension.

`Sub`	`SetTolerance (Limits as IpfcDimTolerance [optional])`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): <reference 1 to unknown entity pfcDimension::Dimension::Tolerance>`
Sets the tolerance of the specified dimension of the object.

`Sub`	`SwitchView (View as IpfcView2D)`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Drawing.SwitchDimensionView`
Switches a drawing dimension to a new view.

Property Detail

Property IsAssociative as Boolean

DEPRECATED: since Creo 4

SUCCESSOR(S): Drawing.IsDimensionAssociative

Whether or not the dimension is associative.

Property IsDisplayed as Boolean

DEPRECATED: since Creo 4

SUCCESSOR(S): <reference 1 to unknown entity pfcDrawing::Drawing::IsDimensionDisplayed>

Whether or not the dimension is current displayed in the drawing.

Property IsToleranceDisplayed as Boolean

DEPRECATED: since Creo 4

SUCCESSOR(S): Drawing.IsDimensionToleranceDisplayed

Whether or not the dimension's tolerance is displayed in the drawing.

Property Location as IpfcPoint3D

DEPRECATED: since Creo 4

SUCCESSOR(S): Drawing.SetDimensionLocation

The placement location of the dimension.

Method Detail

Function ConvertToBaseline (Location as IpfcVector2D) as IpfcDimension2D

DEPRECATED: since Creo 4

SUCCESSOR(S): Drawing.ConvertLinearDimensionToBaseline

Converts a location on a linear drawing dimension to be used as an ordinate baseline dimension. The linear dimension will be converted to ordinate.

The drawing must be displayed.

Parameters:

Location: A point on one of the extension line of the linear dimension specified in screen coordinates.

Returns:: The newly created baseline dimension.

Sub ConvertToLinear ()

DEPRECATED: since Creo 4

SUCCESSOR(S): Drawing.ConvertOrdinateDimensionToLinear

Converts an ordinate drawing dimension to a linear dimension.

The drawing must be displayed.

Sub ConvertToOrdinate (BaselineDimension as IpfcDimension2D)

DEPRECATED: since Creo 4

SUCCESSOR(S): Drawing.ConvertLinearDimensionToOrdinate

Converts a linear drawing dimension to ordinate.

The drawing must be displayed.

Parameters:

BaselineDimension: The ordinate baseline dimension used for the conversion.

Sub EraseFromModel2D ()

DEPRECATED: since Creo 4

SUCCESSOR(S): Drawing.EraseDimension

Erases the dimension from drawing permanently.

Function GetAttachmentPoints () as IpfcSelections

DEPRECATED: since Creo 4

SUCCESSOR(S): Drawing.GetDimensionAttachPoints

Returns the attachment locations for a drawing dimension.

Applicable only for dimensions created in drawing mode. This function does not support dimensions created at intersection points of entities.

See Also:: IpfcDimension2D.GetDimensionSenses(), IpfcDimension2D.GetOrientationHint()

Returns:: Sequence of attachment points. For information about how these attachments are interpreted, see the dimension senses array returned from IpfcDimension2D.GetDimensionSenses().

Function GetBaselineDimension () as IpfcDimension2D [optional]

DEPRECATED: since Creo 4

SUCCESSOR(S): Drawing.GetBaselineDimension

Returns the baseline dimension for an ordinate drawing dimension.

The drawing must be displayed.

Returns:: The ordinate baseline dimension, or null if the dimension is not an ordinate dimension.

Function GetDimensionSenses () as IpfcDimensionSenses

DEPRECATED: since Creo 4

SUCCESSOR(S): Drawing.GetDimensionSenses

Returns the dimension senses for the drawing dimension.

Only applicable for dimensions created in drawing mode. This method does not support drawing dimensions created from intersections of geometric entities.

Exceptions thrown (but not limited to):

<reference to unknown entity pfcExceptions::pfcXInAMethod>

See Also:: IpfcEmptyDimensionSense, IpfcPointDimensionSense, IpfcSplinePointDimensionSense, IpfcTangentIndexDimensionSense, IpfcLinAOCTangentDimensionSense, IpfcAngleDimensionSense, IpfcPointToAngleDimensionSense, IpfcDimension2D.GetOrientationHint(), IpfcDimension2D.GetAttachmentPoints()

Returns:: Sequence of dimension senses, describing how the dimension is attached at each attachment returned from IpfcDimension2D.GetAttachmentPoints().

Function GetIsReference () as Boolean

DEPRECATED: since Creo 4

SUCCESSOR(S): Dimension.IsReference

Determines if a drawing dimension is a reference dimension.

Returns:: true if the dimension is a reference dimension, otherwise false.

Function GetOrientationHint () as IpfcOrientationHint

DEPRECATED: since Creo 4

SUCCESSOR(S): Drawing.GetDimensionOrientHint

Returns the orientation hint used for placing the drawing dimension.

Only applicable for dimensions created in drawing mode. This function does not support drawing dimensions created from intersections of geometric entities.

See Also:: IpfcDimension2D.GetAttachmentPoints(), IpfcDimension2D.GetDimensionSenses()

Returns:: The orientation hint, which determines how Creo Parametric will orient the dimension with respect to the attachment points.

Function GetTolerance () as IpfcDimTolerance [optional]

DEPRECATED: since Creo 4

SUCCESSOR(S): <reference 1 to unknown entity pfcDimension::Dimension::Tolerance>

Retrieves parameters of a specified dimension.

A null value indicates a nominal tolerance.

Returns:: The upper and lower limit of the dimension.

Function GetView () as IpfcView2D [optional]

DEPRECATED: since Creo 4

SUCCESSOR(S): Drawing.GetDimensionView

Returns the view associated with a drawing dimension.

Applies to dimensions stored in the solid or in the drawing.

Returns:: The drawing view where the dimension is displayed, or null, if the dimension is not attached to a drawing view.

Sub SetTolerance (Limits as IpfcDimTolerance [optional])

DEPRECATED: since Creo 4

SUCCESSOR(S): <reference 1 to unknown entity pfcDimension::Dimension::Tolerance>

Sets the tolerance of the specified dimension of the object.

A null value indicates a nominal tolerance.

Parameters:

Limits: The dimension's upper and lower limit.

Sub SwitchView (View as IpfcView2D)

DEPRECATED: since Creo 4

SUCCESSOR(S): Drawing.SwitchDimensionView

Switches a drawing dimension to a new view.

Applies to dimensions stored in the solid or in the drawing.

Parameters:

View: The new drawing view for the dimension.