CIP C++ documentation for class "pfcDrawingDimCreateInstructions"

Class pfcDrawingDimCreateInstructions

# include <pfcDimension2D.h> class pfcDrawingDimCreateInstructions : public virtual xobject { xdeclare(pfcDrawingDimCreateInstructions) ... }; This is a COMPACT class.

Description

This interface is used for creating a drawing dimension.

See Also:: pfcModel2D::CreateDrawingDimension(pfcDrawingDimCreateInstructions_ptr)

Method Summary


`static pfcDrawingDimCreateInstructions_ptr`	`Create (pfcSelections_ptr Attachments, pfcDimensionSenses_ptr Senses, pfcVector2D_ptr TextLocation, pfcOrientationHint Hint)`
	`DEPRECATED: since Creo 4` Create an instructions object used to create a new dimension in a drawing.

`pfcSelections_ptr`	`GetAttachments ()`
`void`	`SetAttachments (pfcSelections_ptr value)`
	`DEPRECATED: since Creo 4` The entities that the dimension references. The selections should include the drawing model view.

`xbool`	`GetDisplay ()`
`void`	`SetDisplay (xbool value)`
	`DEPRECATED: since Creo 4` Whether or not to display the new dimension upon creation. The default is `true`.

`xbool`	`GetIsRefDimension ()`
`void`	`SetIsRefDimension (xbool value)`
	`DEPRECATED: since Creo 4` `true` if the dimension should be a reference dimension, `null` or `false` otherwise.

`pfcOrientationHint`	`GetOrientationHint ()`
`void`	`SetOrientationHint (pfcOrientationHint value)`
	`DEPRECATED: since Creo 4` The orientation hint for proper dimension placement.

`pfcDimensionSenses_ptr`	`GetSenses ()`
`void`	`SetSenses (pfcDimensionSenses_ptr value)`
	`DEPRECATED: since Creo 4` The dimension senses associated with the dimension attachments.

`pfcVector2D_ptr`	`GetTextLocation ()`
`void`	`SetTextLocation (pfcVector2D_ptr value)`
	`DEPRECATED: since Creo 4` The location of the dimension text, in screen coordinates.

	`DEPRECATED: since Creo 4`

	`DEPRECATED: since Creo 4`

	`DEPRECATED: since Creo 4`

	`DEPRECATED: since Creo 4`

	`DEPRECATED: since Creo 4`

	`DEPRECATED: since Creo 4`

Method Detail

`pfcSelections_ptr`	`GetAttachments`	`()`
`void`	`SetAttachments`	`(pfcSelections_ptr value)`

DEPRECATED: since Creo 4

The entities that the dimension references. The selections should include the drawing model view.

`pfcDimensionSenses_ptr`	`GetSenses`	`()`
`void`	`SetSenses`	`(pfcDimensionSenses_ptr value)`

DEPRECATED: since Creo 4

The dimension senses associated with the dimension attachments.

`pfcVector2D_ptr`	`GetTextLocation`	`()`
`void`	`SetTextLocation`	`(pfcVector2D_ptr value)`

DEPRECATED: since Creo 4

The location of the dimension text, in screen coordinates.

`xbool`	`GetIsRefDimension`	`()`
`void`	`SetIsRefDimension`	`(xbool value)`

DEPRECATED: since Creo 4

true if the dimension should be a reference dimension, null or false otherwise.

`pfcOrientationHint`	`GetOrientationHint`	`()`
`void`	`SetOrientationHint`	`(pfcOrientationHint value)`

DEPRECATED: since Creo 4

The orientation hint for proper dimension placement.

`xbool`	`GetDisplay`	`()`
`void`	`SetDisplay`	`(xbool value)`

DEPRECATED: since Creo 4

Whether or not to display the new dimension upon creation. The default is true.

static pfcDrawingDimCreateInstructions_ptr Create (pfcSelections_ptr Attachments, pfcDimensionSenses_ptr Senses, pfcVector2D_ptr TextLocation, pfcOrientationHint Hint)

DEPRECATED: since Creo 4

Create an instructions object used to create a new dimension in a drawing.

See Also:: pfcModel2D::CreateDrawingDimension(pfcDrawingDimCreateInstructions_ptr), pfcAngleDimensionSense, pfcEmptyDimensionSense, pfcLinAOCTangentDimensionSense, pfcPointDimensionSense, pfcPointToAngleDimensionSense, pfcSplinePointDimensionSense, pfcTangentIndexDimensionSense

Manual References:: Drawings: Creating Drawing Dimensions, Drawings: Creating Drawing Dimensions

Parameters:

Attachments: The attachment point(s) used to place the dimension.
Senses: The dimension senses corresponding to each attachment point. There should be one dimension sense for each attachment point.
TextLocation: The point used to calculate the location of the dimension text.
Hint: The orientation hint for the dimension.

Returns:: The created instructions object.