CIP C++ documentation for class "pfcDimension2D"

Class pfcDimension2D

SUCCESSOR(S): pfcDimension

# include <pfcDimension2D.h> class pfcDimension2D : public virtual pfcBaseDimension { xaideclare(pfcDimension2D) ... };

Description

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

See Also:: pfcModel2D::CreateDrawingDimension(pfcDrawingDimCreateInstructions_ptr), pfcModelItemOwner::GetItemById(pfcModelItemType, xint), pfcModelItemOwner::ListItems(optional pfcModelItemType)

Direct Known Subclasses:: wfcWDimension2D

Method Summary


`pfcDimension2D_ptr`	`ConvertToBaseline (pfcVector2D_ptr Location)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDrawing::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): pfcDrawing::ConvertOrdinateDimensionToLinear` Converts an ordinate drawing dimension to a linear dimension.

`void`	`ConvertToOrdinate (pfcDimension2D_ptr BaselineDimension)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDrawing::ConvertLinearDimensionToOrdinate` Converts a linear drawing dimension to ordinate.

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

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

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

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

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

`xbool`	`GetIsDisplayed ()`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): <reference 3 to unknown entity >` Whether or not the dimension is current displayed in the drawing.

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

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

`pfcPoint3D_ptr`	`GetLocation ()`
`void`	`SetLocation (pfcPoint3D_ptr value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDrawing::SetDimensionLocation` The placement location of the dimension.

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

`optional pfcDimTolerance_ptr`	`GetTolerance ()`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDimension::GetTolerance` Retrieves parameters of a specified dimension.

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

	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDrawing::SetDimensionLocation`

`void`	`SetTolerance (optional pfcDimTolerance_ptr Limits)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDimension::GetTolerance` Sets the tolerance of the specified dimension of the object.

`void`	`SwitchView (pfcView2D_ptr View)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDrawing::SwitchDimensionView` Switches a drawing dimension to a new view.

Methods Inherited from Class pfcBaseParameter:: GetValue, SetValue, GetIsDesignated, SetIsDesignated, GetIsRelationDriven, GetIsModified, ResetFromBackup

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Methods Inherited from Class pfcBaseDimension:: GetDimValue, SetDimValue, GetDimType, GetSymbol, SetSymbol, GetTexts, SetTexts, GetExtendsInNegativeDirection, Show, Erase

Method Detail

xbool GetIsReference ()

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDimension::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.

void SetTolerance (optional pfcDimTolerance_ptr Limits)

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDimension::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:

optional pfcDimTolerance_ptr GetTolerance ()

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDimension::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.

xbool GetIsAssociative ()

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDrawing::IsDimensionAssociative

Whether or not the dimension is associative.

xbool GetIsToleranceDisplayed ()

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDrawing::IsDimensionToleranceDisplayed

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

optional pfcDimension2D_ptr GetBaselineDimension ()

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDrawing::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_ptr GetDimensionSenses ()

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDrawing::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()

Manual References:: Drawings: Drawing Dimensions Information

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

pfcSelections_ptr GetAttachmentPoints ()

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDrawing::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().

pfcOrientationHint GetOrientationHint ()

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDrawing::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.

void ConvertToLinear ()

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDrawing::ConvertOrdinateDimensionToLinear

Converts an ordinate drawing dimension to a linear dimension.

The drawing must be displayed.

Returns:

void ConvertToOrdinate (pfcDimension2D_ptr BaselineDimension)

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDrawing::ConvertLinearDimensionToOrdinate

Converts a linear drawing dimension to ordinate.

The drawing must be displayed.

Parameters:

BaselineDimension: The ordinate baseline dimension used for the conversion.

Returns:

pfcDimension2D_ptr ConvertToBaseline (pfcVector2D_ptr Location)

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDrawing::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.

`pfcPoint3D_ptr`	`GetLocation`	`()`
`void`	`SetLocation`	`(pfcPoint3D_ptr value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDrawing::SetDimensionLocation

The placement location of the dimension.

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

optional pfcView2D_ptr GetView ()

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDrawing::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 SwitchView (pfcView2D_ptr View)

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDrawing::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:

xbool GetIsDisplayed ()

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

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

void EraseFromModel2D ()

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDrawing::EraseDimension

Erases the dimension from drawing permanently.

Returns: