CIP C++ documentation for class "pfcDetailEntityInstructions"

Class pfcDetailEntityInstructions

# include <pfcDetail.h> class pfcDetailEntityInstructions : public virtual pfcDetailCreateInstructions { xdeclare(pfcDetailEntityInstructions) ... }; This is a COMPACT class.

Description

This interface contains information used to describe a detail entity item. It may be used when creating detail entities (pfcDetailItemOwner::CreateDetailItem(pfcDetailCreateInstructions_ptr) and pfcDetailSymbolDefItem::CreateDetailItem(pfcDetailCreateInstructions_ptr)), or accessing existing entities (pfcDetailEntityItem::Modify(pfcDetailEntityInstructions_ptr) and pfcDetailEntityItem::GetInstructions()).

See Also:: pfcLineDescriptor::Create(pfcPoint3D_ptr, pfcPoint3D_ptr), pfcArcDescriptor::Create(pfcVector3D_ptr, pfcVector3D_ptr, pfcPoint3D_ptr, xreal, xreal, xreal), pfcArrowDescriptor::Create(pfcPoint3D_ptr, pfcPoint3D_ptr), pfcCircleDescriptor::Create(pfcPoint3D_ptr, xreal, pfcVector3D_ptr), pfcSplineDescriptor::Create(pfcSplinePoints_ptr), pfcBSplineDescriptor::Create(xint, pfcBSplinePoints_ptr, xrealsequence_ptr), pfcEllipseDescriptor::Create(pfcPoint3D_ptr, pfcVector3D_ptr, pfcVector3D_ptr, xreal, xreal, xreal, xreal), pfcPolygonDescriptor::Create(pfcPoint3Ds_ptr), pfcCompositeCurveDescriptor::Create(pfcCurveDescriptors_ptr), pfcModel2D::List2DViews(), pfcSheetOwner::GetSheetBackgroundView(xint)

Manual References:: Drawings: Symbol Instance Data

Method Summary


`static pfcDetailEntityInstructions_ptr`	`Create (pfcCurveDescriptor_ptr inGeometry, optional pfcView2D_ptr inView)`
	Creates an instructions object describing how to construct a detail entity, for use in the methods `pfcDetailItemOwner::CreateDetailItem(pfcDetailCreateInstructions_ptr)`, `pfcDetailSymbolDefItem::CreateDetailItem(pfcDetailCreateInstructions_ptr)` and `pfcDetailEntityItem::Modify(pfcDetailEntityInstructions_ptr)`.

`optional pfcColorRGB_ptr`	`GetColor ()`
`void`	`SetColor (optional pfcColorRGB_ptr value)`
	The color of the detail item. If `null`, the default drawing color is used.

`optional xstring`	`GetFontName ()`
`void`	`SetFontName (optional xrstring value)`
	The name of the linestyle. If `null`, the default linestyle is used.

`pfcCurveDescriptor_ptr`	`GetGeometry ()`
`void`	`SetGeometry (pfcCurveDescriptor_ptr value)`
	The geometry of the detail entity.

`optional xbool`	`GetIsConstruction ()`
`void`	`SetIsConstruction (optional xbool value)`
	Whether or not the entity is construction. If `null`, the entity is not a construction entity.

`optional pfcView2D_ptr`	`GetView ()`
`void`	`SetView (optional pfcView2D_ptr value)`
	The drawing view associated with the entity. This can be a view of a drawing model, or a drawing sheet background view.

`optional xreal`	`GetWidth ()`
`void`	`SetWidth (optional xreal value)`
	The width of the entity line. If `null`, the default width is used.

Methods Inherited from Class pfcDetailCreateInstructions:: GetType, GetId

Method Detail

`pfcCurveDescriptor_ptr`	`GetGeometry`	`()`
`void`	`SetGeometry`	`(pfcCurveDescriptor_ptr value)`

The geometry of the detail entity.

When creating a "circle" detail entity, use an arc with a start angle of 0 and an end angle of 2*PI. Creo Parametric represents circle detail entities with the pfcArcDescriptor object.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

`optional xbool`	`GetIsConstruction`	`()`
`void`	`SetIsConstruction`	`(optional xbool value)`

Whether or not the entity is construction. If null, the entity is not a construction entity.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

`optional pfcColorRGB_ptr`	`GetColor`	`()`
`void`	`SetColor`	`(optional pfcColorRGB_ptr value)`

The color of the detail item. If null, the default drawing color is used.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

`optional xstring`	`GetFontName`	`()`
`void`	`SetFontName`	`(optional xrstring value)`

The name of the linestyle. If null, the default linestyle is used.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No font name is specified.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

`optional xreal`	`GetWidth`	`()`
`void`	`SetWidth`	`(optional xreal value)`

The width of the entity line. If null, the default width is used.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

`optional pfcView2D_ptr`	`GetView`	`()`
`void`	`SetView`	`(optional pfcView2D_ptr value)`

The drawing view associated with the entity. This can be a view of a drawing model, or a drawing sheet background view.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The entity is not attached to a drawing view.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

static pfcDetailEntityInstructions_ptr Create (pfcCurveDescriptor_ptr inGeometry, optional pfcView2D_ptr inView)

Creates an instructions object describing how to construct a detail entity, for use in the methods pfcDetailItemOwner::CreateDetailItem(pfcDetailCreateInstructions_ptr), pfcDetailSymbolDefItem::CreateDetailItem(pfcDetailCreateInstructions_ptr) and pfcDetailEntityItem::Modify(pfcDetailEntityInstructions_ptr).

When creating a "circle" detail entity, use an arc with a start angle of 0 and an end angle of 2*PI. Creo Parametric represents circle detail entities with the pfcArcDescriptor object.

Manual References:: Drawings: Instructions, Drawings: Instructions

Parameters:

inGeometry: The curve geometry describing the trajectory of the detail entity (in screen coordinates).
inView: The drawing view associated with the entity. This can be a model view obtained from pfcModel2D::List2DViews(), or a drawing sheet background view obtained from pfcSheetOwner::GetSheetBackgroundView(xint).

Returns:: The created instructions object.