CIP JavaScript documentation for class " pfcDetailEntityInstructions"

Class pfcDetailEntityInstructions

Description

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

See Also:: pfcLineDescriptor.Create(), pfcArcDescriptor.Create(), pfcArrowDescriptor.Create(), pfcCircleDescriptor.Create(), pfcSplineDescriptor.Create(), pfcBSplineDescriptor.Create(), pfcEllipseDescriptor.Create(), pfcPolygonDescriptor.Create(), pfcCompositeCurveDescriptor.Create(), pfcModel2D.List2DViews(), pfcSheetOwner.GetSheetBackgroundView()

Direct Parent Classes:: pfcDetailCreateInstructions

Property Summary


`/* optional */ pfcColorRGB`	`Color`
	The color of the detail item. If `null`, the default drawing color is used.

`/* optional */ string`	`FontName`
	The name of the linestyle. If `null`, the default linestyle is used.

`pfcCurveDescriptor`	`Geometry`
	The geometry of the detail entity.

`/* optional */ boolean`	`IsConstruction`
	Whether or not the entity is construction. If `null`, the entity is not a construction entity.

`/* optional */ pfcView2D`	`View`
	The drawing view associated with the entity. This can be a view of a drawing model, or a drawing sheet background view.

`/* optional */ number`	`Width`
	The width of the entity line. If `null`, the default width is used.

Method Summary


`static pfcDetailEntityInstructions`	`Create (pfcCurveDescriptor inGeometry, /* optional */ pfcView2D inView)`
	Creates an instructions object describing how to construct a detail entity, for use in the methods `pfcDetailItemOwner.CreateDetailItem()`, `pfcDetailSymbolDefItem.CreateDetailItem()` and `pfcDetailEntityItem.Modify()`.

Property Detail

/* optional */ pfcColorRGB Color

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

/* optional */ string FontName

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

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No font name is specified.

pfcCurveDescriptor Geometry

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.

/* optional */ boolean IsConstruction

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

/* optional */ pfcView2D View

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.

/* optional */ number Width

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

Method Detail

static pfcDetailEntityInstructions Create (pfcCurveDescriptor inGeometry, /* optional */ pfcView2D inView)

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

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.

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().

Returns:: The created instructions object.