CIP JAVA documentation for class "com.ptc.pfc.pfcDimension2D.Dimension2D"

Interface Dimension2D

SUCCESSOR(S): Dimension

package com.ptc.pfc.pfcDimension2D; public interface Dimension2D extends com.ptc.pfc.pfcDimension.BaseDimension

Description

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

See Also:: Model2D.CreateDrawingDimension(DrawingDimCreateInstructions), ModelItemOwner.GetItemById(ModelItemType, int), ModelItemOwner.ListItems(/*optional*/ ModelItemType)

Direct Known Subclasses:: WDimension2D

Method Summary
`Dimension2D`	`ConvertToBaseline (Vector2D 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 (Dimension2D 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.
`Selections`	`GetAttachmentPoints ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): Drawing.GetDimensionAttachPoints` Returns the attachment locations for a drawing dimension.
`/optional/ Dimension2D`	`GetBaselineDimension ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): Drawing.GetBaselineDimension` Returns the baseline dimension for an ordinate drawing dimension.
`DimensionSenses`	`GetDimensionSenses ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): Drawing.GetDimensionSenses` Returns the dimension senses for the drawing dimension.
`boolean`	`GetIsAssociative ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): Drawing.IsDimensionAssociative` Get method for attribute "IsAssociative" Whether or not the dimension is associative.
`boolean`	`GetIsDisplayed ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): <reference 1 to unknown entity >` Get method for attribute "IsDisplayed" Whether or not the dimension is current displayed in the drawing.
`boolean`	`GetIsReference ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): Dimension.IsReference` Determines if a drawing dimension is a reference dimension.
`boolean`	`GetIsToleranceDisplayed ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): Drawing.IsDimensionToleranceDisplayed` Get method for attribute "IsToleranceDisplayed" Whether or not the dimension's tolerance is displayed in the drawing.
`Point3D`	`GetLocation ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): Drawing.SetDimensionLocation` Get method for attribute "Location" The placement location of the dimension.
`OrientationHint`	`GetOrientationHint ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): Drawing.GetDimensionOrientHint` Returns the orientation hint used for placing the drawing dimension.
`/optional/ DimTolerance`	`GetTolerance ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): Dimension.GetTolerance` Retrieves parameters of a specified dimension.
`/optional/ View2D`	`GetView ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): Drawing.GetDimensionView` Returns the view associated with a drawing dimension.
`void`	`SetLocation (Point3D value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): Drawing.SetDimensionLocation` Set method for attribute "Location" The placement location of the dimension.
`void`	`SetTolerance ( /optional/ DimTolerance Limits)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): Dimension.GetTolerance` Sets the tolerance of the specified dimension of the object.
`void`	`SwitchView (View2D View)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): Drawing.SwitchDimensionView` Switches a drawing dimension to a new view.

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.BaseParameter`
`GetValue`, `SetValue`, `GetIsDesignated`, `SetIsDesignated`, `GetIsRelationDriven`, `GetIsModified`, `ResetFromBackup`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItem`
`GetName`, `SetName`, `GetId`, `GetType`

Methods Inherited from Interface `com.ptc.pfc.pfcDimension.BaseDimension`
`GetDimValue`, `SetDimValue`, `GetDimType`, `GetSymbol`, `SetSymbol`, `GetTexts`, `SetTexts`, `GetExtendsInNegativeDirection`, `Show`, `Erase`

Method Detail

GetIsReference

boolean GetIsReference ()

DEPRECATED: since Creo 4
SUCCESSOR(S): Dimension.IsReference

Determines if a drawing dimension is a reference dimension.

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

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

SetTolerance

void SetTolerance ( /*optional*/ DimTolerance Limits)

DEPRECATED: since Creo 4
SUCCESSOR(S): Dimension.GetTolerance

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.

Returns:

GetTolerance

/*optional*/ DimTolerance GetTolerance ()

DEPRECATED: since Creo 4
SUCCESSOR(S): Dimension.GetTolerance

Retrieves parameters of a specified dimension.

A null value indicates a nominal tolerance.

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

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

GetIsAssociative

boolean GetIsAssociative ()

DEPRECATED: since Creo 4
SUCCESSOR(S): Drawing.IsDimensionAssociative

Whether or not the dimension is associative.

GetIsToleranceDisplayed

boolean GetIsToleranceDisplayed ()

DEPRECATED: since Creo 4
SUCCESSOR(S): Drawing.IsDimensionToleranceDisplayed

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

GetBaselineDimension

/*optional*/ Dimension2D 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.

GetDimensionSenses

DimensionSenses 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 6 to unknown entity pfcExceptions::pfcXInAMethod>

See Also:: EmptyDimensionSense, PointDimensionSense, SplinePointDimensionSense, TangentIndexDimensionSense, LinAOCTangentDimensionSense, AngleDimensionSense, PointToAngleDimensionSense, Dimension2D.GetOrientationHint(), Dimension2D.GetAttachmentPoints()

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

GetAttachmentPoints

Selections 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:: Dimension2D.GetDimensionSenses(), Dimension2D.GetOrientationHint()

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

GetOrientationHint

OrientationHint 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:: Dimension2D.GetAttachmentPoints(), Dimension2D.GetDimensionSenses()

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

ConvertToLinear

void ConvertToLinear ()

DEPRECATED: since Creo 4
SUCCESSOR(S): Drawing.ConvertOrdinateDimensionToLinear

Converts an ordinate drawing dimension to a linear dimension.

The drawing must be displayed.

Returns:

ConvertToOrdinate

void ConvertToOrdinate (Dimension2D 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.

Returns:

ConvertToBaseline

Dimension2D ConvertToBaseline (Vector2D 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.

GetLocation/SetLocation

`Point3D`	`GetLocation`	`()`
`void`	`SetLocation`	`(Point3D value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): Drawing.SetDimensionLocation

The placement location of the dimension.

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

GetView

/*optional*/ View2D 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.

SwitchView

void SwitchView (View2D 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.

Returns:

GetIsDisplayed

boolean GetIsDisplayed ()

DEPRECATED: since Creo 4
SUCCESSOR(S): <reference 1 to unknown entity >

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

EraseFromModel2D

void EraseFromModel2D ()

DEPRECATED: since Creo 4
SUCCESSOR(S): Drawing.EraseDimension

Erases the dimension from drawing permanently.

Returns: