CIP JavaScript documentation for class " pfcDimension2D"

Class pfcDimension2D

DEPRECATED: since Creo 4SUCCESSOR(S): DimensionDescription

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

See Also:: pfcModel2D.CreateDrawingDimension(), pfcModelItemOwner.GetItemById(), pfcModelItemOwner.ListItems()

Direct Parent Classes:: pfcBaseDimension

Property Summary


`/* readonly */ boolean`	`IsAssociative`

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

`/* readonly */ boolean`	`IsDisplayed`

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

`/* readonly */ boolean`	`IsToleranceDisplayed`

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

`pfcPoint3D`	`Location`

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

Method Summary


`pfcDimension2D`	`ConvertToBaseline (pfcVector2D Location)`

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

`void`	`ConvertToLinear ()`

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

`void`	`ConvertToOrdinate (pfcDimension2D BaselineDimension)`

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

`void`	`EraseFromModel2D ()`

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

`pfcSelections`	`GetAttachmentPoints ()`

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

`/* optional */ pfcDimension2D`	`GetBaselineDimension ()`

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

`pfcDimensionSenses`	`GetDimensionSenses ()`

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

`boolean`	`GetIsReference ()`

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

`pfcOrientationHint`	`GetOrientationHint ()`

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

`/* optional */ pfcDimTolerance`	`GetTolerance ()`

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

`/* optional */ pfcView2D`	`GetView ()`

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

`void`	`SetTolerance ( /* optional */ pfcDimTolerance Limits)`

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

`void`	`SwitchView (pfcView2D View)`

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

Property Detail

/* readonly */ boolean IsAssociative


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

/* readonly */ boolean IsDisplayed


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

/* readonly */ boolean IsToleranceDisplayed


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

pfcPoint3D Location


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

Method Detail

pfcDimension2D ConvertToBaseline (pfcVector2D Location)


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

void ConvertToLinear ()


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

void ConvertToOrdinate (pfcDimension2D BaselineDimension)


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

void EraseFromModel2D ()


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

pfcSelections GetAttachmentPoints ()


`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: `pfcDimension2D.GetDimensionSenses()`, `pfcDimension2D.GetOrientationHint()` Returns: Sequence of attachment points. For information about how these attachments are interpreted, see the dimension senses array returned from `pfcDimension2D.GetDimensionSenses()`.

/* optional */ pfcDimension2D GetBaselineDimension ()


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

pfcDimensionSenses GetDimensionSenses ()


`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 4 to unknown entity pfcExceptions::pfcXInAMethod>` See Also: `pfcEmptyDimensionSense`, `pfcPointDimensionSense`, `pfcSplinePointDimensionSense`, `pfcTangentIndexDimensionSense`, `pfcLinAOCTangentDimensionSense`, `pfcAngleDimensionSense`, `pfcPointToAngleDimensionSense`, `pfcDimension2D.GetOrientationHint()`, `pfcDimension2D.GetAttachmentPoints()` Returns: Sequence of dimension senses, describing how the dimension is attached at each attachment returned from `pfcDimension2D.GetAttachmentPoints()`.

boolean GetIsReference ()


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

pfcOrientationHint GetOrientationHint ()


`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: `pfcDimension2D.GetAttachmentPoints()`, `pfcDimension2D.GetDimensionSenses()` Returns: The orientation hint, which determines how Creo Parametric will orient the dimension with respect to the attachment points.

/* optional */ pfcDimTolerance GetTolerance ()


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

/* optional */ pfcView2D GetView ()


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

void SetTolerance ( /* optional */ pfcDimTolerance Limits)


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

void SwitchView (pfcView2D View)


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