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

Class pfcDetail

package com.ptc.pfc.pfcDetail; public class pfcDetail

Description

Contains global CIP definitions for module "pfcDetail"

Method Summary
`static AnnotationTextStyle`	`AnnotationTextStyle_Create ()`
`static DetailAttachment`	`DetailAttachment_Create (Attachment NoteAttach, /optional/ DetailLeaderAttachments LeaderAttach)` Creates attachment data for detail item. Currently supports only notes.
`static DetailEntityInstructions`	`DetailEntityInstructions_Create (CurveDescriptor inGeometry, /optional/ View2D inView)` Creates an instructions object describing how to construct a detail entity, for use in the methods `DetailItemOwner.CreateDetailItem(DetailCreateInstructions)`, `DetailSymbolDefItem.CreateDetailItem(DetailCreateInstructions)` and `DetailEntityItem.Modify(DetailEntityInstructions)`.
`static DetailGroupInstructions`	`DetailGroupInstructions_Create (String inName, DetailItems inElements)` Creates an instructions data object used to describe the construction of a detail group, for use in the methods `DetailItemOwner.CreateDetailItem(DetailCreateInstructions)` and `DetailGroupItem.Modify(DetailGroupInstructions)`.
`static DetailLeaders`	`DetailLeaders_Create ()` Creates a data object describing a set of detail item leaders.
`static DetailNoteInstructions`	`DetailNoteInstructions_Create (DetailTextLines inTextLines)` Creates a data object used to describe how a detail note item should be construct, when passed to `DetailItemOwner.CreateDetailItem(DetailCreateInstructions)`, `DetailSymbolDefItem.CreateDetailItem(DetailCreateInstructions)`, or `DetailNoteItem.Modify(DetailNoteInstructions)`.
`static DetailSymbolDefInstructions`	`DetailSymbolDefInstructions_Create (String inFullPath)` Creates an instructions object used to create a symbol definition. Pass this object to `DetailItemOwner.CreateDetailItem(DetailCreateInstructions)` and `DetailSymbolDefItem.Modify(DetailSymbolDefInstructions)`.
`static DetailSymbolGroupInstructions`	`DetailSymbolGroupInstructions_Create (String Name, DetailItems Items)` Creates a data object having a specific name and list of detail items.
`static DetailSymbolInstInstructions`	`DetailSymbolInstInstructions_Create (DetailSymbolDefItem inSymbolDef)` Creates a data object containing information about a symbol instance placement. Pass this object to `DetailItemOwner.CreateDetailItem(DetailCreateInstructions)` and `DetailSymbolInstItem.Modify(DetailSymbolInstInstructions)`.
`static DetailText`	`DetailText_Create (String inText)` Creates a data object containing a text item in a note.
`static DetailTextLine`	`DetailTextLine_Create (DetailTexts inTexts)` Creates a data object containing a line of text in a note.
`static DetailVariantText`	`DetailVariantText_Create (String inPrompt, String inValue)` Creates a data object describing the replacement of variable text in a symbol definition.
`static FreeAttachment`	`FreeAttachment_Create (Point3D inAttachmentPoint)` Creates a data object used for representing a free attachment. A free attachment is relative to a fixed location, or relative to a fixed location with respect to a drawing view.
`static LeaderAttachment`	`LeaderAttachment_Create (Attachment LeaderAttachs)` Creates leader attachment.
`static NormalLeaderAttachment`	`NormalLeaderAttachment_Create (Attachment LeaderAttachs)` Creates normal leader attachment.
`static OffsetAttachment`	`OffsetAttachment_Create (Selection inAttachedGeometry, Point3D inAttachmentPoint)` Creates a data object, used for attaching a detail item, offset to a reference point or axis.
`static ParametricAttachment`	`ParametricAttachment_Create (Selection inAttachedGeometry)` Creates a data object, used for attaching a detail item to an item.
`static SymbolDefAttachment`	`SymbolDefAttachment_Create (SymbolDefAttachmentType inType, Point3D inAttachmentPoint)` Creates a data object that represents the way that an instance may be attached to a symbol definition.
`static TangentLeaderAttachment`	`TangentLeaderAttachment_Create (Attachment LeaderAttachs)` Creates tangent leader attachment.
`static TextReference`	`TextReference_Create (DetailNoteItem inTextRefNote, int inTextLineNumber, int inTextIndexNumber)` Creates a data object that identifies the text item used for a symbol definition which as a height type of SYMDEF_TEXT_RELATED.

Method Detail

FreeAttachment_Create

static FreeAttachment FreeAttachment_Create (Point3D inAttachmentPoint)

Creates a data object used for representing a free attachment. A free attachment is relative to a fixed location, or relative to a fixed location with respect to a drawing view.

See Also:: DetailLeaders

Parameters:

inAttachmentPoint: The attachment point, in screen coordinates.

Returns:

OffsetAttachment_Create

static OffsetAttachment OffsetAttachment_Create (Selection inAttachedGeometry, Point3D inAttachmentPoint)

Creates a data object, used for attaching a detail item, offset to a reference point or axis.

See Also:: DetailLeaders, BaseSession.Select(SelectionOptions, /*optional*/ Selections), pfcSelect.CreateComponentSelection(ComponentPath), pfcSelect.CreateModelItemSelection(ModelItem, /*optional*/ ComponentPath)

Parameters:

inAttachedGeometry: Selection representing the item to attach to. This should include the drawing model view. The attachment will occur at the selected parameters
inAttachmentPoint: The attachment point, in screen coordinates.

Returns:

ParametricAttachment_Create

static ParametricAttachment ParametricAttachment_Create (Selection inAttachedGeometry)

Creates a data object, used for attaching a detail item to an item.

See Also:: DetailLeaders, BaseSession.Select(SelectionOptions, /*optional*/ Selections), pfcSelect.CreateComponentSelection(ComponentPath), pfcSelect.CreateModelItemSelection(ModelItem, /*optional*/ ComponentPath)

Parameters:

inAttachedGeometry: Selection representing the item to attach to. This should include the drawing model view. The attachment will occur at the selected parameters

Returns:

LeaderAttachment_Create

static LeaderAttachment LeaderAttachment_Create (Attachment LeaderAttachs)

Creates leader attachment.

Parameters:

LeaderAttachs: attachment

Returns:: leader attachment

NormalLeaderAttachment_Create

static NormalLeaderAttachment NormalLeaderAttachment_Create (Attachment LeaderAttachs)

Creates normal leader attachment.

Parameters:

LeaderAttachs: attachment

Returns:: normal leader attachment.

TangentLeaderAttachment_Create

static TangentLeaderAttachment TangentLeaderAttachment_Create (Attachment LeaderAttachs)

Creates tangent leader attachment.

Parameters:

LeaderAttachs: attachment

Returns:: tangent leader attachment.

DetailAttachment_Create

static DetailAttachment DetailAttachment_Create (Attachment NoteAttach, /*optional*/ DetailLeaderAttachments LeaderAttach)

Creates attachment data for detail item. Currently supports only notes.

Parameters:

NoteAttach: Attachment of note text.
LeaderAttach: Attachment of note leader.

Returns:

DetailLeaders_Create

static DetailLeaders DetailLeaders_Create ()

Creates a data object describing a set of detail item leaders.

Returns:: The created data object.

DetailEntityInstructions_Create

static DetailEntityInstructions DetailEntityInstructions_Create (CurveDescriptor inGeometry, /*optional*/ View2D inView)

Creates an instructions object describing how to construct a detail entity, for use in the methods DetailItemOwner.CreateDetailItem(DetailCreateInstructions), DetailSymbolDefItem.CreateDetailItem(DetailCreateInstructions) and DetailEntityItem.Modify(DetailEntityInstructions).

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

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 Model2D.List2DViews(), or a drawing sheet background view obtained from SheetOwner.GetSheetBackgroundView(int).

Returns:: The created instructions object.

AnnotationTextStyle_Create

static AnnotationTextStyle AnnotationTextStyle_Create ()

Manual References:: Annotations: Annotation Features and Annotations: Annotation Text Styles, Annotations: Annotation Features and Annotations: Annotation Text Styles

Returns:

DetailText_Create

static DetailText DetailText_Create (String inText)

Creates a data object containing a text item in a note.

Parameters:

inText: The text string.

Returns:: The created data object.

DetailTextLine_Create

static DetailTextLine DetailTextLine_Create (DetailTexts inTexts)

Creates a data object containing a line of text in a note.

Parameters:

inTexts: The text strings that make up the line.

Returns:: The created data object.

DetailNoteInstructions_Create

static DetailNoteInstructions DetailNoteInstructions_Create (DetailTextLines inTextLines)

Creates a data object used to describe how a detail note item should be construct, when passed to DetailItemOwner.CreateDetailItem(DetailCreateInstructions), DetailSymbolDefItem.CreateDetailItem(DetailCreateInstructions), or DetailNoteItem.Modify(DetailNoteInstructions).

Manual References:: Drawings: Instructions, Drawings: Instructions

Parameters:

inTextLines: Sequence of text line data objects describing the contents of the note.

Returns:: The created data object.

SymbolDefAttachment_Create

static SymbolDefAttachment SymbolDefAttachment_Create (SymbolDefAttachmentType inType, Point3D inAttachmentPoint)

Creates a data object that represents the way that an instance may be attached to a symbol definition.

See Also:: DetailSymbolDefInstructions

Parameters:

inType: The type of attachment.
inAttachmentPoint: The attachment point, in the coordinate system of the symbol definition.

Returns:

TextReference_Create

static TextReference TextReference_Create (DetailNoteItem inTextRefNote, int inTextLineNumber, int inTextIndexNumber)

Creates a data object that identifies the text item used for a symbol definition which as a height type of SYMDEF_TEXT_RELATED.

See Also:: SymbolDefHeight, DetailSymbolDefInstructions, DetailSymbolDefItem.ListDetailItems(/*optional*/ DetailType), DetailSymbolDefItem.GetDetailItem(DetailType, int), DetailSymbolDefItem.CreateDetailItem(DetailCreateInstructions)

Parameters:

inTextRefNote: The note item containing the text.
inTextLineNumber: The line number of the note.
inTextIndexNumber: The index of the text, on this line.

Returns:

DetailSymbolDefInstructions_Create

static DetailSymbolDefInstructions DetailSymbolDefInstructions_Create (String inFullPath)

Creates an instructions object used to create a symbol definition. Pass this object to DetailItemOwner.CreateDetailItem(DetailCreateInstructions) and DetailSymbolDefItem.Modify(DetailSymbolDefInstructions).

Manual References:: Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions

Parameters:

inFullPath: Path and name for the symbol definition.

Returns:: The instructions data object.

DetailSymbolGroupInstructions_Create

static DetailSymbolGroupInstructions DetailSymbolGroupInstructions_Create (String Name, DetailItems Items)

Creates a data object having a specific name and list of detail items.

Manual References:: Drawings: Detail Symbol Groups, Drawings: Detail Symbol Groups

Parameters:

Name: The name of the symbol group.
Items: The detail items to be included in the symbol group.

Returns:: The symbol group instructions object.

DetailVariantText_Create

static DetailVariantText DetailVariantText_Create (String inPrompt, String inValue)

Creates a data object describing the replacement of variable text in a symbol definition.

Parameters:

inPrompt: The variable text in the symbol definition (without the boundary "\" characters).
inValue: The text to use in place of the variable text in a symbol instance placement.

Returns:: The created data object.

DetailSymbolInstInstructions_Create

static DetailSymbolInstInstructions DetailSymbolInstInstructions_Create (DetailSymbolDefItem inSymbolDef)

Creates a data object containing information about a symbol instance placement. Pass this object to DetailItemOwner.CreateDetailItem(DetailCreateInstructions) and DetailSymbolInstItem.Modify(DetailSymbolInstInstructions).

Manual References:: Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances

Parameters:

inSymbolDef: The symbol definition.

Returns:: The instructions data object.

DetailGroupInstructions_Create

static DetailGroupInstructions DetailGroupInstructions_Create (String inName, DetailItems inElements)

Creates an instructions data object used to describe the construction of a detail group, for use in the methods DetailItemOwner.CreateDetailItem(DetailCreateInstructions) and DetailGroupItem.Modify(DetailGroupInstructions).

Manual References:: Drawings: Creating a Detail Item, Drawings: Instructions, Drawings: Instructions

Parameters:

inName: The name of the group to create.
inElements: Sequence of detail items (these must be entities, groups or notes).

Returns:: The instructions data object.