CIP JAVA documentation for class "com.ptc.pfc.pfcDetail.DetailEntityInstructions"

Interface DetailEntityInstructions

package com.ptc.pfc.pfcDetail; public interface DetailEntityInstructions extends com.ptc.pfc.pfcDetail.DetailCreateInstructions

Description

This interface contains information used to describe a detail entity item. It may be used when creating detail entities (DetailItemOwner.CreateDetailItem(DetailCreateInstructions) and DetailSymbolDefItem.CreateDetailItem(DetailCreateInstructions)), or accessing existing entities (DetailEntityItem.Modify(DetailEntityInstructions) and DetailEntityItem.GetInstructions()).

See Also:: pfcGeometry.LineDescriptor_Create(Point3D, Point3D), pfcGeometry.ArcDescriptor_Create(Vector3D, Vector3D, Point3D, double, double, double), pfcGeometry.ArrowDescriptor_Create(Point3D, Point3D), pfcGeometry.CircleDescriptor_Create(Point3D, double, Vector3D), pfcGeometry.SplineDescriptor_Create(SplinePoints), pfcGeometry.BSplineDescriptor_Create(int, BSplinePoints, realseq), pfcGeometry.EllipseDescriptor_Create(Point3D, Vector3D, Vector3D, double, double, double, double), pfcGeometry.PolygonDescriptor_Create(Point3Ds), pfcGeometry.CompositeCurveDescriptor_Create(CurveDescriptors), Model2D.List2DViews(), SheetOwner.GetSheetBackgroundView(int)

Method Summary
`/optional/ ColorRGB`	`GetColor ()` Get method for attribute "Color" The color of the detail item. If `null`, the default drawing color is used.
`/optional/ String`	`GetFontName ()` Get method for attribute "FontName" The name of the linestyle. If `null`, the default linestyle is used.
`CurveDescriptor`	`GetGeometry ()` Get method for attribute "Geometry" The geometry of the detail entity.
`/optional/ Boolean`	`GetIsConstruction ()` Get method for attribute "IsConstruction" Whether or not the entity is construction. If `null`, the entity is not a construction entity.
`/optional/ View2D`	`GetView ()` Get method for attribute "View" The drawing view associated with the entity. This can be a view of a drawing model, or a drawing sheet background view.
`/optional/ Double`	`GetWidth ()` Get method for attribute "Width" The width of the entity line. If `null`, the default width is used.
`void`	`SetColor ( /optional/ ColorRGB value)` Set method for attribute "Color" The color of the detail item. If `null`, the default drawing color is used.
`void`	`SetFontName ( /optional/ String value)` Set method for attribute "FontName" The name of the linestyle. If `null`, the default linestyle is used.
`void`	`SetGeometry (CurveDescriptor value)` Set method for attribute "Geometry" The geometry of the detail entity.
`void`	`SetIsConstruction ( /optional/ Boolean value)` Set method for attribute "IsConstruction" Whether or not the entity is construction. If `null`, the entity is not a construction entity.
`void`	`SetView ( /optional/ View2D value)` Set method for attribute "View" The drawing view associated with the entity. This can be a view of a drawing model, or a drawing sheet background view.
`void`	`SetWidth ( /optional/ Double value)` Set method for attribute "Width" The width of the entity line. If `null`, the default width is used.

Methods Inherited from Interface `com.ptc.pfc.pfcDetail.DetailCreateInstructions`
`GetType`, `GetId`

Method Detail

GetGeometry/SetGeometry

`CurveDescriptor`	`GetGeometry`	`()`
`void`	`SetGeometry`	`(CurveDescriptor 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 ArcDescriptor object.

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

GetIsConstruction/SetIsConstruction

`/optional/ Boolean`	`GetIsConstruction`	`()`
`void`	`SetIsConstruction`	`( /optional/ Boolean 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

GetColor/SetColor

`/optional/ ColorRGB`	`GetColor`	`()`
`void`	`SetColor`	`( /optional/ ColorRGB 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

GetFontName/SetFontName

`/optional/ String`	`GetFontName`	`()`
`void`	`SetFontName`	`( /optional/ String value)`

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

Exceptions thrown (but not limited to):

XToolkitNotFound - No font name is specified.

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

GetWidth/SetWidth

`/optional/ Double`	`GetWidth`	`()`
`void`	`SetWidth`	`( /optional/ Double value)`

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

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

GetView/SetView

`/optional/ View2D`	`GetView`	`()`
`void`	`SetView`	`( /optional/ View2D 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):

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

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